javax.jcr.lock
Interface Lock

public interface Lock

Represents a lock placed on an item.

Author:

Peeter Piegaze

Method Summary

java.lang.String	getLockOwner() Returns the user ID of the user who owns this lock.
java.lang.String	getLockToken() May return the lock token for this lock.
Node	getNode() Returns the lock holding node.
boolean	isDeep() Returns true if this is a deep lock; false otherwise.
boolean	isLive() Returns true if this Lock object represents a lock that is currently in effect.
boolean	isSessionScoped() Returns true if this is a session-scoped lock.
void	refresh() If this lock's time-to-live is governed by a timer, this method resets that timer so that the lock does not timeout and expire.

Method Detail

getLockOwner

public java.lang.String getLockOwner()

Returns the user ID of the user who owns this lock. This is the value of the jcr:lockOwner property of the lock-holding node. It is also the value returned by Session.getUserID at the time that the lock was placed. The lock owner's identity is only provided for informational purposes. It does not govern who can perform an unlock or make changes to the locked nodes; that depends entirely upon who the token holder is.

Returns:

a user ID.

isDeep

public boolean isDeep()

Returns true if this is a deep lock; false otherwise.

Returns:

a boolean

getNode

public Node getNode()

Returns the lock holding node. Note that N.getLock().getNode() (where N is a locked node) will only return N if N is the lock holder. If N is in the subtree of the lock holder, H, then this call will return H.

Returns:

an Node.

getLockToken

public java.lang.String getLockToken()

May return the lock token for this lock.

If this Session holds the lock token for this lock, then this method will return that lock token. If this Session does not hold the applicable lock token then this method will return null.

Returns:

a String.

isLive

public boolean isLive()
               throws RepositoryException

Returns true if this Lock object represents a lock that is currently in effect. If this lock has been unlocked either explicitly or due to an implementation-specific limitation (like a timeout) then it returns false. Note that this method is intended for those cases where one is holding a Lock Java object and wants to find out whether the lock (the JCR-level entity that is attached to the lockable node) that this object originally represented still exists. For example, a timeout or explicit unlock will remove a lock from a node but the Lock Java object corresponding to that lock may still exist, and in that case its isLive method will return false.

Returns:

a boolean.

Throws:

RepositoryException - if an error occurs.

isSessionScoped

public boolean isSessionScoped()

Returns true if this is a session-scoped lock. Returns false if this is an open-scoped lock.

Returns:

a boolean.

refresh

public void refresh()
             throws LockException,
                    RepositoryException

If this lock's time-to-live is governed by a timer, this method resets that timer so that the lock does not timeout and expire. If this lock's time-to-live is not governed by a timer, then this method has no effect.

A LockException is thrown if this Session does not hold the correct lock token for this lock.

Throws:

LockException - if this Session does not hold the correct lock token for this lock.

RepositoryException - if another error occurs.