com.authlete.jakarta.BaseCredentialJwtIssuerMetadataEndpoint Maven / Gradle / Ivy
/*
* Copyright (C) 2023 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.common.dto.CredentialJwtIssuerMetadataRequest;
/**
* A base class for the JWT issuer metadata endpoint
* ({@code /.well-known/jwt-issuer}) defined in SD-JWT-based Verifiable Credentials (SD-JWT VC).
*
*
* A JWT issuer provides an endpoint that returns its JWT issuer metadata
* in the JSON format. The URL of the endpoint is defined as follows:
*
*
*
* JWT Issuer Identifier + {@code /.well-known/jwt-issuer}
*
*
*
* JWT Issuer Identifier is a URL that identifies the JWT issuer.
*
*
* @see SD-JWT-based Verifiable Credentials (SD-JWT VC)
*
* @since 2.65
* @since Authlete 3.0
*/
public class BaseCredentialJwtIssuerMetadataEndpoint extends BaseEndpoint
{
/**
* Handle a request to the JWT issuer metadata endpoint.
*
*
* This method internally creates a {@link
* CredentialJwtIssuerMetadataRequestHandler} instance and calls its {@link
* CredentialJwtIssuerMetadataRequestHandler#handle(CredentialJwtIssuerMetadataRequest)
* handle}({@link CredentialJwtIssuerMetadataRequest}) method.
* Then, this method uses the value returned from the handler's method as a
* response from this method.
*
*
*
* When the handler's method raises a {@link WebApplicationException}, this
* method calls {@link #onError(WebApplicationException)
* onError(WebApplicationException)} 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}.
*
* @return
* A response that should be returned from the JWT issuer
* metadata endpoint.
*/
public Response handle(AuthleteApi api, CredentialJwtIssuerMetadataRequest request)
{
try
{
// Create a handler.
CredentialJwtIssuerMetadataRequestHandler handler =
new CredentialJwtIssuerMetadataRequestHandler(api);
// Delegate the task to the handler.
return handler.handle(request);
}
catch (WebApplicationException e)
{
// An error occurred in the handler.
onError(e);
// Convert the error to a Response.
return e.getResponse();
}
}
/**
* Handle a request to the JWT issuer metadata endpoint.
*
*
* This method is an alias of {@link
* #handle(AuthleteApi, CredentialJwtIssuerMetadataRequest)
* handle}{@code (api, new CredentialJwtIssuerMetadataRequest())}
*
*
* @param api
* An implementation of {@link AuthleteApi}.
*
* @return
* A response that should be returned from the JWT issuer
* metadata endpoint.
*/
public Response handle(AuthleteApi api)
{
return handle(api, new CredentialJwtIssuerMetadataRequest());
}
}