AuthKeyAuthenticationHandler.AuthKeyState (JCMS API)

java.lang.Object
- java.lang.Enum<AuthKeyAuthenticationHandler.AuthKeyState>
- - com.jalios.jcms.authentication.handlers.AuthKeyAuthenticationHandler.AuthKeyState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuthKeyAuthenticationHandler.AuthKeyState>

Enclosing class:

AuthKeyAuthenticationHandler
```
public static enum AuthKeyAuthenticationHandler.AuthKeyState
extends java.lang.Enum<AuthKeyAuthenticationHandler.AuthKeyState>
```
Possible AuthKey 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
`FAILED_INVALID_AUTHKEY` An authkey was received but is invalid.
`FAILED_INVALID_AUTHKEY_EXPIRED` An auth key was received but it was expired.
`FAILED_INVALID_AUTHKEY_INVALID_DIGEST` An auth key was received but its digest was invalid.
`FAILED_INVALID_AUTHKEY_INVALID_HTTP_METHOD` An 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_INVALID_AUTHKEY_INVALID_MEMBER` An auth key was received but its Member was invalid.
`LOGGED_WITH_AUTHKEY` An authkey was received and was used to set the loggedMember.
`SKIPPED_ALREADY_LOGGED` Member is already logged in current context, AuthKey was skipped for current request.
`SKIPPED_DISABLED` AuthKey is disabled and was skipped for current request.
`SKIPPED_NO_AUTHKEY` No authKey was received, AuthKey was skipped for current request.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isSet(AuthenticationContext ctxt)` Check if this state was set for the specified AuthenticationContext
`static AuthKeyAuthenticationHandler.AuthKeyState`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static AuthKeyAuthenticationHandler.AuthKeyState[]`	`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 AuthKeyAuthenticationHandler.AuthKeyState SKIPPED_DISABLED
```
    AuthKey is disabled and was skipped for current request.
  - SKIPPED_NO_AUTHKEY
```
public static final AuthKeyAuthenticationHandler.AuthKeyState SKIPPED_NO_AUTHKEY
```
    No authKey was received, AuthKey was skipped for current request.
  - SKIPPED_ALREADY_LOGGED
```
public static final AuthKeyAuthenticationHandler.AuthKeyState SKIPPED_ALREADY_LOGGED
```
    Member is already logged in current context, AuthKey was skipped for current request.
  - FAILED_INVALID_AUTHKEY
```
public static final AuthKeyAuthenticationHandler.AuthKeyState FAILED_INVALID_AUTHKEY
```
    An authkey was received but is invalid.
  - LOGGED_WITH_AUTHKEY
```
public static final AuthKeyAuthenticationHandler.AuthKeyState LOGGED_WITH_AUTHKEY
```
    An authkey was received and was used to set the loggedMember.
  - FAILED_INVALID_AUTHKEY_INVALID_MEMBER
```
public static final AuthKeyAuthenticationHandler.AuthKeyState FAILED_INVALID_AUTHKEY_INVALID_MEMBER
```
    An auth key was received but its Member was invalid.
  - FAILED_INVALID_AUTHKEY_INVALID_DIGEST
```
public static final AuthKeyAuthenticationHandler.AuthKeyState FAILED_INVALID_AUTHKEY_INVALID_DIGEST
```
    An auth key was received but its digest was invalid.
  - FAILED_INVALID_AUTHKEY_EXPIRED
```
public static final AuthKeyAuthenticationHandler.AuthKeyState 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_METHOD
```
    An auth key was received but it does not authorize the HTTP method that was used.
  - FAILED_INVALID_AUTHKEY_INVALID_IP
```
public static final AuthKeyAuthenticationHandler.AuthKeyState FAILED_INVALID_AUTHKEY_INVALID_IP
```
    An auth key was received but it cannot be used from the IP it was sent from.
- Method Detail
  - values
```
public static AuthKeyAuthenticationHandler.AuthKeyState[] 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 (AuthKeyAuthenticationHandler.AuthKeyState c : AuthKeyAuthenticationHandler.AuthKeyState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AuthKeyAuthenticationHandler.AuthKeyState 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

Enum AuthKeyAuthenticationHandler.AuthKeyState

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SKIPPED_DISABLED

SKIPPED_NO_AUTHKEY

SKIPPED_ALREADY_LOGGED

FAILED_INVALID_AUTHKEY

LOGGED_WITH_AUTHKEY

FAILED_INVALID_AUTHKEY_INVALID_MEMBER

FAILED_INVALID_AUTHKEY_INVALID_DIGEST

FAILED_INVALID_AUTHKEY_EXPIRED

FAILED_INVALID_AUTHKEY_INVALID_HTTP_METHOD

FAILED_INVALID_AUTHKEY_INVALID_IP

Method Detail

values

valueOf

isSet