Package org.ametys.plugins.repository.jcr

Class LockComponent

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.repository.jcr.LockComponent

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class LockComponent
extends AbstractLogEnabled
implements Serviceable, Component

Component that provides methods for lock management on JCRAmetysObjects.

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider.
protected UnlockHelper	_unlockHelper	The unlock helper.
static final String	ROLE	The avalon component role.

Constructor Summary

Constructors

Constructor	Description
LockComponent()

Method Summary

Modifier and Type	Method	Description
void	addLockedContent(AmetysObject object)	Register a locked content for automatic unlocking
UserIdentity	getCurrentUser()	Provides the current user.
UserIdentity	getLockOwner(JCRAmetysObject object)	Get the lock owner of a JCRAmetysObject.
protected javax.jcr.Node	getNode(JCRAmetysObject object)	Get an object's base node.
boolean	isLocked(JCRAmetysObject object)	Test if a JCRAmetysObject is locked.
void	lock(JCRAmetysObject object)	Lock a JCRAmetysObject.
void	removeLockedContent(AmetysObject object)	Unregister a locked content for automatic unlocking
void	service(ServiceManager manager)
void	setLockTokenOnCurrentSession(JCRAmetysObject object)	Sets a lock token on the current session for the given JCRAmetysObject
void	unlock(JCRAmetysObject object)	Unlock a JCRAmetysObject.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The avalon component role.

_unlockHelper

protected UnlockHelper _unlockHelper

The unlock helper.

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

Constructor Details

LockComponent

public LockComponent()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

addLockedContent

public void addLockedContent(AmetysObject object)

Register a locked content for automatic unlocking

Parameters:

object - the locked AmetysObject

removeLockedContent

public void removeLockedContent(AmetysObject object)

Unregister a locked content for automatic unlocking

Parameters:

object - the locked AmetysObject

getCurrentUser

public UserIdentity getCurrentUser()

Provides the current user.

Returns:

the current user.

lock

public void lock(JCRAmetysObject object)
          throws AmetysRepositoryException

Lock a JCRAmetysObject.

Parameters:

object - the object to lock.

Throws:

AmetysRepositoryException - if an error occurs.

unlock

public void unlock(JCRAmetysObject object)
            throws AmetysRepositoryException

Unlock a JCRAmetysObject.

Parameters:

object - the object to unlock.

Throws:

AmetysRepositoryException - if an error occurs.

setLockTokenOnCurrentSession

public void setLockTokenOnCurrentSession(JCRAmetysObject object)
                                  throws AmetysRepositoryException

Sets a lock token on the current session for the given JCRAmetysObject

Parameters:

object - the object for which the lock token is set.

Throws:

AmetysRepositoryException - if an error occurs

isLocked

public boolean isLocked(JCRAmetysObject object)
                 throws AmetysRepositoryException

Test if a JCRAmetysObject is locked.

Parameters:

object - the object to test.

Returns:

true if the object is locked, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

getLockOwner

public UserIdentity getLockOwner(JCRAmetysObject object)
                          throws AmetysRepositoryException

Get the lock owner of a JCRAmetysObject.

Parameters:

object - the object of which to get the lock owner.

Returns:

the lock owner or null if there is no lock owner.

Throws:

AmetysRepositoryException - if an error occurs.

getNode

protected javax.jcr.Node getNode(JCRAmetysObject object)

Get an object's base node.

Parameters:

object - the object which node to get.

Returns:

the object's base node.