Package org.opencms.repository

Class CmsRepositoryLockInfo

java.lang.Object

org.opencms.repository.CmsRepositoryLockInfo

public class CmsRepositoryLockInfo
extends Object

The class represents a lock to a I_CmsRepositoryItem.

Since:

6.2.4

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SCOPE	The default scope for locks.
static final String	DEFAULT_TYPE	The default type for locks.
static final int	DEPTH_INFINITY_VALUE	Default depth is infinite.
static final String	SCOPE_EXCLUSIVE	The lock scope "exclusive".
static final String	SCOPE_SHARED	The lock scope "shared".
static final int	TIMEOUT_INFINITE_VALUE	Infinite timeout for the lock.
static final String	TYPE_WRITE	The lock type "write".

Constructor Summary

Constructors

Constructor	Description
CmsRepositoryLockInfo()	Empty default constructor.

Method Summary

Modifier and Type	Method	Description
Date	getCreationDate()	Returns the creationDate.
int	getDepth()	Returns the depth.
long	getExpiresAt()	Returns the expiresAt.
String	getOwner()	Returns the owner.
String	getPath()	Returns the path.
String	getScope()	Returns the scope.
String	getType()	Returns the type.
String	getUsername()	Returns the username.
boolean	hasExpired()	Return true if the lock has expired.
boolean	isExclusive()	Return true if the lock is exclusive.
void	setDepth(int depth)	Sets the depth.
void	setExpiresAt(long expiresAt)	Sets the expiresAt.
void	setOwner(String owner)	Sets the owner.
void	setPath(String path)	Sets the path.
void	setScope(String scope)	Sets the scope.
void	setType(String type)	Sets the type.
void	setUsername(String username)	Sets the username.
String	toString()	Get a string representation of this lock info.

Methods inherited from class java.lang.Object

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

Field Details

SCOPE_EXCLUSIVE

public static final String SCOPE_EXCLUSIVE

The lock scope "exclusive".

See Also:

• Constant Field Values

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

The default scope for locks.

See Also:

• Constant Field Values

TIMEOUT_INFINITE_VALUE

public static final int TIMEOUT_INFINITE_VALUE

Infinite timeout for the lock.

See Also:

• Constant Field Values

TYPE_WRITE

public static final String TYPE_WRITE

The lock type "write".

See Also:

• Constant Field Values

DEFAULT_TYPE

public static final String DEFAULT_TYPE

The default type for locks.

See Also:

• Constant Field Values

DEPTH_INFINITY_VALUE

public static final int DEPTH_INFINITY_VALUE

Default depth is infinite.

See Also:

• Constant Field Values

SCOPE_SHARED

public static final String SCOPE_SHARED

The lock scope "shared".

See Also:

• Constant Field Values

Constructor Details

CmsRepositoryLockInfo

public CmsRepositoryLockInfo()

Empty default constructor.

Method Details

getCreationDate

public Date getCreationDate()

Returns the creationDate.

Returns:

the creationDate

getDepth

public int getDepth()

Returns the depth.

Returns:

the depth

getExpiresAt

public long getExpiresAt()

Returns the expiresAt.

Returns:

the expiresAt

getOwner

public String getOwner()

Returns the owner.

Returns:

the owner

getPath

public String getPath()

Returns the path.

Returns:

the path

getScope

public String getScope()

Returns the scope.

Returns:

the scope

getType

public String getType()

Returns the type.

Returns:

the type

getUsername

public String getUsername()

Returns the username.

Returns:

the username

hasExpired

public boolean hasExpired()

Return true if the lock has expired.

Returns:

true if the lock has expired

isExclusive

public boolean isExclusive()

Return true if the lock is exclusive.

Returns:

true if the lock is exclusive

setDepth

public void setDepth(int depth)

Sets the depth.

Parameters:

depth - the depth to set

setExpiresAt

public void setExpiresAt(long expiresAt)

Sets the expiresAt.

Parameters:

expiresAt - the expiresAt to set

setOwner

public void setOwner(String owner)

Sets the owner.

Parameters:

owner - the owner to set

setPath

public void setPath(String path)

Sets the path.

Parameters:

path - the path to set

setScope

public void setScope(String scope)

Sets the scope.

Parameters:

scope - the scope to set

setType

public void setType(String type)

Sets the type.

Parameters:

type - the type to set

setUsername

public void setUsername(String username)

Sets the username.

Parameters:

username - the username to set

toString

public String toString()

Get a string representation of this lock info.

Overrides:

toString in class Object

Returns:

a string representation of this lock