com.authlete.common.dto

Enum BackchannelAuthenticationCompleteRequest.Result

java.lang.Object

java.lang.Enum<BackchannelAuthenticationCompleteRequest.Result>

com.authlete.common.dto.BackchannelAuthenticationCompleteRequest.Result

All Implemented Interfaces:

Serializable, Comparable<BackchannelAuthenticationCompleteRequest.Result>

Enclosing class:

BackchannelAuthenticationCompleteRequest

public static enum BackchannelAuthenticationCompleteRequest.Result
extends Enum<BackchannelAuthenticationCompleteRequest.Result>

Types of results of end-user authentication and authorization.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_DENIED The end-user denied the backchannel authentication request.
AUTHORIZED The end-user was authenticated and has granted authorization to the client application.
TRANSACTION_FAILED The authorization server could not get the result of end-user authentication and authorization from the authentication device for some reasons.

Method Summary

Modifier and Type	Method and Description
static BackchannelAuthenticationCompleteRequest.Result	getByValue(short value) Find an instance of this enum by a value.
short	getValue() Get the integer representation of this enum instance.
static BackchannelAuthenticationCompleteRequest.Result	valueOf(String name) Returns the enum constant of this type with the specified name.
static BackchannelAuthenticationCompleteRequest.Result[]	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

AUTHORIZED

public static final BackchannelAuthenticationCompleteRequest.Result AUTHORIZED

The end-user was authenticated and has granted authorization to the client application.

ACCESS_DENIED

public static final BackchannelAuthenticationCompleteRequest.Result ACCESS_DENIED

The end-user denied the backchannel authentication request.

TRANSACTION_FAILED

public static final BackchannelAuthenticationCompleteRequest.Result TRANSACTION_FAILED

The authorization server could not get the result of end-user authentication and authorization from the authentication device for some reasons.

For example, the authorization server failed to communicate with the authentication device due to a network error, the device did not return a response within a reasonable time, etc.

This result can be used as a generic error.

Since:

2.36

Method Detail

values

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

Returns:

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

valueOf

public static BackchannelAuthenticationCompleteRequest.Result 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

getValue

public short getValue()

Get the integer representation of this enum instance.

getByValue

public static BackchannelAuthenticationCompleteRequest.Result getByValue(short value)

Find an instance of this enum by a value.

Parameters:

value - The integer representation of the instance to find.

Returns:

An instance of this enum, or null if not found.