Package org.hyperledger.aries.api.issue_credential_v1

Enum CredentialExchangeState

  • All Implemented Interfaces:
    Serializable, Comparable<CredentialExchangeState>
    public enum CredentialExchangeState
extends Enum<CredentialExchangeState>
    Manual credential exchange via aca-py rest api: 1. Holder: /issue-credential/send-proposal 2. Issuer: /issue-credential/records/{id}/send-offer 3. Holder: /issue-credential/records/{id}/send-request 4. Issuer: /issue-credential/records/{id}/send 5. Holder:/issue-credential/records/{id}/store

    • Enum Constant Detail

      • PROPOSAL_SENT

        @SerializedName(value="proposal_sent",
                alternate="proposal-sent")
public static final CredentialExchangeState PROPOSAL_SENT
        Step 1: Holder sends proposal to issuer

      • PROPOSAL_RECEIVED

        @SerializedName(value="proposal_received",
                alternate="proposal-received")
public static final CredentialExchangeState PROPOSAL_RECEIVED
        Step 1: Issuer receives credential proposal from holder

      • OFFER_SENT

        @SerializedName(value="offer_sent",
                alternate="offer-sent")
public static final CredentialExchangeState OFFER_SENT
        Step 2: Issuer sends counter offer to holder, issuer can also start the process by sending an offer without receiving a proposal first

      • OFFER_RECEIVED

        @SerializedName(value="offer_received",
                alternate="offer-received")
public static final CredentialExchangeState OFFER_RECEIVED
        Step 2: Holder receives (counter) offer from issuer

      • REQUEST_SENT

        @SerializedName(value="request_sent",
                alternate="request-sent")
public static final CredentialExchangeState REQUEST_SENT
        Step 3: Holder requests credential from issuer

      • REQUEST_RECEIVED

        @SerializedName(value="request_received",
                alternate="request-received")
public static final CredentialExchangeState REQUEST_RECEIVED
        Step 3: Issuer receives credential request from holder

      • CREDENTIAL_ISSUED

        @SerializedName(value="credential_issued",
                alternate="credential-issued")
public static final CredentialExchangeState CREDENTIAL_ISSUED
        Step 4: Issuer sends credential to holder

      • CREDENTIAL_RECEIVED

        @SerializedName(value="credential_received",
                alternate="credential-received")
public static final CredentialExchangeState CREDENTIAL_RECEIVED
        Step 4: Holder receives credential from issuer

      • CREDENTIAL_ACKED

        @SerializedName(value="credential_acked",
                alternate="credential-acked")
public static final CredentialExchangeState CREDENTIAL_ACKED
        V1 state only Step5: Credential exchange completed

      • DONE

        @SerializedName("done")
public static final CredentialExchangeState DONE
        V2 state only Step 5: Credential exchange completed

      • CREDENTIAL_REVOKED

        @SerializedName(value="credential_revoked",
                alternate={"revoked","credential-revoked"})
public static final CredentialExchangeState CREDENTIAL_REVOKED
        Credential has been revoked

      • ABANDONED

        @SerializedName("abandoned")
public static final CredentialExchangeState ABANDONED
        Credential exchange abandoned

      • DECLINED

        @SerializedName("declined")
public static final CredentialExchangeState DECLINED
        Not an aries state, but useful in business logic reacting on these states

      • PROBLEM

        @SerializedName("problem")
public static final CredentialExchangeState PROBLEM
        Not an aries state, but useful in business logic reacting on these states

    • Method Detail

      • values

        public static CredentialExchangeState[] 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 (CredentialExchangeState c : CredentialExchangeState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CredentialExchangeState 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 name
        NullPointerException - if the argument is null