com.authlete.common.dto

Enum BackchannelAuthenticationResponse.Action

java.lang.Object

java.lang.Enum<BackchannelAuthenticationResponse.Action>

com.authlete.common.dto.BackchannelAuthenticationResponse.Action

All Implemented Interfaces:

Serializable, Comparable<BackchannelAuthenticationResponse.Action>

Enclosing class:

BackchannelAuthenticationResponse

public static enum BackchannelAuthenticationResponse.Action
extends Enum<BackchannelAuthenticationResponse.Action>

The next action that the OpenID provider implementation should take.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_REQUEST The backchannel authentication request is invalid.
INTERNAL_SERVER_ERROR The API call from the authorization server implementation was wrong or an error occurred on Authlete side.
UNAUTHORIZED Client authentication of the backchannel authentication request failed.
USER_IDENTIFICATION The backchannel authentication request was valid.

Method Summary

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

BAD_REQUEST

public static final BackchannelAuthenticationResponse.Action BAD_REQUEST

The backchannel authentication request is invalid. The authorization server implementation should return an error response with 400 Bad Request and application/json to the client application.

UNAUTHORIZED

public static final BackchannelAuthenticationResponse.Action UNAUTHORIZED

Client authentication of the backchannel authentication request failed. The authorization server implementation should return an error response with 401 Unauthorized and application/json to the client application.

INTERNAL_SERVER_ERROR

public static final BackchannelAuthenticationResponse.Action INTERNAL_SERVER_ERROR

The API call from the authorization server implementation was wrong or an error occurred on Authlete side. The authorization server implementation should return an error response with 500 Internal Server Error and application/json to the client application.

USER_IDENTIFICATION

public static final BackchannelAuthenticationResponse.Action USER_IDENTIFICATION

The backchannel authentication request was valid. The authorization server implementation is required to (1) identify the subject of the end-user from the given hint, (2) issue auth_req_id to the client application, (3) communicate with an authentication device of the end-user to perform end-user authentication and authorization, etc. See the API document of BackchannelAuthenticationResponse for details.

Method Detail

values

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

Returns:

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

valueOf

public static BackchannelAuthenticationResponse.Action 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