|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AVMLockingService
Service to handle AVM locking.
Nested Class Summary | |
---|---|
static class |
AVMLockingService.Type
|
Method Summary | |
---|---|
void |
addWebProject(java.lang.String webProject)
Add a web project to the locking tables if it doesn't already exist. |
AVMLock |
getLock(java.lang.String webProject,
java.lang.String path)
Get a lock on a given path |
java.util.List |
getStoreLocks(java.lang.String store)
Get all locks that reside in a given store. |
java.util.List |
getUsersLocks(java.lang.String user)
Get all the locks that a user owns. |
java.util.List |
getWebProjectLocks(java.lang.String webProject)
Get all locks in a give web project. |
java.util.List |
getWebProjects()
Get the names of all the web projects the service knows about. |
boolean |
hasAccess(NodeRef webProjectRef,
java.lang.String avmPath,
java.lang.String user)
Is the user allowed to do anything to the given asset, other than read? |
boolean |
hasAccess(java.lang.String webProject,
java.lang.String avmPath,
java.lang.String user)
Is the user allowed to do anything to the given asset, other than read? |
void |
lockPath(AVMLock lock)
Creates a lock of the given type on a path. |
void |
modifyLock(java.lang.String webProject,
java.lang.String path,
java.lang.String newPath,
java.lang.String newStore,
java.util.List usersToRemove,
java.util.List usersToAdd)
Modify a lock. |
void |
removeLock(java.lang.String webProject,
java.lang.String path)
Remove a lock. |
void |
removeLocksInDirectory(java.lang.String webProject,
java.lang.String store,
java.lang.String path)
Remove all locks on files contained within a directory. |
void |
removeStoreLocks(java.lang.String store)
Removes all locks residing in a store. |
void |
removeWebProject(java.lang.String webProject)
Remove a web project and all associated data from the locking tables. |
Method Detail |
---|
void lockPath(AVMLock lock)
lock
- The lock structure to create.AVMLock getLock(java.lang.String webProject, java.lang.String path)
webProject
- The website for which to get the lock.path
- The path to check for a lock.
void modifyLock(java.lang.String webProject, java.lang.String path, java.lang.String newPath, java.lang.String newStore, java.util.List usersToRemove, java.util.List usersToAdd)
webProject
- The name of the web project.path
- The path of the lock.newPath
- The path that the lock should be given. (may be null)newStore
- The store that the lock should be given. (may be null)usersToRemove
- List of users to remove from the lock. (may be null)usersToAdd
- List of users to add to the lock. (may be null)void removeLock(java.lang.String webProject, java.lang.String path)
webProject
- The web project the lock lives in.path
- The store relative path of the lock.void removeLocksInDirectory(java.lang.String webProject, java.lang.String store, java.lang.String path)
webProject
- store
- path
- void removeStoreLocks(java.lang.String store)
store
- The store name.java.util.List getUsersLocks(java.lang.String user)
user
- The name of the user.
void addWebProject(java.lang.String webProject)
webProject
- The web project name.void removeWebProject(java.lang.String webProject)
webProject
- The web project name.java.util.List getWebProjectLocks(java.lang.String webProject)
webProject
- The web project name.
java.util.List getStoreLocks(java.lang.String store)
store
- The store name.
boolean hasAccess(java.lang.String webProject, java.lang.String avmPath, java.lang.String user)
webProject
- The name of the web project that this path is being checked in.avmPath
- A full avmPathuser
- The name of the user, group, role to check on.
boolean hasAccess(NodeRef webProjectRef, java.lang.String avmPath, java.lang.String user)
webProjectRef
- The NodeRef to the web project that this path is being checked in.avmPath
- A full avmPathuser
- The name of the user, group, role to check on.
java.util.List getWebProjects()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |