Package com.authlete.common.dto

Enum BackchannelAuthenticationCompleteResponse.Action

java.lang.Object

java.lang.Enum<BackchannelAuthenticationCompleteResponse.Action>

com.authlete.common.dto.BackchannelAuthenticationCompleteResponse.Action

All Implemented Interfaces:

Serializable, Comparable<BackchannelAuthenticationCompleteResponse.Action>

Enclosing class:

BackchannelAuthenticationCompleteResponse

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

The next action that the OpenID provider implementation should take.

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_ACTION	The OpenID provider implementation does not have to take any immediate action for this API response.
NOTIFICATION	The OpenID provider implementation must send a notification to the client's notification endpoint.
SERVER_ERROR	An error occurred either because the ticket included in the API call was invalid or because an error occurred on Authlete side.

Method Summary

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

NOTIFICATION

public static final BackchannelAuthenticationCompleteResponse.Action NOTIFICATION

The OpenID provider implementation must send a notification to the client's notification endpoint. This action code is returned when the backchannel token delivery mode is "ping" or "push".

NO_ACTION

public static final BackchannelAuthenticationCompleteResponse.Action NO_ACTION

The OpenID provider implementation does not have to take any immediate action for this API response. The remaining task is just to handle polling requests from the client to the token endpoint. This action code is returned when the backchannel token delivery mode is "poll".

SERVER_ERROR

public static final BackchannelAuthenticationCompleteResponse.Action SERVER_ERROR

An error occurred either because the ticket included in the API call was invalid or because an error occurred on Authlete side.

If an error occurred after Authlete succeeded in retrieving data associated with the ticket from the database and if the backchannel token delivery mode is "ping" or "push", NOTIFICATION is used as the value of action instead of SERVER_ERROR. In the case, responseContent contains "error":"server_error".

Method Detail

values

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