com.authlete.jaxrs.BaseTokenEndpoint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of authlete-java-jaxrs Show documentation
Authlete library for JAX-RS (Java)
The newest version!
/*
 * Copyright (C) 2016-2025 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.jaxrs;


import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import com.authlete.common.api.AuthleteApi;
import com.authlete.common.api.Options;
import com.authlete.jaxrs.TokenRequestHandler.Params;
import com.authlete.jaxrs.spi.TokenRequestHandlerSpi;


/**
 * A base class for token endpoints.
 *
 * @since 1.2
 *
 * @see RFC 6749, 3.2. Token Endpoint
 *
 * @see OpenID Connect Core 1.0, 3.3.3. Token Endpoint
 *
 * @author Takahiko Kawasaki
 */
public class BaseTokenEndpoint extends BaseEndpoint
{
    /**
     * Handle a token request. This method is an alias of {@link #handle(AuthleteApi,
     * TokenRequestHandlerSpi, MultivaluedMap, String, Options, Options, Options)
     * handle}{@code (api, spi, parameters, authorization, null, null, null)}.
     *
     * @param api
     *         An implementation of {@link AuthleteApi}.
     *
     * @param spi
     *         An implementation of {@link TokenRequestHandlerSpi}.
     *
     * @param parameters
     *         The request parameters of the token request.
     *
     * @param authorization
     *         The value of {@code Authorization} header of the token request.
     *
     * @return
     *         A response that should be returned to the client application.
     */
    public Response handle(
            AuthleteApi api, TokenRequestHandlerSpi spi,
            MultivaluedMap parameters, String authorization)
    {
        return handle(api, spi, parameters, authorization, null, null, null);
    }


    /**
     * Handle a token request. This method is an alias of the {@link #handle(AuthleteApi,
     * TokenRequestHandlerSpi, MultivaluedMap, String, String[], Options) handle}{@code
     * (api, spi, parameters, authorization, null, tokenOptions, tokenIssueOptions, tokenFailOptions)}.
     *
     * @param api
     *         An implementation of {@link AuthleteApi}.
     *
     * @param spi
     *         An implementation of {@link TokenRequestHandlerSpi}.
     *
     * @param parameters
     *         The request parameters of the token request.
     *
     * @param authorization
     *         The value of {@code Authorization} header of the token request.
     *
     * @param tokenOptions
     *         The request options for the {@code /api/auth/token} API.
     *
     * @param tokenIssueOptions
     *         The request options for the {@code /api/auth/token/issue} API.
     *
     * @param tokenFailOptions
     *         The request options for the {@code /api/auth/token/fail} API.
     *
     * @return
     *         A response that should be returned to the client application.
     *
     * @since 2.82
     */
    public Response handle(
            AuthleteApi api, TokenRequestHandlerSpi spi,
            MultivaluedMap parameters, String authorization,
            Options tokenOptions, Options tokenIssueOptions, Options tokenFailOptions)
    {
        return handle(
                api, spi, parameters, authorization, null, tokenOptions, tokenIssueOptions, tokenFailOptions);
    }


    /**
     * Handle a token request. This method is an alias of {@link #handle(AuthleteApi,
     * TokenRequestHandlerSpi, MultivaluedMap, String, String[], Options, Options, Options)
     * handle}{@code (api, spi, parameters, authorization, clientCertificatePath, null, null, null)}.
     *
     * @param api
     *         An implementation of {@link AuthleteApi}.
     *
     * @param spi
     *         An implementation of {@link TokenRequestHandlerSpi}.
     *
     * @param parameters
     *         The request parameters of the token request.
     *
     * @param authorization
     *         The value of {@code Authorization} header of the token request.
     *
     * @param clientCertificatePath
     *         The certificate path used in mutual TLS authentication, each in
     *         PEM format. The client's own certificate is the first in this
     *         array. Can be {@code null}.
     *
     * @return
     *         A response that should be returned to the client application.
     *
     * @since 2.8
     */
    public Response handle(
            AuthleteApi api, TokenRequestHandlerSpi spi,
            MultivaluedMap parameters, String authorization, String[] clientCertificatePath)
    {
        return handle(
                api, spi, parameters, authorization, clientCertificatePath, null, null, null);
    }


    /**
     * Handle a token request. This method is an alias of the {@link #handle(AuthleteApi,
     * TokenRequestHandlerSpi, TokenRequestHandler.Params)} method.
     *
     * @param api
     *         An implementation of {@link AuthleteApi}.
     *
     * @param spi
     *         An implementation of {@link TokenRequestHandlerSpi}.
     *
     * @param parameters
     *         The request parameters of the token request.
     *
     * @param authorization
     *         The value of {@code Authorization} header of the token request.
     *
     * @param clientCertificatePath
     *         The certificate path used in mutual TLS authentication, each in
     *         PEM format. The client's own certificate is the first in this
     *         array. Can be {@code null}.
     *
     * @param tokenOptions
     *         The request options for the {@code /api/auth/token} API.
     *
     * @param tokenIssueOptions
     *         The request options for the {@code /api/auth/token/issue} API.
     *
     * @param tokenFailOptions
     *         The request options for the {@code /api/auth/token/fail} API.
     *
     * @return
     *         A response that should be returned to the client application.
     *
     * @since 2.82
     */
    public Response handle(
            AuthleteApi api, TokenRequestHandlerSpi spi,
            MultivaluedMap parameters, String authorization,
            String[] clientCertificatePath, Options tokenOptions, Options tokenIssueOptions,
            Options tokenFailOptions)
    {
        Params params = new Params()
                .setParameters(parameters)
                .setAuthorization(authorization)
                .setClientCertificatePath(clientCertificatePath)
                ;

        return handle(api, spi, params);
    }


    /**
     * Handle a token request. This method is an alias of {@link #handle(AuthleteApi,
     * TokenRequestHandlerSpi, Params, Options, Options, Options) handle}{@code
     * (api, spi, params, null, null, null)}.
     *
     * @param api
     *         An implementation of {@link AuthleteApi}.
     *
     * @param spi
     *         An implementation of {@link TokenRequestHandlerSpi}.
     *
     * @param params
     *         Parameters needed to handle the token request.
     *
     * @return
     *         A response that should be returned to the client application.
     *
     * @since 2.27
     */
    public Response handle(
            AuthleteApi api, TokenRequestHandlerSpi spi, Params params)
    {
        return handle(api, spi, params, null, null, null);
    }


    /**
     * Handle a token request.
     *
     * 
     * This method internally creates a {@link TokenRequestHandler} instance and
     * calls its {@link TokenRequestHandler#handle(TokenRequestHandler.Params, Options, Options, Options)
     * handle()} method. Then, this method uses the value returned from the {@code handle()}
     * method as a response from this method.
     * 
     *
     * 
     * When {@code TokenRequestHandler.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 TokenRequestHandlerSpi}.
     *
     * @param params
     *         Parameters needed to handle the token request.
     *
     * @param tokenOptions
     *         The request options for the {@code /api/auth/token} API.
     *
     * @param tokenIssueOptions
     *         The request options for the {@code /api/auth/token/issue} API.
     *
     * @param tokenFailOptions
     *         The request options for the {@code /api/auth/token/fail} API.
     *
     * @return
     *         A response that should be returned to the client application.
     *
     * @since 2.82
     */
    public Response handle(
            AuthleteApi api, TokenRequestHandlerSpi spi, Params params,
            Options tokenOptions, Options tokenIssueOptions, Options tokenFailOptions)
    {
        try
        {
            // Create a handler.
            TokenRequestHandler handler = new TokenRequestHandler(api, spi);

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

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