com.unboundid.ldap.sdk.unboundidds.controls

Enum AssuredReplicationServerResultCode

java.lang.Object

java.lang.Enum<AssuredReplicationServerResultCode>

com.unboundid.ldap.sdk.unboundidds.controls.AssuredReplicationServerResultCode

All Implemented Interfaces:

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

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum AssuredReplicationServerResultCode
extends java.lang.Enum<AssuredReplicationServerResultCode>

This enum defines the set of result code values that may be included in a an assured replication server result.

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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE Indicates that the requested level of assurance was successfully attained.
CONFLICT Indicates that a replication conflict was encountered that will prevent the associated operation from being applied to the target server.
DUPLICATE Indicates that the replication assurance engine detected a duplicate request for the same operation.
SERVER_SHUTDOWN Indicates that the target server was shut down while waiting for an assurance result.
TIMEOUT Indicates that the requested level of assurance could not be attained before the timeout elapsed.
UNAVAILABLE Indicates that the target server became unavailable while waiting for an assurance result.

Method Summary

Modifier and Type	Method and Description
static AssuredReplicationServerResultCode	forName(java.lang.String name) Retrieves the assured replication server result code with the specified name.
int	intValue() Retrieves the integer value for this assured replication server result code.
static AssuredReplicationServerResultCode	valueOf(int intValue) Retrieves the assured replication server result code with the specified integer value.
static AssuredReplicationServerResultCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AssuredReplicationServerResultCode[]	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

COMPLETE

public static final AssuredReplicationServerResultCode COMPLETE

Indicates that the requested level of assurance was successfully attained.

TIMEOUT

public static final AssuredReplicationServerResultCode TIMEOUT

Indicates that the requested level of assurance could not be attained before the timeout elapsed.

CONFLICT

public static final AssuredReplicationServerResultCode CONFLICT

Indicates that a replication conflict was encountered that will prevent the associated operation from being applied to the target server.

SERVER_SHUTDOWN

public static final AssuredReplicationServerResultCode SERVER_SHUTDOWN

Indicates that the target server was shut down while waiting for an assurance result.

UNAVAILABLE

public static final AssuredReplicationServerResultCode UNAVAILABLE

Indicates that the target server became unavailable while waiting for an assurance result.

DUPLICATE

public static final AssuredReplicationServerResultCode DUPLICATE

Indicates that the replication assurance engine detected a duplicate request for the same operation.

Method Detail

values

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

Returns:

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

valueOf

public static AssuredReplicationServerResultCode 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 for this assured replication server result code.

Returns:

The integer value for this assured replication server result code.

valueOf

@Nullable
public static AssuredReplicationServerResultCode valueOf(int intValue)

Retrieves the assured replication server result code with the specified integer value.

Parameters:

intValue - The integer value for the server result code to retrieve.

Returns:

The requested assured replication server result code, or null if there is no server result code with the specified integer value.

forName

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

Retrieves the assured replication server result code with the specified name.

Parameters:

name - The name of the assured replication server result code to retrieve. It must not be null.

Returns:

The requested assured replication server result code, or null if no such result code is defined.