org.apache.jackrabbit.jcr2spi.lock

Class LockManagerImpl

java.lang.Object

org.apache.jackrabbit.jcr2spi.lock.LockManagerImpl

All Implemented Interfaces:

LockStateManager, SessionListener

public class LockManagerImpl
extends Object
implements LockStateManager, SessionListener

LockManagerImpl... TODO: TOBEFIXED. Lock objects obtained through this mgr are not informed if another session is or becomes lock-holder and removes the lock again.

Constructor Summary

Constructors

Constructor and Description
LockManagerImpl(WorkspaceManager wspManager, ItemManager itemManager, CacheBehaviour cacheBehaviour)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLockToken(String lt) Delegates this call to WorkspaceManager.addLockToken(String).
void	checkLock(NodeState nodeState) Check whether the given node state is locked by somebody else than the current session.
javax.jcr.lock.Lock	getLock(NodeState nodeState) If the session created a lock on the node with the given state, we already know the lock.
String[]	getLockTokens() Returns the lock tokens present on the SessionInfo this manager has been created with.
boolean	isLocked(NodeState nodeState) Returns true if this node is locked either as a result of a lock held by this node or by a deep lock on a node above this node; otherwise returns false.
javax.jcr.lock.Lock	lock(NodeState nodeState, boolean isDeep, boolean isSessionScoped) Lock a node.
javax.jcr.lock.Lock	lock(NodeState nodeState, boolean isDeep, boolean isSessionScoped, long timeoutHint, String ownerHint) Lock a node.
void	loggedOut(javax.jcr.Session session) Called when a Session has been 'closed' by calling Session.logout().
void	loggingOut(javax.jcr.Session session) Called when a Session is about to be 'closed' by calling Session.logout().
void	removeLockToken(String lt) If the lock addressed by the token is session-scoped, this method will throw a LockException, such as defined by JSR170 v.1.0.1 for Session.removeLockToken(String). Otherwise the call is delegated to WorkspaceManager.removeLockToken(String).
void	unlock(NodeState nodeState) Removes the lock on a node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LockManagerImpl

public LockManagerImpl(WorkspaceManager wspManager,
               ItemManager itemManager,
               CacheBehaviour cacheBehaviour)

Method Detail

lock

public javax.jcr.lock.Lock lock(NodeState nodeState,
                       boolean isDeep,
                       boolean isSessionScoped)
                         throws javax.jcr.lock.LockException,
                                javax.jcr.RepositoryException

Description copied from interface: LockStateManager

Lock a node. Checks whether the node is not locked and then returns a lock object for this node.

Specified by:

lock in interface LockStateManager

isDeep - whether the lock applies to this node only

isSessionScoped - whether the lock is session scoped

Returns:

lock object

Throws:

javax.jcr.lock.LockException - if this node already is locked, or some descendant node is locked and isDeep is true

javax.jcr.RepositoryException

See Also:

LockStateManager.lock(NodeState,boolean,boolean)

lock

public javax.jcr.lock.Lock lock(NodeState nodeState,
                       boolean isDeep,
                       boolean isSessionScoped,
                       long timeoutHint,
                       String ownerHint)
                         throws javax.jcr.RepositoryException

Description copied from interface: LockStateManager

Lock a node. Checks whether the node is not locked and then returns a lock object for this node.

Specified by:

lock in interface LockStateManager

isDeep - whether the lock applies to this node only

isSessionScoped - whether the lock is session scoped

timeoutHint - optional timeout hint.

ownerHint - optional String defining the lock owner info to be displayed.

Returns:

lock object

Throws:

javax.jcr.lock.LockException - if this node already is locked, or some descendant node is locked and isDeep is true

javax.jcr.RepositoryException

See Also:

LockStateManager.lock(NodeState,boolean,boolean,long,String)

unlock

public void unlock(NodeState nodeState)
            throws javax.jcr.lock.LockException,
                   javax.jcr.RepositoryException

Description copied from interface: LockStateManager

Removes the lock on a node.

Specified by:

unlock in interface LockStateManager

Throws:

javax.jcr.lock.LockException - if this node is not locked or the session does not have the correct lock token

javax.jcr.RepositoryException

See Also:

LockStateManager.unlock(NodeState)

