com.unboundid.ldap.sdk.unboundidds.logs

Enum BindRequestAuthenticationType

java.lang.Object

java.lang.Enum<BindRequestAuthenticationType>

com.unboundid.ldap.sdk.unboundidds.logs.BindRequestAuthenticationType

All Implemented Interfaces:

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

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

This enum defines the set of authentication types that may appear in log messages about bind operations.

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
INTERNAL The authentication type that will be used for authentication by an internal client.
SASL The authentication type that will be used for SASL authentication.
SIMPLE The authentication type that will be used for simple authentication.

Method Summary

Modifier and Type	Method and Description
static BindRequestAuthenticationType	forName(java.lang.String name) Retrieves the authentication type with the specified name.
static BindRequestAuthenticationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BindRequestAuthenticationType[]	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

INTERNAL

public static final BindRequestAuthenticationType INTERNAL

The authentication type that will be used for authentication by an internal client.

SASL

public static final BindRequestAuthenticationType SASL

The authentication type that will be used for SASL authentication.

SIMPLE

public static final BindRequestAuthenticationType SIMPLE

The authentication type that will be used for simple authentication.

Method Detail

values

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

Returns:

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

valueOf

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

forName

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

Retrieves the authentication type with the specified name.

Parameters:

name - The name of the authentication type to retrieve. It must not be null.

Returns:

The requested authentication type, or null if no such type is defined.