Enum Class AuthKeyAuthenticationHandler.AuthKeyState
java.lang.Object
java.lang.Enum<AuthKeyAuthenticationHandler.AuthKeyState>
com.jalios.jcms.authentication.handlers.AuthKeyAuthenticationHandler.AuthKeyState
- All Implemented Interfaces:
Serializable,Comparable<AuthKeyAuthenticationHandler.AuthKeyState>,Constable
- Enclosing class:
AuthKeyAuthenticationHandler
public static enum AuthKeyAuthenticationHandler.AuthKeyState
extends Enum<AuthKeyAuthenticationHandler.AuthKeyState>
Possible AuthKey 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 ConstantDescriptionAn auth key was received but it could not be found in database.An authkey was received but is invalid.An auth key was received but it was expired.An auth key was received but its digest was invalid.An auth key was received but it does not authorize the HTTP method that was used.An auth key was received but it cannot be used from the IP it was sent from.An auth key was received but its Member was invalid.An authkey was received and was used to set the loggedMember.Member is already logged in current context, AuthKey was skipped for current request.AuthKey is disabled and was skipped for current request.No authKey was received, AuthKey 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
AuthKey is disabled and was skipped for current request. -
SKIPPED_NO_AUTHKEY
No authKey was received, AuthKey was skipped for current request. -
SKIPPED_ALREADY_LOGGED
Member is already logged in current context, AuthKey was skipped for current request. -
FAILED_INVALID_AUTHKEY
An authkey was received but is invalid. -
LOGGED_WITH_AUTHKEY
An authkey was received and was used to set the loggedMember. -
FAILED_INVALID_AUTHKEY_INVALID_MEMBER
An auth key was received but its Member was invalid. -
FAILED_INVALID_AUTHKEY_INVALID_DIGEST
An auth key was received but its digest was invalid. -
FAILED_INVALID_AUTHKEY_EXPIRED
An auth key was received but it was expired. -
FAILED_INVALID_AUTHKEY_INVALID_HTTP_METHOD
public static final AuthKeyAuthenticationHandler.AuthKeyState FAILED_INVALID_AUTHKEY_INVALID_HTTP_METHODAn auth key was received but it does not authorize the HTTP method that was used. -
FAILED_INVALID_AUTHKEY_INVALID_IP
An auth key was received but it cannot be used from the IP it was sent from. -
FAILED_AUTHKEY_NOT_IN_DB
An auth key was received but it could not be found in database.- Since:
- 10.0.8 / JCMS-4770
-
-
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
-