Enum AccessControlHandling

java.lang.Object
java.lang.Enum<AccessControlHandling>
org.apache.jackrabbit.vault.fs.io.AccessControlHandling
All Implemented Interfaces:
Serializable, Comparable<AccessControlHandling>

public enum AccessControlHandling extends Enum<AccessControlHandling>
AccessControlHandling defines the behavior when importing access control nodes.
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Clears all access control on the target system.
    Ignores the packaged access control and leaves the target unchanged.
    Merge access control provided with the package with the one in the content by replacing the access control entries of corresponding principals (i.e.
    Merge access control in the content with the one provided with the package by adding the access control entries of principals not present in the content (i.e.
    Applies the access control provided with the package to the target.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this type with the specified name.
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • IGNORE

      public static final AccessControlHandling IGNORE
      Ignores the packaged access control and leaves the target unchanged.
    • OVERWRITE

      public static final AccessControlHandling OVERWRITE
      Applies the access control provided with the package to the target. this also removes existing access control.
    • MERGE

      public static final AccessControlHandling MERGE
      Merge access control provided with the package with the one in the content by replacing the access control entries of corresponding principals (i.e. package first). It never alters access control entries of principals not present in the package.

      Example:
      Content ACL:

           everyone, deny, jcr:all
           bob, allow, jcr:read
           bob, allow, jcr:write
       
      Package ACL:
           bob, deny, jcr:all
           alice, allow, jcr:read
       
      Result ACL:
           everyone, deny, jcr:all
           bob, deny, jcr:all
           alice, allow, jcr:read
       
    • MERGE_PRESERVE

      public static final AccessControlHandling MERGE_PRESERVE
      Merge access control in the content with the one provided with the package by adding the access control entries of principals not present in the content (i.e. content first). It never alters access control entries already existing in the content.

      Example:
      Content ACL:

           everyone, deny, jcr:all
           bob, allow, jcr:read
           bob, allow, jcr:write
       
      Package ACL:
           bob, deny, jcr:all
           alice, allow, jcr:read
       
      Result ACL:
           everyone, deny, jcr:all
           bob, allow, jcr:read
           bob, allow, jcr:write
           alice, allow, jcr:read
       
    • CLEAR

      public static final AccessControlHandling CLEAR
      Clears all access control on the target system.
  • Method Details

    • values

      public static AccessControlHandling[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static AccessControlHandling valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null