Enum Class SimpleAuthenticationHandler.SimpleAuthState
java.lang.Object
java.lang.Enum<SimpleAuthenticationHandler.SimpleAuthState>
com.jalios.jcms.authentication.handlers.SimpleAuthenticationHandler.SimpleAuthState
- All Implemented Interfaces:
Serializable,Comparable<SimpleAuthenticationHandler.SimpleAuthState>,Constable
- Enclosing class:
SimpleAuthenticationHandler
public static enum SimpleAuthenticationHandler.SimpleAuthState
extends Enum<SimpleAuthenticationHandler.SimpleAuthState>
Possible SimpleAuth state after handler invocation.
AuthenticationContext may cumulate several states.
- Since:
- jcms-10.0.5 / JCMS-7956
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionSimpleAuth failed because CSRF token was missing or was invalid.SimpleAuth failed because specified credential are invalid.Credentials were specified and were used to set the loggedMember.A redirection was performed following change of logged member.Member is already logged in current context, SimpleAuth was skipped for current request.SimpleAuth is disabled and was skipped for current request.SimpleAuth was skipped as no credential were specified. -
Method Summary
Modifier and TypeMethodDescriptionbooleanisSet(AuthenticationContext ctxt) Check if this state was set for the specified AuthenticationContextReturns the enum constant of this class with the specified name.values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SKIPPED_DISABLED
SimpleAuth is disabled and was skipped for current request. -
SKIPPED_NO_CREDENTIALS
SimpleAuth was skipped as no credential were specified. -
SKIPPED_ALREADY_LOGGED
Member is already logged in current context, SimpleAuth was skipped for current request. -
FAILED_CSRF
SimpleAuth failed because CSRF token was missing or was invalid. -
FAILED_INVALID_CREDENTIALS
SimpleAuth failed because specified credential are invalid. -
LOGGED_WITH_SIMPLE_AUTH
Credentials were specified and were used to set the loggedMember. -
REDIRECT
A redirection was performed following change of logged member.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
isSet
Check if this state was set for the specified AuthenticationContext- Parameters:
ctxt- the AuthenticationContext in which to check state- Returns:
- true if state was encountered, false otherwise
-