com.authlete.common.dto

Class DeviceCompleteResponse

java.lang.Object

com.authlete.common.dto.ApiResponse

com.authlete.common.dto.DeviceCompleteResponse

All Implemented Interfaces:

Serializable

public class DeviceCompleteResponse
extends ApiResponse

Response from Authlete's /api/device/complete API.

Authlete's /api/device/complete API returns JSON which can be mapped to this class. The authorization server implementation should retrieve the value of action from the response and take the following steps according to the value.

SUCCESS

When the value of action is SUCCESS, it means that the API call has been processed successfully. The authorization server should return a successful response to the web browser the end-user is using.

INVALID_REQUEST

When the value of action is INVALID_REQUEST, it means that the API call is invalid. Probably, the authorization server implementation has some bugs.

USER_CODE_EXPIRED

When the value of action is USER_CODE_EXPIRED, it means that the user code included in the API call 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.

USER_CODE_NOT_EXIST

When the value of action is USER_CODE_NOT_EXIST, it means that the user code included in the API call does not exist. The authorization server implementation should tell the end-user that the user code has been invalidated and urge her to re-initiate a device flow.

SERVER_ERROR

When the value of action is SERVER_ERROR, it means that 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.

Since:

2.42

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeviceCompleteResponse.Action The next action that the authorization server implementation should take.

Constructor Summary

Constructors

Constructor and Description
DeviceCompleteResponse()

Method Summary

Modifier and Type	Method and Description
DeviceCompleteResponse.Action	getAction() Get the next action that the authorization server implementation should take.
DeviceCompleteResponse	setAction(DeviceCompleteResponse.Action action) Set the next action that the authorization server implementation should take.

Methods inherited from class com.authlete.common.dto.ApiResponse

getResultCode, getResultMessage, setResultCode, setResultMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeviceCompleteResponse

public DeviceCompleteResponse()

Method Detail

getAction

public DeviceCompleteResponse.Action getAction()

Get the next action that the authorization server implementation should take.

Returns:

The next action.

setAction

public DeviceCompleteResponse setAction(DeviceCompleteResponse.Action action)

Set the next action that the authorization server implementation should take.

Parameters:

action - The next action.

Returns:

this object.