Package com.authlete.jaxrs

Class BackchannelAuthenticationCompleteRequestHandler

java.lang.Object

com.authlete.jaxrs.BackchannelAuthenticationCompleteRequestHandler

public class BackchannelAuthenticationCompleteRequestHandler
extends Object

Handler for the result of end-user authentication and authorization in CIBA (Client Initiated Backchannel Authentication) flow.

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

Since:

2.13

Author:

Hideki Ikeda

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected com.authlete.jaxrs.AuthleteApiCaller	getApiCaller()
void	handle(String ticket, String[] claimNames)	Handle the result of end-user authentication and authorization in CIBA (Client Initiated Backchannel Authentication) flow.
void	handle(String ticket, String[] claimNames, com.authlete.common.api.Options options)	Handle the result of end-user authentication and authorization in CIBA (Client Initiated Backchannel Authentication) 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

BackchannelAuthenticationCompleteRequestHandler

public BackchannelAuthenticationCompleteRequestHandler(com.authlete.common.api.AuthleteApi api,
                                                       BackchannelAuthenticationCompleteRequestHandlerSpi spi)

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

Parameters:

api - Implementation of AuthleteApi interface.

spi - Implementation of BackchannelAuthenticationCompleteRequestHandlerSpi interface.

Method Detail

handle

public void handle(String ticket,
                   String[] claimNames)
            throws javax.ws.rs.WebApplicationException

Handle the result of end-user authentication and authorization in CIBA (Client Initiated Backchannel Authentication) flow. This method is an alias of handle(ticket, claimNames, null).

Parameters:

ticket - A ticket that was issued by Authlete's /api/backchannel/authentication API.

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

Throws:

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

handle

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

Handle the result of end-user authentication and authorization in CIBA (Client Initiated Backchannel Authentication) flow.

Parameters:

ticket - A ticket that was issued by Authlete's /api/backchannel/authentication API.

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

options - The request options for the /api/backchannel/authentication/complete API.

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)