Class RolePermissions


  • public class RolePermissions
    extends Object
    Represents the POSIX-style permissions on given resource for an arbitrary role. Each role can have any combination of read, write, and execute permissions. Manipulating resource permissions is only supported when ADLS interop and Hierarchical Namespace are enabled.
    • Constructor Detail

      • RolePermissions

        public RolePermissions()
        Initializes an instance of RolePermissions with all values set to false.
    • Method Detail

      • parseOctal

        public static RolePermissions parseOctal​(int octal)
        Convert an octal representation of permissions for a given role into an RolePermissions instance.
        Parameters:
        octal - The octal digit representing the permissions for the given role.
        Returns:
        An RolePermissions instance with appropriate fields set.
      • parseSymbolic

        public static RolePermissions parseSymbolic​(String str,
                                                    boolean allowStickyBit)
        Convert a symbolic representation of permissions for a given role into an RolePermissions instance.
        Parameters:
        str - The string representing the permissions for the given role.
        allowStickyBit - Indicates whether or not the parsing should tolerate the sticky bit. The sticky bit is only valid as the last character of permissions for "other" in a String representing full permissions for a resource.
        Returns:
        An RolePermissions instance with appropriate fields set.
        Throws:
        IllegalArgumentException - if the String does not match the format.
      • toOctal

        public String toOctal()
        Converts the RolePermissions instance into its octal representation.
        Returns:
        The String representation of the permissions.
      • toSymbolic

        public String toSymbolic()
        Converts the RolePermissions instance into its symbolic representation.
        Returns:
        The String representation of the permission.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • hasReadPermission

        public boolean hasReadPermission()
        Returns:
        the read permission status
      • hasWritePermission

        public boolean hasWritePermission()
        Returns:
        the write permission status
      • hasExecutePermission

        public boolean hasExecutePermission()
        Returns:
        the execute permission status
      • setReadPermission

        public RolePermissions setReadPermission​(boolean hasReadPermission)
        Sets the read permission status.
        Parameters:
        hasReadPermission - Permission status to set
        Returns:
        the updated RolePermissions object
      • setWritePermission

        public RolePermissions setWritePermission​(boolean hasWritePermission)
        Sets the write permission status.
        Parameters:
        hasWritePermission - Permission status to set
        Returns:
        the updated RolePermissions object
      • setExecutePermission

        public RolePermissions setExecutePermission​(boolean hasExecutePermission)
        Sets the execute permission status.
        Parameters:
        hasExecutePermission - Permission status to set
        Returns:
        the updated RolePermissions object