LockResource Method

Obtain a lock for a specified resource.

Syntax

public void lockResource(String resourceURI);

Remarks

The LockResource method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. The method is linked to a number of properties that it uses to generate the lock request:


LockOwner	The principle that will own the lock.
LockScope	The scope of the lock. The bean only currently supports locks of scope "exclusive" and "shared".
LockTimeout	The amount of time that the lock is allowed to exist before ResourceURI is automatically unlocked by the server.
LockTokens	The lock itself. If the user sets this before making the request, the timeout on the existing lock will be refreshed (reset to 0). Otherwise, a new set of lock tokens will be returned.
LockType	The type of lock. The bean only currently supports of type "write".

After a successful call to the LockResource method the bean will receive the new lock values, which it will parse and store in the lock properties.

This method is associated with the Depth property. If Depth is set to "0", the bean will lock only ResourceURI and its properties. If Depth is set to "infinity", the bean will lock ResourceURI and its entire subtree.

If MoveResource or CopyResource are used to place a resource or collection in a location under a resource locked with "infinity", the new resource or collection will be added to the lock. Any lock on a collection will prevent non-lock owners from adding resources to that collection.