org.hyperledger.aries.api.present_proof.PresentProofRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aries-client-python Show documentation
Aries Cloud Agent - Python: Java client implementation
There is a newer version: 0.10.0
/*
 * Copyright (c) 2020-2021 - for information on the respective copyright owner
 * see the NOTICE file and/or the repository at
 * https://github.com/hyperledger-labs/acapy-java-client
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package org.hyperledger.aries.api.present_proof;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import com.google.gson.annotations.SerializedName;
import lombok.*;
import org.hyperledger.acy_py.generated.model.IndyProofReqPredSpec;
import org.hyperledger.aries.api.serializer.JsonObjectArrayDeserializer;
import org.hyperledger.aries.api.serializer.JsonObjectArraySerializer;
import org.hyperledger.aries.config.CredDefId;
import org.hyperledger.aries.config.GsonConfig;

import java.util.List;
import java.util.Map;

/**
 * Aka PresentationSendRequestRequest
 * This model is used to send a presentation request, or in other words to request a proof.
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class PresentProofRequest {

    private String connectionId;

    @NonNull
    private ProofRequest proofRequest;

    private Boolean trace;

    private String comment;

    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    @Builder
    public static class ProofRequest {

        @Builder.Default
        private String name = "Proof request";

        @Builder.Default
        private String version = "1.0";

        private String nonce;

        private ProofNonRevoked nonRevoked;

        @Singular
        private Map requestedAttributes;

        @Singular
        private Map requestedPredicates;

        @Data
        @NoArgsConstructor
        @AllArgsConstructor
        @Builder
        public static class ProofRequestedAttributes {
            private String name;
            /**
             * @since 0.5.4
             */
            private List names;
            private ProofNonRevoked nonRevoked;
            @Singular
            @JsonSerialize(using = JsonObjectArraySerializer.class)
            @JsonDeserialize(using = JsonObjectArrayDeserializer.class)
            private List restrictions;
        }

        @Data
        @NoArgsConstructor
        @AllArgsConstructor
        @Builder
        public static class ProofRequestedPredicates {
            private String name;
            private ProofNonRevoked nonRevoked;
            private IndyProofReqPredSpec.PTypeEnum pType;
            private Integer pValue;
            @Singular
            @JsonSerialize(using = JsonObjectArraySerializer.class)
            @JsonDeserialize(using = JsonObjectArrayDeserializer.class)
            private List restrictions;
        }

        @Data
        @NoArgsConstructor
        @AllArgsConstructor
        @Builder
        public static class ProofNonRevoked {
            // epoch seconds e.g. Instant.now().getEpochSecond()
            private Long from;
            private Long to;

            public boolean isSet() {
                return from != null || to != null;
            }
        }

        @Data
        @NoArgsConstructor
        @AllArgsConstructor
        @Builder
        public static class ProofRestrictions {
            private String schemaId;

            private String schemaName;

            private String schemaVersion;

            private String schemaIssuerDid;

            @SerializedName(value = CredDefId.CRED_DEF_ID, alternate = CredDefId.CREDENTIAL_DEFINITION_ID)
            private String credentialDefinitionId;

            private String issuerDid;

            @Singular
            private transient Map genericRestrictions;

            public JsonObject toJsonObject() {
                JsonObject result = GsonConfig.defaultConfig().toJsonTree(this)
                        .getAsJsonObject();
                return flattenGenericRestrictions(result);
            }

            public static ProofRestrictions fromJsonObject(@NonNull JsonObject json) {
                ProofRestrictions result = GsonConfig.defaultConfig().fromJson(json, ProofRestrictions.class);
                json.keySet().stream().filter(key -> key.startsWith("attr::")).findFirst().ifPresent(key ->
                        result.setGenericRestrictions(Map.of(key, json.get(key).getAsString())));
                return result;
            }

            @NonNull
            private JsonObject flattenGenericRestrictions(@NonNull JsonObject result) {
                genericRestrictions.forEach((k,v)-> result.add(k,new JsonPrimitive(v)));
                return result;
            }

            // This extends the lombok generated builder with contained methods.
            public static class ProofRestrictionsBuilder{
                public ProofRestrictionsBuilder addAttributeValueRestriction(@NonNull String name, @NonNull String value) {
                    this.genericRestriction("attr::" + name + "::value", value);
                    return this;
                }
            }
        }
    }
}