com.sap.netweaver.bc.rf.mi.lock
Interface IMutableLockManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.mi_api.jar]

All Superinterfaces:

ILockManager

public interface IMutableLockManager

extends ILockManager

Read-And-Write interface describing a repository sub manager for locking. Resources may be locked shallow or deep (in the resource hierarchy), exclusiv or shared (concerning concurrent access) and for reading or writing. Shallow locks affect only the given resource handle (content, properties, etc. and the namespace, not the resources, below the resource), where deep locks effect also the descendents in the resource hierarchy. Exclusive locks block any other lock from being obtained on the given resource handle and block any unlocked access. Shared locks block any exclusive lock from being obtained on the given resource handle and block any unlocked access too, but allow for further shared locks. Write locks block any other lock from being obtained on the given resource handle and block any unlocked access. Read locks block any write lock from being obtained on the given resource handle and block any unlocked access too, but allow for further read locks.

Method Summary

ILockInfo	lock(IResourceHandle resourceHandle, ILockDescriptor lockDescriptor) Lock a resource (content, properties, etc. and the namespace, not the resources, below the resource).
ILockInfo	refreshLock(IResourceHandle resourceHandle, java.lang.String lockToken) Refresh, i.e. reset the timer of the given lock for a given resource handle until the lock is released automatically.
void	unlock(IResourceHandle resourceHandle, java.lang.String lockToken) Unlock a resource (content, properties, etc. and the namespace, not the resources, below the resource).

Methods inherited from interface com.sap.netweaver.bc.rf.mi.lock.ILockManager

getLocks

Method Detail

lock

public ILockInfo lock(IResourceHandle resourceHandle,
                      ILockDescriptor lockDescriptor)
               throws ResourceException

Lock a resource (content, properties, etc. and the namespace, not the resources, below the resource).

Parameters:

resourceHandle - resource handle

lockDescriptor - lock descriptor object describing the properties of the lock

Returns:

lock info object describing the state of the lock

Throws:

ResourceException - when the lock can't be obtained

unlock

public void unlock(IResourceHandle resourceHandle,
                   java.lang.String lockToken)
            throws ResourceException

Unlock a resource (content, properties, etc. and the namespace, not the resources, below the resource).

Parameters:

resourceHandle - resource handle

lockToken - lock token identifying the lock

Throws:

ResourceException - when the lock can't be released

refreshLock

public ILockInfo refreshLock(IResourceHandle resourceHandle,
                             java.lang.String lockToken)
                      throws ResourceException

Refresh, i.e. reset the timer of the given lock for a given resource handle until the lock is released automatically.

Parameters:

resourceHandle - resource handle

lockToken - lock token identifying the lock

Returns:

lock info object describing the new state of the lock

Throws:

ResourceException - when the lock can't be refreshed