org.exoplatform.services.cms.lock.impl

Class LockServiceImpl

java.lang.Object

org.exoplatform.services.cms.lock.impl.LockServiceImpl

All Implemented Interfaces:

LockService, org.picocontainer.Startable

public class LockServiceImpl
extends Object
implements LockService, org.picocontainer.Startable

Created by The eXo Platform SAS Author : Chien Nguyen chien.nguyen@exoplatform.com Nov 17, 2009

Constructor Summary

Constructors

Constructor and Description
LockServiceImpl(org.exoplatform.container.xml.InitParams params, org.exoplatform.services.cache.CacheService cacheService) Constructor method

Method Summary

Modifier and Type	Method and Description
void	addGroupsOrUsersForLock(String groupsOrUsers) Allow to add user or group to the locking manager list which allowed to unlock all nodes
void	addLockGroupsOrUsersPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Add new users or groups into lockGroupsOrUsersPlugin_
void	changeLockToken(javax.jcr.Node oldNode, javax.jcr.Node newNode) Change lock token from old node to new node.
void	changeLockToken(String srcPath, javax.jcr.Node newNode) Change lock token from source path to new node.
String	createLockKey(javax.jcr.Node node) Create Lock key from specific node.
String	createLockKey(javax.jcr.Node node, String userId) Create Lock key from a specific node and user id.
List<String>	getAllGroupsOrUsersForLock() Get all the identities which allowed to unlock nodes
HashMap<String,Map<String,String>>	getLockHolding() Return a HashMap which keeping all locked nodes informations
Map<String,String>	getLockInformation(String userId) Return a Map which kept lock token of node which locked by user
String	getLockToken(javax.jcr.Node node) Get Lock token from specifiec node.
String	getLockTokenOfUser(javax.jcr.Node node) Get lock token of user from a specific node.
String	getOldLockKey(String srcPath, javax.jcr.Node node) Get old lock key from source path and a specific node.
List<String>	getPreSettingLockList() Get all pre-setting lock list
void	putToLockHoding(String userId, Map<String,String> lockedNodesInfo) Put all informations of locked node such as locktoken to the Map
void	removeGroupsOrUsersForLock(String groupsOrUsers) Remove user or group out of the locking manager list
void	removeLocks() Remove all locked nodes in the system.
void	removeLocksOfUser(String userId) Remove all locked nodes user
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

LockServiceImpl

public LockServiceImpl(org.exoplatform.container.xml.InitParams params,
                       org.exoplatform.services.cache.CacheService cacheService)
                throws Exception

Constructor method

Parameters:

params -

Throws:

Exception

Method Detail

addLockGroupsOrUsersPlugin

public void addLockGroupsOrUsersPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Add new users or groups into lockGroupsOrUsersPlugin_

Parameters:

plugin -

getPreSettingLockList

public List<String> getPreSettingLockList()

Get all pre-setting lock list

Specified by:

getPreSettingLockList in interface LockService

Returns:

lock list

getAllGroupsOrUsersForLock

public List<String> getAllGroupsOrUsersForLock()
                                        throws Exception

Get all the identities which allowed to unlock nodes

Specified by:

getAllGroupsOrUsersForLock in interface LockService

Returns:

lock list

Throws:

Exception

addGroupsOrUsersForLock

public void addGroupsOrUsersForLock(String groupsOrUsers)
                             throws Exception

Allow to add user or group to the locking manager list which allowed to unlock all nodes

Specified by:

addGroupsOrUsersForLock in interface LockService

Parameters:

groupsOrUsers - User id or group id

Throws:

Exception

removeGroupsOrUsersForLock

public void removeGroupsOrUsersForLock(String groupsOrUsers)
                                throws Exception

Remove user or group out of the locking manager list

Specified by:

removeGroupsOrUsersForLock in interface LockService

Throws:

Exception

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

getLockHolding

public HashMap<String,Map<String,String>> getLockHolding()

Return a HashMap which keeping all locked nodes informations

Specified by:

getLockHolding in interface LockService

Returns:

locks holding map

putToLockHoding

public void putToLockHoding(String userId,
                            Map<String,String> lockedNodesInfo)

Put all informations of locked node such as locktoken to the Map

Specified by:

putToLockHoding in interface LockService

Parameters:

userId - It is a key which will be used to get the locked information

lockedNodesInfo - A Map which kept the locked node information

getLockInformation

public Map<String,String> getLockInformation(String userId)

Return a Map which kept lock token of node which locked by user

Specified by:

getLockInformation in interface LockService

Returns:

removeLocksOfUser

public void removeLocksOfUser(String userId)

Remove all locked nodes user

Specified by:

removeLocksOfUser in interface LockService

Parameters:

userId - User Identity which will be used to remove all locked node which belong to he/she

removeLocks

public void removeLocks()

Remove all locked nodes in the system. This function just used in the case server stop working

Specified by:

removeLocks in interface LockService

getLockTokenOfUser

public String getLockTokenOfUser(javax.jcr.Node node)
                          throws Exception

Get lock token of user from a specific node.

Specified by:

getLockTokenOfUser in interface LockService

Parameters:

node - a specific node

Returns:

lock token

Throws:

Exception

createLockKey

public String createLockKey(javax.jcr.Node node)
                     throws Exception

Create Lock key from specific node.

Specified by:

createLockKey in interface LockService

Parameters:

node - a specific node

Returns:

lock key

Throws:

Exception

createLockKey

public String createLockKey(javax.jcr.Node node,
                            String userId)
                     throws Exception

Create Lock key from a specific node and user id.

Specified by:

createLockKey in interface LockService

Parameters:

node - a specific node

userId - user ID

Returns:

lock key

Throws:

Exception

getLockToken

public String getLockToken(javax.jcr.Node node)
                    throws Exception

Get Lock token from specifiec node.

Specified by:

getLockToken in interface LockService

Parameters:

node - a specific node

Returns:

lock token

Throws:

Exception

changeLockToken

public void changeLockToken(String srcPath,
                            javax.jcr.Node newNode)
                     throws Exception

Change lock token from source path to new node.

Specified by:

changeLockToken in interface LockService

Parameters:

srcPath - source node path

newNode - new node

Throws:

Exception

changeLockToken

public void changeLockToken(javax.jcr.Node oldNode,
                            javax.jcr.Node newNode)
                     throws Exception

Change lock token from old node to new node.

Specified by:

changeLockToken in interface LockService

Parameters:

oldNode - old node

newNode - new node

Throws:

Exception

getOldLockKey

public String getOldLockKey(String srcPath,
                            javax.jcr.Node node)
                     throws Exception

Get old lock key from source path and a specific node.

Specified by:

getOldLockKey in interface LockService

Parameters:

srcPath - source path

node - a specific node

Returns:

Throws:

Exception