LockInfo (Apache Jackrabbit 2.20.16 API)

All Known Implementing Classes:

LockInfoImpl, LockInfoImpl
```
public interface LockInfo
```
LockInfo is used to transport lock information across the SPI boundary.

See Also:

RepositoryService.getLockInfo(SessionInfo, NodeId), RepositoryService.lock(SessionInfo, NodeId, boolean, boolean)

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Method Detail
  - getLockToken
```
String getLockToken()
```
    Returns the lock token for this lock or null if the token should not be exposed to the API user.
    
    Returns:
    
    lock token or null
    
    See Also:
    
    Lock.getLockToken()
  - getOwner
```
String getOwner()
```
    Returns the user ID of the user who owns this lock or some user defined information about the lock owner.
    
    Returns:
    
    user ID of the user who owns this lock.
    
    See Also:
    
    Lock.getLockOwner()
  - isDeep
```
boolean isDeep()
```
    Returns true if the Lock is deep. False otherwise.
    
    Returns:
    
    true if the Lock is deep. False otherwise.
    
    See Also:
    
    Lock.isDeep()
  - isSessionScoped
```
boolean isSessionScoped()
```
    Returns true if the Lock is session scoped. False otherwise.
    
    Returns:
    
    true if the Lock is session scoped. False otherwise.
    
    See Also:
    
    Lock.isSessionScoped()
  - getSecondsRemaining
```
long getSecondsRemaining()
```
    Returns the seconds remaining until the lock times out or (Long.MAX_VALUE if the timeout is unknown or infinite).
    
    Returns:
    
    number of seconds until the lock times out.
    
    Since:
    
    JCR 2.0
    
    See Also:
    
    Lock.getSecondsRemaining()
  - isLockOwner
```
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.
    
    Returns:
    
    true if the SessionInfo used to retrieve this LockInfo is the lock holder.
    
    Since:
    
    JCR 2.0
    
    See Also:
    
    Lock.isLockOwningSession()
  - getNodeId
```
NodeId getNodeId()
```
    Returns the NodeId of the lock-holding Node.
    
    Returns:
    
    the NodeId of the lock-holding Node.

Interface LockInfo

Method Summary

Method Detail

getLockToken

getOwner

isDeep

isSessionScoped

getSecondsRemaining

isLockOwner

getNodeId