Package com.authlete.jaxrs

Class BaseBackchannelAuthenticationEndpoint

java.lang.Object

com.authlete.jaxrs.BaseEndpoint

com.authlete.jaxrs.BaseBackchannelAuthenticationEndpoint

public class BaseBackchannelAuthenticationEndpoint
extends BaseEndpoint

A base class for backchannel authentication endpoints of CIBA (Client Initiated Backchannel Authentication).

Since:

2.13

Author:

Hideki Ikeda

Constructor Summary

Constructors

Constructor	Description
BaseBackchannelAuthenticationEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi, BackchannelAuthenticationRequestHandler.Params params)	Handle a backchannel authentication request.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi, BackchannelAuthenticationRequestHandler.Params params, com.authlete.common.api.Options bcAuthOptions, com.authlete.common.api.Options bcAuthIssueOptions, com.authlete.common.api.Options bcAuthFailOptions)	Handle a backchannel authentication request.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi, javax.ws.rs.core.MultivaluedMap<String,String> parameters, String authorization, String[] clientCertificatePath)	Handle a backchannel authentication request in CIBA (Client Initiated Backchannel Authentication) flow.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi, javax.ws.rs.core.MultivaluedMap<String,String> parameters, String authorization, String[] clientCertificatePath, com.authlete.common.api.Options bcAuthOptions, com.authlete.common.api.Options bcAuthIssueOptions, com.authlete.common.api.Options bcAuthFailOptions)	Handle a backchannel authentication request in CIBA (Client Initiated Backchannel Authentication) flow.

Methods inherited from class com.authlete.jaxrs.BaseEndpoint

extractClientCertificate, extractClientCertificateChain, extractHeadersAsPairs, onError, takeAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseBackchannelAuthenticationEndpoint

public BaseBackchannelAuthenticationEndpoint()

Method Detail

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        BackchannelAuthenticationRequestHandlerSpi spi,
                                        javax.ws.rs.core.MultivaluedMap<String,String> parameters,
                                        String authorization,
                                        String[] clientCertificatePath)

Handle a backchannel authentication request in CIBA (Client Initiated Backchannel Authentication) flow. This method is an alias of handle(api, spi, parameters, authorization, clientCertificatePath, null, null, null).

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of BackchannelAuthenticationRequestHandlerSpi.

parameters - The request parameters of the backchannel authentication request.

authorization - The value of Authorization header of the backchannel authentication request.

clientCertificatePath - The certificate path used in mutual TLS authentication, in PEM format. The client's own certificate is the first in this array. Can be null.

Returns:

A response that should be returned to the client application.

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        BackchannelAuthenticationRequestHandlerSpi spi,
                                        javax.ws.rs.core.MultivaluedMap<String,String> parameters,
                                        String authorization,
                                        String[] clientCertificatePath,
                                        com.authlete.common.api.Options bcAuthOptions,
                                        com.authlete.common.api.Options bcAuthIssueOptions,
                                        com.authlete.common.api.Options bcAuthFailOptions)

Handle a backchannel authentication request in CIBA (Client Initiated Backchannel Authentication) flow. This method is an alias of the handle(AuthleteApi, BackchannelAuthenticationRequestHandlerSpi, Params, Options, Options, Options) method.

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of BackchannelAuthenticationRequestHandlerSpi.

parameters - The request parameters of the backchannel authentication request.

authorization - The value of Authorization header of the backchannel authentication request.

clientCertificatePath - The certificate path used in mutual TLS authentication, in PEM format. The client's own certificate is the first in this array. Can be null.

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

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

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

Returns:

A response that should be returned to the client application.

Since:

2.82

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        BackchannelAuthenticationRequestHandlerSpi spi,
                                        BackchannelAuthenticationRequestHandler.Params params)

Handle a backchannel authentication request.

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of BackchannelAuthenticationRequestHandlerSpi.

params - Parameters for Authlete's /backchannel/authentication API.

Returns:

A response that should be returned to the client application.

Since:

2.79

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        BackchannelAuthenticationRequestHandlerSpi spi,
                                        BackchannelAuthenticationRequestHandler.Params params,
                                        com.authlete.common.api.Options bcAuthOptions,
                                        com.authlete.common.api.Options bcAuthIssueOptions,
                                        com.authlete.common.api.Options bcAuthFailOptions)

Handle a backchannel authentication request.

This method internally creates a BackchannelAuthenticationRequestHandler instance and calls its handle() method. Then, this method uses the value returned from the handle() method as a response from this method.

When BackchannelAuthenticationRequestHandler.handle() method raises a WebApplicationException, this method calls onError() method with the exception. The default implementation of onError() does nothing. You can override the method as necessary. After calling onError() method, this method calls getResponse() method of the exception and uses the returned value as a response from this method.

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of BackchannelAuthenticationRequestHandlerSpi.

params - Parameters for Authlete's /backchannel/authentication API.

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

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

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

Returns:

A response that should be returned to the client application.

Since:

2.82