com.authlete.common.dto.CredentialJwtIssuerMetadataRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of authlete-java-common Show documentation

Authlete Java library used commonly by service implementations and the Authlete server.

There is a newer version: 4.15

/*
 * 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.common.dto;


import java.io.Serializable;


/**
 * Request to Authlete's {@code /vci/jwtissuer} API.
 *
 * 
 * The Authlete API is supposed to be called from within the implementation of
 * the JWT VC issuer metadata endpoint ({@code /.well-known/jwt-vc-issuer}) of
 * the credential issuer.
 * 
 *
 * 
 * The API will generate JSON like below.
 * 
 *
 * 
 *  * {
 *   "issuer": "{@link Service}.{@link Service#getCredentialIssuerMetadata()
 *              getCredentialIssuerMetadata()}.{@link CredentialIssuerMetadata#getCredentialIssuer()
 *              getCredentialIssuer()}",
 *   "jwks_uri": "{@link Service}.{@link Service#getCredentialJwksUri()
 *              getCredentialJwksUri()}"
 * }
 * 
 * 
 *
 * 
 * Note that the JWT VC issuer metadata endpoint ({@code /.well-known/jwt-vc-issuer})
 * is different from the credential issuer metadata endpoint
 * ({@code /.well-known/openid-credential-issuer}).
 * 
 *
 * 
 * NOTE: The well-known path has been changed from {@code /.well-known/jwt-issuer}
 * to {@code /.well-known/jwt-vc-issuer} by a breaking change of the SD-JWT VC
 * specification.
 * 
 *
 * @since 3.79
 * @since Authlete 3.0
 *
 * @see CredentialJwtIssuerMetadataResponse
 * @see SD-JWT-based Verifiable Credentials (SD-JWT VC)
 */
public class CredentialJwtIssuerMetadataRequest implements Serializable
{
    private static final long serialVersionUID = 1L;


    private boolean pretty;


    /**
     * Get the flag indicating whether the metadata is written in the pretty
     * format or not.
     *
     * @return
     *         {@code true} if the metadata is written in the pretty format.
     */
    public boolean isPretty()
    {
        return pretty;
    }


    /**
     * Set the flag indicating whether the metadata is written in the pretty
     * format or not.
     *
     * @param pretty
     *         {@code true} to write the metadata in the pretty format.
     *
     * @return
     *         {@code this} object.
     */
    public CredentialJwtIssuerMetadataRequest setPretty(boolean pretty)
    {
        this.pretty = pretty;

        return this;
    }
}