org.opends.server.types
Enum Privilege

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

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public enum Privilege
extends java.lang.Enum<Privilege>

This class implements an enumeration that defines the set of privileges available in the Directory Server.


Enum Constant Summary
BACKEND_BACKUP
          The privilege that provides the ability to perform backend backup operations.
BACKEND_RESTORE
          The privilege that provides the ability to perform backend restore operations.
BYPASS_ACL
          The privilege that provides the ability to bypass access control evaluation.
CANCEL_REQUEST
          The privilege that provides the ability to cancel arbitrary client requests.
CONFIG_READ
          The privilege that provides the ability to read the server configuration.
CONFIG_WRITE
          The privilege that provides the ability to update the server configuration.
DATA_SYNC
          The privilege that provides the ability to participate in a data synchronization environment.
DISCONNECT_CLIENT
          The privilege that provides the ability to terminate arbitrary client connections.
JMX_NOTIFY
          The privilege that provides the ability to subscribe to JMX notifications.
JMX_READ
          The privilege that provides the ability to perform read operations via JMX.
JMX_WRITE
          The privilege that provides the ability to perform write operations via JMX.
LDIF_EXPORT
          The privilege that provides the ability to perform LDIF export operations.
LDIF_IMPORT
          The privilege that provides the ability to perform LDIF import operations.
MODIFY_ACL
          The privilege that provides the ability to modify access control rules.
PASSWORD_RESET
          The privilege that provides the ability to reset user passwords.
PRIVILEGE_CHANGE
          The privilege that provides the ability to change the set of privileges for a user, or to change the set of privileges automatically assigned to a root user.
PROXIED_AUTH
          The privilege that provides the ability to perform proxied authorization or request an alternate authorization identity.
SERVER_RESTART
          The privilege that provides the ability to request a server restart.
SERVER_SHUTDOWN
          The privilege that provides the ability to request a server shutdown.
UNINDEXED_SEARCH
          The privilege that provides the ability to perform an unindexed search in the JE backend.
UPDATE_SCHEMA
          The privilege that provides the ability to update the server schema.
 
Method Summary
static java.util.Set<Privilege> getDefaultRootPrivileges()
          Retrieves the set of privileges that should be automatically granted to root users if the root privilege set is not specified in the configuration.
 java.lang.String getName()
          Retrieves the name for this privilege.
static java.util.Set<java.lang.String> getPrivilegeNames()
          Retrieves the set of available privilege names.
static Privilege privilegeForName(java.lang.String lowerPrivName)
          Retrieves the privilege with the specified name.
 java.lang.String toString()
          Retrieves the human-readable name for this privilege.
static Privilege valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Privilege[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

BYPASS_ACL

public static final Privilege BYPASS_ACL
The privilege that provides the ability to bypass access control evaluation.


MODIFY_ACL

public static final Privilege MODIFY_ACL
The privilege that provides the ability to modify access control rules.


CONFIG_READ

public static final Privilege CONFIG_READ
The privilege that provides the ability to read the server configuration.


CONFIG_WRITE

public static final Privilege CONFIG_WRITE
The privilege that provides the ability to update the server configuration.


JMX_READ

public static final Privilege JMX_READ
The privilege that provides the ability to perform read operations via JMX.


JMX_WRITE

public static final Privilege JMX_WRITE
The privilege that provides the ability to perform write operations via JMX.


JMX_NOTIFY

public static final Privilege JMX_NOTIFY
The privilege that provides the ability to subscribe to JMX notifications.


LDIF_IMPORT

public static final Privilege LDIF_IMPORT
The privilege that provides the ability to perform LDIF import operations.


LDIF_EXPORT

public static final Privilege LDIF_EXPORT
The privilege that provides the ability to perform LDIF export operations.


BACKEND_BACKUP

public static final Privilege BACKEND_BACKUP
The privilege that provides the ability to perform backend backup operations.


BACKEND_RESTORE

public static final Privilege BACKEND_RESTORE
The privilege that provides the ability to perform backend restore operations.


SERVER_SHUTDOWN

public static final Privilege SERVER_SHUTDOWN
The privilege that provides the ability to request a server shutdown.


SERVER_RESTART

public static final Privilege SERVER_RESTART
The privilege that provides the ability to request a server restart.


PROXIED_AUTH

public static final Privilege PROXIED_AUTH
The privilege that provides the ability to perform proxied authorization or request an alternate authorization identity.


DISCONNECT_CLIENT

public static final Privilege DISCONNECT_CLIENT
The privilege that provides the ability to terminate arbitrary client connections.


CANCEL_REQUEST

public static final Privilege CANCEL_REQUEST
The privilege that provides the ability to cancel arbitrary client requests.


PASSWORD_RESET

public static final Privilege PASSWORD_RESET
The privilege that provides the ability to reset user passwords.


DATA_SYNC

public static final Privilege DATA_SYNC
The privilege that provides the ability to participate in a data synchronization environment.


UPDATE_SCHEMA

public static final Privilege UPDATE_SCHEMA
The privilege that provides the ability to update the server schema.


PRIVILEGE_CHANGE

public static final Privilege PRIVILEGE_CHANGE
The privilege that provides the ability to change the set of privileges for a user, or to change the set of privileges automatically assigned to a root user.


UNINDEXED_SEARCH

public static final Privilege UNINDEXED_SEARCH
The privilege that provides the ability to perform an unindexed search in the JE backend.

Method Detail

values

public static Privilege[] 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 (Privilege c : Privilege.values())
    System.out.println(c);

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

valueOf

public static Privilege 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

getName

public java.lang.String getName()
Retrieves the name for this privilege.

Returns:
The name for this privilege.

privilegeForName

public static Privilege privilegeForName(java.lang.String lowerPrivName)
Retrieves the privilege with the specified name.

Parameters:
lowerPrivName - The name of the privilege to retrieve, formatted in all lowercase characters.
Returns:
The requested privilege, or null if the provided value is not the name of a valid privilege.

toString

public java.lang.String toString()
Retrieves the human-readable name for this privilege.

Overrides:
toString in class java.lang.Enum<Privilege>
Returns:
The human-readable name for this privilege.

getPrivilegeNames

public static java.util.Set<java.lang.String> getPrivilegeNames()
Retrieves the set of available privilege names.

Returns:
The set of available privilege names.

getDefaultRootPrivileges

public static java.util.Set<Privilege> getDefaultRootPrivileges()
Retrieves the set of privileges that should be automatically granted to root users if the root privilege set is not specified in the configuration.

Returns:
The set of privileges that should be automatically granted to root users if the root privilege set is not specified in the configuration.