com.sap.netweaver.bc.rf.mi.lock
Class LockInfo

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.mi_api.jar]

java.lang.Object
  |
  +--com.sap.netweaver.bc.rf.mi.lock.LockInfo

All Implemented Interfaces:

ILockInfo

public class LockInfo

extends java.lang.Object

implements ILockInfo

Class implementing lock information.

Field Summary

static long

LOCK_TIMEOUT_INFINITE

Constructor Summary

LockInfo(java.lang.String token, IRid rid, LockDepthType depth, LockScopeType scope, LockKindType kind, java.util.Date creationDate, long timeout, java.lang.String owner)
Construct object of class LockInfo.

LockInfo(java.lang.String token, IRid rid, LockDepthType depth, LockScopeType scope, LockKindType kind, java.util.Date creationDate, long timeout, java.lang.String owner, java.lang.String clientSuppliedOwner)
Construct object of class LockInfo.

LockInfo(java.lang.String token, IRid rid, LockDepthType depth, LockScopeType scope, LockKindType kind, long timeout, java.lang.String owner)
Construct object of class LockInfo.

LockInfo(java.lang.String token, IRid rid, LockDepthType depth, LockScopeType scope, LockKindType kind, long timeout, java.lang.String owner, java.lang.String clientSuppliedOwner)
Construct object of class LockInfo.

Method Summary

boolean	equals(java.lang.Object obj) Check this and another object for equality.
java.lang.String	getClientSuppliedOwner() Get client supplied owner for the lock.
java.util.Date	getCreationDate() Get creation date.
LockDepthType	getDepth() Get lock depth.
java.util.Date	getExpirationDate() Get lock expiration timestamp.
LockKindType	getKind() Get lock kind.
java.lang.String	getLockToken() Get lock token.
java.lang.String	getOwner() Get user id of lock owner.
IRid	getRid() Get resource id this lock info is valid for.
LockScopeType	getScope() Get lock scope.
long	getTimeout() Get lock timeout in milliseconds.
long	getTimeRemaining() Get time remaining until lock expires.
int	hashCode() Get hash code of this object.
void	refreshExpirationDate() reset the expiration period if timeout info is available

Methods inherited from class java.lang.Object

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

Field Detail

LOCK_TIMEOUT_INFINITE

public static final long LOCK_TIMEOUT_INFINITE

Constructor Detail

LockInfo

public LockInfo(java.lang.String token,
                IRid rid,
                LockDepthType depth,
                LockScopeType scope,
                LockKindType kind,
                long timeout,
                java.lang.String owner)

Construct object of class LockInfo.

Parameters:

token - lock token identifying the lock

rid - resource id this lock is valid for

depth - LockDepthType of lock

scope - LockScopeType of lock

kind - LockKindType of lock

timeout - lock timeout in milliseconds

owner - owner for the lock

LockInfo

public LockInfo(java.lang.String token,
                IRid rid,
                LockDepthType depth,
                LockScopeType scope,
                LockKindType kind,
                java.util.Date creationDate,
                long timeout,
                java.lang.String owner)

Construct object of class LockInfo.

Parameters:

token - lock token identifying the lock

rid - resource id this lock is valid for

depth - LockDepthType of lock

scope - LockScopeType of lock

kind - LockKindType of lock

creationDate - creation date of the lock

timeout - lock timeout in milliseconds

owner - owner for the lock

LockInfo

public LockInfo(java.lang.String token,
                IRid rid,
                LockDepthType depth,
                LockScopeType scope,
                LockKindType kind,
                long timeout,
                java.lang.String owner,
                java.lang.String clientSuppliedOwner)

Construct object of class LockInfo.

Parameters:

token - lock token identifying the lock

rid - resource id this lock is valid for

depth - LockDepthType of lock

scope - LockScopeType of lock

kind - LockKindType of lock

timeout - lock timeout in milliseconds

owner - owner for the lock

clientSuppliedOwner - client supplied owner for the lock

LockInfo

public LockInfo(java.lang.String token,
                IRid rid,
                LockDepthType depth,
                LockScopeType scope,
                LockKindType kind,
                java.util.Date creationDate,
                long timeout,
                java.lang.String owner,
                java.lang.String clientSuppliedOwner)

Construct object of class LockInfo.

Parameters:

token - lock token identifying the lock

rid - resource id this lock is valid for

depth - LockDepthType of lock

scope - LockScopeType of lock

kind - LockKindType of lock

creationDate - creation date of the lock

timeout - lock timeout in milliseconds

owner - owner for the lock

clientSuppliedOwner - client supplied owner for the lock

Method Detail

getLockToken

public java.lang.String getLockToken()

Get lock token. The lock token must be either an absolute URI (as defined in RFC2396 or a relative URI reference (in which case the opaquelocktoken URI scheme is assumed).

Specified by:

getLockToken in interface ILockInfo

Returns:

lock token

getRid

public IRid getRid()

Get resource id this lock info is valid for.

Specified by:

getRid in interface ILockInfo

Returns:

resource id

getDepth

public LockDepthType getDepth()

Get lock depth.

Specified by:

getDepth in interface ILockInfo

Returns:

LockDepthType of lock

getScope

public LockScopeType getScope()

Get lock scope.

Specified by:

getScope in interface ILockInfo

Returns:

LockScopeType of lock

getKind

public LockKindType getKind()

Get lock kind.

Specified by:

getKind in interface ILockInfo

Returns:

LockKindType of lock

getCreationDate

public java.util.Date getCreationDate()

Get creation date.

Specified by:

getCreationDate in interface ILockInfo

Returns:

creation date

getExpirationDate

public java.util.Date getExpirationDate()

Get lock expiration timestamp.

Specified by:

getExpirationDate in interface ILockInfo

Returns:

lock expiration timestamp

getTimeRemaining

public long getTimeRemaining()

Get time remaining until lock expires.

Specified by:

getTimeRemaining in interface ILockInfo

Returns:

time remaining until lock expires (or -1 for "infinite").

getTimeout

public long getTimeout()

Get lock timeout in milliseconds.

Specified by:

getTimeout in interface ILockInfo

Returns:

lock timeout in milliseconds

getOwner

public java.lang.String getOwner()

Get user id of lock owner.

Specified by:

getOwner in interface ILockInfo

Returns:

user id of lock owner

getClientSuppliedOwner

public java.lang.String getClientSuppliedOwner()

Get client supplied owner for the lock. A client can submit his own owner information that should be returned upon lock discovery. If present, the format must be the XML serialization of a DAV:owner element.

Specified by:

getClientSuppliedOwner in interface ILockInfo

Returns:

client supplied owner for the lock

equals

public boolean equals(java.lang.Object obj)

Check this and another object for equality.

Overrides:

equals in class java.lang.Object

Parameters:

obj - object to compare this object with

Returns:

true if both objects are considered to be equal, false otherwise

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Get hash code of this object.

Overrides:

hashCode in class java.lang.Object

Returns:

hash code of this object

See Also:

Object.hashCode()

refreshExpirationDate

public void refreshExpirationDate()

reset the expiration period if timeout info is available