com.authlete.common.dto

Class DeviceAuthorizationResponse

java.lang.Object

com.authlete.common.dto.ApiResponse

com.authlete.common.dto.DeviceAuthorizationResponse

All Implemented Interfaces:

Serializable

public class DeviceAuthorizationResponse
extends ApiResponse

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

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

OK

When the value of action is OK, it means that the device authorization request from the client application is valid.

The authorization server implementation should generate a response to the client application with 200 OK and application/json.

The getResponseContent() method returns a JSON string which can be used as the entity body of the response.

The following illustrates the response which the authorization server implementation should generate and return to the client application.

 HTTP/1.1 200 OK
 Content-Type: application/json
 Cache-Control: no-store
 Pragma: no-cache

 (The value returned from getResponseContent())

BAD_REQUEST

When the value of action is BAD_REQUEST, it means that the device authorization request from the client application was wrong.

The authorization server implementation should generate a response to the client application with 400 Bad Request and application/json.

The getResponseContent() method returns a JSON string which describes the error, so it can be used as the entity body of the response.

The following illustrates the response which the authorization server implementation should generate and return to the client application.

 HTTP/1.1 400 Bad Request
 Content-Type: application/json
 Cache-Control: no-store
 Pragma: no-cache

 (The value returned from getResponseContent())

UNAUTHORIZED

When the value of action is UNAUTHORIZED, it means that client authentication of the device authorization request failed.

The authorization server implementation should generate a response to the client application with 401 Unauthorized and application/json.

The getResponseContent() method returns a JSON string which describes the error, so it can be used as the entity body of the response.

The following illustrates the response which the authorization server implementation should generate and return to the client application.

 HTTP/1.1 401 Unauthorized
 WWW-Authenticate: (challenge)
 Content-Type: application/json
 Cache-Control: no-store
 Pragma: no-cache

 (The value returned from getResponseContent())

INTERNAL_SERVER_ERROR

When the value of action is INTERNAL_SERVER_ERROR, it means that the API call from the authorization server implementation was wrong or that an error occurred in Authlete.

In either case, from a viewpoint of the client application, it is an error on the server side. Therefore, the authorization server implementation should generate a response to the client application with 500 Internal Server Error and application/json.

The getResponseContent() method returns a JSON string which describes the error, so it can be used as the entity body of the response.

The following illustrates the response which the authorization server implementation should generate and return to the client application.

 HTTP/1.1 500 Internal Server Error
 Content-Type: application/json
 Cache-Control: no-store
 Pragma: no-cache

 (The value returned from getResponseContent())

Since:

2.42

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
DeviceAuthorizationResponse()

Method Summary

