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

Interface ACLManagement

  • @ProviderType
public interface ACLManagement
    AccessControlManagement...

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearACL​(javax.jcr.Node node)
      Removes all ACLs from the given node.
      boolean ensureAccessControllable​(javax.jcr.Node node, java.lang.String policyPrimaryType)
      Checks if the given node is access controllable, i.e.
      @NotNull java.util.Map<java.lang.String,​java.util.List<? extends javax.jcr.security.AccessControlPolicy>> getPrincipalAcls​(javax.jcr.Node node)  
      boolean isAccessControllableMixin​(java.lang.String name)
      Checks if the given node type name is use as access controllable mixin.
      boolean isACLNode​(javax.jcr.Node node)
      Checks if the given node is an ACL node.
      boolean isACLNodeType​(java.lang.String name)
      Checks if the given node type name is used for ACLs

    • Method Detail

      • isACLNodeType

        boolean isACLNodeType​(java.lang.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​(java.lang.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​(javax.jcr.Node node)
           throws javax.jcr.RepositoryException
        Checks if the given node is an ACL node.
        Parameters:
        node - the node
        Returns:
        true if it's an ACL node.
        Throws:
        javax.jcr.RepositoryException - if an error occurs

      • ensureAccessControllable

        boolean ensureAccessControllable​(javax.jcr.Node node,
                                 java.lang.String policyPrimaryType)
                          throws javax.jcr.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:
        javax.jcr.RepositoryException - if an error occurs

      • clearACL

        void clearACL​(javax.jcr.Node node)
       throws javax.jcr.RepositoryException
        Removes all ACLs from the given node.
        Parameters:
        node - the node
        Throws:
        javax.jcr.RepositoryException - if an error occurs

      • getPrincipalAcls

        @NotNull
@NotNull java.util.Map<java.lang.String,​java.util.List<? extends javax.jcr.security.AccessControlPolicy>> getPrincipalAcls​(javax.jcr.Node node)
                                                                                                                          throws javax.jcr.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:
        javax.jcr.RepositoryException - in case some error occurred while collecting the principal policies
        Since:
        3.7.0
        See Also:
        Access Control