Enum AuthenticationFailureReason
- java.lang.Object
-
- java.lang.Enum<AuthenticationFailureReason>
-
- io.micronaut.security.authentication.AuthenticationFailureReason
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<AuthenticationFailureReason>
public enum AuthenticationFailureReason extends java.lang.Enum<AuthenticationFailureReason>
Enums describes the different authentication failures.- Since:
- 1.0
- Author:
- Sergio del Amo
-
-
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.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
All Methods Static Methods Concrete Methods Modifier and Type Method Description static AuthenticationFailureReason
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static AuthenticationFailureReason[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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.
-
-
Method Detail
-
values
public static AuthenticationFailureReason[] 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 (AuthenticationFailureReason c : AuthenticationFailureReason.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AuthenticationFailureReason 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 namejava.lang.NullPointerException
- if the argument is null
-
-