|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.lock.LockServiceImpl
public class LockServiceImpl
Simple Lock service implementation
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy |
---|
Policy.Arg |
Field Summary |
---|
Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnCreateChildAssociationPolicy |
---|
QNAME |
Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeUpdateNodePolicy |
---|
QNAME |
Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy |
---|
QNAME |
Fields inherited from interface org.alfresco.repo.copy.CopyServicePolicies.OnCopyNodePolicy |
---|
ARG_0, ARG_1, QNAME |
Fields inherited from interface org.alfresco.repo.version.VersionServicePolicies.BeforeCreateVersionPolicy |
---|
QNAME |
Fields inherited from interface org.alfresco.repo.version.VersionServicePolicies.OnCreateVersionPolicy |
---|
QNAME |
Fields inherited from interface org.alfresco.repo.policy.Policy |
---|
NAMESPACE |
Constructor Summary | |
---|---|
LockServiceImpl()
|
Method Summary | |
---|---|
void |
beforeCreateVersion(org.alfresco.service.cmr.repository.NodeRef versionableNode)
Ensures that node is not locked. |
void |
beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Ensures that node is not locked. |
void |
beforeUpdateNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Ensures that node is not locked. |
void |
checkForLock(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Checks to see if the current user has access to the specified node. |
CopyBehaviourCallback |
getCopyCallback(org.alfresco.service.namespace.QName classRef,
CopyDetails copyDetails)
Called for all types and aspects before copying a 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 a node and a user name |
LockType |
getLockType(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets the lock type for the node indicated. |
void |
init()
Initialise methods called by Spring framework |
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 |
onCreateChildAssociation(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef,
boolean isNewNode)
Ensures that the parent is not locked. |
void |
onCreateVersion(org.alfresco.service.namespace.QName classRef,
org.alfresco.service.cmr.repository.NodeRef versionableNode,
java.util.Map versionProperties,
PolicyScope nodeDetails)
OnCreateVersion behaviour for the lock aspect |
void |
setAuthenticationService(AuthenticationService authenticationService)
|
void |
setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
|
void |
setPolicyComponent(PolicyComponent policyComponent)
|
void |
setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
|
void |
setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
|
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 unlockChildren)
Removes the lock on a node and optional on its children. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LockServiceImpl()
Method Detail |
---|
public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)
public void setPolicyComponent(PolicyComponent policyComponent)
public void setAuthenticationService(AuthenticationService authenticationService)
public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
public void init()
public void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType)
LockService
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.
lock
in interface LockService
nodeRef
- a reference to a nodelockType
- the lock typeorg.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.cmr.lock.LockType)
public void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType, int timeToExpire)
LockService
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.
lock
in interface LockService
nodeRef
- a reference to a nodelockType
- the lock typetimeToExpire
- the number of seconds before the locks expires.org.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.cmr.lock.LockType, int)
public void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType, int timeToExpire, boolean lockChildren) throws UnableToAquireLockException
LockService
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.
lock
in interface LockService
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 obtainedorg.alfresco.service.cmr.lock.LockService#lock(org.alfresco.service.cmr.repository.NodeRef, java.lang.String, org.alfresco.service.cmr.lock.LockType, int, boolean)
public void lock(java.util.Collection nodeRefs, LockType lockType, int timeToExpire) throws UnableToAquireLockException
LockService
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.
lock
in interface LockService
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 obtainedorg.alfresco.service.cmr.lock.LockService#lock(java.util.Collection, java.lang.String, org.alfresco.service.cmr.lock.LockType, int)
public void unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws UnableToReleaseLockException
LockService
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.
unlock
in interface LockService
nodeRef
- a reference to a node
UnableToReleaseLockException
- thrown if the lock could not be releasedorg.alfresco.service.cmr.lock.LockService#unlock(NodeRef, String)
public void unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean unlockChildren) throws UnableToReleaseLockException
LockService
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.
unlock
in interface LockService
nodeRef
- a node referenceunlockChildren
- 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 releasedorg.alfresco.service.cmr.lock.LockService#unlock(NodeRef, String,
boolean)
public void unlock(java.util.Collection nodeRefs) throws UnableToReleaseLockException
LockService
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.
unlock
in interface LockService
nodeRefs
- the node references
UnableToReleaseLockException
- thrown if the lock could not be releasedorg.alfresco.repo.lock.LockService#unlock(Collection,
String)
public LockStatus getLockStatus(org.alfresco.service.cmr.repository.NodeRef nodeRef)
LockService
getLockStatus
in interface LockService
nodeRef
- the node reference
LockService.getLockStatus(NodeRef)
public LockStatus getLockStatus(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.lang.String userName)
getLockStatus
in interface LockService
nodeRef
- the node referenceuserName
- the user name
LockService#getLockStatus(NodeRef, NodeRef)
public LockType getLockType(org.alfresco.service.cmr.repository.NodeRef nodeRef)
LockService
Returns null if the node is not locked.
Throws an exception if the node does not have the lock aspect.
getLockType
in interface LockService
nodeRef
- the node reference
LockService.getLockType(NodeRef)
public void checkForLock(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws NodeLockedException
If the node is locked by another user then a NodeLockedException is thrown.
Gets the user reference from the current session.
checkForLock
in interface LockService
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.public void onCreateChildAssociation(org.alfresco.service.cmr.repository.ChildAssociationRef childAssocRef, boolean isNewNode)
onCreateChildAssociation
in interface NodeServicePolicies.OnCreateChildAssociationPolicy
childAssocRef
- the child association that has been createdisNewNode
- true if the node is new or false if the node is being linked inLockServiceImpl.checkForLock(NodeRef)
public void beforeUpdateNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
beforeUpdateNode
in interface NodeServicePolicies.BeforeUpdateNodePolicy
nodeRef
- reference to the node being updatedLockServiceImpl.checkForLock(NodeRef)
public void beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef nodeRef)
beforeDeleteNode
in interface NodeServicePolicies.BeforeDeleteNodePolicy
nodeRef
- the node referenceLockServiceImpl.checkForLock(NodeRef)
public CopyBehaviourCallback getCopyCallback(org.alfresco.service.namespace.QName classRef, CopyDetails copyDetails)
CopyServicePolicies.OnCopyNodePolicy
getCopyCallback
in interface CopyServicePolicies.OnCopyNodePolicy
classRef
- the type or aspect qualified namecopyDetails
- the details of the impending copy
LockableAspectCopyBehaviourCallback
CopyServicePolicies
public void beforeCreateVersion(org.alfresco.service.cmr.repository.NodeRef versionableNode)
beforeCreateVersion
in interface VersionServicePolicies.BeforeCreateVersionPolicy
versionableNode
- reference to the node about to be versionedLockServiceImpl.checkForLock(NodeRef)
public void onCreateVersion(org.alfresco.service.namespace.QName classRef, org.alfresco.service.cmr.repository.NodeRef versionableNode, java.util.Map versionProperties, PolicyScope nodeDetails)
Ensures that the property values of the lock aspect are not 'frozen' in the version store.
onCreateVersion
in interface VersionServicePolicies.OnCreateVersionPolicy
classRef
- the class referenceversionableNode
- the versionable node referenceversionProperties
- the version propertiesnodeDetails
- the details of the node to be versionedpublic java.util.List getLocks(org.alfresco.service.cmr.repository.StoreRef storeRef)
LockService
getLocks
in interface LockService
storeRef
- the store reference
org.alfresco.service.cmr.lock.LockService#getLocks()
public java.util.List getLocks(org.alfresco.service.cmr.repository.StoreRef storeRef, LockType lockType)
LockService
getLocks
in interface LockService
storeRef
- the store referencelockType
- the lock type to filter the results by
org.alfresco.service.cmr.lock.LockService#getLocks(org.alfresco.service.cmr.lock.LockType)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |