JCL-476: Adjust ProblemDetails API (#1393)

acoburn · web-flow · commit acbc518d0f7a · 2024-07-03T17:00:03.000+02:00
diff --git a/access-grant/pom.xml b/access-grant/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
   </properties>
 
   <dependencies>
diff --git a/api/pom.xml b/api/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
   </properties>
 
   <dependencies>
diff --git a/api/src/main/java/com/inrupt/client/ProblemDetails.java b/api/src/main/java/com/inrupt/client/ProblemDetails.java
@@ -37,7 +37,7 @@ public interface ProblemDetails {
     /**
      * The <a href="https://www.rfc-editor.org/rfc/rfc9457">RFC9457</a> default problem type.
      */
-    String DEFAULT_TYPE = "about:blank";
+    URI DEFAULT_TYPE = URI.create("about:blank");
 
     /**
      * The problem type.
@@ -52,10 +52,10 @@ public interface ProblemDetails {
     String getTitle();
 
     /**
-     * The problem details.
-     * @return the details
+     * The problem detail.
+     * @return the detail
      */
-    String getDetails();
+    String getDetail();
 
     /**
      * The problem status code.
diff --git a/core/pom.xml b/core/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
   </properties>
 
   <dependencyManagement>
diff --git a/examples/cli/pom.xml b/examples/cli/pom.xml
@@ -16,8 +16,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>17</maven.compiler.target>
-    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.release>17</maven.compiler.release>
 
     <quarkus.version>3.12.0</quarkus.version>
   </properties>
diff --git a/examples/spring-web/pom.xml b/examples/spring-web/pom.xml
@@ -16,8 +16,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>17</maven.compiler.target>
-    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.release>17</maven.compiler.release>
     <springboot.version>3.3.1</springboot.version>
   </properties>
 
diff --git a/examples/springboot/pom.xml b/examples/springboot/pom.xml
@@ -16,8 +16,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>17</maven.compiler.target>
-    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.release>17</maven.compiler.release>
     <springboot.version>3.3.1</springboot.version>
   </properties>
 
diff --git a/examples/webapp/pom.xml b/examples/webapp/pom.xml
@@ -16,8 +16,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>17</maven.compiler.target>
-    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.release>17</maven.compiler.release>
 
     <quarkus.version>3.12.0</quarkus.version>
   </properties>
diff --git a/okhttp/pom.xml b/okhttp/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
   </properties>
 
   <dependencies>
diff --git a/openid/pom.xml b/openid/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
   </properties>
 
   <dependencies>
diff --git a/parser/pom.xml b/parser/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
   </properties>
 
   <dependencies>
diff --git a/pom.xml b/pom.xml
@@ -14,8 +14,7 @@
 
   <properties>
     <maven.compiler.parameters>true</maven.compiler.parameters>
-    <maven.compiler.source>11</maven.compiler.source>
-    <maven.compiler.target>11</maven.compiler.target>
+    <maven.compiler.release>11</maven.compiler.release>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 
diff --git a/quarkus/pom.xml b/quarkus/pom.xml
@@ -13,11 +13,6 @@
       Integration utilities for Quarkus support.
   </description>
 
-  <properties>
-    <maven.compiler.target>11</maven.compiler.target>
-    <maven.compiler.source>11</maven.compiler.source>
-  </properties>
-
   <dependencyManagement>
     <dependencies>
       <dependency>
diff --git a/rdf-legacy/pom.xml b/rdf-legacy/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
 
     <!-- version management -->
     <commons.text.version>1.12.0</commons.text.version>
diff --git a/rdf4j/pom.xml b/rdf4j/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
     <rdf4j.version>5.0.0</rdf4j.version>
   </properties>
 
diff --git a/solid/pom.xml b/solid/pom.xml
@@ -14,8 +14,7 @@
   </description>
 
   <properties>
-    <maven.compiler.target>1.8</maven.compiler.target>
-    <maven.compiler.source>1.8</maven.compiler.source>
+    <maven.compiler.release>8</maven.compiler.release>
   </properties>
 
   <dependencies>
@@ -29,6 +28,11 @@
       <artifactId>inrupt-client-vocabulary</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>${slf4j.version}</version>
+    </dependency>
 
     <!-- test dependencies -->
     <dependency>
@@ -85,12 +89,6 @@
       <version>${project.version}</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>org.slf4j</groupId>
-      <artifactId>slf4j-api</artifactId>
-      <version>${slf4j.version}</version>
-      <scope>test</scope>
-    </dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-simple</artifactId>
diff --git a/solid/src/main/java/com/inrupt/client/solid/SolidClientException.java b/solid/src/main/java/com/inrupt/client/solid/SolidClientException.java
@@ -97,7 +97,7 @@ public String getBody() {
      * @return the problem details object
      */
     public ProblemDetails getProblemDetails() {
-        return SolidProblemDetails.fromErrorResponse(statusCode, headers, body.getBytes());
+        return SolidProblemDetails.fromErrorResponse(uri, statusCode, headers, body.getBytes());
     }
 
     /**
diff --git a/solid/src/main/java/com/inrupt/client/solid/SolidProblemDetails.java b/solid/src/main/java/com/inrupt/client/solid/SolidProblemDetails.java
@@ -27,16 +27,21 @@
 
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.net.URI;
 import java.util.Optional;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 public class SolidProblemDetails implements ProblemDetails {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(SolidProblemDetails.class);
     private static final long serialVersionUID = -4597170432270957765L;
 
     private final URI type;
     private final String title;
-    private final String details;
+    private final String detail;
     private final int status;
     private final URI instance;
     private static JsonService jsonService;
@@ -47,20 +52,20 @@ public class SolidProblemDetails implements ProblemDetails {
      * <a href="https://www.rfc-editor.org/rfc/rfc9457">RFC9457</a>.
      * @param type the problem type
      * @param title the problem title
-     * @param details the problem details
+     * @param detail the problem details
      * @param status the error response status code
      * @param instance the problem instance
      */
     public SolidProblemDetails(
         final URI type,
         final String title,
-        final String details,
+        final String detail,
         final int status,
         final URI instance
     ) {
         this.type = type;
         this.title = title;
-        this.details = details;
+        this.detail = detail;
         this.status = status;
         this.instance = instance;
     }
@@ -76,8 +81,8 @@ public String getTitle() {
     }
 
     @Override
-    public String getDetails() {
-        return this.details;
+    public String getDetail() {
+        return this.detail;
     }
 
     @Override
@@ -103,9 +108,9 @@ static class Data {
          */
         public String title;
         /**
-         * The problem details.
+         * The problem detail.
          */
-        public String details;
+        public String detail;
         /**
          * The problem status code.
          */
@@ -133,51 +138,30 @@ private static JsonService getJsonService() {
 
     /**
      * Builds a {@link ProblemDetails} instance from an HTTP error response.
+     * @param uri the original URI
      * @param statusCode the HTTP error response status code
      * @param headers the HTTP error response headers
      * @param body the HTTP error response body
      * @return a {@link ProblemDetails} instance
      */
-    public static SolidProblemDetails fromErrorResponse(
-            final int statusCode,
-            final Headers headers,
-            final byte[] body
-    ) {
+    static SolidProblemDetails fromErrorResponse(final URI uri, final int statusCode, final Headers headers,
+            final byte[] body) {
         final JsonService jsonService = getJsonService();
-        if (jsonService == null
-                || (headers != null && !headers.allValues("Content-Type").contains(ProblemDetails.MIME_TYPE))) {
-            return new SolidProblemDetails(
-                URI.create(ProblemDetails.DEFAULT_TYPE),
-                null,
-                null,
-                statusCode,
-                null
-            );
-        }
-        try {
-            final Data pdData = jsonService.fromJson(
-                    new ByteArrayInputStream(body),
-                    Data.class
-            );
-            final URI type = Optional.ofNullable(pdData.type)
-                .orElse(URI.create(ProblemDetails.DEFAULT_TYPE));
-            // JSON mappers map invalid integers to 0, which is an invalid value in our case anyway.
-            final int status = Optional.of(pdData.status).filter(s -> s != 0).orElse(statusCode);
-            return new SolidProblemDetails(
-                    type,
-                    pdData.title,
-                    pdData.details,
-                    status,
-                    pdData.instance
-            );
-        } catch (IOException e) {
-            return new SolidProblemDetails(
-                URI.create(ProblemDetails.DEFAULT_TYPE),
-                null,
-                null,
-                statusCode,
-                null
-            );
+        if (jsonService != null
+                && (headers != null && headers.allValues("Content-Type").contains(ProblemDetails.MIME_TYPE))) {
+            try (final InputStream input = new ByteArrayInputStream(body)) {
+                final Data pdData = jsonService.fromJson(input, Data.class);
+                final URI type = Optional.ofNullable(pdData.type)
+                    .map(uri::resolve)
+                    .orElse(ProblemDetails.DEFAULT_TYPE);
+                final URI instance = pdData.instance != null ? uri.resolve(pdData.instance) : null;
+                // JSON mappers map invalid integers to 0, which is an invalid value in our case anyway.
+                final int status = Optional.of(pdData.status).filter(s -> s != 0).orElse(statusCode);
+                return new SolidProblemDetails(type, pdData.title, pdData.detail, status, instance);
+            } catch (IOException e) {
+                LOGGER.debug("Unable to parse ProblemDetails response from server", e);
+            }
         }
+        return new SolidProblemDetails(ProblemDetails.DEFAULT_TYPE, null, null, statusCode, null);
     }
 }
diff --git a/solid/src/test/java/com/inrupt/client/solid/SolidClientTest.java b/solid/src/test/java/com/inrupt/client/solid/SolidClientTest.java
@@ -412,10 +412,10 @@ public int statusCode() {
         assertEquals(statusCode, exception.getStatusCode());
         // The following assertions check that in absence of an RFC9457 compliant response, we properly initialize the
         // default values for the attached Problem Details.
-        assertEquals(ProblemDetails.DEFAULT_TYPE, exception.getProblemDetails().getType().toString());
+        assertEquals(ProblemDetails.DEFAULT_TYPE, exception.getProblemDetails().getType());
         assertEquals(statusCode, exception.getProblemDetails().getStatus());
         assertNull(exception.getProblemDetails().getTitle());
-        assertNull(exception.getProblemDetails().getDetails());
+        assertNull(exception.getProblemDetails().getDetail());
         assertNull(exception.getProblemDetails().getInstance());
     }
 
@@ -487,7 +487,7 @@ public int statusCode() {
         assertEquals(problemDetails.getType(), exception.getProblemDetails().getType());
         assertEquals(problemDetails.getTitle(), exception.getProblemDetails().getTitle());
         assertEquals(problemDetails.getStatus(), exception.getProblemDetails().getStatus());
-        assertEquals(problemDetails.getDetails(), exception.getProblemDetails().getDetails());
+        assertEquals(problemDetails.getDetail(), exception.getProblemDetails().getDetail());
         assertEquals(problemDetails.getInstance(), exception.getProblemDetails().getInstance());
     }
 
@@ -606,10 +606,10 @@ public int statusCode() {
         );
         assertEquals(statusCode, exception.getStatusCode());
         // On malformed response, the ProblemDetails should fall back to defaults.
-        assertEquals(ProblemDetails.DEFAULT_TYPE, exception.getProblemDetails().getType().toString());
+        assertEquals(ProblemDetails.DEFAULT_TYPE, exception.getProblemDetails().getType());
         assertNull(exception.getProblemDetails().getTitle());
         assertEquals(statusCode, exception.getProblemDetails().getStatus());
-        assertNull(exception.getProblemDetails().getDetails());
+        assertNull(exception.getProblemDetails().getDetail());
         assertNull(exception.getProblemDetails().getInstance());
     }
 
@@ -653,10 +653,10 @@ public int statusCode() {
         );
         assertEquals(statusCode, exception.getStatusCode());
         // On malformed response, the ProblemDetails should fall back to defaults.
-        assertEquals(ProblemDetails.DEFAULT_TYPE, exception.getProblemDetails().getType().toString());
+        assertEquals(ProblemDetails.DEFAULT_TYPE, exception.getProblemDetails().getType());
         assertNull(exception.getProblemDetails().getTitle());
         assertEquals(statusCode, exception.getProblemDetails().getStatus());
-        assertNull(exception.getProblemDetails().getDetails());
+        assertNull(exception.getProblemDetails().getDetail());
         assertNull(exception.getProblemDetails().getInstance());
     }
 }
diff --git a/solid/src/test/java/com/inrupt/client/solid/SolidProblemDetailsTest.java b/solid/src/test/java/com/inrupt/client/solid/SolidProblemDetailsTest.java
diff --git a/spring/pom.xml b/spring/pom.xml
diff --git a/uma/pom.xml b/uma/pom.xml
