Package com.authlete.jakarta

Class UserInfoRequestHandler

java.lang.Object

com.authlete.jakarta.UserInfoRequestHandler

public class UserInfoRequestHandler
extends Object

Handler for userinfo requests to a UserInfo Endpoint defined in OpenID Connect Core 1.0.

In an implementation of userinfo endpoint, call one of handle() method variants and use the response as the response from the endpoint to the client application. handle() method calls Authlete's /api/auth/userinfo API and /api/auth/userinfo/issue API.

Since:

1.2

Author:

Takahiko Kawasaki

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected com.authlete.jakarta.AuthleteApiCaller	getApiCaller()
jakarta.ws.rs.core.Response	handle(UserInfoRequestHandler.Params params)	Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect Core 1.0.
jakarta.ws.rs.core.Response	handle(UserInfoRequestHandler.Params params, com.authlete.common.api.Options userInfoOptions, com.authlete.common.api.Options userInfoIssueOptions)	Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect Core 1.0.
jakarta.ws.rs.core.Response	handle(String accessToken)	Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect Core 1.0.
jakarta.ws.rs.core.Response	handle(String accessToken, com.authlete.common.api.Options userInfoOptions, com.authlete.common.api.Options userInfoIssueOptions)	Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect Core 1.0.
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

UserInfoRequestHandler

public UserInfoRequestHandler(com.authlete.common.api.AuthleteApi api,
                              UserInfoRequestHandlerSpi spi)

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

Parameters:

api - Implementation of AuthleteApi interface.

spi - Implementation of UserInfoRequestHandlerSpi interface.

Method Detail

handle

public jakarta.ws.rs.core.Response handle(String accessToken)
                                   throws jakarta.ws.rs.WebApplicationException

Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect Core 1.0. This method is an alias of handle(accessToken, null, null).

Parameters:

accessToken - An access token.

Returns:

A response that should be returned from the endpoint to the client application.

Throws:

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

handle

public jakarta.ws.rs.core.Response handle(String accessToken,
                                          com.authlete.common.api.Options userInfoOptions,
                                          com.authlete.common.api.Options userInfoIssueOptions)
                                   throws jakarta.ws.rs.WebApplicationException

Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect Core 1.0. This method is an alias of the handle(Params, Options, Options) method.

Parameters:

accessToken - An access token.

userInfoOptions - The request options for the /api/auth/userinfo API.

userInfoIssueOptions - The request options for the /api/auth/userinfo/issue API.

Returns:

A response that should be returned from the endpoint to the client application.

Throws:

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

Since:

2.82

handle

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

Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect Core 1.0. This method is an alias of handle (params, null, null).

Parameters:

params - Parameters needed to handle the userinfo request.

Returns:

A response that should be returned from the endpoint to the client application.

Throws:

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

handle

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

Handle a userinfo request to a UserInfo Endpoint defined in OpenID Connect Core 1.0.

Parameters:

params - Parameters needed to handle the userinfo request.

userInfoOptions - The request options for the /api/auth/userinfo API.

userInfoIssueOptions - The request options for the /api/auth/userinfo/issue API.

Returns:

A response that should be returned from the endpoint to the client application.

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)