com.unboundid.ldap.sdk.unboundidds.controls

Enum AssuredReplicationRemoteLevel

java.lang.Object

java.lang.Enum<AssuredReplicationRemoteLevel>

com.unboundid.ldap.sdk.unboundidds.controls.AssuredReplicationRemoteLevel

All Implemented Interfaces:

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

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

This enum defines an assurance level that may be used for servers in different locations from the server receiving the change.

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
NONE Indicates that no remote assurance is desired for the associated operation.
PROCESSED_ALL_REMOTE_SERVERS Indicates that the operation result should not be returned to the client until the change has been processed by all available servers in all remote locations.
RECEIVED_ALL_REMOTE_LOCATIONS Indicates that the operation result should not be returned to the client until the change has been received by at least one replication server in each of the remote locations.
RECEIVED_ANY_REMOTE_LOCATION Indicates that the operation result should not be returned to the client until the change has been received by at least one replication server in a different location.

Method Summary

Modifier and Type	Method and Description
static AssuredReplicationRemoteLevel	forName(java.lang.String name) Retrieves the remote assurance level with the specified name.
static AssuredReplicationRemoteLevel	getLessStrict(AssuredReplicationRemoteLevel l1, AssuredReplicationRemoteLevel l2) Retrieves the less strict of the two provided assured replication remote level values.
static AssuredReplicationRemoteLevel	getMoreStrict(AssuredReplicationRemoteLevel l1, AssuredReplicationRemoteLevel l2) Retrieves the more strict of the two provided assured replication remote level values.
java.lang.String	getName() Retrieves the name for this remote assurance level.
int	intValue() Retrieves integer value for this remote assurance level.
static AssuredReplicationRemoteLevel	valueOf(int intValue) Retrieves the remote assurance level with the specified integer value.
static AssuredReplicationRemoteLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AssuredReplicationRemoteLevel[]	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

NONE

public static final AssuredReplicationRemoteLevel NONE

Indicates that no remote assurance is desired for the associated operation.

RECEIVED_ANY_REMOTE_LOCATION

public static final AssuredReplicationRemoteLevel RECEIVED_ANY_REMOTE_LOCATION

Indicates that the operation result should not be returned to the client until the change has been received by at least one replication server in a different location. Note that this level does not require the change to have already been processed by any other directory server, but merely requires that it exist in at least one remote replication server for the sake of redundancy. If the client interacts with another remote directory server immediately after receiving a result with this level of assurance, there is no guarantee that the associated change will be visible on that server.

RECEIVED_ALL_REMOTE_LOCATIONS

public static final AssuredReplicationRemoteLevel RECEIVED_ALL_REMOTE_LOCATIONS

Indicates that the operation result should not be returned to the client until the change has been received by at least one replication server in each of the remote locations. Note that this level does not require the change to have already been processed by any other directory server, but merely requires that it exist in at least one remote replication server in each remote location for the sake of redundancy. If the client interacts with another remote directory server immediately after receiving a result with this level of assurance, there is no guarantee that the associated change will be visible on that server.

PROCESSED_ALL_REMOTE_SERVERS

public static final AssuredReplicationRemoteLevel PROCESSED_ALL_REMOTE_SERVERS

Indicates that the operation result should not be returned to the client until the change has been processed by all available servers in all remote locations.

Method Detail

values

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

Returns:

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

valueOf

public static AssuredReplicationRemoteLevel 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 integer value for this remote assurance level.

Returns:

The integer value for this remote assurance level.

getName

@NotNull
public java.lang.String getName()

Retrieves the name for this remote assurance level.

Returns:

The name for this remote assurance level.

valueOf

@Nullable
public static AssuredReplicationRemoteLevel valueOf(int intValue)

Retrieves the remote assurance level with the specified integer value.

Parameters:

intValue - The integer value for the remote assurance level to retrieve.

Returns:

The requested remote assurance level, or null if there is no remote assurance level with the specified integer value.

forName

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

Retrieves the remote assurance level with the specified name.

Parameters:

name - The name of the remote assurance level to retrieve. It must not be null.

Returns:

The requested remote assurance level, or null if no such level is defined.

getLessStrict

@NotNull
public static AssuredReplicationRemoteLevel getLessStrict(@NotNull
                                                                   AssuredReplicationRemoteLevel l1,
                                                                   @NotNull
                                                                   AssuredReplicationRemoteLevel l2)

Retrieves the less strict of the two provided assured replication remote level values. If the two provided values are the same, then that value will be returned.

Parameters:

l1 - The first value to compare.

l2 - The second value to compare.

Returns:

The less strict of the two provided assured replication remote level values.

getMoreStrict

@NotNull
public static AssuredReplicationRemoteLevel getMoreStrict(@NotNull
                                                                   AssuredReplicationRemoteLevel l1,
                                                                   @NotNull
                                                                   AssuredReplicationRemoteLevel l2)

Retrieves the more strict of the two provided assured replication remote level values. If the two provided values are the same, then that value will be returned.

Parameters:

l1 - The first value to compare.

l2 - The second value to compare.

Returns:

The more strict of the two provided assured replication remote level values.