Package io.micronaut.security.authentication

Enum Class AuthenticationFailureReason

java.lang.Object

java.lang.Enum<AuthenticationFailureReason>

io.micronaut.security.authentication.AuthenticationFailureReason

All Implemented Interfaces:

Serializable, Comparable<AuthenticationFailureReason>, Constable

public enum AuthenticationFailureReason
extends Enum<AuthenticationFailureReason>

Enums describes the different authentication failures.

Since:

1.0

Author:

Sergio del Amo

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCOUNT_EXPIRED	Failure when the cause is the user account expired.
ACCOUNT_LOCKED	Failure when the cause is the user account was locked.
CREDENTIALS_DO_NOT_MATCH	Failure when the cause is the credentials don't match.
CUSTOM	An custom failure.
PASSWORD_EXPIRED	Failure when the cause is the user's password expired.
UNKNOWN	An unknown failure.
USER_DISABLED	Failure when the cause is the user account is disabled.
USER_NOT_FOUND	Failure when the cause is the user is not found.

Method Summary

Modifier and Type	Method	Description
static AuthenticationFailureReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AuthenticationFailureReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USER_NOT_FOUND

public static final AuthenticationFailureReason USER_NOT_FOUND

Failure when the cause is the user is not found.

CREDENTIALS_DO_NOT_MATCH

public static final AuthenticationFailureReason CREDENTIALS_DO_NOT_MATCH

Failure when the cause is the credentials don't match.

USER_DISABLED

public static final AuthenticationFailureReason USER_DISABLED

Failure when the cause is the user account is disabled.

ACCOUNT_EXPIRED

public static final AuthenticationFailureReason ACCOUNT_EXPIRED

Failure when the cause is the user account expired.

ACCOUNT_LOCKED

public static final AuthenticationFailureReason ACCOUNT_LOCKED

Failure when the cause is the user account was locked.

PASSWORD_EXPIRED

public static final AuthenticationFailureReason PASSWORD_EXPIRED

Failure when the cause is the user's password expired.

UNKNOWN

public static final AuthenticationFailureReason UNKNOWN

An unknown failure.

CUSTOM

public static final AuthenticationFailureReason CUSTOM

An custom failure.

Method Details

values

public static AuthenticationFailureReason[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AuthenticationFailureReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null