Package com.jalios.jcms.authentication.handlers

Enum SimpleAuthenticationHandler.SimpleAuthState

java.lang.Object

java.lang.Enum<SimpleAuthenticationHandler.SimpleAuthState>

com.jalios.jcms.authentication.handlers.SimpleAuthenticationHandler.SimpleAuthState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimpleAuthenticationHandler.SimpleAuthState>

Enclosing class:

SimpleAuthenticationHandler

public static enum SimpleAuthenticationHandler.SimpleAuthState
extends java.lang.Enum<SimpleAuthenticationHandler.SimpleAuthState>

Possible SimpleAuth state after handler invocation. AuthenticationContext may cumulate several states.

Since:

jcms-10.0.5 / JCMS-7956

Enum Constant Summary

Enum Constants

Enum Constant	Description
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.
SKIPPED_ALREADY_LOGGED	Member is already logged in current context, SimpleAuth was skipped for current request.
SKIPPED_DISABLED	SimpleAuth is disabled and was skipped for current request.
SKIPPED_NO_CREDENTIALS	SimpleAuth was skipped as no credential were specified.

Method Summary

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

SimpleAuth is disabled and was skipped for current request.

SKIPPED_NO_CREDENTIALS

public static final SimpleAuthenticationHandler.SimpleAuthState SKIPPED_NO_CREDENTIALS

SimpleAuth was skipped as no credential were specified.

SKIPPED_ALREADY_LOGGED

public static final SimpleAuthenticationHandler.SimpleAuthState SKIPPED_ALREADY_LOGGED

Member is already logged in current context, SimpleAuth was skipped for current request.

FAILED_CSRF

public static final SimpleAuthenticationHandler.SimpleAuthState FAILED_CSRF

SimpleAuth failed because CSRF token was missing or was invalid.

FAILED_INVALID_CREDENTIALS

public static final SimpleAuthenticationHandler.SimpleAuthState FAILED_INVALID_CREDENTIALS

SimpleAuth failed because specified credential are invalid.

LOGGED_WITH_SIMPLE_AUTH

public static final SimpleAuthenticationHandler.SimpleAuthState LOGGED_WITH_SIMPLE_AUTH

Credentials were specified and were used to set the loggedMember.

REDIRECT

public static final SimpleAuthenticationHandler.SimpleAuthState REDIRECT

A redirection was performed following change of logged member.

Method Detail

values

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

Returns:

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

valueOf

public static SimpleAuthenticationHandler.SimpleAuthState 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