public class LockInfo extends Object implements ILockInfo
Copyright 2004 SAP AG
Modifier and Type | Field and Description |
---|---|
protected XMLMarkup |
clientSuppliedOwner |
protected Date |
created |
protected LockDepth |
depth |
protected Date |
expiration |
static int |
LOCK_TIMEOUT_INFINITE |
protected String |
lockToken |
protected String |
owner |
protected LockScope |
scope |
protected int |
timeout
Timeout in seconds
|
protected LockType |
type |
Constructor and Description |
---|
LockInfo(LockType type,
LockScope scope,
LockDepth depth,
String owner,
int timeout,
String lockToken) |
LockInfo(LockType type,
LockScope scope,
LockDepth depth,
String owner,
int timeout,
String lockToken,
Date created) |
LockInfo(LockType type,
LockScope scope,
LockDepth depth,
String owner,
int timeout,
String lockToken,
Date created,
XMLMarkup ownerInfoFromClient) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o)
Compare this LockInfo with another one or with a String (token)
|
XMLMarkup |
getClientSuppliedOwner()
A client can submit his own owner information that SHOULD be returned upon
lock discovery.
|
Date |
getCreated() |
LockDepth |
getDepth() |
Date |
getExpiration()
The date and time when the lock will expire.
|
String |
getLockToken()
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).
|
String |
getOwner()
Returns the unique id of the lock owner.
|
LockScope |
getScope() |
int |
getTimeout() |
LockType |
getType() |
int |
hashCode() |
long |
timeRemaining()
The time remaining until the lock expires.
|
public static final int LOCK_TIMEOUT_INFINITE
protected LockType type
protected LockScope scope
protected LockDepth depth
protected String owner
protected XMLMarkup clientSuppliedOwner
protected String lockToken
protected int timeout
protected Date expiration
protected Date created
public LockInfo(LockType type, LockScope scope, LockDepth depth, String owner, int timeout, String lockToken, Date created, XMLMarkup ownerInfoFromClient)
type
- lock typescope
- lock scopedepth
- lock depthowner
- lock ownertimeout
- timeout in secondslockToken
- 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).created
- creation timeownerInfoFromClient
- 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.public LockInfo(LockType type, LockScope scope, LockDepth depth, String owner, int timeout, String lockToken, Date created)
public LockType getType()
public LockScope getScope()
public LockDepth getDepth()
public String getOwner()
public int getTimeout()
getTimeout
in interface ILockInfo
public XMLMarkup getClientSuppliedOwner()
ILockInfo
getClientSuppliedOwner
in interface ILockInfo
null
if not available).public Date getExpiration()
getExpiration
in interface ILockInfo
public long timeRemaining()
timeRemaining
in interface ILockInfo
public String getLockToken()
ILockInfo
getLockToken
in interface ILockInfo
public Date getCreated()
getCreated
in interface ILockInfo
public boolean equals(Object o)
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice