• Home
• com.authlete
• authlete-java-jakarta
• 2.88
• source code
• BaseBackchannelAuthenticationEndpoint.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*
 * Copyright (C) 2019-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.jakarta;


import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.core.Response;
import com.authlete.common.api.AuthleteApi;
import com.authlete.common.api.Options;
import com.authlete.jakarta.BackchannelAuthenticationRequestHandler.Params;
import com.authlete.jakarta.spi.BackchannelAuthenticationRequestHandlerSpi;


/**
 * A base class for backchannel authentication endpoints of CIBA (Client Initiated
 * Backchannel Authentication).
 *
 * @since 2.13
 *
 * @author Hideki Ikeda
 */
public class BaseBackchannelAuthenticationEndpoint extends BaseEndpoint
{
    /**
     * Handle a backchannel authentication request in CIBA (Client Initiated
     * Backchannel Authentication) flow. This method is an alias of {@link
     * #handle(AuthleteApi, BackchannelAuthenticationRequestHandlerSpi, 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 BackchannelAuthenticationRequestHandlerSpi}.
     *
     * @param parameters
     *         The request parameters of the backchannel authentication request.
     *
     * @param authorization
     *         The value of {@code Authorization} header of the backchannel authentication
     *         request.
     *
     * @param clientCertificatePath
     *         The certificate path used in mutual TLS authentication, 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.
     */
    public Response handle(
            AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi,
            MultivaluedMap parameters, String authorization,
            String[] clientCertificatePath)
    {
        return handle(
                api, spi, parameters, authorization, clientCertificatePath, null, null, null);
    }


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

        // Delegate the task to the handler.
        return handle(api, spi, params, bcAuthOptions, bcAuthIssueOptions, bcAuthFailOptions);
    }


    /**
     * Handle a backchannel authentication request.
     *
     * @param api
     *         An implementation of {@link AuthleteApi}.
     *
     * @param spi
     *         An implementation of {@link BackchannelAuthenticationRequestHandlerSpi}.
     *
     * @param params
     *         Parameters for Authlete's {@code /backchannel/authentication} API.
     *
     * @return
     *         A response that should be returned to the client application.
     *
     * @since 2.79
     */
    public Response handle(
            AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi, Params params)
    {
        return handle(api, spi, params, null, null, null);
    }


    /**
     * Handle a backchannel authentication request.
     *
     * 

     * This method internally creates a {@link BackchannelAuthenticationRequestHandler}
     * instance and calls its {@link BackchannelAuthenticationRequestHandler#handle(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 BackchannelAuthenticationRequestHandler.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 BackchannelAuthenticationRequestHandlerSpi}.
     *
     * @param params
     *         Parameters for Authlete's {@code /backchannel/authentication} API.
     *
     * @param bcAuthOptions
     *         The request options for the {@code /api/backchannel/authentication} API.
     *
     * @param bcAuthIssueOptions
     *         The request options for the {@code /api/backchannel/authentication/issue} API.
     *
     * @param bcAuthFailOptions
     *         The request options for the {@code /api/backchannel/authentication/fail} API.
     *
     * @return
     *         A response that should be returned to the client application.
     *
     * @since 2.82
     */
    public Response handle(
            AuthleteApi api, BackchannelAuthenticationRequestHandlerSpi spi, Params params,
            Options bcAuthOptions, Options bcAuthIssueOptions, Options bcAuthFailOptions)
    {
        try
        {
            // Create a handler.
            BackchannelAuthenticationRequestHandler handler =
                    new BackchannelAuthenticationRequestHandler(api, spi);

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

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