JCL-363: Rework verification response object (#477)

Author: acoburn

access-grant/src/main/java/com/inrupt/client/accessgrant/AccessCredentialVerification.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright 2023 Inrupt Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+ * Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+ * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+package com.inrupt.client.accessgrant;
+
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * The response from a verification operation.
+ */
+public class AccessCredentialVerification {
+
+    private final List<String> checks;
+    private final List<String> warnings;
+    private final List<String> errors;
+
+    /**
+     * Create a verification response.
+     *
+     * @param checks the checks that were performed
+     * @param warnings any warnings from the verification operation
+     * @param errors any errors from the verification operation
+     */
+    public AccessCredentialVerification(final List<String> checks, final List<String> warnings,
+            final List<String> errors) {
+        this.checks = makeImmutable(checks);
+        this.warnings = makeImmutable(warnings);
+        this.errors = makeImmutable(errors);
+    }
+
+    /**
+     * The verification checks that were performed.
+     *
+     * @return an unmodifiable list of any verification checks performed, never {@code null}
+     */
+    public List<String> getChecks() {
+        return checks;
+    }
+
+    /**
+     * The verification warnings that were discovered.
+     *
+     * @return an unmodifiable list of any verification warnings, never {@code null}
+     */
+    public List<String> getWarnings() {
+        return warnings;
+    }
+
+    /**
+     * The verification errors that were discovered.
+     *
+     * @return an unmodifiable list of any verification errors, never {@code null}
+     */
+    public List<String> getErrors() {
+        return errors;
+    }
+
+    static List<String> makeImmutable(final List<String> list) {
+        if (list != null) {
+            return Collections.unmodifiableList(list);
+        }
+        return Collections.emptyList();
+    }
+}
+

access-grant/src/main/java/com/inrupt/client/accessgrant/AccessGrantClient.java

@@ -289,7 +289,7 @@ public CompletionStage<AccessGrant> issue(final URI type, final URI agent, final
      * @param credential the credential to verify
      * @return the next stage of completion containing the verification result
      */
-    public CompletionStage<VerificationResponse> verify(final AccessCredential credential) {
+    public CompletionStage<AccessCredentialVerification> verify(final AccessCredential credential) {
         return v1Metadata().thenCompose(metadata -> {
 
             final Map<String, Object> presentation = new HashMap<>();
@@ -312,7 +312,9 @@ public CompletionStage<VerificationResponse> verify(final AccessCredential crede
                     try (final InputStream input = res.body()) {
                         final int status = res.statusCode();
                         if (isSuccess(status)) {
-                            return processVerificationResult(input);
+                            final VerificationResponseData data = jsonService.fromJson(input,
+                                    VerificationResponseData.class);
+                            return new AccessCredentialVerification(data.checks, data.warnings, data.errors);
                         }
                         throw new AccessGrantException("Unable to perform Access Grant verify: HTTP error " + status,
                                 status);
@@ -544,10 +546,6 @@ <T extends AccessCredential> T processVerifiableCredential(final InputStream inp
         throw new AccessGrantException("Invalid Access Grant: missing supported type");
     }
 
-    VerificationResponse processVerificationResult(final InputStream input) throws IOException {
-        return jsonService.fromJson(input, VerificationResponse.class);
-    }
-
     <T extends AccessCredential> List<T> processQueryResponse(final InputStream input, final Set<String> validTypes,
             final Class<T> clazz) throws IOException {
         final Map<String, Object> data = jsonService.fromJson(input,
@@ -778,9 +776,9 @@ static boolean isAccessRequest(final URI type) {
     }
 
     /**
-     * A data objects for verification responses.
+     * A data object for verification responses.
      */
-    public static class VerificationResponse {
+    static class VerificationResponseData {
         /**
          * The verification checks that were performed.
          */

access-grant/src/test/java/com/inrupt/client/accessgrant/AccessGrantClientTest.java

@@ -101,10 +101,10 @@ void testFetch1() {
         assertEquals(uri, grant.getIdentifier());
         assertEquals(baseUri, grant.getIssuer());
 
-        final AccessGrantClient.VerificationResponse response = client.verify(grant).toCompletableFuture().join();
-        assertTrue(response.checks.contains("expirationDate"));
-        assertTrue(response.warnings.isEmpty());
-        assertTrue(response.errors.isEmpty());
+        final AccessCredentialVerification response = client.verify(grant).toCompletableFuture().join();
+        assertTrue(response.getChecks().contains("expirationDate"));
+        assertTrue(response.getWarnings().isEmpty());
+        assertTrue(response.getErrors().isEmpty());
 
         // Revoke
         assertDoesNotThrow(client.revoke(grant).toCompletableFuture()::join);
@@ -144,10 +144,10 @@ void testFetchDeprecated() {
         assertEquals(uri, grant.getIdentifier());
         assertEquals(baseUri, grant.getIssuer());
 
-        final AccessGrantClient.VerificationResponse response = client.verify(grant).toCompletableFuture().join();
-        assertTrue(response.checks.contains("expirationDate"));
-        assertTrue(response.warnings.isEmpty());
-        assertTrue(response.errors.isEmpty());
+        final AccessCredentialVerification response = client.verify(grant).toCompletableFuture().join();
+        assertTrue(response.getChecks().contains("expirationDate"));
+        assertTrue(response.getWarnings().isEmpty());
+        assertTrue(response.getErrors().isEmpty());
 
         // Revoke
         assertDoesNotThrow(client.revoke(grant).toCompletableFuture()::join);
@@ -197,10 +197,10 @@ void testFetch5() {
         assertEquals(uri, request.getIdentifier());
         assertEquals(baseUri, request.getIssuer());
 
-        final AccessGrantClient.VerificationResponse response = client.verify(request).toCompletableFuture().join();
-        assertTrue(response.checks.contains("expirationDate"));
-        assertTrue(response.warnings.isEmpty());
-        assertTrue(response.errors.isEmpty());
+        final AccessCredentialVerification response = client.verify(request).toCompletableFuture().join();
+        assertTrue(response.getChecks().contains("expirationDate"));
+        assertTrue(response.getWarnings().isEmpty());
+        assertTrue(response.getErrors().isEmpty());
 
         // Revoke
         final CompletionException err1 = assertThrows(CompletionException.class, () ->