Package org.forgerock.opendj.rest2ldap

Enum ReadOnUpdatePolicy

java.lang.Object

java.lang.Enum<ReadOnUpdatePolicy>

org.forgerock.opendj.rest2ldap.ReadOnUpdatePolicy

All Implemented Interfaces:

Serializable, Comparable<ReadOnUpdatePolicy>

public enum ReadOnUpdatePolicy
extends Enum<ReadOnUpdatePolicy>

The policy which should be used in order to read an entry before it is deleted, or after it is added or modified.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTROLS	The LDAP entry will be read atomically using the RFC 4527 read-entry controls.
DISABLED	The LDAP entry will not be read when an update is performed.
SEARCH	The LDAP entry will be read non-atomically using an LDAP search when an update is performed.

Method Summary

Modifier and Type	Method	Description
static ReadOnUpdatePolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReadOnUpdatePolicy[]	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

DISABLED

public static final ReadOnUpdatePolicy DISABLED

The LDAP entry will not be read when an update is performed. More specifically, the REST resource will not be returned as part of a create, delete, patch, or update request.

CONTROLS

public static final ReadOnUpdatePolicy CONTROLS

The LDAP entry will be read atomically using the RFC 4527 read-entry controls. More specifically, the REST resource will be returned as part of a create, delete, patch, or update request, and it will reflect the state of the resource at the time the update was performed. This policy requires that the LDAP server supports RFC 4527.

SEARCH

public static final ReadOnUpdatePolicy SEARCH

The LDAP entry will be read non-atomically using an LDAP search when an update is performed. More specifically, the REST resource will be returned as part of a create, delete, patch, or update request, but it may not reflect the state of the resource at the time the update was performed.

Method Detail

values

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

Returns:

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

valueOf

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