com.authlete.common.dto.CredentialDeferredIssueRequest 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;


/**
 * A request to Authlete's {@code /vci/deferred/issue} API.
 *
 * 
 * The Authlete API is supposed to be called by the implementation of the
 * deferred credential endpoint. The endpoint is defined in the "OpenID for Verifiable Credential Issuance" (OID4VCI) specification.
 * 
 *
 * 
 * The implementation of the deferred credential endpoint is expected to call
 * the following Authlete APIs in the order.
 * 
 *
 * 
 * {@code /auth/introspection}
 * 
{@code /vci/deferred/parse}
 * 
{@code /vci/deferred/issue}
 * 
 *
 * 
 * The role of the {@code /vci/deferred/issue} API is to issue a credential.
 * 
 *
 * 
 * If the credential for the transaction ID is not ready, the implementation
 * of the deferred credential endpoint should prepare an error response with
 * {@code "error":"issuance_pending"} manually and return it to the request
 * sender, without calling the {@code /vci/deferred/issue} API.
 * 
 *
 *  * HTTP/1.1 400 Bad Request
 * Content-Type: application/json
 * Cache-Control: no-store
 *
 * {
 *   "error": "issuance_pending"
 * }
 * 
 *
 * @since 3.70
 * @since Authlete 3.0
 *
 * @see OpenID for Verifiable Credential Issuance
 */
public class CredentialDeferredIssueRequest implements Serializable
{
    private static final long serialVersionUID = 1L;


    /**
     * The instruction for credential issuance.
     */
    private CredentialIssuanceOrder order;


    /**
     * Get the credential order that provides an instruction for issuing a
     * credential.
     *
     * @return
     *         The instruction for credential issuance.
     */
    public CredentialIssuanceOrder getOrder()
    {
        return order;
    }


    /**
     * Set the credential order that provides an instruction for issuing a
     * credential.
     *
     * @param order
     *         The instruction for credential issuance.
     *
     * @return
     *         {@code this} object.
     */
    public CredentialDeferredIssueRequest setOrder(CredentialIssuanceOrder order)
    {
        this.order = order;

        return this;
    }
}