com.unboundid.ldap.sdk.unboundidds.controls

Enum EntryRight

java.lang.Object

java.lang.Enum<EntryRight>

com.unboundid.ldap.sdk.unboundidds.controls.EntryRight

All Implemented Interfaces:

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

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

This enum contains the set of possible entry-level rights that may be described 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
ADD The entry right that indicates that the user has sufficient permission to add a subordinate of the target entry.
DELETE The entry right that indicates that the user has sufficient permission to delete the target entry.
PROXY The entry right that indicates that the user has sufficient permission to perform operations involving proxied authorization with the entry.
READ The entry right that indicates that the user has sufficient permission to perform read operations with the entry.
WRITE The entry right that indicates that the user has sufficient permission to perform write operations with the entry.

Method Summary

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

ADD

public static final EntryRight ADD

The entry right that indicates that the user has sufficient permission to add a subordinate of the target entry.

DELETE

public static final EntryRight DELETE

The entry right that indicates that the user has sufficient permission to delete the target entry.

READ

public static final EntryRight READ

The entry right that indicates that the user has sufficient permission to perform read operations with the entry.

WRITE

public static final EntryRight WRITE

The entry right that indicates that the user has sufficient permission to perform write operations with the entry.

PROXY

public static final EntryRight PROXY

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

Method Detail

values

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

Returns:

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

valueOf

public static EntryRight 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 entry right.

Returns:

The name of this entry right.

forName

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

Retrieves the entry right for the specified name.

Parameters:

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

Returns:

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

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this entry right.

Overrides:

toString in class java.lang.Enum<EntryRight>

Returns:

A string representation of this entry right.