com.jalios.jcms.authentication.handlers

Enum DelegationAuthenticationHandler.DelegationAuthState

java.lang.Object

java.lang.Enum<DelegationAuthenticationHandler.DelegationAuthState>

com.jalios.jcms.authentication.handlers.DelegationAuthenticationHandler.DelegationAuthState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DelegationAuthenticationHandler.DelegationAuthState>

Enclosing class:

DelegationAuthenticationHandler

public static enum DelegationAuthenticationHandler.DelegationAuthState
extends java.lang.Enum<DelegationAuthenticationHandler.DelegationAuthState>

Possible Delegation Auth state after handler invocation. AuthenticationContext may cumulate several states.

Since:

jcms-10.0.5 / JCMS-7956

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELEGATION_LOGBACK Delegation was used to logout to a previously authenticated user in the session.
DELEGATION_LOGIN Delegation was used to login to a new user in the session.
FAILED_CSRF Delegation failed because CSRF token was missing or was invalid.
FAILED_INVALID_SULOGIN_PARAM Delegation failed because specified credential are invalid.
FAILED_UNAUTHORIZED Delegation failed because specified currently logged member is not authorized to delegate as specified target member.
LOGGED_WITH_DELEGATION Delegation was used to set the loggedMember.
SKIPPED_DISABLED Delegation is disabled and was skipped for current request.
SKIPPED_NO_SULOGIN_PARAM Delegation was skipped as no parameter was specified.
SKIPPED_NOT_LOGGED Delegation was skipped as Member is not logged in current context, delegation require an currently logged member.

Method Summary

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

Delegation is disabled and was skipped for current request.

SKIPPED_NO_SULOGIN_PARAM

public static final DelegationAuthenticationHandler.DelegationAuthState SKIPPED_NO_SULOGIN_PARAM

Delegation was skipped as no parameter was specified.

SKIPPED_NOT_LOGGED

public static final DelegationAuthenticationHandler.DelegationAuthState SKIPPED_NOT_LOGGED

Delegation was skipped as Member is not logged in current context, delegation require an currently logged member.

FAILED_INVALID_SULOGIN_PARAM

public static final DelegationAuthenticationHandler.DelegationAuthState FAILED_INVALID_SULOGIN_PARAM

Delegation failed because specified credential are invalid.

FAILED_UNAUTHORIZED

public static final DelegationAuthenticationHandler.DelegationAuthState FAILED_UNAUTHORIZED

Delegation failed because specified currently logged member is not authorized to delegate as specified target member.

FAILED_CSRF

public static final DelegationAuthenticationHandler.DelegationAuthState FAILED_CSRF

Delegation failed because CSRF token was missing or was invalid.

LOGGED_WITH_DELEGATION

public static final DelegationAuthenticationHandler.DelegationAuthState LOGGED_WITH_DELEGATION

Delegation was used to set the loggedMember.

DELEGATION_LOGIN

public static final DelegationAuthenticationHandler.DelegationAuthState DELEGATION_LOGIN

Delegation was used to login to a new user in the session.

DELEGATION_LOGBACK

public static final DelegationAuthenticationHandler.DelegationAuthState DELEGATION_LOGBACK

Delegation was used to logout to a previously authenticated user in the session.

Method Detail

values

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

Returns:

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

valueOf

public static DelegationAuthenticationHandler.DelegationAuthState 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