org.opends.server.authorization.dseecompat
Enum EnumRight

java.lang.Object
  extended by java.lang.Enum<EnumRight>
      extended by org.opends.server.authorization.dseecompat.EnumRight
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<EnumRight>

public enum EnumRight
extends java.lang.Enum<EnumRight>

This class provides an enumeration of the allowed rights.


Enum Constant Summary
ADD
          This enumeration is returned when the result of the right is "add".
ADDWRITE
          This enumerations is used internally by the modify operation processing and is not part of the ACI syntax.
ALL
          This enumeration is returned when the result of the right is "all".
COMPARE
          This enumeration is returned when the result of the right is "compare".
DELETE
          This enumeration is returned when the result of the right is "delete".
DELWRITE
          This enumeration is used internally by the modify operation processing and is not part of the ACI syntax.
EXPORT
          This enumeration is returned when the result of the right is "export".
IMPORT
          This enumeration is returned when the result of the right is "import".
PROXY
          This enumeration is returned when the result of the right is "proxy".
READ
          This enumeration is returned when the result of the right is "read".
SEARCH
          This enumeration is returned when the result of the right is "search".
SELFWRITE
          This enumeration is returned when the result of the right is "selfwrite".
WRITE
          This enumeration is returned when the result of the right is "write".
 
Method Summary
static EnumRight decode(java.lang.String right)
          Creates an enumeration of the right name.
static int getMask(EnumRight right)
          Returns bit mask associated with the specified right.
 boolean isRight(java.lang.String right)
          Checks if the enumeration is equal to the right name.
static EnumRight valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static EnumRight[] values()
          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 Detail

READ

public static final EnumRight READ
This enumeration is returned when the result of the right is "read".


WRITE

public static final EnumRight WRITE
This enumeration is returned when the result of the right is "write".


ADD

public static final EnumRight ADD
This enumeration is returned when the result of the right is "add".


DELETE

public static final EnumRight DELETE
This enumeration is returned when the result of the right is "delete".


SEARCH

public static final EnumRight SEARCH
This enumeration is returned when the result of the right is "search".


COMPARE

public static final EnumRight COMPARE
This enumeration is returned when the result of the right is "compare".


SELFWRITE

public static final EnumRight SELFWRITE
This enumeration is returned when the result of the right is "selfwrite".


PROXY

public static final EnumRight PROXY
This enumeration is returned when the result of the right is "proxy".


IMPORT

public static final EnumRight IMPORT
This enumeration is returned when the result of the right is "import".


EXPORT

public static final EnumRight EXPORT
This enumeration is returned when the result of the right is "export".


ALL

public static final EnumRight ALL
This enumeration is returned when the result of the right is "all".


DELWRITE

public static final EnumRight DELWRITE
This enumeration is used internally by the modify operation processing and is not part of the ACI syntax.


ADDWRITE

public static final EnumRight ADDWRITE
This enumerations is used internally by the modify operation processing and is not part of the ACI syntax.

Method Detail

values

public static EnumRight[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (EnumRight c : EnumRight.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static EnumRight valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

isRight

public boolean isRight(java.lang.String right)
Checks if the enumeration is equal to the right name.

Parameters:
right - The name of the right to check.
Returns:
True if the right is equal to the enumeration's.

decode

public static EnumRight decode(java.lang.String right)
Creates an enumeration of the right name.

Parameters:
right - The name of the right.
Returns:
An enumeration of the right or null if the name is invalid.

getMask

public static int getMask(EnumRight right)
Returns bit mask associated with the specified right.

Parameters:
right - The right enumeration to return the mask for.
Returns:
The bit mask associated with the right.