Modifier and Type	Method and Description
String[]	getAcrs() Get the list of ACR values requested by the device authorization request.
DeviceAuthorizationResponse.Action	getAction() Get the next action that the implementation of the device authorization endpoint should take.
String[]	getClaimNames() Get the names of the claims which were requested indirectly via some special scopes.
ClientAuthMethod	getClientAuthMethod() Get the client authentication method that should be performed at the device authorization endpoint.
long	getClientId() Get the client ID of the client application that has made the device authorization request.
String	getClientIdAlias() Get the client ID alias of the client application that has made the device authorization request.
String	getClientIdentifier() Get the client identifier used in the device authorization request.
String	getClientName() Get the name of the client application which has made the device authorization request.
String	getDeviceCode() Get the device verification code.
int	getExpiresIn() Get the duration of the issued device verification code and end-user verification code in seconds.
int	getInterval() Get the minimum amount of time in seconds that the client must wait for between polling requests to the token endpoint.
String	getResponseContent() Get the content that can be used to generate a response to the client application.
Scope[]	getScopes() Get the scopes requested by the device authorization request.
String	getUserCode() Get the end-user verification code.
URI	getVerificationUri() Get the end-user verification URI.
URI	getVerificationUriComplete() Get the end-user verification URI that includes the end-user verification code.
String[]	getWarnings() Get the warnings raised during processing the device authorization request.
boolean	isClientIdAliasUsed() Get the flag which indicates whether the client ID alias was used in the device authorization request.
DeviceAuthorizationResponse	setAcrs(String[] acrs) Set the list of ACR values requested by the device authorization request.
DeviceAuthorizationResponse	setAction(DeviceAuthorizationResponse.Action action) Set the next action that the implementation of the device authorization endpoint should take.
DeviceAuthorizationResponse	setClaimNames(String[] names) Set the names of the claims which were requested indirectly via some special scopes.
DeviceAuthorizationResponse	setClientAuthMethod(ClientAuthMethod method) Set the client authentication method that should be performed at the device authorization endpoint.
DeviceAuthorizationResponse	setClientId(long clientId) Set the client ID of the client application that has made the device authorization request.
DeviceAuthorizationResponse	setClientIdAlias(String alias) Set the client ID alias of the client application that has made the device authorization request.
DeviceAuthorizationResponse	setClientIdAliasUsed(boolean used) Set the flag which indicates whether the client ID alias was used in the device authorization request.
DeviceAuthorizationResponse	setClientName(String name) Set the name of the client application which has made the device authorization request.
DeviceAuthorizationResponse	setDeviceCode(String code) Set the device verification code.
DeviceAuthorizationResponse	setExpiresIn(int expiresIn) Set the duration of the issued device verification code and end-user verification code in seconds.
DeviceAuthorizationResponse	setInterval(int interval) Set the minimum amount of time in seconds that the client must wait for between polling requests to the token endpoint.
DeviceAuthorizationResponse	setResponseContent(String responseContent) Set the content that can be used to generate a response to the client application.
DeviceAuthorizationResponse	setScopes(Scope[] scopes) Set the scopes requested by the device authorization request.
DeviceAuthorizationResponse	setUserCode(String code) Set the end-user verification code.
DeviceAuthorizationResponse	setVerificationUri(URI uri) Set the end-user verification URI.
DeviceAuthorizationResponse	setVerificationUriComplete(URI uri) Set the end-user verification URI that includes the end-user verification code.
DeviceAuthorizationResponse	setWarnings(String[] warnings) Set the warnings raised during processing the device authorization request.

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

DeviceAuthorizationResponse

public DeviceAuthorizationResponse()

Method Detail

getAction

public DeviceAuthorizationResponse.Action getAction()

Get the next action that the implementation of the device authorization endpoint should take.

Returns:

The next action.

setAction

public DeviceAuthorizationResponse setAction(DeviceAuthorizationResponse.Action action)

Set the next action that the implementation of the device authorization endpoint should take.

Parameters:

action - The next action.

Returns:

this object.

getResponseContent

public String getResponseContent()

Get the content that can be used to generate a response to the client application.

Returns:

The content of a response to the client.

setResponseContent

public DeviceAuthorizationResponse setResponseContent(String responseContent)

Set the content that can be used to generate a response to the client application.

Parameters:

responseContent - The content of a response to the client.

Returns:

this object.

getClientId

public long getClientId()

Get the client ID of the client application that has made the device authorization request.

Returns:

The client ID of the client application.

setClientId

public DeviceAuthorizationResponse setClientId(long clientId)

Set the client ID of the client application that has made the device authorization request.

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 that has made the device authorization request.

Returns:

The client ID alias of the client application.

setClientIdAlias

public DeviceAuthorizationResponse setClientIdAlias(String alias)

Set the client ID alias of the client application that has made the device authorization request.

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.

Returns:

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

setClientIdAliasUsed

public DeviceAuthorizationResponse setClientIdAliasUsed(boolean used)

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

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.

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.

getClientName

public String getClientName()

Get the name of the client application which has made the device authorization request.

Returns:

The name of the client application.

setClientName

public DeviceAuthorizationResponse setClientName(String name)

Set the name of the client application which has made the device authorization request.

Parameters:

name - The name of the client application.

Returns:

this object.

getClientAuthMethod

public ClientAuthMethod getClientAuthMethod()

Get the client authentication method that should be performed at the device authorization endpoint.

If the client could not be identified by the information in the request, this method returns null.

Returns:

The client authentication method that should be performed at the device authorization endpoint.

Since:

2.50

setClientAuthMethod

public DeviceAuthorizationResponse setClientAuthMethod(ClientAuthMethod method)

Set the client authentication method that should be performed at the device authorization endpoint.

