com.authlete.common.dto

Enum AuthorizationFailRequest.Reason

java.lang.Object

java.lang.Enum<AuthorizationFailRequest.Reason>

com.authlete.common.dto.AuthorizationFailRequest.Reason

All Implemented Interfaces:

Serializable, Comparable<AuthorizationFailRequest.Reason>

Enclosing class:

AuthorizationFailRequest

public static enum AuthorizationFailRequest.Reason
extends Enum<AuthorizationFailRequest.Reason>

Failure reasons of authorization requests.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACR_NOT_SATISFIED The authorization request from the client application contained "acr" claim in "claims" request parameter and the claim was marked as essential, but the ACR performed for the end-user does not match any one of the requested ACRs.
DENIED The end-user denied the authorization request from the client application.
DIFFERENT_SUBJECT The authorization request from the client application requested a specific value for sub claim, but the current end-user (in the case of prompt=none) or the end-user after the authentication is different from the specified value.
EXCEEDS_MAX_AGE The authorization request from the client application contained prompt=none, but the time specified by max_age request parameter or by default_max_age configuration parameter has passed since the time at which the end-user logged in.
MAX_AGE_NOT_SUPPORTED The authorization request from the client application contained max_age parameter with a non-zero value or the client's configuration has a non-zero value for default_max_age configuration parameter, but the service implementation cannot behave properly based on the max age value mainly because the service implementation does not manage authentication time of end-users.
NOT_AUTHENTICATED The end-user was not authenticated.
NOT_LOGGED_IN The authorization request from the client application contained prompt=none, but any end-user has not logged in.
SERVER_ERROR Server error.
UNKNOWN Unknown reason.

Method Summary

Modifier and Type	Method and Description
static AuthorizationFailRequest.Reason	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthorizationFailRequest.Reason[]	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

UNKNOWN

public static final AuthorizationFailRequest.Reason UNKNOWN

Unknown reason.

NOT_LOGGED_IN

public static final AuthorizationFailRequest.Reason NOT_LOGGED_IN

The authorization request from the client application contained prompt=none, but any end-user has not logged in.

See "OpenID Connect Core 1.0, 3.1.2.1. Authentication Request" for prompt request parameter.

See Also:

OpenID Connect Core 1.0, 3.1.2.1. Authentication Request

MAX_AGE_NOT_SUPPORTED

public static final AuthorizationFailRequest.Reason MAX_AGE_NOT_SUPPORTED

The authorization request from the client application contained max_age parameter with a non-zero value or the client's configuration has a non-zero value for default_max_age configuration parameter, but the service implementation cannot behave properly based on the max age value mainly because the service implementation does not manage authentication time of end-users.

See "OpenID Connect Core 1.0, 3.1.2.1. Authentication Request" for prompt request parameter.

See "OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata" for default_max_age configuration parameter.

See Also:

OpenID Connect Core 1.0, 3.1.2.1. Authentication Request, OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata

EXCEEDS_MAX_AGE

public static final AuthorizationFailRequest.Reason EXCEEDS_MAX_AGE

The authorization request from the client application contained prompt=none, but the time specified by max_age request parameter or by default_max_age configuration parameter has passed since the time at which the end-user logged in.

See "OpenID Connect Core 1.0, 3.1.2.1. Authentication Request" for prompt and max_age request parameters.

See "OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata" for default_max_age configuration parameter.

See Also:

OpenID Connect Core 1.0, 3.1.2.1. Authentication Request, OpenID Connect Dynamic Client Registration 1.0, 2. Client Metadata

DIFFERENT_SUBJECT

public static final AuthorizationFailRequest.Reason DIFFERENT_SUBJECT

The authorization request from the client application requested a specific value for sub claim, but the current end-user (in the case of prompt=none) or the end-user after the authentication is different from the specified value.

ACR_NOT_SATISFIED

public static final AuthorizationFailRequest.Reason ACR_NOT_SATISFIED

The authorization request from the client application contained "acr" claim in "claims" request parameter and the claim was marked as essential, but the ACR performed for the end-user does not match any one of the requested ACRs.

DENIED

public static final AuthorizationFailRequest.Reason DENIED

The end-user denied the authorization request from the client application.

SERVER_ERROR

public static final AuthorizationFailRequest.Reason SERVER_ERROR

Server error.

Since:

1.3

NOT_AUTHENTICATED

public static final AuthorizationFailRequest.Reason NOT_AUTHENTICATED

The end-user was not authenticated.

Since:

1.3

Method Detail

values

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

Returns:

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

valueOf

public static AuthorizationFailRequest.Reason valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null