Package com.authlete.jakarta

Class DeviceVerificationRequestHandler

java.lang.Object

com.authlete.jakarta.DeviceVerificationRequestHandler

public class DeviceVerificationRequestHandler
extends Object

Handler for getting information associated with a user code that the end-user input at the verification endpoint in OAuth 2.0 Device Authorization Grant (Device Flow).

handle() method should be called after the authorization server receives a user code that the end-user input at the verification endpoint. The handle() method calls Authlete's /api/device/verification 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
DeviceVerificationRequestHandler(com.authlete.common.api.AuthleteApi api, DeviceVerificationRequestHandlerSpi spi)	Constructor with an implementation of AuthleteApi interface and an implementation of DeviceVerificationRequestHandlerSpi interface.

Method Summary

Modifier and Type	Method	Description
protected com.authlete.jakarta.AuthleteApiCaller	getApiCaller()
jakarta.ws.rs.core.Response	handle()	Handle information associated with a user code that the end-user input at the verification endpoint in OAuth 2.0 Device Authorization Grant (Device Flow).
jakarta.ws.rs.core.Response	handle(com.authlete.common.api.Options options)	Handle information associated with a user code that the end-user input at the verification endpoint in OAuth 2.0 Device Authorization Grant (Device Flow).
protected jakarta.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

DeviceVerificationRequestHandler

public DeviceVerificationRequestHandler(com.authlete.common.api.AuthleteApi api,
                                        DeviceVerificationRequestHandlerSpi spi)

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

Parameters:

api - Implementation of AuthleteApi interface.

spi - Implementation of DeviceVerificationRequestHandlerSpi interface.

Method Detail

handle

public jakarta.ws.rs.core.Response handle()
                                   throws jakarta.ws.rs.WebApplicationException

Handle information associated with a user code that the end-user input at the verification endpoint in OAuth 2.0 Device Authorization Grant (Device Flow). This method is an alias of handle (null).

Returns:

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

Throws:

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

handle

public jakarta.ws.rs.core.Response handle(com.authlete.common.api.Options options)
                                   throws jakarta.ws.rs.WebApplicationException

Handle information associated with a user code that the end-user input at the verification endpoint in OAuth 2.0 Device Authorization Grant (Device Flow).

Parameters:

options - The request options for the /api/device/verification API.

Returns:

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

Throws:

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

Since:

2.82

getApiCaller

protected com.authlete.jakarta.AuthleteApiCaller getApiCaller()

unexpected

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