Package com.authlete.common.dto

Enum DeviceVerificationResponse.Action

java.lang.Object

java.lang.Enum<DeviceVerificationResponse.Action>

com.authlete.common.dto.DeviceVerificationResponse.Action

All Implemented Interfaces:

Serializable, Comparable<DeviceVerificationResponse.Action>

Enclosing class:

DeviceVerificationResponse

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

The next action that the authorization server implementation should take.

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXPIRED	The user code has expired.
NOT_EXIST	The user code does not exist.
SERVER_ERROR	An error occurred on Authlete side.
VALID	The user code is valid.

Method Summary

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

VALID

public static final DeviceVerificationResponse.Action VALID

The user code is valid. This means that the user code exists, has not expired, and belongs to the service. The authorization server implementation should interact with the end-user to ask whether she approves or rejects the authorization request from the device.

EXPIRED

public static final DeviceVerificationResponse.Action EXPIRED

The user code has expired. The authorization server implementation should tell the end-user that the user code has expired and urge her to re-initiate a device flow.

NOT_EXIST

public static final DeviceVerificationResponse.Action NOT_EXIST

The user code does not exist. The authorization server implementation should tell the end-user that the user code is invalid and urge her to retry to input a valid user code.

SERVER_ERROR

public static final DeviceVerificationResponse.Action SERVER_ERROR

An error occurred on Authlete side. The authorization server implementation should tell the end-user that something wrong happened and urge her to re-initiate a device flow.

Method Detail

values

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