getLock

public javax.jcr.lock.Lock getLock(NodeState nodeState)
                            throws javax.jcr.lock.LockException,
                                   javax.jcr.RepositoryException

If the session created a lock on the node with the given state, we already know the lock. Otherwise, the node state and its ancestors are searched for properties indicating a lock.
Note, that the flag indicating session-scoped lock cannot be retrieved unless the current session is the lock holder.

Specified by:

getLock in interface LockStateManager

Parameters:

nodeState -

Returns:

lock object

Throws:

javax.jcr.lock.LockException - if this node is not locked

javax.jcr.RepositoryException

See Also:

LockStateManager.getLock(NodeState)

isLocked

public boolean isLocked(NodeState nodeState)
                 throws javax.jcr.RepositoryException

Description copied from interface: LockStateManager

Returns true if this node is locked either as a result of a lock held by this node or by a deep lock on a node above this node; otherwise returns false.

Specified by:

isLocked in interface LockStateManager

Returns:

true if this node is locked either as a result of a lock held by this node or by a deep lock on a node above this node; otherwise returns false

Throws:

javax.jcr.RepositoryException - If an error occurs.

See Also:

LockStateManager.isLocked(NodeState)

checkLock

public void checkLock(NodeState nodeState)
               throws javax.jcr.lock.LockException,
                      javax.jcr.RepositoryException

Description copied from interface: LockStateManager

Check whether the given node state is locked by somebody else than the current session. Access is allowed if the node is not locked or if the session itself holds the lock to this node, i.e. the session contains the lock token for the lock. If the node is not locked at all this method returns silently.

Specified by:

checkLock in interface LockStateManager

Throws:

javax.jcr.lock.LockException - if write access to the specified node is not allowed

javax.jcr.RepositoryException - if some other error occurs

See Also:

LockStateManager.checkLock(NodeState)

getLockTokens

public String[] getLockTokens()
                       throws javax.jcr.UnsupportedRepositoryOperationException,
                              javax.jcr.RepositoryException

Returns the lock tokens present on the SessionInfo this manager has been created with.

Specified by:

getLockTokens in interface LockStateManager

Returns:

The lock tokens associated with the Session this lock manager has been created for.

Throws:

javax.jcr.UnsupportedRepositoryOperationException

javax.jcr.RepositoryException

See Also:

LockStateManager.getLockTokens()

addLockToken

public void addLockToken(String lt)
                  throws javax.jcr.lock.LockException,
                         javax.jcr.RepositoryException

Delegates this call to WorkspaceManager.addLockToken(String). If this succeeds this method will inform all locks stored in the local map in order to give them the chance to update their lock information.

Specified by:

addLockToken in interface LockStateManager

Parameters:

lt - added lock token

Throws:

javax.jcr.lock.LockException

javax.jcr.RepositoryException

See Also:

LockStateManager.addLockToken(String)

removeLockToken

public void removeLockToken(String lt)
                     throws javax.jcr.lock.LockException,
                            javax.jcr.RepositoryException

If the lock addressed by the token is session-scoped, this method will throw a LockException, such as defined by JSR170 v.1.0.1 for Session.removeLockToken(String).
Otherwise the call is delegated to WorkspaceManager.removeLockToken(String). All locks stored in the local lock map are notified by the removed token in order have them updated their lock information.

Specified by:

removeLockToken in interface LockStateManager

Parameters:

lt - removed lock token

Throws:

javax.jcr.lock.LockException

javax.jcr.RepositoryException

See Also:

LockStateManager.removeLockToken(String)

loggingOut

public void loggingOut(javax.jcr.Session session)

Description copied from interface: SessionListener

Called when a Session is about to be 'closed' by calling Session.logout(). At this moment the session is still valid.

Specified by:

loggingOut in interface SessionListener

Parameters:

session - the Session that is about to be 'closed'

See Also:

SessionListener.loggingOut(Session)

loggedOut

public void loggedOut(javax.jcr.Session session)

Description copied from interface: SessionListener

Called when a Session has been 'closed' by calling Session.logout().

Specified by:

loggedOut in interface SessionListener

Parameters:

session - the Session that has been 'closed'

See Also:

SessionListener.loggedOut(Session)