org.exoplatform.services.cms.lock

Interface LockService

All Known Implementing Classes:

LockServiceImpl

public interface LockService

This service used to manage all the stuff which related to the locking nodes.

Author:

minh_dang

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	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

Method Detail

getPreSettingLockList

List<String> getPreSettingLockList()
                            throws Exception

Get all pre-setting lock list

Returns:

lock list

Throws:

Exception

getAllGroupsOrUsersForLock

List<String> getAllGroupsOrUsersForLock()
                                 throws Exception

Get all the identities which allowed to unlock nodes

Returns:

lock list

Throws:

Exception

addGroupsOrUsersForLock

void addGroupsOrUsersForLock(String groupsOrUsers)
                      throws Exception

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

Parameters:

groupsOrUsers - User id or group id

Throws:

Exception

removeGroupsOrUsersForLock

void removeGroupsOrUsersForLock(String groupsOrUsers)
                         throws Exception

Remove user or group out of the locking manager list

Parameters:

groupsOrUsers -

Throws:

Exception

getLockHolding

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

Return a HashMap which keeping all locked nodes informations

Returns:

locks holding map

putToLockHoding

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

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

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

Map<String,String> getLockInformation(String userId)

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

Parameters:

userId -

Returns:

removeLocksOfUser

void removeLocksOfUser(String userId)

Remove all locked nodes user

Parameters:

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

removeLocks

void removeLocks()

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

getLockTokenOfUser

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

Get lock token of user from a specific node.

Parameters:

node - a specific node

Returns:

lock token

Throws:

Exception

createLockKey

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

Create Lock key from specific node.

Parameters:

node - a specific node

Returns:

lock key

Throws:

Exception

createLockKey

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

Create Lock key from a specific node and user id.

Parameters:

node - a specific node

userId - user ID

Returns:

lock key

Throws:

Exception

getLockToken

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

Get Lock token from specifiec node.

Parameters:

node - a specific node

Returns:

lock token

Throws:

Exception

changeLockToken

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

Change lock token from source path to new node.

Parameters:

srcPath - source node path

newNode - new node

Throws:

Exception

changeLockToken

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

Change lock token from old node to new node.

Parameters:

oldNode - old node

newNode - new node

Throws:

Exception

getOldLockKey

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

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

Parameters:

srcPath - source path

node - a specific node

Returns:

Throws:

Exception