Package com.authlete.jaxrs

Class BaseAuthorizationEndpoint

java.lang.Object

com.authlete.jaxrs.BaseEndpoint

com.authlete.jaxrs.BaseAuthorizationEndpoint

public class BaseAuthorizationEndpoint
extends BaseEndpoint

A base class for authorization endpoints.

Since:

1.2

Author:

Takahiko Kawasaki

See Also:

RFC 6749, 3.1. Authorization Endpoint, OpenID Connect Core 1.0, 3.1.2. Authorization Endpoint (Authorization Code Flow), OpenID Connect Core 1.0, 3.2.2. Authorization Endpoint (Implicit Flow), OpenID Connect Core 1.0, 3.3.2. Authorization Endpoint (Hybrid Flow)

Constructor Summary

Constructors

Constructor	Description
BaseAuthorizationEndpoint()

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, AuthorizationRequestHandlerSpi spi, javax.ws.rs.core.MultivaluedMap<String,String> parameters)	Handle an authorization request.
javax.ws.rs.core.Response	handle(com.authlete.common.api.AuthleteApi api, AuthorizationRequestHandlerSpi spi, javax.ws.rs.core.MultivaluedMap<String,String> parameters, com.authlete.common.api.Options authzOptions, com.authlete.common.api.Options authzIssueOptions, com.authlete.common.api.Options authzFailOptions)	Handle an 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

BaseAuthorizationEndpoint

public BaseAuthorizationEndpoint()

Method Detail

handle

public javax.ws.rs.core.Response handle(com.authlete.common.api.AuthleteApi api,
                                        AuthorizationRequestHandlerSpi spi,
                                        javax.ws.rs.core.MultivaluedMap<String,String> parameters)

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

Parameters:

api - An implementation of AuthleteApi.

spi - An implementation of AuthorizationRequestHandlerSpi.

parameters - The request parameters of the authorization request.

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,
                                        AuthorizationRequestHandlerSpi spi,
                                        javax.ws.rs.core.MultivaluedMap<String,String> parameters,
                                        com.authlete.common.api.Options authzOptions,
                                        com.authlete.common.api.Options authzIssueOptions,
                                        com.authlete.common.api.Options authzFailOptions)

Handle an authorization request.

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

When AuthorizationRequestHandler.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 AuthorizationRequestHandlerSpi.

parameters - The request parameters of the authorization request.

authzOptions - The request options for the /api/auth/authorization API.

authzIssueOptions - The request options for the /api/auth/authorization/issue API.

authzFailOptions - The request options for the /api/auth/authorization/fail API.

Returns:

A response that should be returned to the client application.

Since:

2.82