All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.hyperledger.aries.api.resolver.DIDDocument Maven / Gradle / Ivy

    There is a newer version: 0.10.0
    Show newest version
    /*
 * 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.resolver;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.google.gson.annotations.SerializedName;
import lombok.*;
import org.apache.commons.lang3.StringUtils;

import java.util.List;
import java.util.Optional;

/**
 * W3C Did Document
 * https://www.w3.org/TR/did-core/#core-properties
 */
@JsonPropertyOrder({"context", "id"})
@Data @NoArgsConstructor @AllArgsConstructor @Builder
public class DIDDocument {

    public static final String ENDPOINT_TYPE_DID_COMM = "did-communication";

    public static final String ENDPOINT_TYPE_PROFILE = "profile";

    @JsonProperty("@context")
    @SerializedName("@context")
    private List context = List.of("https://www.w3.org/ns/did/v1");

    private String id;

    @SerializedName("alsoKnownAs")
    private List alsoKnownAs;

    private String controller;

    @SerializedName("verificationMethod")
    private List verificationMethod;

    // structures below have the following content:
    // String did = indexAt[0], VerificationMethod method = indexAt[1]
    private List authentication;
    @SerializedName("assertionMethod")
    private List assertionMethod;
    @SerializedName("keyAgreement")
    private List keyAgreement;
    @SerializedName("capabilityInvocation")
    private List capabilityInvocation;
    @SerializedName("capabilityDelegation")
    private List capabilityDelegation;

    private List service;

    @Data
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    public static final class VerificationMethod {
        private String id;
        private String type;
        private String controller;
        @SerializedName("publicKeyBase58")
        private String publicKeyBase58;
    }

    /**
     * @see did-core/#service-endpoints
     */
    @Data
    @Builder
    @NoArgsConstructor
    @AllArgsConstructor
    public static final class Service {
        private String id;
        private String type;
        @SerializedName("serviceEndpoint")
        private String serviceEndpoint;
        @SerializedName("recipientKeys")
        private List recipientKeys;
        @SerializedName("routingKeys")
        private List routingKeys;
        private Integer priority;
    }

    public List getService() {
        if (service == null) {
            return List.of();
        }
        return service;
    }

    public Optional findPublicProfileUrl() {
        return findUrlByType(ENDPOINT_TYPE_PROFILE);
    }

    public Optional findAriesEndpointUrl() {
        return findUrlByType(ENDPOINT_TYPE_DID_COMM);
    }

    private Optional findUrlByType(@NonNull String type) {
        return getService()
                .stream()
                .filter(s -> StringUtils.equals(type, s.getType()))
                .findFirst()
                .map(Service::getServiceEndpoint);
    }

    public boolean hasProfileEndpoint() {
        return getService().stream().anyMatch(s -> StringUtils.equals(ENDPOINT_TYPE_PROFILE, s.getType()));
    }

    public boolean hasAriesEndpoint() {
        return getService().stream().anyMatch(s -> StringUtils.equals(ENDPOINT_TYPE_DID_COMM, s.getType()));
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy