Package com.authlete.jaxrs

Class DeviceCompleteRequestHandler

java.lang.Object

com.authlete.jaxrs.DeviceCompleteRequestHandler

public class DeviceCompleteRequestHandler
extends Object

Handler for processing the result of end-user authentication and authorization in OAuth 2.0 Device Authorization Grant (Device Flow).

handle() method should be called after the authorization server receives the result of end-user authentication and authorization, or even in the case where the server gave up getting the result for some reasons. The handle() method calls Authlete's /api/device/complete API, receives a response from the API, and dispatches processing according to the action parameter in the response.

Since:

2.18

Author:

Hideki Ikeda

Constructor Summary

Constructors

Constructor	Description
DeviceCompleteRequestHandler(com.authlete.common.api.AuthleteApi api, DeviceCompleteRequestHandlerSpi spi)	Constructor with an implementation of AuthleteApi interface and an implementation of DeviceCompleteRequestHandlerSpi interface.

Method Summary

Modifier and Type	Method	Description
protected com.authlete.jaxrs.AuthleteApiCaller	getApiCaller()
javax.ws.rs.core.Response	handle(String userCode, String[] claimNames)	Handle the result of end-user authentication and authorization in OAuth 2.0 Device Authorization Grant (Device Flow).
javax.ws.rs.core.Response	handle(String userCode, String[] claimNames, com.authlete.common.api.Options options)	Handle the result of end-user authentication and authorization in OAuth 2.0 Device Authorization Grant (Device Flow).
protected javax.ws.rs.InternalServerErrorException	unexpected(String message, Throwable cause)

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceCompleteRequestHandler

public DeviceCompleteRequestHandler(com.authlete.common.api.AuthleteApi api,
                                    DeviceCompleteRequestHandlerSpi spi)

Constructor with an implementation of AuthleteApi interface and an implementation of DeviceCompleteRequestHandlerSpi interface.

Parameters:

api - Implementation of AuthleteApi interface.

spi - Implementation of DeviceCompleteRequestHandlerSpi interface.

Method Detail

handle

public javax.ws.rs.core.Response handle(String userCode,
                                        String[] claimNames)
                                 throws javax.ws.rs.WebApplicationException

Handle the result of end-user authentication and authorization in OAuth 2.0 Device Authorization Grant (Device Flow). This method is an alias of handle(userCode, claimNames, null).

Parameters:

userCode - The user code that the end-user input.

claimNames - Names of requested claims. Use the value of the claimNames parameter in a response from Authlete's /api/device/verification API.

Returns:

A response that should be returned to the end-user.

Throws:

javax.ws.rs.WebApplicationException - An error occurred.

handle

public javax.ws.rs.core.Response handle(String userCode,
                                        String[] claimNames,
                                        com.authlete.common.api.Options options)
                                 throws javax.ws.rs.WebApplicationException

Handle the result of end-user authentication and authorization in OAuth 2.0 Device Authorization Grant (Device Flow).

Parameters:

userCode - The user code that the end-user input.

claimNames - Names of requested claims. Use the value of the claimNames parameter in a response from Authlete's /api/device/verification API.

options - The request options for the /api/client/registration API.

Returns:

A response that should be returned to the end-user.

Throws:

javax.ws.rs.WebApplicationException - An error occurred.

Since:

2.82

getApiCaller

protected com.authlete.jaxrs.AuthleteApiCaller getApiCaller()

unexpected

protected javax.ws.rs.InternalServerErrorException unexpected(String message,
                                                              Throwable cause)