|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AVMLockingService
Service to handle AVM locking. Note that this service is a low-level service and does no "self-permissioning" e.g. checking ownership of locks.
Nested Class Summary | |
---|---|
static class |
AVMLockingService.LockState
Enumeration of the state of a lock's with respect to a specific user. |
Method Summary | |
---|---|
java.util.Map |
getLockData(java.lang.String avmStore,
java.lang.String path)
Get the data associated with a lock |
java.lang.String |
getLockOwner(java.lang.String avmStore,
java.lang.String path)
Get the current holder of a lock on AVM store path |
AVMLockingService.LockState |
getLockState(java.lang.String avmStore,
java.lang.String path,
java.lang.String lockOwner)
Get the state of a lock with respect to a given AVM store, path and user |
boolean |
hasAccess(org.alfresco.service.cmr.repository.NodeRef webProject,
java.lang.String avmPath,
java.lang.String lockOwner)
Deprecated. This will move into a WCMLockingService |
boolean |
hasAccess(java.lang.String webProject,
java.lang.String avmPath,
java.lang.String lockOwner)
Deprecated. This will move into a WCMLockingService |
void |
lock(java.lang.String avmStore,
java.lang.String path,
java.lang.String lockOwner,
java.util.Map lockData)
Creates a lock of the given type on a path within an AVM store. |
boolean |
modifyLock(java.lang.String avmStore,
java.lang.String path,
java.lang.String lockOwner,
java.lang.String newAvmStore,
java.lang.String newPath,
java.util.Map lockData)
Modify a lock if it exists or do nothing if it doesn't. |
void |
removeLock(java.lang.String avmStore,
java.lang.String path)
Remove a lock. |
void |
removeLocks(java.lang.String avmStore)
Remove all locks for a specific AVM store |
void |
removeLocks(java.lang.String avmStore,
java.util.Map lockDataToMatch)
Remove all locks for a specific AVM store that also optionally match a map of lock data entries. |
void |
removeLocks(java.lang.String avmStore,
java.lang.String dirPath,
java.util.Map lockDataToMatch)
Remove all locks for a specific AVM store that start with a given directory path that also optionally match a map of lock data entries. |
Method Detail |
---|
void lock(java.lang.String avmStore, java.lang.String path, java.lang.String lockOwner, java.util.Map lockData)
avmStore
- the name of the AVM storepath
- the relative path of the locklockOwner
- the user taking the locklockData
- additional data to append to the lockboolean modifyLock(java.lang.String avmStore, java.lang.String path, java.lang.String lockOwner, java.lang.String newAvmStore, java.lang.String newPath, java.util.Map lockData)
avmStore
- the name of the AVM storepath
- the relative path of the locklockOwner
- the user taking the lock and who must also own the existing locknewAvmStore
- the name of the new AVM storenewPath
- the new relative path of the locklockData
- the new additional data to append to the lock
java.lang.String getLockOwner(java.lang.String avmStore, java.lang.String path)
avmStore
- the name of the AVM storepath
- the relative path of the lock
AVMLockingService.LockState getLockState(java.lang.String avmStore, java.lang.String path, java.lang.String lockOwner)
avmStore
- the name of the AVM storepath
- the relative path of the locklockOwner
- the user who might own the lock
java.util.Map getLockData(java.lang.String avmStore, java.lang.String path)
avmStore
- the name of the AVM storepath
- the relative path of the lock
void removeLock(java.lang.String avmStore, java.lang.String path)
webProject
- the name of the web projectpath
- the relative path of the lockvoid removeLocks(java.lang.String avmStore)
avmStore
- the name of the AVM storevoid removeLocks(java.lang.String avmStore, java.lang.String dirPath, java.util.Map lockDataToMatch)
avmStore
- the name of the AVM storedirPath
- optional - start with given directory path or null to match alllockDataToMatch
- optional - lock data to match (note: all entries must match) or null/empty to match allvoid removeLocks(java.lang.String avmStore, java.util.Map lockDataToMatch)
avmStore
- the name of the AVM storelockDataToMatch
- optional - lock data to match (note: all entries must match) or null/empty to match allboolean hasAccess(java.lang.String webProject, java.lang.String avmPath, java.lang.String lockOwner)
webProject
- the name of the WCM projectpath
- the relative path of the locklockOwner
- the user to check
boolean hasAccess(org.alfresco.service.cmr.repository.NodeRef webProject, java.lang.String avmPath, java.lang.String lockOwner)
webProject
- the name of the WCM projectpath
- the relative path of the locklockOwner
- the user to check
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |