Package org.apache.jackrabbit.vault.fs.spi

Interface ACLManagement

@ProviderType
public interface ACLManagement

AccessControlManagement...

Method Summary

Modifier and Type	Method	Description
void	clearACL(Node node)	Removes all ACLs from the given node.
boolean	ensureAccessControllable(Node node, String policyPrimaryType)	Checks if the given node is access controllable, i.e. has the respective mixin and adds it if missing.
@NotNull Map<String,List<? extends AccessControlPolicy>>	getPrincipalAcls(Node node)
boolean	isAccessControllableMixin(String name)	Checks if the given node type name is use as access controllable mixin.
boolean	isACLNode(Node node)	Checks if the given node is an ACL node.
boolean	isACLNodeType(String name)	Checks if the given node type name is used for ACLs

Method Detail

isACLNodeType

boolean isACLNodeType(String name)

Checks if the given node type name is used for ACLs

Parameters:

name - the node type name

Returns:

true if used for ACLs

isAccessControllableMixin

boolean isAccessControllableMixin(String name)

Checks if the given node type name is use as access controllable mixin.

Parameters:

name - the node type name

Returns:

true if the name is the mixin name

isACLNode

boolean isACLNode(Node node)
           throws RepositoryException

Checks if the given node is an ACL node.

Parameters:

node - the node

Returns:

true if it's an ACL node.

Throws:

RepositoryException - if an error occurs

ensureAccessControllable

boolean ensureAccessControllable(Node node,
                                 String policyPrimaryType)
                          throws RepositoryException

Checks if the given node is access controllable, i.e. has the respective mixin and adds it if missing.

Parameters:

node - the node to check

policyPrimaryType - Primary node type of policy

Returns:

true if was made access controllable

Throws:

RepositoryException - if an error occurs

clearACL

void clearACL(Node node)
       throws RepositoryException

Removes all ACLs from the given node.

Parameters:

node - the node

Throws:

RepositoryException - if an error occurs

getPrincipalAcls

@NotNull
@NotNull Map<String,List<? extends AccessControlPolicy>> getPrincipalAcls(Node node)
                                                                         throws RepositoryException

Parameters:

node - the start node from where to collect principal policies

Returns:

all collected principal access control policies per principal name inside the given node (even nested ones)

Throws:

RepositoryException - in case some error occurred while collecting the principal policies

Since:

3.7.0

See Also:

Access Control