com.unboundid.ldap.sdk.unboundidds.extensions

Enum MultiUpdateErrorBehavior

java.lang.Object

java.lang.Enum<MultiUpdateErrorBehavior>

com.unboundid.ldap.sdk.unboundidds.extensions.MultiUpdateErrorBehavior

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MultiUpdateErrorBehavior>

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

This enum defines the set of possible error behavior values that may be used in the multi-update extended request.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

See Also:

MultiUpdateExtendedRequest

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT_ON_ERROR The behavior which indicates that processing will end for the multi-update operation after the first failure is encountered while attempting to apply a change.
ATOMIC The behavior which indicates that all operations must be processed atomically.
CONTINUE_ON_ERROR The behavior which indicates that the server should attempt to process all elements of the multi-update request even if one or more failures are encountered.

Method Summary

Modifier and Type	Method and Description
static MultiUpdateErrorBehavior	forName(java.lang.String name) Retrieves the multi-update error behavior with the specified name.
int	intValue() Retrieves the integer value associated with this error behavior.
static MultiUpdateErrorBehavior	valueOf(int intValue) Retrieves the multi-update error behavior value with the specified integer value.
static MultiUpdateErrorBehavior	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MultiUpdateErrorBehavior[]	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

ATOMIC

public static final MultiUpdateErrorBehavior ATOMIC

The behavior which indicates that all operations must be processed atomically. The entire set of updates will succeed or fail as a single unit, and directory clients will not see any updates while the multi-update request is in progress. Note that the server may place constraints on the ability to use this error behavior such that it may not be usable in all circumstances (e.g., when passing through a Directory Proxy Server with entry balancing enabled or that would otherwise need to communicate with multiple servers, or if it is necessary to interact with entries in multiple Directory Server backends).

ABORT_ON_ERROR

public static final MultiUpdateErrorBehavior ABORT_ON_ERROR

The behavior which indicates that processing will end for the multi-update operation after the first failure is encountered while attempting to apply a change. Any changes processed before the first failure was encountered will still have been applied, and clients accessing the server in the course of processing the multi-update request may see changes after only some of them have been completed.

CONTINUE_ON_ERROR

public static final MultiUpdateErrorBehavior CONTINUE_ON_ERROR

The behavior which indicates that the server should attempt to process all elements of the multi-update request even if one or more failures are encountered. Clients accessing the server in the course of processing the multi-update request may see changes after only some of them have been completed.

Method Detail

values

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

Returns:

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

valueOf

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

intValue

public int intValue()

Retrieves the integer value associated with this error behavior.

Returns:

The integer value associated with this error behavior.

valueOf

@Nullable
public static MultiUpdateErrorBehavior valueOf(int intValue)

Retrieves the multi-update error behavior value with the specified integer value.

Parameters:

intValue - The integer value for the error behavior to retrieve.

Returns:

The multi-update error behavior with the specified integer value, or null if there is no error behavior with the specified value.

forName

@Nullable
public static MultiUpdateErrorBehavior forName(@NotNull
                                                         java.lang.String name)

Retrieves the multi-update error behavior with the specified name.

Parameters:

name - The name of the multi-update error behavior to retrieve. It must not be null.

Returns:

The requested multi-update error behavior, or null if no such behavior is defined.