Enum Class CookieAuthenticationHandler.CookieAuthState
java.lang.Object
java.lang.Enum<CookieAuthenticationHandler.CookieAuthState>
com.jalios.jcms.authentication.handlers.CookieAuthenticationHandler.CookieAuthState
- All Implemented Interfaces:
Serializable,Comparable<CookieAuthenticationHandler.CookieAuthState>,Constable
- Enclosing class:
CookieAuthenticationHandler
public static enum CookieAuthenticationHandler.CookieAuthState
extends Enum<CookieAuthenticationHandler.CookieAuthState>
Possible Cookie authentication 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 ConstantDescriptionA cookie had been sent and was supposed to be verified but it could not.A cookie has been sent and was verified.A cookie was receive but it has expired.A cookie was receive but its digest was invalid.A cookie was receive but could not be found in database.A valid cookie was use to set the logged member.A new authentication cookie was sent to user.A new authentication cookie could not be sent.Member is already logged in current context, Cookie authentication auth was skipped for current request.CookieAuthentication is disabled and was skipped for current request.No memberId cookie was received, Cookie authentication was skipped for current request. -
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
CookieAuthentication is disabled and was skipped for current request. -
SKIPPED_NO_COOKIE
No memberId cookie was received, Cookie authentication was skipped for current request. -
SKIPPED_ALREADY_LOGGED
Member is already logged in current context, Cookie authentication auth was skipped for current request. -
COOKIE_CHECK_FAILED
A cookie had been sent and was supposed to be verified but it could not. -
COOKIE_CHECK_SUCCESS
A cookie has been sent and was verified. -
FAILED_COOKIE_INVALID_DIGEST
A cookie was receive but its digest was invalid. Note : because several memberId cookie can be received this state may be set with a valid cookie state. -
FAILED_COOKIE_EXPIRED
A cookie was receive but it has expired. Note : because several memberId cookie can be received this state may be set with a valid cookie state. -
FAILED_COOKIE_NOT_IN_DB
A cookie was receive but could not be found in database. Note : because several memberId cookie can be received this state may be set with a valid cookie state. -
LOGGED_WITH_COOKIE
A valid cookie was use to set the logged member. Note : because several memberId cookie can be received this state may be set with a invalid cookie state. -
NEW_COOKIE_ADDED
A new authentication cookie was sent to user. -
NEW_COOKIE_FAILED
A new authentication cookie could not be sent.
-
-
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
-