org.apache.jackrabbit.spi2dav

Class LockInfoImpl

java.lang.Object

org.apache.jackrabbit.spi2dav.LockInfoImpl

All Implemented Interfaces:

LockInfo

public class LockInfoImpl
extends Object
implements LockInfo

LockInfoImpl...

Constructor Summary

Constructors

Constructor and Description
LockInfoImpl(ActiveLock activeLock, NodeId nodeId, Set<String> sessionLockTokens)

Method Summary

Modifier and Type	Method and Description
String	getLockToken() Returns the lock token for this lock or null if the token should not be exposed to the API user.
NodeId	getNodeId() Returns the NodeId of the lock-holding Node.
String	getOwner() Returns the user ID of the user who owns this lock or some user defined information about the lock owner.
long	getSecondsRemaining() Returns the seconds remaining until the lock times out or (Long.MAX_VALUE if the timeout is unknown or infinite).
boolean	isDeep() Returns true if the Lock is deep.
boolean	isLockOwner() Returns true if the SessionInfo used to retrieve this LockInfo is the lock holder and thus enabled to refresh or release the lock.
boolean	isSessionScoped() Returns true if the Lock is session scoped.

Methods inherited from class java.lang.Object

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

Constructor Detail

LockInfoImpl

public LockInfoImpl(ActiveLock activeLock,
                    NodeId nodeId,
                    Set<String> sessionLockTokens)

Method Detail

getLockToken

public String getLockToken()

Description copied from interface: LockInfo

Returns the lock token for this lock or null if the token should not be exposed to the API user.

Specified by:

getLockToken in interface LockInfo

Returns:

lock token or null

See Also:

Lock.getLockToken()

getOwner

public String getOwner()

Description copied from interface: LockInfo

Returns the user ID of the user who owns this lock or some user defined information about the lock owner.

Specified by:

getOwner in interface LockInfo

Returns:

user ID of the user who owns this lock.

See Also:

Lock.getLockOwner()

isDeep

public boolean isDeep()

Description copied from interface: LockInfo

Returns true if the Lock is deep. False otherwise.

Specified by:

isDeep in interface LockInfo

Returns:

true if the Lock is deep. False otherwise.

See Also:

Lock.isDeep()

isSessionScoped

public boolean isSessionScoped()

Description copied from interface: LockInfo

Returns true if the Lock is session scoped. False otherwise.

Specified by:

isSessionScoped in interface LockInfo

Returns:

true if the Lock is session scoped. False otherwise.

See Also:

Lock.isSessionScoped()

getSecondsRemaining

public long getSecondsRemaining()

Description copied from interface: LockInfo

Returns the seconds remaining until the lock times out or (Long.MAX_VALUE if the timeout is unknown or infinite).

Specified by:

getSecondsRemaining in interface LockInfo

Returns:

number of seconds until the lock times out.

See Also:

Lock.getSecondsRemaining()

isLockOwner

public boolean isLockOwner()

Description copied from interface: LockInfo

Returns true if the SessionInfo used to retrieve this LockInfo is the lock holder and thus enabled to refresh or release the lock.

Specified by:

isLockOwner in interface LockInfo

Returns:

true if the SessionInfo used to retrieve this LockInfo is the lock holder.

See Also:

Lock.isLockOwningSession()

getNodeId

public NodeId getNodeId()

Description copied from interface: LockInfo

Returns the NodeId of the lock-holding Node.

Specified by:

getNodeId in interface LockInfo

Returns:

the NodeId of the lock-holding Node.