com.unboundid.ldap.sdk.unboundidds.controls

Enum UniquenessValidationLevel

java.lang.Object

java.lang.Enum<UniquenessValidationLevel>

com.unboundid.ldap.sdk.unboundidds.controls.UniquenessValidationLevel

All Implemented Interfaces:

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

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

This enum defines the set of validation level values that may be used in conjunction with the UniquenessRequestControl.

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
ALL_AVAILABLE_BACKEND_SERVERS Indicates that all available servers within the scope of the uniqueness criteria should be searched for potential uniqueness conflicts.
ALL_BACKEND_SETS Indicates that one server from each entry-balanced backend set should be searched for potential uniqueness conflicts.
ALL_SUBTREE_VIEWS Indicates that a single search should be performed per subtree view to ensure that there are no uniqueness conflicts.
NONE Indicates that no uniqueness validation should be performed.

Method Summary

Modifier and Type	Method and Description
static UniquenessValidationLevel	forName(java.lang.String name) Retrieves the uniqueness validation level with the specified name.
int	intValue() Retrieves the integer value for this uniqueness validation level.
static UniquenessValidationLevel	valueOf(int intValue) Retrieves the uniqueness validation level with the specified integer value.
static UniquenessValidationLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UniquenessValidationLevel[]	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 UniquenessValidationLevel NONE

Indicates that no uniqueness validation should be performed. This validation level has the same effect for requests sent directly to a Directory Server and requests sent through a Directory Proxy Server.

ALL_SUBTREE_VIEWS

public static final UniquenessValidationLevel ALL_SUBTREE_VIEWS

Indicates that a single search should be performed per subtree view to ensure that there are no uniqueness conflicts. This has the following behavior:

• If the request is received by a Directory Server instance, then only that instance will be searched for potential conflicts. No replicas will be examined.
• If the request is received by a Directory Proxy Server instance that does not use entry balancing, then only one backend server will be searched for potential conflicts.
• If the request is received by a Directory Proxy Server instance that uses entry balancing, then the server may only search one backend server in one backend set if it can use its global index to identify which backend set is appropriate. However, if the scope of the uniqueness request control contains the entire set of entry-balanced data and the global index does not include enough information to restrict the search to one backend set, then it may be necessary to issue the search to one server in each backend set.

ALL_BACKEND_SETS

public static final UniquenessValidationLevel ALL_BACKEND_SETS

Indicates that one server from each entry-balanced backend set should be searched for potential uniqueness conflicts. This has the following behavior:

• If the request is received by a Directory Server instance, then only that instance will be searched for potential conflicts. No replicas will be examined.
• If the request is received by a Directory Proxy Server instance that does not use entry balancing, then only one backend server will be searched for potential conflicts.
• If the request is received by a Directory Proxy Server instance that uses entry balancing and the scope of the uniqueness request control covers the entire set of entry-balanced data, then one server from each backend set will be searched for potential conflicts.
• If the request is received by a Directory Proxy Server instance that uses entry balancing, and if the uniqueness request control has a base DN that is below the balancing point, and if the server's global index can be used to identify which backend set contains the entry with that DN, then it may only be necessary to search within that one backend set, and only within one server in that set. However, if the global index cannot be used to identify the appropriate backend set, then it may be necessary to search one server in each backend set.

ALL_AVAILABLE_BACKEND_SERVERS

public static final UniquenessValidationLevel ALL_AVAILABLE_BACKEND_SERVERS

Indicates that all available servers within the scope of the uniqueness criteria should be searched for potential uniqueness conflicts. This has the following behavior:

• If the request is received by a Directory Server instance, then only that instance will be searched for potential conflicts. No replicas will be examined.
• If the request is received by a Directory Proxy Server instance that does not use entry balancing, then all backend servers with a health check state of "AVAILABLE" will be searched for potential conflicts.
• If the request is received by a Directory Proxy Server instance that uses entry balancing and the scope of the uniqueness request control covers the entire set of entry-balanced data, then all backend servers with a health check state of "AVAILABLE" will be searched for potential conflicts, across all backend sets.
• If the request is received by a Directory Proxy Server instance that uses entry balancing, and if the uniqueness request control has a base DN that is below the balancing point, and if the server's global index can be used to identify which backend set contains the entry with that DN, then it may only be necessary to search all available servers within that one backend set. However, if the global index cannot be used to identify the appropriate backend set, then it may be necessary to search all available servers in all backend sets.

Method Detail

values

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

Returns:

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

valueOf

public static UniquenessValidationLevel 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 uniqueness validation level.

Returns:

The integer value for this uniqueness validation level.

valueOf

@Nullable
public static UniquenessValidationLevel valueOf(int intValue)

Retrieves the uniqueness validation level with the specified integer value.

Parameters:

intValue - The integer value for the uniqueness validation level to retrieve.

Returns:

The uniqueness validation level for the provided integer value, or null if there is no validation level with the given integer value.

forName

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

Retrieves the uniqueness validation level with the specified name.

Parameters:

name - The name of the uniqueness validation level to retrieve. It must not be null.

Returns:

The requested uniqueness validation level, or null if no such level is defined.