ithit.webdav.server/Class2/ILock.d.ts

With IT Hit WebDAV Server Engine for Node.js you can create your own WebDAV server, add WebDAV support to your existing Node.js project or DAV-enable your CMS/DMS/CRM.

import { LockInfo } from "./LockInfo";
import { LockLevel } from "./LockLevel";
import { LockResult } from "./LockResult";
import { RefreshLockResult } from "./RefreshLockResult";
/**
 * Defines the properties and methods that WebDAV Class 2 compliant server hierarchy items must implement.
 * @remarks This interface provides the means for locking the hierarchy item, updating lock timeout and accessing the
 * list of applied locks. To create WebDAV Class 2 compliant server you must implement this interface on
 * your file and folder items.
 *
 * When this interface is implemented on an item the server reports Class 2 compliance, returning DAV: 1, 2, 3
 * header in response to the OPTIONS request. Note that while most WebDAV clients never lock folder items,
 * you must still add this interface on folders, as soon as WebDAV clients submit OPTIONS request against folder
 * items when discovering server compliance.
 *
 * When a WebDAV client requires to protect an item from concurrent updates, it locks the item (usually file),
 * submitting lock request to server. The server generates the new lock-token, marks the item as locked and returns
 * the new lock-token to the client. The WebDAV client application keeps the lock-token and when it requires to
 * perform any updates, it supplies the lock-token with the request. When the server receives the update request,
 * it verifies that the lock token belongs to the item that is being updated and performs modifications.
 */
export interface ILock {
    /**
     * Gets the IEnumerable with all locks for this item.
     * @exception NeedPrivilegesException The user doesn't have enough privileges.
     * @exception DavException In other cases.
     * @remarks This property must return all locks for the item including deep locks on any of the parent folders.
     */
    getActiveLocks(): Promise<LockInfo[]>;
    /**
     * Locks this item.
     * @param level Whether lock is shared or exclusive. If an exclusive lock is set other users are not
     * be able to set any locks. If a shared lock is set other users are able to set shared lock on the item.
     * @param isDeep Specifies if the lock applied only to this item or to the entire subtree.
     * @param requestedTimeOut Lock timeout which was requested by client. Note that your server can ignore this parameter and set
     * timeout that is different from the one requested by client.
     * Some clients may not provide any timeout. The null is passed in this case.
     * @param owner Owner of the lock as specified by client.
     * @exception LockedException This folder was locked. Client did not provide the lock token.
     * @exception NeedPrivilegesException The user doesn't have enough privileges.
     * @exception InsufficientStorageException Quota limit is reached.
     * @exception MultistatusException Errors has occured during processing of the subtree.
     * @exception DavException In other cases.{@link LockResult}
     * @returns that contains lock-token and timeout that was actually set.
     * @remarks This method is called when item is being locked by {@link LockResult}  WebDAV client. In your implementation you must do the following:
     * 1. Generate the new lock-token, usually GUID.
     * 2. Save information about the lock in a storage.
     * 3. Associate the lock with the item in the repository.
     * 4. Return the lock-token to the Engine.
     *
     * Optionally in in this method you can modify the lock timeout requested by client. For example instead of infinity
     * lock you can set lock for some limited time. You must return both lock-token and lock timeout via {@link LockResult}
     * return value, the engine than sends the lock-token and timeout values back to WebDAV client.
     */
    lock(level: LockLevel, isDeep: boolean, requestedTimeOut: number | null, owner: string): Promise<LockResult>;
    /**
     * Updates lock timeout information on this item.
     * @param token Lock token.
     * @param requestedTimeOut Lock timeout which was requested by client. Note that your server can ignore this parameter and set
     * timeout that is different from the one requested by client.
     * @exception LockedException This folder was locked. Client did not provide the lock token.
     * @exception NeedPrivilegesException The user doesn't have enough privileges.
     * @exception InsufficientStorageException Quota limit is reached.
     * @exception MultistatusException Errors has occurred during processing of the subtree.
     * @exception DavException In other cases.
     * @returns that contains information about the lock including timeout that was actually set.
     * @remarks  This method is called when WebDAV client wants to modify (usually prolong) timeout for the previously
     * set lock. In this method implementation you can update the lock timeout. Note that you can ignore the requested
     * timout and set timeout that is different from the one requested by client.
     */
    refreshLock(token: string, requestedTimeOut: number | null): Promise<RefreshLockResult>;
    /**
     * Removes lock with the specified token from this item.
     * @param lockToken Lock with this token should be removed from the item.
     * @exception LockedException This folder was locked. Client did not provide the lock token.
     * @exception NeedPrivilegesException The user doesn't have enough privileges.
     * @exception InsufficientStorageException Quota limit is reached.
     * @exception MultistatusException Errors has occured during processing of the subtree.
     * @exception DavException In other cases.
     * @remarks
     * If this lock included more than one hierarchy item, the lock is removed from all items included in the lock.
     */
    unlock(lockToken: string): Promise<void>;
}