public interface LockInfo
LockInfo
is used to transport lock information across the SPI
boundary.Modifier and Type | Method and Description |
---|---|
java.lang.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. |
java.lang.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.
|
java.lang.String getLockToken()
null
if the token
should not be exposed to the API user.null
Lock.getLockToken()
java.lang.String getOwner()
Lock.getLockOwner()
boolean isDeep()
Lock.isDeep()
boolean isSessionScoped()
Lock.isSessionScoped()
long getSecondsRemaining()
Long.MAX_VALUE
if the timeout is unknown or infinite).Lock.getSecondsRemaining()
boolean isLockOwner()
true
if the SessionInfo
used to
retrieve this LockInfo
is the lock holder and thus enabled
to refresh or release the lock.true
if the SessionInfo
used to
retrieve this LockInfo
is the lock holder.Lock.isLockOwningSession()
NodeId getNodeId()
NodeId
of the lock-holding Node.NodeId
of the lock-holding Node.Copyright © 2010 - 2020 Adobe. All Rights Reserved