Package com.authlete.common.dto
Enum CredentialBatchIssueResponse.Action
- java.lang.Object
-
- java.lang.Enum<CredentialBatchIssueResponse.Action>
-
- com.authlete.common.dto.CredentialBatchIssueResponse.Action
-
- All Implemented Interfaces:
Serializable
,Comparable<CredentialBatchIssueResponse.Action>
- Enclosing class:
- CredentialBatchIssueResponse
public static enum CredentialBatchIssueResponse.Action extends Enum<CredentialBatchIssueResponse.Action>
The next action that the implementation of the batch credential endpoint should take.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACCEPTED
Transaction IDs were issued successfully, but not a single credential was issued.ACCEPTED_JWT
Transaction IDs were issued successfully, but not a single credential was issued, and the batch credential response should be encrypted.BAD_REQUEST
The original batch credential request is wrong.CALLER_ERROR
The API call is invalid.FORBIDDEN
The feature of Verifiable Credentials is not enabled in the service configuration.INTERNAL_SERVER_ERROR
An error occurred on Authlete side.OK
Credentials and/or transaction IDs were issued successfully.OK_JWT
Credentials and/or transaction IDs were issued successfully and the batch credential response should be encrypted.UNAUTHORIZED
The API call does not contain an access token or the access token is invalid.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CredentialBatchIssueResponse.Action
valueOf(String name)
Returns the enum constant of this type with the specified name.static CredentialBatchIssueResponse.Action[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
OK
public static final CredentialBatchIssueResponse.Action OK
Credentials and/or transaction IDs were issued successfully. The implementation of the batch credential endpoint should return a successful response with the HTTP status code "200 OK" and the content typeapplication/json
.
-
OK_JWT
public static final CredentialBatchIssueResponse.Action OK_JWT
Credentials and/or transaction IDs were issued successfully and the batch credential response should be encrypted. The implementation of the batch credential endpoint should return a successful response with the HTTP status code "200 OK" and the content typeapplication/jwt
.- Since:
- 3.86
-
ACCEPTED
public static final CredentialBatchIssueResponse.Action ACCEPTED
Transaction IDs were issued successfully, but not a single credential was issued. The implementation of the batch credential endpoint should return a successful response with the HTTP status code "202 Accepted" and the content typeapplication/json
.NOTE: OpenID4VCI PR 293 "rework credential and batch credential endpoint" has added the following new requirement:
If all requests are responded to using a
transaction_id
, the Issuer MUST use the HTTP status code 202 (as detailed in Section 15.3.3 of [RFC9110]).- Since:
- 4.2
-
ACCEPTED_JWT
public static final CredentialBatchIssueResponse.Action ACCEPTED_JWT
Transaction IDs were issued successfully, but not a single credential was issued, and the batch credential response should be encrypted. The implementation of the batch credential endpoint should return a successful response with the HTTP status code "202 Accepted" and the content typeapplication/jwt
.NOTE: OpenID4VCI PR 293 "rework credential and batch credential endpoint" has added the following new requirement:
If all requests are responded to using a
transaction_id
, the Issuer MUST use the HTTP status code 202 (as detailed in Section 15.3.3 of [RFC9110]).- Since:
- 4.2
-
BAD_REQUEST
public static final CredentialBatchIssueResponse.Action BAD_REQUEST
The original batch credential request is wrong. This can happen, for example, when the process for encrypting the batch credential response with the encryption parameters specified in the batch credential request failed.- Since:
- 3.86
-
UNAUTHORIZED
public static final CredentialBatchIssueResponse.Action UNAUTHORIZED
The API call does not contain an access token or the access token is invalid.
-
FORBIDDEN
public static final CredentialBatchIssueResponse.Action FORBIDDEN
The feature of Verifiable Credentials is not enabled in the service configuration.
-
INTERNAL_SERVER_ERROR
public static final CredentialBatchIssueResponse.Action INTERNAL_SERVER_ERROR
An error occurred on Authlete side.
-
CALLER_ERROR
public static final CredentialBatchIssueResponse.Action CALLER_ERROR
The API call is invalid.
-
-
Method Detail
-
values
public static CredentialBatchIssueResponse.Action[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (CredentialBatchIssueResponse.Action c : CredentialBatchIssueResponse.Action.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CredentialBatchIssueResponse.Action valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
-