Package com.authlete.common.dto

Class CredentialNonceResponse

  • All Implemented Interfaces:
    Serializable
    public class CredentialNonceResponse
extends ApiResponse
    Response from Authlete's /vci/nonce API.

    The Authlete API is supposed to be used from within the implementation the nonce endpoint of the credential issuer.

    Authlete's /vci/nonce API returns JSON which can be mapped to this class. The credential issuer implementation should retrieve the value of the action response parameter from the API response and take the following steps according to the value.

    OK

    When the value of the action response parameter is OK, it means that Authlete could prepare a nonce response successfully.

    In this case, the implementation of the nonce endpoint of the credential issuer should return an HTTP response with the HTTP status code "200 OK" and the content type "application/json". The message body of the response has been prepared by Authlete's /vci/nonce API and it is available as the responseContent response parameter.

    The implementation of the nonce endpoint can construct an HTTP response by doing like below. 

     200 OK
 Content-Type: application/json
 Cache-Control: no-store
 (Other HTTP headers)

 (the value of the responseContent response parameter)

    Note that the OpenID for Verifiable Credential Issuance 1.0 specification requires the response to include the Cache-Control header including the value no-store.

    NOT_FOUND

    When the value of the action response parameter is NOT_FOUND, it means that the service configuration has not enabled the feature of Verifiable Credentials and so the nonce endpoint should not be accessed.

    In this case, the implementation of the nonce endpoint of the credential issuer should return an HTTP response with the HTTP status code "404 Not Found" and the content type "application/json". The message body (= error information in the JSON format) of the response has been prepared by Authlete's /vci/nonce API and it is available as the responseContent response parameter.

    The implementation of the nonce endpoint can construct an HTTP response by doing like below. 

     404 Not Found
 Content-Type: application/json
 (Other HTTP headers)

 (the value of the responseContent response parameter)

    INTERNAL_SERVER_ERROR

    When the value of the action response parameter is INTERNAL_SERVER_ERROR, it means that an unexpected error has occurred on Authlete side or the service has not been set up properly yet.

    In this case, a simple implementation of the nonce endpoint would return an HTTP response with the HTTP status code "500 Internal Server Error" and the content type "application/json". The message body (= error information in the JSON format) of the response has been prepared by Authlete's /vci/nonce API and it is available as the responseContent response parameter.

    Such simple implementation of the nonce endpoint can construct an HTTP response by doing like below. 

     500 Internal Server Error
 Content-Type: application/json
 (Other HTTP headers)

 (the value of the responseContent response parameter)

    However, in real commercial deployments, it is rare for a credential issuer to return "500 Internal Server Error" when it encounters an unexpected internal error. It's up to implementations of credential issuers what they actually return in the case of internal server error.

    Since:
    4.27, Authlete 3.0.22
    See Also:
    OpenID for Verifiable Credential Issuance 1.0, Serialized Form

    • Constructor Detail

      • CredentialNonceResponse

        public CredentialNonceResponse()

    • Method Detail

      • getAction

        public CredentialNonceResponse.Action getAction()
        Get the next action that the implementation of the nonce endpoint should take after getting a response from Authlete's /vci/nonce API.
        Returns:
        The next action.

      • setAction

        public CredentialNonceResponse setAction​(CredentialNonceResponse.Action action)
        Set the next action that the implementation of the nonce endpoint should take after getting a response from Authlete's /vci/nonce API.
        Parameters:
        action - The next action.
        Returns:
        this object.

      • getResponseContent

        public String getResponseContent()
        Get the content that the implementation of the nonce endpoint should use when it constructs a response.
        Returns:
        The response content in the JSON format.

      • setResponseContent

        public CredentialNonceResponse setResponseContent​(String content)
        Set the content that the implementation of the nonce endpoint should use when it constructs a response.
        Parameters:
        content - The response content in the JSON format.
        Returns:
        this object.

      • getCnonce

        public String getCnonce()
        Get the c_nonce value generated by the /vci/nonce API.
        Returns:
        The generated c_nonce value.

      • setCnonce

        public CredentialNonceResponse setCnonce​(String cnonce)
        Set the c_nonce value generated by the /vci/nonce API.
        Parameters:
        cnonce - The generated c_nonce value.
        Returns:
        this object.