com.authlete.common.dto

Enum UserInfoResponse.Action

java.lang.Object

java.lang.Enum<UserInfoResponse.Action>

com.authlete.common.dto.UserInfoResponse.Action

All Implemented Interfaces:

Serializable, Comparable<UserInfoResponse.Action>

Enclosing class:

UserInfoResponse

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

The next action the service implementation should take.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_REQUEST The request does not contain an access token.
FORBIDDEN The access token does not cover the required scopes.
INTERNAL_SERVER_ERROR The request from the service implementation was wrong or an error occurred in Authlete.
OK The access token is valid.
UNAUTHORIZED The access token does not exist or has expired.

Method Summary

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

INTERNAL_SERVER_ERROR

public static final UserInfoResponse.Action INTERNAL_SERVER_ERROR

The request from the service implementation was wrong or an error occurred in Authlete. The service implementation should return "500 Internal Server Error" to the client application.

BAD_REQUEST

public static final UserInfoResponse.Action BAD_REQUEST

The request does not contain an access token. The service implementation should return "400 Bad Request" to the client application.

UNAUTHORIZED

public static final UserInfoResponse.Action UNAUTHORIZED

The access token does not exist or has expired. The service implementation should return "401 Unauthorized" to the client application.

FORBIDDEN

public static final UserInfoResponse.Action FORBIDDEN

The access token does not cover the required scopes. To be concrete, the access token does not include the "openid" scope. The service implementation should return "403 Forbidden" to the client application.

OK

public static final UserInfoResponse.Action OK

The access token is valid. The service implementation should collect information about requested claims and pass the information to Authlete's /auth/userinfo/issue endpoint in order to make Authlete generate an ID token.

Method Detail

values

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