|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LockService
Interface for public and internal lock operations.
Method Summary | |
---|---|
void |
checkForLock(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Checks to see if the current user has access to the specified node. |
java.util.List |
getLocks(org.alfresco.service.cmr.repository.StoreRef storeRef)
Get all the node references that the current user has locked. |
java.util.List |
getLocks(org.alfresco.service.cmr.repository.StoreRef storeRef,
LockType lockType)
Get all the node references that the current user has locked filtered by the provided lock type. |
LockStatus |
getLockStatus(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets the lock status for the node reference relative to the current user. |
LockStatus |
getLockStatus(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.lang.String userName)
Gets the lock status for the node reference relative to the current user. |
LockType |
getLockType(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets the lock type for the node indicated. |
void |
lock(java.util.Collection nodeRefs,
LockType lockType,
int timeToExpire)
Places a lock on all the nodes referenced in the passed list. |
void |
lock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
LockType lockType)
Places a lock on a node. |
void |
lock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
LockType lockType,
int timeToExpire)
Places a lock on a node. |
void |
lock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
LockType lockType,
int timeToExpire,
boolean lockChildren)
Places a lock on a node and optionally on all its children. |
void |
unlock(java.util.Collection nodeRefs)
Removes a lock on the nodes provided. |
void |
unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Removes the lock on a node; if there is no lock then nothing is done. |
void |
unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
boolean lockChildren)
Removes the lock on a node and optional on its children. |
Method Detail |
---|
@Auditable(parameters={"nodeRef", "lockType"}) void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType) throws UnableToAquireLockException
The lock prevents any other user or process from comitting updates to the node until the lock is released.
The lock will be owned by the current user.
A lock made with this call will never expire.
nodeRef
- a reference to a nodeuserName
- a reference to the user that will own the locklockType
- the lock type
UnableToAquireLockException
- thrown if the lock could not be obtained@Auditable(parameters={"nodeRef", "lockType", "timeToExpire"}) void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType, int timeToExpire) throws UnableToAquireLockException
The lock prevents any other user or process from comitting updates to the node until the lock is released.
The lock will be owned by the current user.
If the time to expire is 0 then the lock will never expire. Otherwise the timeToExpire indicates the number of seconds before the lock expires. When a lock expires the lock is considered to have been released.
If the node is already locked and the user is the lock owner then the lock will be renewed with the passed timeToExpire.
nodeRef
- a reference to a nodelockType
- the lock typetimeToExpire
- the number of seconds before the locks expires.
UnableToAquireLockException
- thrown if the lock could not be obtained@Auditable(parameters={"nodeRef", "lockType", "timeToExpire", "lockChildren"}) void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType, int timeToExpire, boolean lockChildren) throws UnableToAquireLockException
The lock prevents any other user or process from comitting updates to the node until the lock is released.
The lock will be owned by the current user.
If any one of the child locks can not be taken then an exception will be raised and all locks canceled.
If the time to expire is 0 then the lock will never expire. Otherwise the timeToExpire indicates the number of seconds before the lock expires. When a lock expires the lock is considered to have been released.
If the node is already locked and the user is the lock owner then the lock will be renewed with the passed timeToExpire.
nodeRef
- a reference to a nodelockType
- the lock typetimeToExpire
- the number of seconds before the locks expires.lockChildren
- if true indicates that all the children (and
grandchildren, etc) of the node will also be locked,
false otherwise
UnableToAquireLockException
- thrown if the lock could not be obtained@Auditable(parameters={"nodeRefs", "lockType", "timeToExpire"}) void lock(java.util.Collection nodeRefs, LockType lockType, int timeToExpire) throws UnableToAquireLockException
The lock prevents any other user or process from comitting updates to the node until the lock is released.
The lock will be owned by the current user.
If the time to expire is 0 then the lock will never expire. Otherwise the timeToExpire indicates the number of seconds before the lock expires. When a lock expires the lock is considered to have been released.
If the node is already locked and the current user is the lock owner then the lock will be renewed with the passed timeToExpire.
nodeRefs
- a list of node referenceslockType
- the type of lock being createdtimeToExpire
- the number of seconds before the locks expires.
UnableToAquireLockException
- thrown if the lock could not be obtained@Auditable(parameters="nodeRef") void unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws UnableToReleaseLockException
The user must have sufficient permissions to remove the lock (ie: be the owner of the lock or have admin rights) otherwise an exception will be raised.
nodeRef
- a reference to a node
UnableToReleaseLockException
- thrown if the lock could not be released@Auditable(parameters={"nodeRef", "lockChildren"}) void unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean lockChildren) throws UnableToReleaseLockException
The user must have sufficient permissions to remove the lock(s) (ie: be the owner of the lock(s) or have admin rights) otherwise an exception will be raised.
If one of the child nodes is not locked then it will be ignored and the process continue without error.
If the lock on any one of the child nodes cannot be released then an exception will be raised.
nodeRef
- a node referencelockChildren
- if true then all the children (and grandchildren, etc)
of the node will also be unlocked, false otherwise
UnableToReleaseLockException
- thrown if the lock could not be released@Auditable(parameters="nodeRefs") void unlock(java.util.Collection nodeRefs) throws UnableToReleaseLockException
The user must have sufficient permissions to remove the locks (ie: be the owner of the locks or have admin rights) otherwise an exception will be raised.
If one of the nodes is not locked then it will be ignored and the process will continue without an error.
If the lock on any one of the nodes cannot be released than an exception will be raised and the process rolled back.
nodeRefs
- the node referencesuserName
- the user reference
UnableToReleaseLockException
- thrown if the lock could not be released@Auditable(parameters="nodeRef") LockStatus getLockStatus(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- the node reference
LockService#getLockStatus(NodeRef, NodeRef)
@Auditable(parameters={"nodeRef", "userName"}) LockStatus getLockStatus(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String userName)
nodeRef
- the node reference
LockService#getLockStatus(NodeRef, NodeRef)
@Auditable(parameters="nodeRef") LockType getLockType(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Returns null if the node is not locked.
Throws an exception if the node does not have the lock aspect.
nodeRef
- the node reference
@Auditable(parameters="nodeRef") void checkForLock(org.alfresco.service.cmr.repository.NodeRef nodeRef)
If the node is locked by another user then a NodeLockedException is thrown.
Gets the user reference from the current session.
nodeRef
- the node reference
NodeLockedException
- thrown if the node is locked by someone else. This is based on the lock status of the lock,
the user ref and the lock type.@Auditable(parameters="storeRef") java.util.List getLocks(org.alfresco.service.cmr.repository.StoreRef storeRef)
storeRef
- the store reference
@Auditable(parameters={"storeRef", "lockType"}) java.util.List getLocks(org.alfresco.service.cmr.repository.StoreRef storeRef, LockType lockType)
storeRef
- the store referencelockType
- the lock type to filter the results by
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |