com.authlete.common.dto

Class DeviceVerificationResponse

java.lang.Object

com.authlete.common.dto.ApiResponse

com.authlete.common.dto.DeviceVerificationResponse

All Implemented Interfaces:

Serializable

public class DeviceVerificationResponse
extends ApiResponse

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

Authlete's /api/device/verification 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.

VALID

When the value of action is VALID, it 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

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

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

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	DeviceVerificationResponse.Action The next action that the authorization server implementation should take.

Constructor Summary

Constructors

Constructor and Description
DeviceVerificationResponse()

Method Summary

Modifier and Type	Method and Description
String[]	getAcrs() Get the list of ACR values requested by the device authorization request.
DeviceVerificationResponse.Action	getAction() Get the next action that the authorization server should take.
String[]	getClaimNames() Get the names of the claims which were requested indirectly via some special scopes.
long	getClientId() Get the client ID of the client application to which the user code has been issued.
String	getClientIdAlias() Get the client ID alias of the client application to which the user code has been issued.
String	getClientIdentifier() Get the client identifier used in the device authorization request for the user code.
String	getClientName() Get the name of the client application to which the user code has been issued.
long	getExpiresAt() Get the date in milliseconds since the Unix epoch (1970-01-01) at which the user code will expire.
Scope[]	getScopes() Get the scopes requested by the device authorization request for the user code.
boolean	isClientIdAliasUsed() Get the flag which indicates whether the client ID alias was used in the device authorization request for the user code.
DeviceVerificationResponse	setAcrs(String[] acrs) Set the list of ACR values requested by the device authorization request.
DeviceVerificationResponse	setAction(DeviceVerificationResponse.Action action) Set the next action that the authorization server should take.
DeviceVerificationResponse	setClaimNames(String[] names) Set the names of the claims which were requested indirectly via some special scopes.
DeviceVerificationResponse	setClientId(long clientId) Set the client ID of the client application to which the user code has been issued.
DeviceVerificationResponse	setClientIdAlias(String alias) Set the client ID alias of the client application to which the user code has been issued.
DeviceVerificationResponse	setClientIdAliasUsed(boolean used) Set the flag which indicates whether the client ID alias was used in the device authorization request for the user code.
DeviceVerificationResponse	setClientName(String name) Set the name of the client application to which the user code has been issued.
DeviceVerificationResponse	setExpiresAt(long expiresAt) Set the date in milliseconds since the Unix epoch (1970-01-01) at which the user code will expire.
DeviceVerificationResponse	setScopes(Scope[] scopes) Set the scopes requested by the device authorization request for the user code.

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

DeviceVerificationResponse

public DeviceVerificationResponse()

Method Detail

getAction

public DeviceVerificationResponse.Action getAction()

Get the next action that the authorization server should take.

Returns:

The next action.

setAction

public DeviceVerificationResponse setAction(DeviceVerificationResponse.Action action)

Set the next action that the authorization server should take.

Parameters:

action - The next action.

Returns:

this object.

getClientId

public long getClientId()

Get the client ID of the client application to which the user code has been issued.

Returns:

The client ID of the client application.

setClientId

public DeviceVerificationResponse setClientId(long clientId)

Set the client ID of the client application to which the user code has been issued.

Parameters:

clientId - The client ID of the client application.

Returns:

this object.

getClientIdAlias

public String getClientIdAlias()

Get the client ID alias of the client application to which the user code has been issued.

Returns:

The client ID alias of the client application.

setClientIdAlias

public DeviceVerificationResponse setClientIdAlias(String alias)

Set the client ID alias of the client application to which the user code has been issued.

Parameters:

alias - The client ID alias of the client application.

Returns:

this object.

isClientIdAliasUsed

public boolean isClientIdAliasUsed()

Get the flag which indicates whether the client ID alias was used in the device authorization request for the user code.

Returns:

true if the client ID alias was used in the request.

setClientIdAliasUsed

public DeviceVerificationResponse setClientIdAliasUsed(boolean used)

Set the flag which indicates whether the client ID alias was used in the device authorization request for the user code.

Parameters:

used - true to indicate that the client ID alias was used in the request.

Returns:

this object.

getClientIdentifier

public String getClientIdentifier()

Get the client identifier used in the device authorization request for the user code.

When isClientIdAliasUsed() returns true, this method returns the same value as getClientIdAlias() does. Otherwise, this method returns the string representation of the value returned from getClientId().

Returns:

The client identifier used in the device authorization request for the user code.

getClientName

public String getClientName()

Get the name of the client application to which the user code has been issued.

Returns:

The name of the client application.

setClientName

public DeviceVerificationResponse setClientName(String name)

Set the name of the client application to which the user code has been issued.

Parameters:

name - The name of the client application.

Returns:

this object.

getScopes

public Scope[] getScopes()

Get the scopes requested by the device authorization request for the user code.

Note that Scope.getDescription() method and Scope.getDescriptions() method of each element (Scope instance) in the array returned from this method always return null even if descriptions of the scopes are registered.

Returns:

The requested scopes.

setScopes

public DeviceVerificationResponse setScopes(Scope[] scopes)

Set the scopes requested by the device authorization request for the user code.

Parameters:

scopes - The requested scopes.

Returns:

this object.

getClaimNames

public String[] getClaimNames()

Get the names of the claims which were requested indirectly via some special scopes. See 5.4. Requesting Claims using Scope Values in OpenID Connect Core 1.0 for details.

This method always returns null if the scope request parameter of the device authorization request does not include the openid scope even if special scopes (such as profile) are included in the request (unless the openid scope is included in the default set of scopes which is used when the scope request parameter is omitted).

Returns:

The names of the requested claims.

Since:

2.44

setClaimNames

public DeviceVerificationResponse setClaimNames(String[] names)

Set the names of the claims which were requested indirectly via some special scopes.

Parameters:

names - The names of the requested claims.

Returns:

this object.

Since:

2.44

getAcrs

public String[] getAcrs()

Get the list of ACR values requested by the device authorization request.

Returns:

The list of requested ACR values.

Since:

2.44

setAcrs

public DeviceVerificationResponse setAcrs(String[] acrs)

Set the list of ACR values requested by the device authorization request.

Parameters:

acrs - The list of requested ACR values.

Returns:

this object.

Since:

2.44

getExpiresAt

public long getExpiresAt()

Get the date in milliseconds since the Unix epoch (1970-01-01) at which the user code will expire.

Returns:

The expiration date in milliseconds since the Unix epoch (1970-01-01) at which the user code will expire.

Since:

2.44

setExpiresAt

public DeviceVerificationResponse setExpiresAt(long expiresAt)

Set the date in milliseconds since the Unix epoch (1970-01-01) at which the user code will expire.

Parameters:

expiresAt - The expiration date in milliseconds since the Unix epoch (1970-01-01) at which the user code will expire.

Returns:

this object.

Since:

2.44