com.unboundid.ldap.sdk.unboundidds.controls

Enum AssuredReplicationLocalLevel

java.lang.Object

java.lang.Enum<AssuredReplicationLocalLevel>

com.unboundid.ldap.sdk.unboundidds.controls.AssuredReplicationLocalLevel

All Implemented Interfaces:

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

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

This enum defines an assurance level that may be used for servers in the same location as 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 local assurance is desired for the associated operation.
PROCESSED_ALL_SERVERS Indicates that the operation result should not be returned to the client until the change has been processed by all available directory servers in the same location as the original server.
RECEIVED_ANY_SERVER Indicates that the operation result should not be returned to the client until the change has been received by at least one other replication server in same location.

Method Summary

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

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

RECEIVED_ANY_SERVER

public static final AssuredReplicationLocalLevel RECEIVED_ANY_SERVER

Indicates that the operation result should not be returned to the client until the change has been received by at least one other replication server in same 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 other replication server for the sake of redundancy. If the client interacts with another local 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_SERVERS

public static final AssuredReplicationLocalLevel PROCESSED_ALL_SERVERS

Indicates that the operation result should not be returned to the client until the change has been processed by all available directory servers in the same location as the original server.

Method Detail

values

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

Returns:

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

valueOf

public static AssuredReplicationLocalLevel 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 local assurance level.

Returns:

The integer value for this local assurance level.

getName

@NotNull
public java.lang.String getName()

Retrieves the name for this local assurance level.

Returns:

The name for this local assurance level.

valueOf

@Nullable
public static AssuredReplicationLocalLevel valueOf(int intValue)

Retrieves the local assurance level with the specified integer value.

Parameters:

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

Returns:

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

forName

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

Retrieves the local assurance level with the specified name.

Parameters:

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

Returns:

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

getLessStrict

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

Retrieves the less strict of the two provided assured replication local 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 local level values.

getMoreStrict

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

Retrieves the more strict of the two provided assured replication local 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 local level values.