com.authlete.common.dto.CredentialBatchIssueRequest 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/batch/issue} API.
 *
 * 
 * The Authlete API is supposed to be called by the implementation of the
 * batch credential endpoint. The endpoint is defined in the "OpenID for Verifiable Credential Issuance" (OID4VCI) specification.
 * 
 *
 * 
 * The implementation of the batch credential endpoint is expected to call
 * the following Authlete APIs in the order.
 * 
 *
 * 
 * {@code /auth/introspection}
 * 
{@code /vci/batch/parse}
 * 
{@code /vci/batch/issue}
 * 
 *
 * 
 * The role of the {@code /vci/batch/issue} API is to issue credentials and/or
 * transaction IDs and to prepare a response that should be returned from th
 * batch credential endpoint.
 * 
 *
 * @since 3.71
 * @since Authlete 3.0
 *
 * @see OpenID for Verifiable Credential Issuance
 */
public class CredentialBatchIssueRequest implements Serializable
{
    private static final long serialVersionUID = 1L;


    /**
     * The access token that was presented at the batch credential endpoint.
     */
    private String accessToken;


    /**
     * The instructions for issuance of credentials and/or transaction IDs.
     */
    private CredentialIssuanceOrder[] orders;


    /**
     * Get the access token that was presented at the batch credential endpoint.
     *
     * @return
     *         The access token that was presented at the batch credential endpoint.
     */
    public String getAccessToken()
    {
        return accessToken;
    }


    /**
     * Set the access token that was presented at the batch credential endpoint.
     *
     * @param accessToken
     *         The access token that was presented at the batch credential endpoint.
     *
     * @return
     *         {@code this} object.
     */
    public CredentialBatchIssueRequest setAccessToken(String accessToken)
    {
        this.accessToken = accessToken;

        return this;
    }


    /**
     * Get the credential orders that provide instructions for issuance of
     * credentials and/or transaction IDs.
     *
     * @return
     *         The instructions for issuance of credentials and/or transaction IDs.
     */
    public CredentialIssuanceOrder[] getOrders()
    {
        return orders;
    }


    /**
     * Set the credential orders that provide instructions for issuance of
     * credentials and/or transaction IDs.
     *
     * @param order
     *         The instructions for issuance of credentials and/or transaction IDs.
     *
     * @return
     *         {@code this} object.
     */
    public CredentialBatchIssueRequest setOrders(CredentialIssuanceOrder[] orders)
    {
        this.orders = orders;

        return this;
    }
}