com.authlete.common.dto

Enum BackchannelAuthenticationFailResponse.Action

java.lang.Object

java.lang.Enum<BackchannelAuthenticationFailResponse.Action>

com.authlete.common.dto.BackchannelAuthenticationFailResponse.Action

All Implemented Interfaces:

Serializable, Comparable<BackchannelAuthenticationFailResponse.Action>

Enclosing class:

BackchannelAuthenticationFailResponse

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

The next action that the OpenID provider implementation should take.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_REQUEST The implementation of the backchannel authentication endpoint should return a 400 Bad Request response to the client application.
FORBIDDEN The implementation of the backchannel authentication endpoint should return a 403 Forbidden response to the client application.
INTERNAL_SERVER_ERROR The implementation of the backchannel authentication endpoint should return a 500 Internal Server Error response to the client application.

Method Summary

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

The implementation of the backchannel authentication endpoint should return a 400 Bad Request response to the client application.

FORBIDDEN

public static final BackchannelAuthenticationFailResponse.Action FORBIDDEN

The implementation of the backchannel authentication endpoint should return a 403 Forbidden response to the client application.

BackchannelAuthenticationFailResponse.getAction() returns this value only when the reason request parameter of the API call was ACCESS_DENIED.

INTERNAL_SERVER_ERROR

public static final BackchannelAuthenticationFailResponse.Action INTERNAL_SERVER_ERROR

The implementation of the backchannel authentication endpoint should return a 500 Internal Server Error response to the client application. However, in most cases, commercial implementations prefer to use other HTTP status code than 5xx.

BackchannelAuthenticationFailResponse.getAction() returns this value when (1) the reason request parameter of the API call was SERVER_ERROR, (2) an error occurred on Authlete side, or (3) the request parameters of the API call were wrong.

Method Detail

values

public static BackchannelAuthenticationFailResponse.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 (BackchannelAuthenticationFailResponse.Action c : BackchannelAuthenticationFailResponse.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 BackchannelAuthenticationFailResponse.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