Package org.forgerock.opendj.server.core

Enum DataProviderStatus

java.lang.Object

java.lang.Enum<DataProviderStatus>

org.forgerock.opendj.server.core.DataProviderStatus

All Implemented Interfaces:

Serializable, Comparable<DataProviderStatus>

public enum DataProviderStatus
extends Enum<DataProviderStatus>

The status of a data provider. A data provider may be enabled, disabled, or providing a restricted service.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	The data provider is disabled and rejecting all operations.
ENABLED	The data provider is enabled and accepting all operations.
READ_ONLY	The data provider is only accepting read operations; all write operations will be rejected.
WRITE_INTERNAL_ONLY	The data provider is accepting read operations, internal write operations, and updates through synchronization; all other write operations will be rejected.

Method Summary

Modifier and Type	Method	Description
String	toString()	Retrieves a string representation of this status.
static DataProviderStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DataProviderStatus[]	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

DISABLED

public static final DataProviderStatus DISABLED

The data provider is disabled and rejecting all operations.

ENABLED

public static final DataProviderStatus ENABLED

The data provider is enabled and accepting all operations.

READ_ONLY

public static final DataProviderStatus READ_ONLY

The data provider is only accepting read operations; all write operations will be rejected.

WRITE_INTERNAL_ONLY

public static final DataProviderStatus WRITE_INTERNAL_ONLY

The data provider is accepting read operations, internal write operations, and updates through synchronization; all other write operations will be rejected.

Method Detail

values

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

Returns:

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

valueOf

public static DataProviderStatus valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Retrieves a string representation of this status.

Overrides:

toString in class Enum<DataProviderStatus>

Returns:

A string representation of this status.