com.authlete.jakarta.BaseUserInfoEndpoint Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2016-2022 Authlete, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the
 * License.
 */
package com.authlete.jakarta;


import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.Response;
import com.authlete.common.api.AuthleteApi;
import com.authlete.jakarta.UserInfoRequestHandler.Params;
import com.authlete.jakarta.spi.UserInfoRequestHandlerSpi;


/**
 * A base class for userinfo endpoints.
 *
 * @since 1.2
 *
 * @see OpenID Connect Core 1.0, 5.3. UserInfo Endpoint
 *
 * @author Takahiko Kawasaki
 */
public class BaseUserInfoEndpoint extends BaseResourceEndpoint
{
    /**
     * Handle a userinfo request.
     *
     * This method is an alias of the {@link #handle(AuthleteApi,
     * UserInfoRequestHandlerSpi, UserInfoRequestHandler.Params)} method.
     *
     * @param api
     *         An implementation of {@link AuthleteApi}.
     *
     * @param spi
     *         An implementation of {@link UserInfoRequestHandlerSpi}.
     *
     * @param accessToken
     *         An access token.
     *
     * @return
     *         A response that should be returned to the client application.
     */
    public Response handle(
            AuthleteApi api, UserInfoRequestHandlerSpi spi, String accessToken)
    {
        Params params = new Params()
                .setAccessToken(accessToken)
                ;

        return handle(api, spi, params);
    }


    /**
     * Handle a userinfo request.
     *
     * 
     * This method internally creates a {@link UserInfoRequestHandler} instance
     * and calls its
     * {@link UserInfoRequestHandler#handle(UserInfoRequestHandler.Params)
     * handle(Params)} method. Then, this method uses the value returned from
     * the {@code handle()} method as a response from this method.
     * 
     *
     * 
     * When {@code UserInfoRequestHandler.handle()} method raises a {@link
     * WebApplicationException}, this method calls {@link
     * #onError(WebApplicationException) onError()} method with the exception.
     * The default implementation of {@code onError()} does nothing. You can
     * override the method as necessary. After calling {@code onError()}
     * method, this method calls {@code getResponse()} method of the exception
     * and uses the returned value as a response from this method.
     * 
     *
     * @param api
     *         An implementation of {@link AuthleteApi}.
     *
     * @param spi
     *         An implementation of {@link UserInfoRequestHandlerSpi}.
     *
     * @param params
     *         Parameters needed to handle the userinfo request.
     *
     * @return
     *         A response that should be returned to the client application.
     *
     * @since 2.27
     */
    public Response handle(
            AuthleteApi api, UserInfoRequestHandlerSpi spi, Params params)
    {
        try
        {
            // Create a handler.
            UserInfoRequestHandler handler = new UserInfoRequestHandler(api, spi);

            // Delegate the task to the handler.
            return handler.handle(params);
        }
        catch (WebApplicationException e)
        {
            // An error occurred in the handler.
            onError(e);

            // Convert the error to a Response.
            return e.getResponse();
        }
    }
}