Package com.authlete.jakarta

Class IntrospectionRequestHandler

java.lang.Object

com.authlete.jakarta.IntrospectionRequestHandler

public class IntrospectionRequestHandler
extends Object

Handler for token introspection requests (RFC 7662).

In an implementation of introspection endpoint, call handle() method and use the response as the response from the endpoint to the resource server. handle() method calls Authlete's /api/auth/introspection/standard API, receives a response from the API, and dispatches processing according to the action parameter in the response.

Since:

2.2

Author:

Takahiko Kawasaki, Hideki Ikeda

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IntrospectionRequestHandler.Params	Parameters passed to the handle(Params) method.

Constructor Summary

Constructors

Constructor	Description
IntrospectionRequestHandler(com.authlete.common.api.AuthleteApi api)	Constructor with an implementation of AuthleteApi interface.

Method Summary

Modifier and Type	Method	Description
protected com.authlete.jakarta.AuthleteApiCaller	getApiCaller()
jakarta.ws.rs.core.Response	handle(IntrospectionRequestHandler.Params params)	Handle an introspection request (RFC 7662).
jakarta.ws.rs.core.Response	handle(IntrospectionRequestHandler.Params params, com.authlete.common.api.Options options)	Handle an introspection request (RFC 7662).
jakarta.ws.rs.core.Response	handle(jakarta.ws.rs.core.MultivaluedMap<String,String> parameters)	Handle an introspection request (RFC 7662).
jakarta.ws.rs.core.Response	handle(jakarta.ws.rs.core.MultivaluedMap<String,String> parameters, com.authlete.common.api.Options options)	Handle an introspection request (RFC 7662).
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

IntrospectionRequestHandler

public IntrospectionRequestHandler(com.authlete.common.api.AuthleteApi api)

Constructor with an implementation of AuthleteApi interface.

Parameters:

api - Implementation of AuthleteApi interface.

Method Detail

handle

public jakarta.ws.rs.core.Response handle(jakarta.ws.rs.core.MultivaluedMap<String,String> parameters)
                                   throws jakarta.ws.rs.WebApplicationException

Handle an introspection request (RFC 7662). This method is an alias of handle(parameters, null).

Parameters:

parameters - The request parameters of an introspection request.

Returns:

A response that should be returned from the endpoint to the resource server.

Throws:

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

handle

public jakarta.ws.rs.core.Response handle(jakarta.ws.rs.core.MultivaluedMap<String,String> parameters,
                                          com.authlete.common.api.Options options)
                                   throws jakarta.ws.rs.WebApplicationException

Handle an introspection request (RFC 7662). This method is an alias of the handle(Params) method.

Parameters:

parameters - The request parameters of an introspection request.

options - The request options for the /api/auth/introspection/standard API.

Returns:

A response that should be returned from the endpoint to the resource server.

Throws:

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

Since:

2.82

handle

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

Handle an introspection request (RFC 7662). This method is an alias of handle(params, null).

Parameters:

params - Parameters needed to handle the introspection request. Must not be null.

Returns:

A response that should be returned from the endpoint to the resource server.

Throws:

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

Since:

2.63

handle

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

Handle an introspection request (RFC 7662).

Parameters:

params - Parameters needed to handle the introspection request. Must not be null.

options - The request options for the /api/auth/introspection API.

Returns:

A response that should be returned from the endpoint to the resource server.

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)