Parameters:

method - The client authentication method that should be performed at the device authorization endpoint.

Returns:

this object.

Since:

2.50

getScopes

public Scope[] getScopes()

Get the scopes requested by the device authorization request.

Basically, this method returns the value of the "scope" request parameter in the device authorization request. However, because unregistered scopes are dropped on Authlete side, if the "scope" request parameter contains unknown scopes, the list returned by this method becomes different from the value of the "scope" request parameter.

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 DeviceAuthorizationResponse setScopes(Scope[] scopes)

Set the scopes requested by the device authorization request.

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 DeviceAuthorizationResponse 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.

Basically, this method returns the value of the "acr_values" request parameter in the device authorization request. However, because unsupported ACR values are dropped on Authlete side, if the "acr_values" request parameter contains unrecognized ACR values, the list returned by this method becomes different from the value of the "acr_values" request parameter.

If the request does not include the acr_values request parameter, the value of the default_acr_values client metadata is used.

Returns:

The list of requested ACR values.

Since:

2.44

setAcrs

public DeviceAuthorizationResponse 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

getDeviceCode

public String getDeviceCode()

Get the device verification code. This corresponds to the device_code property in the response to the client.

Returns:

The device verification code.

setDeviceCode

public DeviceAuthorizationResponse setDeviceCode(String code)

Set the device verification code. This corresponds to the device_code property in the response to the client.

Parameters:

code - The device verification code.

Returns:

this object.

getUserCode

public String getUserCode()

Get the end-user verification code. This corresponds to the user_code property in the response to the client.

Returns:

The end-user verification code.

setUserCode

public DeviceAuthorizationResponse setUserCode(String code)

Set the end-user verification code. This corresponds to the user_code property in the response to the client.

Parameters:

code - The end-user verification code.

Returns:

this object.

getVerificationUri

public URI getVerificationUri()

Get the end-user verification URI. This corresponds to the verification_uri property in the response to the client.

Returns:

The end-user verification URI.

setVerificationUri

public DeviceAuthorizationResponse setVerificationUri(URI uri)

Set the end-user verification URI. This corresponds to the verification_uri property in the response to the client.

Parameters:

uri - The end-user verification URI.

Returns:

this object.

getVerificationUriComplete

public URI getVerificationUriComplete()

Get the end-user verification URI that includes the end-user verification code. This corresponds to the verification_uri_complete property in the response to the client.

Returns:

The end-user verification URI that includes the end-user verification code.

setVerificationUriComplete

public DeviceAuthorizationResponse setVerificationUriComplete(URI uri)

Set the end-user verification URI that includes the end-user verification code. This corresponds to the verification_uri_complete property in the response to the client.

Parameters:

uri - The end-user verification URI that includes the end-user verification code.

Returns:

this object.

getExpiresIn

public int getExpiresIn()

Get the duration of the issued device verification code and end-user verification code in seconds. This corresponds to the expires_in property in the response to the client.

Returns:

The duration of the issued device verification code and end-user verification code in seconds.

setExpiresIn

public DeviceAuthorizationResponse setExpiresIn(int expiresIn)

Set the duration of the issued device verification code and end-user verification code in seconds. This corresponds to the expires_in property in the response to the client.

Parameters:

expiresIn - The duration of the issued device verification code and end-user verification code in seconds.

Returns:

this object.

getInterval

public int getInterval()

Get the minimum amount of time in seconds that the client must wait for between polling requests to the token endpoint. This corresponds to the interval property in the response to the client.

Returns:

The minimum amount of time in seconds between polling requests.

setInterval

public DeviceAuthorizationResponse setInterval(int interval)

Set the minimum amount of time in seconds that the client must wait for between polling requests to the token endpoint. This corresponds to the interval property in the response to the client.

Parameters:

interval - The minimum amount of time in seconds between polling requests.

Returns:

this object.

getWarnings

public String[] getWarnings()

Get the warnings raised during processing the device authorization request.

Returns:

Warnings. This may be null.

setWarnings

public DeviceAuthorizationResponse setWarnings(String[] warnings)

Set the warnings raised during processing the device authorization request.

Parameters:

warnings - Warnings.

Returns:

this object.