Package com.authlete.jaxrs

Class BasePushedAuthReqEndpoint

java.lang.Object

com.authlete.jaxrs.BaseEndpoint

com.authlete.jaxrs.BasePushedAuthReqEndpoint

public class BasePushedAuthReqEndpoint
extends BaseEndpoint

A base class for pushed authorization endpoints.

Since:

2.21

Author:

Justin Richer

See Also:

OAuth 2.0 Pushed Authorization Requests

Constructor Summary

Constructors

Constructor	Description
BasePushedAuthReqEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, PushedAuthReqHandler.Params params)	Handle a PAR request.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, PushedAuthReqHandler.Params params, com.authlete.common.api.Options options)	Handle a PAR request.
protected javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, javax.ws.rs.core.MultivaluedMap<String,String> parameters, String authorization, String[] clientCertificates)	Handle a pushed authorization request.
protected javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, javax.ws.rs.core.MultivaluedMap<String,String> parameters, String authorization, String[] clientCertificates, com.authlete.common.api.Options options)	Handle a pushed authorization request.

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

BasePushedAuthReqEndpoint

public BasePushedAuthReqEndpoint()

Method Detail

handle

protected javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                           javax.ws.rs.core.MultivaluedMap<String,String> parameters,
                                           String authorization,
                                           String[] clientCertificates)

Handle a pushed authorization request. This method is an alias of handle (api, parameters, authorization, clientCertificates, null).

Parameters:

api - An implementation of AuthleteApi.

parameters - The request parameters of the pushed authorization request.

authorization - The value of Authorization header of the pushed authorization request.

clientCertificates - 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

protected javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                           javax.ws.rs.core.MultivaluedMap<String,String> parameters,
                                           String authorization,
                                           String[] clientCertificates,
                                           com.authlete.common.api.Options options)

Handle a pushed authorization request. This method is an alias of the handle(AuthleteApi, Params, Options) method.

Parameters:

api - An implementation of AuthleteApi.

parameters - The request parameters of the pushed authorization request.

authorization - The value of Authorization header of the pushed authorization request.

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

options - The request options for the /api/pushed_auth_req 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,
                                        PushedAuthReqHandler.Params params)

Handle a PAR request. This method is an alias of handle(api, params, null).

Parameters:

api - An implementation of AuthleteApi.

params - Parameters needed to handle the PAR request.

Returns:

A response that should be returned to the client application.

Since:

2.70

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        PushedAuthReqHandler.Params params,
                                        com.authlete.common.api.Options options)

Handle a PAR request.

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

When PushedAuthReqHandler.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.

params - The request parameters needed to handle the PAR request.

options - The request options for the PAR request.

Returns:

A response that should be returned to the client application.

Since:

2.82