org.apache.sling.auth.core.spi

Enum AuthenticationHandler.FAILURE_REASON_CODES

java.lang.Object

java.lang.Enum<AuthenticationHandler.FAILURE_REASON_CODES>

org.apache.sling.auth.core.spi.AuthenticationHandler.FAILURE_REASON_CODES

All Implemented Interfaces:

Serializable, Comparable<AuthenticationHandler.FAILURE_REASON_CODES>

Enclosing interface:

AuthenticationHandler

public static enum AuthenticationHandler.FAILURE_REASON_CODES
extends Enum<AuthenticationHandler.FAILURE_REASON_CODES>

This enum indicates the supported detailed login failure reason codes:

• invalid_login:
indicates username/password mismatch.
• password_expired:
indicates password has expired or was never set and change initial password is enabled
• unknown:
an unknown reason for the login failure was encountered.

Since:

1.1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID_LOGIN
PASSWORD_EXPIRED
UNKNOWN

Method Summary

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

INVALID_LOGIN

public static final AuthenticationHandler.FAILURE_REASON_CODES INVALID_LOGIN

PASSWORD_EXPIRED

public static final AuthenticationHandler.FAILURE_REASON_CODES PASSWORD_EXPIRED

UNKNOWN

public static final AuthenticationHandler.FAILURE_REASON_CODES UNKNOWN

Method Detail

values

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

Returns:

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

valueOf

public static AuthenticationHandler.FAILURE_REASON_CODES valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<AuthenticationHandler.FAILURE_REASON_CODES>