public class VirtualLockServiceExtension extends SpringBeanExtension<LockServiceExtension,LockServiceTrait> implements LockServiceExtension
Constructor and Description |
---|
VirtualLockServiceExtension() |
Modifier and Type | Method and Description |
---|---|
void |
checkForLock(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Checks to see if the current user has access to the specified node.
|
void |
enableLocks()
After calling suspendLocks turn the locks back on.
|
String |
getAdditionalInfo(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Retrieve the additional lock info associated with a node ref.
|
LockState |
getLockState(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Retrieve the lock properties for the given NodeRef.
|
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,
String userName)
Gets the lock status for the node reference for the specified user.
|
LockType |
getLockType(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets the lock type for the node indicated.
|
boolean |
isLocked(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Indicates if the node is locked for the current user.
|
boolean |
isLockedAndReadOnly(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Indicates if the node is locked AND it's *not* a WRITE_LOCK for the current user.
|
void |
lock(Collection<org.alfresco.service.cmr.repository.NodeRef> 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
persistent 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 |
lock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
LockType lockType,
int timeToExpire,
Lifetime lifetime)
Places a lock on a node.
|
void |
lock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
LockType lockType,
int timeToExpire,
Lifetime lifetime,
boolean lockChildren)
Places a lock on a node and optionally on all its children.
|
void |
lock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
LockType lockType,
int timeToExpire,
Lifetime lifetime,
String additionalInfo)
Places a lock on a node.
|
void |
setEphemeralExpiryThreshold(int threshSecs)
Specifies the maximum expiry time for which a request for an ephemeral lock
will be honoured.
|
void |
setSmartStore(VirtualStore smartStore) |
void |
suspendLocks()
Allow the current transaction to update a node despite any locks that may be on it.
|
void |
unlock(Collection<org.alfresco.service.cmr.repository.NodeRef> 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.
|
void |
unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef,
boolean lockChildren,
boolean allowCheckedOut)
Removes the lock on a node and optional on its children.
|
register, setExtensionPoint
acceptsTrait, acceptsTraitClass, getTrait
public void setSmartStore(VirtualStore smartStore)
public void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType) 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.
A lock made with this call will never expire.
lock
in interface LockService
nodeRef
- a reference to a nodelockType
- the lock typeUnableToAquireLockException
- thrown if the lock could not be obtainedpublic void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType, int timeToExpire) throws UnableToAquireLockException
LockService
persistent
lock on a node.
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.UnableToAquireLockException
- thrown if the lock could not be obtainedpublic void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType, int timeToExpire, Lifetime lifetime) 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 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.lifetime
- allows persistent or ephemeral locks to be specified.UnableToAquireLockException
- thrown if the lock could not be obtainedpublic void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType, int timeToExpire, Lifetime lifetime, String additionalInfo) 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 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.lifetime
- allows persistent or ephemeral locks to be specified.additionalInfo
- additional lock data stored alongside core lock data such as
timeToExpire. NOTE: only valid for ephemeral locks.UnableToAquireLockException
- thrown if the lock could not be obtainedpublic 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 committing 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 cancelled.
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 otherwiseUnableToAquireLockException
- thrown if the lock could not be obtainedpublic void lock(org.alfresco.service.cmr.repository.NodeRef nodeRef, LockType lockType, int timeToExpire, Lifetime lifetime, boolean lockChildren) throws UnableToAquireLockException
LockService
The lock prevents any other user or process from committing 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.lifetime
- allows persistent or ephemeral locks to be specified.lockChildren
- if true indicates that all the children (and
grandchildren, etc) of the node will also be locked,
false otherwiseUnableToAquireLockException
- thrown if the lock could not be obtainedpublic void lock(Collection<org.alfresco.service.cmr.repository.NodeRef> 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 obtainedpublic 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) and the node must not be checked out. Otherwise an exception will be raised.
unlock
in interface LockService
nodeRef
- a reference to a nodeUnableToReleaseLockException
- thrown if the lock could not be releasedpublic void unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean lockChildren) 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) and the node(s) must not be checked out. 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 referencelockChildren
- if true then all the children (and grandchildren, etc)
of the node will also be unlocked, false otherwiseUnableToReleaseLockException
- thrown if the lock could not be releasedpublic void unlock(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean lockChildren, boolean allowCheckedOut) 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 referencelockChildren
- if true then all the children (and grandchildren, etc)
of the node will also be unlocked, false otherwiseallowCheckedOut
- is it permissable for a node to be a checked out node?UnableToReleaseLockException
- thrown if the lock could not be releasedpublic void unlock(Collection<org.alfresco.service.cmr.repository.NodeRef> 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 referencesUnableToReleaseLockException
- thrown if the lock could not be releasedpublic LockStatus getLockStatus(org.alfresco.service.cmr.repository.NodeRef nodeRef)
LockService
getLockStatus
in interface LockService
nodeRef
- the node referenceLockService.getLockStatus(NodeRef)
public LockStatus getLockStatus(org.alfresco.service.cmr.repository.NodeRef nodeRef, String userName)
LockService
getLockStatus
in interface LockService
nodeRef
- the node referenceuserName
- the user nameLockService.getLockStatus(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 referencepublic void checkForLock(org.alfresco.service.cmr.repository.NodeRef nodeRef)
LockService
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 referencepublic void suspendLocks()
LockService
Used for the system to be able to update locked nodes.
suspendLocks
in interface LockService
public void enableLocks()
LockService
enableLocks
in interface LockService
public String getAdditionalInfo(org.alfresco.service.cmr.repository.NodeRef nodeRef)
LockService
getAdditionalInfo
in interface LockService
nodeRef
- NodeRefpublic LockState getLockState(org.alfresco.service.cmr.repository.NodeRef nodeRef)
LockService
Do NOT use the returned information to determine the actual state of a lock,
use LockService.getLockStatus(NodeRef)
and other LockService methods for this purpose.
The returned data is intended for information purposes only, e.g. returning the timeout in a WebDAV response.
getLockState
in interface LockService
nodeRef
- NodeRefpublic void setEphemeralExpiryThreshold(int threshSecs)
LockService
setEphemeralExpiryThreshold
in interface LockService
threshSecs
- intpublic boolean isLocked(org.alfresco.service.cmr.repository.NodeRef nodeRef)
LockService
isLocked
in interface LockService
public boolean isLockedAndReadOnly(org.alfresco.service.cmr.repository.NodeRef nodeRef)
LockService
isLockedAndReadOnly
in interface LockService
Copyright © 2005–2017 Alfresco Software. All rights reserved.