com.unboundid.ldap.sdk.unboundidds.controls

Enum AttributeRight

java.lang.Object

java.lang.Enum<AttributeRight>

com.unboundid.ldap.sdk.unboundidds.controls.AttributeRight

All Implemented Interfaces:

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

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

This enum contains the set of possible attribute-level rights that may be described for an attribute in an entry retrieved with the get effective rights control.

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
COMPARE The attribute right that indicates that the user has sufficient permission to make comparisons against the value of the specified attribute.
PROXY The attribute right that indicates that the user has sufficient permission to perform operations involving proxied authorization with the attribute.
READ The attribute right that indicates that the user has sufficient permission to read the values of the specified attribute.
SEARCH The attribute right that indicates that the user has sufficient permission to perform search operations that target the associated attribute.
SELFWRITE_ADD The attribute right that indicates that the user has sufficient permission to add his or her own DN to the set of values for the specified attribute.
SELFWRITE_DELETE The attribute right that indicates that the user has sufficient permission to remove his or her own DN from the set of values for the specified attribute.
WRITE The attribute right that indicates that the user has sufficient permission to alter the values of the specified attribute.

Method Summary

Modifier and Type	Method and Description
static AttributeRight	forName(java.lang.String name) Retrieves the attribute right for the specified name.
java.lang.String	getName() Retrieves the name of this attribute right.
java.lang.String	toString() Retrieves a string representation of this attribute right.
static AttributeRight	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AttributeRight[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SEARCH

public static final AttributeRight SEARCH

The attribute right that indicates that the user has sufficient permission to perform search operations that target the associated attribute.

READ

public static final AttributeRight READ

The attribute right that indicates that the user has sufficient permission to read the values of the specified attribute.

COMPARE

public static final AttributeRight COMPARE

The attribute right that indicates that the user has sufficient permission to make comparisons against the value of the specified attribute.

WRITE

public static final AttributeRight WRITE

The attribute right that indicates that the user has sufficient permission to alter the values of the specified attribute.

SELFWRITE_ADD

public static final AttributeRight SELFWRITE_ADD

The attribute right that indicates that the user has sufficient permission to add his or her own DN to the set of values for the specified attribute.

SELFWRITE_DELETE

public static final AttributeRight SELFWRITE_DELETE

The attribute right that indicates that the user has sufficient permission to remove his or her own DN from the set of values for the specified attribute.

PROXY

public static final AttributeRight PROXY

The attribute right that indicates that the user has sufficient permission to perform operations involving proxied authorization with the attribute.

Method Detail

values

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

Returns:

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

valueOf

public static AttributeRight 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

getName

@NotNull
public java.lang.String getName()

Retrieves the name of this attribute right.

Returns:

The name of this attribute right.

forName

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

Retrieves the attribute right for the specified name.

Parameters:

name - The name for which to retrieve the corresponding attribute right.

Returns:

The requested attribute right, or null if there is no such right.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this attribute right.

Overrides:

toString in class java.lang.Enum<AttributeRight>

Returns:

A string representation of this attribute right.