com.unboundid.ldap.sdk.unboundidds.controls

Enum UniquenessMultipleAttributeBehavior

java.lang.Object

java.lang.Enum<UniquenessMultipleAttributeBehavior>

com.unboundid.ldap.sdk.unboundidds.controls.UniquenessMultipleAttributeBehavior

All Implemented Interfaces:

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

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

This enum defines the set of multiple attribute behavior 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
UNIQUE_ACROSS_ALL_ATTRIBUTES_EXCEPT_IN_SAME_ENTRY Indicates that the server should flag any case in which any entry has a conflicting value in any of the configured attribute types, with the exception that conflicts will be permitted across different attributes in the same entry.
UNIQUE_ACROSS_ALL_ATTRIBUTES_INCLUDING_IN_SAME_ENTRY Indicates that the server should flag any case in which any entry has a conflicting value in any of the configured attribute types, including cases in which the same value appears in multiple attributes within the same entry.
UNIQUE_IN_COMBINATION Indicates that the server should flag any case in which another entry has the same combination of values for all of the configured attribute types.
UNIQUE_WITHIN_EACH_ATTRIBUTE Indicates that the server should treat each configured attribute separately.

Method Summary

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

UNIQUE_WITHIN_EACH_ATTRIBUTE

public static final UniquenessMultipleAttributeBehavior UNIQUE_WITHIN_EACH_ATTRIBUTE

Indicates that the server should treat each configured attribute separately. For each attribute, the server will attempt to identify conflicts with other entries that have the same value for the same attribute, but it will not flag cases in which the same value is used in different attribute types. This behavior is equivalent to including multiple controls in the request, where each control only references a single attribute type.

UNIQUE_ACROSS_ALL_ATTRIBUTES_INCLUDING_IN_SAME_ENTRY

public static final UniquenessMultipleAttributeBehavior UNIQUE_ACROSS_ALL_ATTRIBUTES_INCLUDING_IN_SAME_ENTRY

Indicates that the server should flag any case in which any entry has a conflicting value in any of the configured attribute types, including cases in which the same value appears in multiple attributes within the same entry.

UNIQUE_ACROSS_ALL_ATTRIBUTES_EXCEPT_IN_SAME_ENTRY

public static final UniquenessMultipleAttributeBehavior UNIQUE_ACROSS_ALL_ATTRIBUTES_EXCEPT_IN_SAME_ENTRY

Indicates that the server should flag any case in which any entry has a conflicting value in any of the configured attribute types, with the exception that conflicts will be permitted across different attributes in the same entry.

UNIQUE_IN_COMBINATION

public static final UniquenessMultipleAttributeBehavior UNIQUE_IN_COMBINATION

Indicates that the server should flag any case in which another entry has the same combination of values for all of the configured attribute types. This will only apply to entries that have at least one value for each of the target attributes. If any of the target attributes has multiple values, then the server will flag each unique combination of those values.

Method Detail

values

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

Returns:

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

valueOf

public static UniquenessMultipleAttributeBehavior 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 multiple attribute behavior.

Returns:

The integer value for this uniqueness multiple attribute behavior.

valueOf

@Nullable
public static UniquenessMultipleAttributeBehavior valueOf(int intValue)

Retrieves the uniqueness multiple attribute behavior with the specified integer value.

Parameters:

intValue - The integer value for the uniqueness multiple attribute behavior to retrieve.

Returns:

The uniqueness multiple attribute behavior for the provided integer value, or null if there is no multiple attribute behavior with the given integer value.

forName

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

Retrieves the uniqueness multiple attribute behavior with the specified name.

Parameters:

name - The name of the uniqueness multiple attribute behavior to retrieve. It must not be null.

Returns:

The requested uniqueness multiple attribute behavior, or null if no such behavior is defined.