Module org.cryptomator.frontend.dokany
Package org.cryptomator.frontend.dokany.internal.structure.filesecurity

Enum Class AccessMask

java.lang.Object
java.lang.Enum<AccessMask>
org.cryptomator.frontend.dokany.internal.structure.filesecurity.AccessMask
All Implemented Interfaces:
Serializable, Comparable<AccessMask>, Constable, EnumInteger
public enum AccessMask extends Enum<AccessMask> implements EnumInteger
Enumeration of the possible AccesMask options. For more info see the Microsoft Documentation.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AS
    ACCESS_SYSTEM_SECURITY When used in an Access Request operation: When requested, this bit grants the requestor the right to change the SACL of an object.
    DE
    DELETE Specifies access to delete an object.
    GA
    GENERIC_ALL When used in an Access Request operation: When all access permissions to an object are requested, this bit is translated to a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK.
    GR
    GENERIC_READ When used in an Access Request operation: When read access to an object is requested, this bit is translated to a combination of bits.
    GW
    GENERIC_WRITE When used in an Access Request operation: When write access to an object is requested, this bit is translated to a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK.
    GX
    GENERIC_EXECUTE
    MA
    MAXIMUM_ALLOWED
    RC
    READ_CONTROL Specifies access to read the security descriptor of an object.
    SY
    SYNCHRONIZE
    WD
    WRITE_DACL Specifies access to change the discretionary access control list of the security descriptor of an object.
    WO
    WRITE_OWNER Specifies access to change the owner of the object as listed in the security descriptor.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMask()
     
    static AccessMask
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static AccessMask[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • GR

      public static final AccessMask GR
      GENERIC_READ When used in an Access Request operation: When read access to an object is requested, this bit is translated to a combination of bits. These are most often set in the lower 16 bits of the ACCESS_MASK. (Individual protocol specifications MAY specify a different configuration.) The bits that are set are implementation dependent. During this translation, the GR bit is cleared. The resulting ACCESS_MASK bits are the actual permissions that are checked against the ACE structures in the security descriptor that attached to the object.

      When used to set the Security Descriptor on an object: When the GR bit is set in an ACE that is to be attached to an object, it is translated into a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK. (Individual protocol specifications MAY specify a different configuration.) The bits that are set are implementation dependent. During this translation, the GR bit is cleared. The resulting ACCESS_MASK bits are the actual permissions that are granted by this ACE.

    • GW

      public static final AccessMask GW
      GENERIC_WRITE When used in an Access Request operation: When write access to an object is requested, this bit is translated to a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK. (Individual protocol specifications MAY specify a different configuration.) The bits that are set are implementation dependent. During this translation, the GW bit is cleared. The resulting ACCESS_MASK bits are the actual permissions that are checked against the ACE structures in the security descriptor that attached to the object.

      When used to set the Security Descriptor on an object: When the GW bit is set in an ACE that is to be attached to an object, it is translated into a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK. (Individual protocol specifications MAY specify a different configuration.) The bits that are set are implementation dependent. During this translation, the GW bit is cleared. The resulting ACCESS_MASK bits are the actual permissions that are granted by this ACE.

    • GX

      public static final AccessMask GX
      GENERIC_EXECUTE

      When used in an Access Request operation: When execute access to an object is requested, this bit is translated to a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK. (Individual protocol specifications MAY specify a different configuration.) The bits that are set are implementation dependent. During this translation, the GX bit is cleared. The resulting ACCESS_MASK bits are the actual permissions that are checked against the ACE structures in the security descriptor that attached to the object.

      When used to set the Security Descriptor on an object: When the GX bit is set in an ACE that is to be attached to an object, it is translated into a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK. (Individual protocol specifications MAY specify a different configuration.) The bits that are set are implementation dependent. During this translation, the GX bit is cleared. The resulting ACCESS_MASK bits are the actual permissions that are granted by this ACE.

    • GA

      public static final AccessMask GA
      GENERIC_ALL When used in an Access Request operation: When all access permissions to an object are requested, this bit is translated to a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK. (Individual protocol specifications MAY specify a different configuration.) Objects are free to include bits from the upper 16 bits in that translation as required by the objects semantics. The bits that are set are implementation dependent. During this translation, the GA bit is cleared. The resulting ACCESS_MASK bits are the actual permissions that are checked against the ACE structures in the security descriptor that attached to the object.

      When used to set the Security Descriptor on an object: When the GA bit is set in an ACE that is to be attached to an object, it is translated into a combination of bits, which are usually set in the lower 16 bits of the ACCESS_MASK. (Individual protocol specifications MAY specify a different configuration.) Objects are free to include bits from the upper 16 bits in that translation, if required by the objects semantics. The bits that are set are implementation dependent. During this translation, the GA bit is cleared. The resulting ACCESS_MASK bits are the actual permissions that are granted by this ACE.

    • MA

      public static final AccessMask MA
      MAXIMUM_ALLOWED

      When used in an Access Request operation: When requested, this bit grants the requestor the maximum permissions allowed to the object through the Access Check Algorithm. This bit can only be requested; it cannot be set in an ACE.

      When used to set the Security Descriptor on an object: Specifying the Maximum Allowed bit in the SECURITY_DESCRIPTOR has no meaning. The MA bit SHOULD NOT be set and SHOULD be ignored when part of a SECURITY_DESCRIPTOR structure.

    • AS

      public static final AccessMask AS
      ACCESS_SYSTEM_SECURITY When used in an Access Request operation: When requested, this bit grants the requestor the right to change the SACL of an object. This bit MUST NOT be set in an ACE that is part of a DACL. When set in an ACE that is part of a SACL, this bit controls auditing of accesses to the SACL itself.

    • SY

      public static final AccessMask SY
      SYNCHRONIZE

      Specifies access to the object sufficient to synchronize or wait on the object.

    • WO

      public static final AccessMask WO
      WRITE_OWNER Specifies access to change the owner of the object as listed in the security descriptor.

    • WD

      public static final AccessMask WD
      WRITE_DACL Specifies access to change the discretionary access control list of the security descriptor of an object.

    • RC

      public static final AccessMask RC
      READ_CONTROL Specifies access to read the security descriptor of an object.

    • DE

      public static final AccessMask DE
      DELETE Specifies access to delete an object.

  • Method Details

    • values

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

    • valueOf

      public static AccessMask valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMask

      public int getMask()
      Specified by:
      getMask in interface EnumInteger