@AlfrescoPublicApi
public interface PermissionService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADD_CHILDREN |
static java.lang.String |
ADMINISTRATOR_AUTHORITY
The admin authority - currently a role.
|
static java.lang.String |
ALL_AUTHORITIES
The group that contains everyone except guest.
|
static java.lang.String |
ALL_PERMISSIONS
The permission for all - not defined in the model.
|
static java.lang.String |
ASPECTS |
static java.lang.String |
CANCEL_CHECK_OUT |
static java.lang.String |
CHANGE_PERMISSIONS |
static java.lang.String |
CHECK_IN |
static java.lang.String |
CHECK_OUT |
static java.lang.String |
CONSUMER |
static java.lang.String |
CONTRIBUTOR |
static java.lang.String |
COORDINATOR |
static java.lang.String |
CREATE_ASSOCIATIONS |
static java.lang.String |
CREATE_CHILDREN |
static java.lang.String |
DELETE |
static java.lang.String |
DELETE_ASSOCIATIONS |
static java.lang.String |
DELETE_CHILDREN |
static java.lang.String |
DELETE_NODE |
static java.lang.String |
EDITOR |
static java.lang.String |
EXECUTE |
static java.lang.String |
EXECUTE_CONTENT |
static java.lang.String |
FLATTEN |
static java.lang.String |
FULL_CONTROL |
static java.lang.String |
GROUP_PREFIX
Prefix used for authorities of type group.
|
static java.lang.String |
GUEST_AUTHORITY
The guest authority
|
static java.lang.String |
LINK_CHILDREN |
static java.lang.String |
LOCK |
static java.lang.String |
LOCK_OWNER_AUTHORITY
The dynamic authority used for the ownership of locks.
|
static java.lang.String |
OWNER_AUTHORITY
The dynamic authority used for ownership
|
static java.lang.String |
PROPERTIES |
static java.lang.String |
READ |
static java.lang.String |
READ_ASSOCIATIONS |
static java.lang.String |
READ_CHILDREN |
static java.lang.String |
READ_CONTENT |
static java.lang.String |
READ_PERMISSIONS |
static java.lang.String |
READ_PROPERTIES |
static java.lang.String |
ROLE_PREFIX
Prefixes used for authorities of type role.
|
static java.lang.String |
SET_OWNER |
static java.lang.String |
TAKE_OWNERSHIP |
static java.lang.String |
UNLOCK |
static java.lang.String |
WCM_CONTENT_CONTRIBUTOR |
static java.lang.String |
WCM_CONTENT_MANAGER |
static java.lang.String |
WCM_CONTENT_PUBLISHER |
static java.lang.String |
WCM_CONTENT_REVIEWER |
static java.lang.String |
WCM_STORE_OWNER_AUTHORITY
The authority that all owners of WCM stores have.
|
static java.lang.String |
WRITE |
static java.lang.String |
WRITE_CONTENT |
static java.lang.String |
WRITE_PROPERTIES |
Modifier and Type | Method and Description |
---|---|
void |
clearPermission(NodeRef nodeRef,
java.lang.String authority)
Delete all permission for the given authority.
|
void |
clearPermission(StoreRef storeRef,
java.lang.String authority)
Clear all permission masks for an authority on a store
|
void |
deletePermission(NodeRef nodeRef,
java.lang.String authority,
java.lang.String permission)
Find and delete a access control entry by node, authentication and permission.
|
void |
deletePermission(StoreRef storeRef,
java.lang.String authority,
java.lang.String permission)
Remove part of a permission mask on a store
|
void |
deletePermissions(NodeRef nodeRef)
Delete all the permission assigned to the node
|
void |
deletePermissions(StoreRef storeRef)
Remove all permission mask on a store
|
java.lang.String |
getAllAuthorities()
Get the All Authorities
|
java.lang.String |
getAllPermission()
Get the All Permission
|
java.util.Set |
getAllSetPermissions(NodeRef nodeRef)
Get all the AccessPermissions that are set for anyone for the given node
|
java.util.Set |
getAllSetPermissions(StoreRef storeRef)
Get all the AccessPermissions that are set for anyone for the given node
|
java.util.Set |
getAuthorisations()
Get the set of authorities for currently authenticated user
|
boolean |
getInheritParentPermissions(NodeRef nodeRef)
Return the global inheritance behaviour for permissions on a node.
|
java.lang.String |
getOwnerAuthority()
Get the Owner Authority
|
java.util.Set |
getPermissions(NodeRef nodeRef)
Get all the AccessPermissions that are granted/denied to the current authentication for the given node
|
java.util.Set |
getReaders(java.lang.Long aclId)
Get the readers associated with a given ACL
|
java.util.Set |
getSettablePermissions(NodeRef nodeRef)
Get the permissions that can be set for a given node
|
java.util.Set |
getSettablePermissions(QName type)
Get the permissions that can be set for a given type
|
AccessStatus |
hasPermission(java.lang.Long aclID,
PermissionContext context,
java.lang.String permission)
Check if a permission is allowed on an acl.
|
AccessStatus |
hasPermission(NodeRef nodeRef,
java.lang.String permission)
Check that the given authentication has a particular permission for the given node.
|
AccessStatus |
hasReadPermission(NodeRef nodeRef)
Check if read permission is allowed on an acl (optimised)
caveats:
doesn't take into account dynamic authorities/groups
doesn't take into account node types/aspects for permissions
|
void |
setInheritParentPermissions(NodeRef nodeRef,
boolean inheritParentPermissions)
Set the global inheritance behaviour for permissions on a node.
|
void |
setPermission(NodeRef nodeRef,
java.lang.String authority,
java.lang.String permission,
boolean allow)
Set a specific permission on a node.
|
void |
setPermission(StoreRef storeRef,
java.lang.String authority,
java.lang.String permission,
boolean allow)
Add a permission mask to a store
|
static final java.lang.String ROLE_PREFIX
static final java.lang.String GROUP_PREFIX
static final java.lang.String ALL_AUTHORITIES
static final java.lang.String OWNER_AUTHORITY
static final java.lang.String WCM_STORE_OWNER_AUTHORITY
static final java.lang.String LOCK_OWNER_AUTHORITY
static final java.lang.String ADMINISTRATOR_AUTHORITY
static final java.lang.String GUEST_AUTHORITY
static final java.lang.String ALL_PERMISSIONS
static final java.lang.String FULL_CONTROL
static final java.lang.String READ
static final java.lang.String WRITE
static final java.lang.String DELETE
static final java.lang.String ADD_CHILDREN
static final java.lang.String READ_PROPERTIES
static final java.lang.String READ_CHILDREN
static final java.lang.String WRITE_PROPERTIES
static final java.lang.String DELETE_NODE
static final java.lang.String DELETE_CHILDREN
static final java.lang.String CREATE_CHILDREN
static final java.lang.String LINK_CHILDREN
static final java.lang.String DELETE_ASSOCIATIONS
static final java.lang.String READ_ASSOCIATIONS
static final java.lang.String CREATE_ASSOCIATIONS
static final java.lang.String READ_PERMISSIONS
static final java.lang.String CHANGE_PERMISSIONS
static final java.lang.String EXECUTE
static final java.lang.String READ_CONTENT
static final java.lang.String WRITE_CONTENT
static final java.lang.String EXECUTE_CONTENT
static final java.lang.String TAKE_OWNERSHIP
static final java.lang.String SET_OWNER
static final java.lang.String COORDINATOR
static final java.lang.String CONTRIBUTOR
static final java.lang.String EDITOR
static final java.lang.String CONSUMER
static final java.lang.String LOCK
static final java.lang.String UNLOCK
static final java.lang.String CHECK_OUT
static final java.lang.String CHECK_IN
static final java.lang.String CANCEL_CHECK_OUT
static final java.lang.String ASPECTS
static final java.lang.String PROPERTIES
static final java.lang.String WCM_CONTENT_MANAGER
static final java.lang.String WCM_CONTENT_PUBLISHER
static final java.lang.String WCM_CONTENT_CONTRIBUTOR
static final java.lang.String WCM_CONTENT_REVIEWER
static final java.lang.String FLATTEN
@Auditable java.lang.String getOwnerAuthority()
@Auditable java.lang.String getAllAuthorities()
@Auditable java.lang.String getAllPermission()
@Auditable(parameters="nodeRef") java.util.Set getPermissions(NodeRef nodeRef)
nodeRef
- -
the reference to the node@Auditable(parameters="nodeRef") java.util.Set getAllSetPermissions(NodeRef nodeRef)
nodeRef
- -
the reference to the node@Auditable(parameters="nodeRef") java.util.Set getSettablePermissions(NodeRef nodeRef)
@Auditable(parameters="type") java.util.Set getSettablePermissions(QName type)
@Auditable(parameters={"nodeRef", "permission"}) AccessStatus hasPermission(NodeRef nodeRef, java.lang.String permission)
@Auditable(parameters="nodeRef") AccessStatus hasReadPermission(NodeRef nodeRef)
nodeRef
- -
the reference to the node@Auditable(parameters="aclId") java.util.Set getReaders(java.lang.Long aclId)
aclId
- the low-level ACL ID@Auditable(parameters={"aclID", "context", "permission"}) AccessStatus hasPermission(java.lang.Long aclID, PermissionContext context, java.lang.String permission)
@Auditable(parameters="nodeRef") void deletePermissions(NodeRef nodeRef)
@Auditable(parameters={"nodeRef", "authority"}) void clearPermission(NodeRef nodeRef, java.lang.String authority)
authority
- (if null then this will match all authorities)@Auditable(parameters={"nodeRef", "authority", "permission"}) void deletePermission(NodeRef nodeRef, java.lang.String authority, java.lang.String permission)
nodeRef
- the node that the entry applies toauthority
- the authority recipient (if null then this will match all authorities)permission
- the entry permission (if null then this will match all permissions)@Auditable(parameters={"nodeRef", "authority", "permission", "allow"}) void setPermission(NodeRef nodeRef, java.lang.String authority, java.lang.String permission, boolean allow)
@Auditable(parameters={"nodeRef", "inheritParentPermissions"}) void setInheritParentPermissions(NodeRef nodeRef, boolean inheritParentPermissions)
@Auditable(parameters="nodeRef") boolean getInheritParentPermissions(NodeRef nodeRef)
@Auditable(parameters={"storeRef", "authority", "permission", "allow"}) void setPermission(StoreRef storeRef, java.lang.String authority, java.lang.String permission, boolean allow)
@Auditable(parameters={"storeRef", "authority", "permission"}) void deletePermission(StoreRef storeRef, java.lang.String authority, java.lang.String permission)
@Auditable(parameters={"storeRef", "authority"}) void clearPermission(StoreRef storeRef, java.lang.String authority)
@Auditable(parameters="storeRef") void deletePermissions(StoreRef storeRef)
@Auditable(parameters="storeRef") java.util.Set getAllSetPermissions(StoreRef storeRef)
storeRef
- -
the reference to the storejava.util.Set getAuthorisations()
Copyright © 2005 - 2013 Alfresco Software, Inc. All Rights Reserved.