Package com.jalios.jcms.authentication.handlers

Enum CookieAuthenticationHandler.CookieAuthState

java.lang.Object

java.lang.Enum<CookieAuthenticationHandler.CookieAuthState>

com.jalios.jcms.authentication.handlers.CookieAuthenticationHandler.CookieAuthState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CookieAuthenticationHandler.CookieAuthState>

Enclosing class:

CookieAuthenticationHandler

public static enum CookieAuthenticationHandler.CookieAuthState
extends java.lang.Enum<CookieAuthenticationHandler.CookieAuthState>

Possible Cookie authentication state after handler invocation. AuthenticationContext may cumulate several states.

Since:

jcms-10.0.5 / JCMS-7956

Enum Constant Summary

Enum Constants

Enum Constant	Description
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_EXPIRED	A cookie was receive but it has expired.
FAILED_COOKIE_INVALID_DIGEST	A cookie was receive but its digest was invalid.
FAILED_COOKIE_NOT_IN_DB	A cookie was receive but could not be found in database.
LOGGED_WITH_COOKIE	A valid cookie was use to set the logged member.
NEW_COOKIE_ADDED	A new authentication cookie was sent to user.
NEW_COOKIE_FAILED	A new authentication cookie could not be sent.
SKIPPED_ALREADY_LOGGED	Member is already logged in current context, Cookie authentication auth was skipped for current request.
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.

Method Summary

Modifier and Type	Method	Description
boolean	isSet(AuthenticationContext ctxt)	Check if this state was set for the specified AuthenticationContext
static CookieAuthenticationHandler.CookieAuthState	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static CookieAuthenticationHandler.CookieAuthState[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SKIPPED_DISABLED

public static final CookieAuthenticationHandler.CookieAuthState SKIPPED_DISABLED

CookieAuthentication is disabled and was skipped for current request.

SKIPPED_NO_COOKIE

public static final CookieAuthenticationHandler.CookieAuthState SKIPPED_NO_COOKIE

No memberId cookie was received, Cookie authentication was skipped for current request.

SKIPPED_ALREADY_LOGGED

public static final CookieAuthenticationHandler.CookieAuthState SKIPPED_ALREADY_LOGGED

Member is already logged in current context, Cookie authentication auth was skipped for current request.

COOKIE_CHECK_FAILED

public static final CookieAuthenticationHandler.CookieAuthState COOKIE_CHECK_FAILED

A cookie had been sent and was supposed to be verified but it could not.

COOKIE_CHECK_SUCCESS

public static final CookieAuthenticationHandler.CookieAuthState COOKIE_CHECK_SUCCESS

A cookie has been sent and was verified.

FAILED_COOKIE_INVALID_DIGEST

public static final CookieAuthenticationHandler.CookieAuthState 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

public static final CookieAuthenticationHandler.CookieAuthState 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

public static final CookieAuthenticationHandler.CookieAuthState 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

public static final CookieAuthenticationHandler.CookieAuthState 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

public static final CookieAuthenticationHandler.CookieAuthState NEW_COOKIE_ADDED

A new authentication cookie was sent to user.

NEW_COOKIE_FAILED

public static final CookieAuthenticationHandler.CookieAuthState NEW_COOKIE_FAILED

A new authentication cookie could not be sent.

Method Detail

values

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

Returns:

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

valueOf

public static CookieAuthenticationHandler.CookieAuthState 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 name

java.lang.NullPointerException - if the argument is null

isSet

public boolean isSet(AuthenticationContext ctxt)

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