Interface AclEntry

  • All Superinterfaces:
    Cloneable

    public interface AclEntry
    extends Cloneable
    The Access Control List Entry interface definition.

    An AclEntry is a list of the Permissions that are granted (positive) or denied (negative) to a Principal.

    • Method Detail

      • setPrincipal

        boolean setPrincipal​(Principal user)
        Set the principal for this ACL entry.

        The principal for an ACL entry can only be set once.

        Parameters:
        user - the principal for this ACL entry.
        Returns:
        true on success, false if there is a principal already set for this entry.
      • getPrincipal

        Principal getPrincipal()
        Returns the principal of this ACL entry.
        Returns:
        the principal of this ACL entry, or null if none is set.
      • setNegativePermissions

        void setNegativePermissions()
        Sets this ACL entry to be negative.

        The permissions in this ACL entry will be denied to the principal associated with this entry.

        Note: An ACL entry is positive by default and can only become negative by calling this method.

      • isNegative

        boolean isNegative()
        Returns whether this ACL entry is negative.
        Returns:
        true if this ACL entry is negative, false if it's positive.
      • addPermission

        boolean addPermission​(Permission permission)
        Adds the specified permission to this ACL entry.
        Parameters:
        permission - the permission to be added.
        Returns:
        true if the specified permission is added, false if the permission was already in this entry.
      • removePermission

        boolean removePermission​(Permission permission)
        Removes the specified permission from this ACL entry.
        Parameters:
        permission - the permission to be removed.
        Returns:
        true if the permission is removed, false if the permission was not in this entry.
      • checkPermission

        boolean checkPermission​(Permission permission)
        Checks whether the specified permission is in this ACL entry.
        Parameters:
        permission - the permission to check.
        Returns:
        true if the permission is in this entry, otherwise false.
      • permissions

        Enumeration<Permission> permissions()
        Returns the list of permissions of this ACL entry.
        Returns:
        the list of permissions of this ACL entry,
      • toString

        String toString()
        Returns the string representation of this ACL entry.
        Overrides:
        toString in class Object
        Returns:
        the string representation of this ACL entry.
      • clone

        Object clone()
        Clones this ACL entry instance.
        Returns:
        a copy of this entry.