Simplify DidDocument API

Author: filip26

README.md

@@ -1,10 +1,9 @@
-# Carbon DID
+# Carbon Decentralized Identifiers
 An implementation of the Decentralized Identifiers (DIDs) Primitives & API in Java.
 
 
 [![Java 8 CI](https://github.com/filip26/carbon-did-core/actions/workflows/java8-build.yml/badge.svg)](https://github.com/filip26/carbon-did-core/actions/workflows/java8-build.yml)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/dd79aafc6eb14ed18f2217de62585ba7)](https://app.codacy.com/gh/filip26/carbon-decentralized-identifiers/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
-[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/dd79aafc6eb14ed18f2217de62585ba7)](https://app.codacy.com/gh/filip26/carbon-decentralized-identifiers/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/dd79aafc6eb14ed18f2217de62585ba7)](https://app.codacy.com/gh/filip26/carbon-did-core/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Maven Central](https://img.shields.io/maven-central/v/com.apicatalog/carbon-did.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:com.apicatalog%20AND%20a:carbon-did)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
@@ -49,8 +48,10 @@ Fork and clone the project repository.
 
 ## Resources
 
-- [Decentralized Identifiers (DIDs) v1.0](https://www.w3.org/TR/did-core/)
+- [W3C Decentralized Identifiers (DIDs) v1.0](https://www.w3.org/TR/did-core/)
+- [W3C Controlled Identifiers v1.0](https://www.w3.org/TR/cid-1.0/)
 - [Carbon DID Key Method](https://github.com/filip26/carbon-did-key)
+- [Carbon Controlled Identifiers](https://github.com/filip26/carbon-cid)
 
 ## Sponsors
 

SECURITY.md

@@ -2,9 +2,10 @@
 
 ## Supported Versions
 
-| Version | Supported          |
-| ------- |:------------------:|
+| Version | Supported |
+| ------- |:---------:|
 | 0.x.x   | ❌ |
+| 1.x.x   |  |
 
 ## Reporting a Vulnerability
 

src/main/java/com/apicatalog/did/document/DidDocument.java

@@ -1,8 +1,8 @@
 package com.apicatalog.did.document;
 
 import java.net.URI;
+import java.util.Collection;
 import java.util.Collections;
-import java.util.Set;
 
 import com.apicatalog.did.Did;
 
@@ -28,7 +28,7 @@ public interface DidDocument {
      *
      * @return controller set, possibly empty
      */
-    default Set<Did> controller() {
+    default Collection<Did> controller() {
         return Collections.emptySet();
     }
 
@@ -38,7 +38,7 @@ default Set<Did> controller() {
      *
      * @return verification methods, possibly empty
      */
-    default Set<DidVerificationMethod> verification() {
+    default Collection<DidVerificationMethod> verification() {
         return Collections.emptySet();
     }
 
@@ -48,7 +48,7 @@ default Set<DidVerificationMethod> verification() {
      *
      * @return URIs, possibly empty
      */
-    default Set<URI> alsoKnownAs() {
+    default Collection<URI> alsoKnownAs() {
         return Collections.emptySet();
     }
 
@@ -58,7 +58,7 @@ default Set<URI> alsoKnownAs() {
      *
      * @return authentication methods, possibly empty
      */
-    default Set<DidVerificationMethod> authentication() {
+    default Collection<DidVerificationMethod> authentication() {
         return Collections.emptySet();
     }
 
@@ -67,7 +67,7 @@ default Set<DidVerificationMethod> authentication() {
      *
      * @return assertion methods, possibly empty
      */
-    default Set<DidVerificationMethod> assertion() {
+    default Collection<DidVerificationMethod> assertion() {
         return Collections.emptySet();
     }
 
@@ -76,7 +76,7 @@ default Set<DidVerificationMethod> assertion() {
      *
      * @return key agreement methods, possibly empty
      */
-    default Set<DidVerificationMethod> keyAgreement() {
+    default Collection<DidVerificationMethod> keyAgreement() {
         return Collections.emptySet();
     }
 
@@ -86,7 +86,7 @@ default Set<DidVerificationMethod> keyAgreement() {
      *
      * @return invocation methods, possibly empty
      */
-    default Set<DidVerificationMethod> capabilityInvocation() {
+    default Collection<DidVerificationMethod> capabilityInvocation() {
         return Collections.emptySet();
     }
 
@@ -96,7 +96,7 @@ default Set<DidVerificationMethod> capabilityInvocation() {
      *
      * @return delegation methods, possibly empty
      */
-    default Set<DidVerificationMethod> capabilityDelegation() {
+    default Collection<DidVerificationMethod> capabilityDelegation() {
         return Collections.emptySet();
     }
 
@@ -105,7 +105,7 @@ default Set<DidVerificationMethod> capabilityDelegation() {
      *
      * @return service definitions, possibly empty
      */
-    default Set<DidService> service() {
+    default Collection<DidService> service() {
         return Collections.emptySet();
     }
 

src/main/java/com/apicatalog/did/resolver/DidMethodResolver.java

@@ -0,0 +1,57 @@
+package com.apicatalog.did.resolver;
+
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.Objects;
+
+import com.apicatalog.did.Did;
+import com.apicatalog.did.resolver.DidResolutionException.Code;
+
+public class DidMethodResolver implements DidResolver {
+
+    protected final Map<String, DidResolver> resolvers;
+
+    protected DidMethodResolver(final Map<String, DidResolver> resolvers) {
+        this.resolvers = resolvers;
+    }
+
+    @Override
+    public ResolvedDidDocument resolve(Did did) throws DidResolutionException {
+
+        Objects.requireNonNull(did);
+
+        final DidResolver resolver = resolvers.get(did.getMethod());
+
+        if (resolver == null) {
+            throw new DidResolutionException(did, Code.UnsupportedMethod);
+        }
+        return resolver.resolve(did);
+    }
+
+    public static Builder with(String method, DidResolver resolver) {
+        return (new Builder()).with(method, resolver);
+    }
+
+    public static class Builder {
+
+        final Map<String, DidResolver> resolvers;
+
+        Builder() {
+            this.resolvers = new LinkedHashMap<>();
+        }
+
+        public Builder with(String method, DidResolver resolver) {
+            resolvers.put(method, resolver);
+            return this;
+        }
+
+        public DidResolver build() {
+            if (resolvers.size() == 1) {
+                return resolvers.values().iterator().next();
+            }
+            return new DidMethodResolver(Collections.unmodifiableMap(resolvers));
+        }
+    }
+
+}

src/main/java/com/apicatalog/did/resolver/DidResolver.java

@@ -7,6 +7,7 @@
  * A <a href="https://www.w3.org/TR/did-core/#dfn-did-resolvers">DID
  * Resolver</a> expands a {@link Did} into a corresponding {@link DidDocument}.
  */
+@FunctionalInterface
 public interface DidResolver {
 
     /**

src/test/java/com/apicatalog/did/DidTest.java

@@ -32,17 +32,6 @@ void ofString(String uri, String method, String specificId) {
         assertEquals(specificId, did.getMethodSpecificId());
     }
 
-    @DisplayName("!of(String)")
-    @ParameterizedTest()
-    @MethodSource({ "negativeVectors" })
-    void ofStringNegative(String uri) {
-        try {
-            Did.of(uri);
-            fail();
-        } catch (IllegalArgumentException e) {
-            /* expected */ }
-    }
-
     @DisplayName("of(URI)")
     @ParameterizedTest(name = "{0}")
     @MethodSource({ "positiveVectors" })
@@ -65,7 +54,18 @@ void toString(String input, String method, String specificId) {
         assertEquals(input, did.toString());
     }
 
-    @DisplayName("!of(URI)")
+    @DisplayName("negative: of(String)")
+    @ParameterizedTest()
+    @MethodSource({ "negativeVectors" })
+    void ofStringNegative(String uri) {
+        try {
+            Did.of(uri);
+            fail();
+        } catch (IllegalArgumentException e) {
+            /* expected */ }
+    }
+
+    @DisplayName("negative: of(URI)")
     @ParameterizedTest()
     @MethodSource({ "negativeVectors" })
     void ofUriNegative(String uri) {
@@ -92,8 +92,8 @@ void toUri(String input, String method, String specificId) {
     void stringIsDid(String uri) {
         assertTrue(Did.isDid(uri));
     }
-
-    @DisplayName("isNotDid(String)")
+    
+    @DisplayName("negative: isDid(String)")
     @ParameterizedTest()
     @MethodSource({ "negativeVectors" })
     void stringIsNotDid(String uri) {