org.ldaptive.auth

Enum AuthenticationResultCode

java.lang.Object

java.lang.Enum<AuthenticationResultCode>

org.ldaptive.auth.AuthenticationResultCode

All Implemented Interfaces:

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

public enum AuthenticationResultCode
extends java.lang.Enum<AuthenticationResultCode>

Enum to define authentication results.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHENTICATION_HANDLER_FAILURE The configured authentication handler produced a result of false.
AUTHENTICATION_HANDLER_SUCCESS The configured authentication handler produced a result of true.
DN_RESOLUTION_FAILURE The configured DN resolver produced an empty or null value.
INVALID_CREDENTIAL The supplied credential was empty or null.

Method Summary

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

AUTHENTICATION_HANDLER_SUCCESS

public static final AuthenticationResultCode AUTHENTICATION_HANDLER_SUCCESS

The configured authentication handler produced a result of true.

AUTHENTICATION_HANDLER_FAILURE

public static final AuthenticationResultCode AUTHENTICATION_HANDLER_FAILURE

The configured authentication handler produced a result of false.

INVALID_CREDENTIAL

public static final AuthenticationResultCode INVALID_CREDENTIAL

The supplied credential was empty or null.

DN_RESOLUTION_FAILURE

public static final AuthenticationResultCode DN_RESOLUTION_FAILURE

The configured DN resolver produced an empty or null value.

Method Detail

values

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

Returns:

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

valueOf

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