Release: com.io7m.darco 2.0.0

Change: (Backwards incompatible) Allow for passing in SAX parser factories explicitly.
Change: Update ch.qos.logback:logback-classic:1.5.7 → 1.5.8.
Change: Update io.opentelemetry:opentelemetry-bom:1.41.0 → 1.42.0.

README-CHANGES.xml

@@ -1,9 +1,16 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <c:changelog project="com.io7m.darco" xmlns:c="urn:com.io7m.changelog:4.0">
   <c:releases>
-    <c:release date="2024-09-01T11:00:18+00:00" is-open="false" ticket-system="com.github.io7m.darco" version="1.0.0">
+    <c:release date="2024-09-01T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.darco" version="1.0.0">
       <c:changes/>
     </c:release>
+    <c:release date="2024-09-07T08:58:36+00:00" is-open="false" ticket-system="com.github.io7m.darco" version="2.0.0">
+      <c:changes>
+        <c:change compatible="false" date="2024-09-06T00:00:00+00:00" summary="Allow for passing in SAX parser factories explicitly."/>
+        <c:change date="2024-09-06T00:00:00+00:00" summary="Update ch.qos.logback:logback-classic:1.5.7 → 1.5.8."/>
+        <c:change date="2024-09-06T00:00:00+00:00" summary="Update io.opentelemetry:opentelemetry-bom:1.41.0 → 1.42.0."/>
+      </c:changes>
+    </c:release>
   </c:releases>
   <c:ticket-systems>
     <c:ticket-system default="true" id="com.github.io7m.darco" url="https://www.github.com/io7m/darco/issues/"/>

com.io7m.darco.api/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.darco</artifactId>
     <groupId>com.io7m.darco</groupId>
-    <version>1.0.0</version>
+    <version>2.0.0</version>
   </parent>
   <artifactId>com.io7m.darco.api</artifactId>
 
@@ -39,6 +39,10 @@
       <groupId>com.io7m.jmulticlose</groupId>
       <artifactId>com.io7m.jmulticlose.core</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.io7m.jxe</groupId>
+      <artifactId>com.io7m.jxe.core</artifactId>
+    </dependency>
 
     <dependency>
       <groupId>org.osgi</groupId>

com.io7m.darco.api/src/main/java/com/io7m/darco/api/DDatabaseConfigurationType.java

@@ -16,12 +16,22 @@
 
 package com.io7m.darco.api;
 
+import com.io7m.jxe.core.JXEHardenedSAXParsers;
+
+import java.util.Optional;
+
 /**
  * The base database configuration.
  */
 
 public interface DDatabaseConfigurationType
 {
+  /**
+   * @return A factory of SAX parsers used to parse database schemas
+   */
+
+  Optional<JXEHardenedSAXParsers> saxParsers();
+
   /**
    * @return The database telemetry interface
    */

com.io7m.darco.api/src/main/java/com/io7m/darco/api/package-info.java

@@ -19,7 +19,7 @@
  */
 
 @Export
-@Version("1.0.0")
+@Version("2.0.0")
 package com.io7m.darco.api;
 
 import org.osgi.annotation.bundle.Export;

com.io7m.darco.api/src/main/java/module-info.java

@@ -24,6 +24,7 @@
   requires static org.osgi.annotation.versioning;
 
   requires com.io7m.jmulticlose.core;
+  requires com.io7m.jxe.core;
   requires com.io7m.lanark.core;
   requires com.io7m.seltzer.api;
   requires io.opentelemetry.api;

com.io7m.darco.examples/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.darco</artifactId>
     <groupId>com.io7m.darco</groupId>
-    <version>1.0.0</version>
+    <version>2.0.0</version>
   </parent>
   <artifactId>com.io7m.darco.examples</artifactId>
 
@@ -35,6 +35,10 @@
       <version>${project.version}</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.io7m.jxe</groupId>
+      <artifactId>com.io7m.jxe.core</artifactId>
+    </dependency>
     <dependency>
       <groupId>com.io7m.jmulticlose</groupId>
       <artifactId>com.io7m.jmulticlose.core</artifactId>

com.io7m.darco.examples/src/main/java/com/io7m/darco/examples/package-info.java

@@ -19,7 +19,7 @@
  */
 
 @Export
-@Version("1.0.0")
+@Version("2.0.0")
 package com.io7m.darco.examples;
 
 import org.osgi.annotation.bundle.Export;

com.io7m.darco.examples/src/main/java/com/io7m/darco/examples/postgresql/EPQDatabaseConfiguration.java

@@ -22,12 +22,15 @@
 import com.io7m.darco.api.DDatabaseUpgrade;
 import com.io7m.darco.api.DUsernamePassword;
 import com.io7m.darco.postgres.DPQDatabaseConfigurationType;
+import com.io7m.jxe.core.JXEHardenedSAXParsers;
 
 import java.util.Objects;
+import java.util.Optional;
 
 /**
  * The configuration information for the example PostgreSQL database.
  *
+ * @param saxParsers      The SAX parser factory
  * @param telemetry       The telemetry interface
  * @param create          The database creation option
  * @param upgrade         The database upgrade option
@@ -40,6 +43,7 @@
  */
 
 public record EPQDatabaseConfiguration(
+  Optional<JXEHardenedSAXParsers> saxParsers,
   DDatabaseTelemetryType telemetry,
   DDatabaseCreate create,
   DDatabaseUpgrade upgrade,
@@ -54,6 +58,7 @@ public record EPQDatabaseConfiguration(
   /**
    * The configuration information for the example PostgreSQL database.
    *
+   * @param saxParsers      The SAX parser factory
    * @param telemetry       The telemetry interface
    * @param create          The database creation option
    * @param upgrade         The database upgrade option
@@ -67,6 +72,7 @@ public record EPQDatabaseConfiguration(
 
   public EPQDatabaseConfiguration
   {
+    Objects.requireNonNull(saxParsers, "saxParsers");
     Objects.requireNonNull(telemetry, "telemetry");
     Objects.requireNonNull(create, "create");
     Objects.requireNonNull(upgrade, "upgrade");

com.io7m.darco.examples/src/main/java/com/io7m/darco/examples/postgresql/package-info.java

@@ -19,7 +19,7 @@
  */
 
 @Export
-@Version("1.0.0")
+@Version("2.0.0")
 package com.io7m.darco.examples.postgresql;
 
 import org.osgi.annotation.bundle.Export;

com.io7m.darco.examples/src/main/java/com/io7m/darco/examples/sqlite/ESDatabaseConfiguration.java

@@ -21,20 +21,24 @@
 import com.io7m.darco.api.DDatabaseTelemetryType;
 import com.io7m.darco.api.DDatabaseUpgrade;
 import com.io7m.darco.sqlite.DSDatabaseConfigurationType;
+import com.io7m.jxe.core.JXEHardenedSAXParsers;
 
 import java.nio.file.Path;
 import java.util.Objects;
+import java.util.Optional;
 
 /**
  * The configuration information for the example SQLite database.
  *
- * @param telemetry The telemetry interface
- * @param create    The database creation option
- * @param upgrade   The database upgrade option
- * @param file      The database file
+ * @param saxParsers The SAX parsers
+ * @param telemetry  The telemetry interface
+ * @param create     The database creation option
+ * @param upgrade    The database upgrade option
+ * @param file       The database file
  */
 
 public record ESDatabaseConfiguration(
+  Optional<JXEHardenedSAXParsers> saxParsers,
   DDatabaseTelemetryType telemetry,
   DDatabaseCreate create,
   DDatabaseUpgrade upgrade,
@@ -44,14 +48,16 @@ public record ESDatabaseConfiguration(
   /**
    * The configuration information for the example SQLite database.
    *
-   * @param telemetry The telemetry interface
-   * @param create    The database creation option
-   * @param upgrade   The database upgrade option
-   * @param file      The database file
+   * @param saxParsers The SAX parsers
+   * @param telemetry  The telemetry interface
+   * @param create     The database creation option
+   * @param upgrade    The database upgrade option
+   * @param file       The database file
    */
 
   public ESDatabaseConfiguration
   {
+    Objects.requireNonNull(saxParsers, "saxParsers");
     Objects.requireNonNull(telemetry, "telemetry");
     Objects.requireNonNull(create, "create");
     Objects.requireNonNull(upgrade, "upgrade");

com.io7m.darco.examples/src/main/java/com/io7m/darco/examples/sqlite/package-info.java

@@ -19,7 +19,7 @@
  */
 
 @Export
-@Version("1.0.0")
+@Version("2.0.0")
 package com.io7m.darco.examples.sqlite;
 
 import org.osgi.annotation.bundle.Export;

com.io7m.darco.examples/src/main/java/module-info.java

@@ -41,6 +41,7 @@
   requires io.opentelemetry.api;
   requires org.slf4j;
   requires org.xerial.sqlitejdbc;
+  requires com.io7m.jxe.core;
 
   uses ESDatabaseQueryProviderType;
   uses EPQDatabaseQueryProviderType;

com.io7m.darco.postgres/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.darco</artifactId>
     <groupId>com.io7m.darco</groupId>
-    <version>1.0.0</version>
+    <version>2.0.0</version>
   </parent>
   <artifactId>com.io7m.darco.postgres</artifactId>
 
@@ -25,6 +25,14 @@
       <version>${project.version}</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.io7m.jxe</groupId>
+      <artifactId>com.io7m.jxe.core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.io7m.anethum</groupId>
+      <artifactId>com.io7m.anethum.api</artifactId>
+    </dependency>
     <dependency>
       <groupId>com.io7m.jmulticlose</groupId>
       <artifactId>com.io7m.jmulticlose.core</artifactId>

com.io7m.darco.postgres/src/main/java/com/io7m/darco/postgres/DPQDatabaseFactory.java

@@ -26,6 +26,7 @@
 import com.io7m.darco.api.DDatabaseType;
 import com.io7m.jmulticlose.core.CloseableCollection;
 import com.io7m.jmulticlose.core.CloseableCollectionType;
+import com.io7m.jxe.core.JXEHardenedSAXParsers;
 import com.io7m.lanark.core.RDottedName;
 import com.io7m.trasco.api.TrArguments;
 import com.io7m.trasco.api.TrEventExecutingSQL;
@@ -367,7 +368,17 @@ private void createOrUpgrade(
         final var parsers = new TrSchemaRevisionSetParsers();
         final TrSchemaRevisionSet revisions;
         try (var stream = this.onRequireDatabaseSchemaXML()) {
-          revisions = parsers.parse(URI.create("urn:source"), stream);
+          final var parser =
+            parsers.createParserWithContext(
+              configuration.saxParsers()
+                .orElseGet(JXEHardenedSAXParsers::new),
+              URI.create("urn:source"),
+              stream,
+              parseStatus -> {
+
+              }
+            );
+          revisions = parser.execute();
         }
 
         try (var connection = installDataSource.getConnection()) {

com.io7m.darco.postgres/src/main/java/module-info.java

@@ -28,7 +28,9 @@
   requires java.sql;
   requires java.naming;
 
+  requires com.io7m.anethum.api;
   requires com.io7m.jmulticlose.core;
+  requires com.io7m.jxe.core;
   requires com.io7m.lanark.core;
   requires com.io7m.trasco.api;
   requires com.io7m.trasco.vanilla;

com.io7m.darco.sqlite/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.darco</artifactId>
     <groupId>com.io7m.darco</groupId>
-    <version>1.0.0</version>
+    <version>2.0.0</version>
   </parent>
   <artifactId>com.io7m.darco.sqlite</artifactId>
 
@@ -25,6 +25,14 @@
       <version>${project.version}</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.io7m.jxe</groupId>
+      <artifactId>com.io7m.jxe.core</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>com.io7m.anethum</groupId>
+      <artifactId>com.io7m.anethum.api</artifactId>
+    </dependency>
     <dependency>
       <groupId>com.io7m.jmulticlose</groupId>
       <artifactId>com.io7m.jmulticlose.core</artifactId>

com.io7m.darco.sqlite/src/main/java/com/io7m/darco/sqlite/DSDatabaseFactory.java

@@ -26,6 +26,7 @@
 import com.io7m.darco.api.DDatabaseType;
 import com.io7m.jmulticlose.core.CloseableCollection;
 import com.io7m.jmulticlose.core.CloseableCollectionType;
+import com.io7m.jxe.core.JXEHardenedSAXParsers;
 import com.io7m.lanark.core.RDottedName;
 import com.io7m.trasco.api.TrArguments;
 import com.io7m.trasco.api.TrEventExecutingSQL;
@@ -295,7 +296,17 @@ private SQLiteDataSource openDataSourceInSpan(
       final var parsers = new TrSchemaRevisionSetParsers();
       final TrSchemaRevisionSet revisions;
       try (var stream = this.onRequireDatabaseSchemaXML()) {
-        revisions = parsers.parse(URI.create("urn:source"), stream);
+        final var parser =
+          parsers.createParserWithContext(
+            configuration.saxParsers()
+              .orElseGet(JXEHardenedSAXParsers::new),
+            URI.create("urn:source"),
+            stream,
+            parseStatus -> {
+
+            }
+          );
+        revisions = parser.execute();
       }
 
       final var arguments =

com.io7m.darco.sqlite/src/main/java/module-info.java

@@ -27,14 +27,16 @@
 
   requires java.sql;
 
+  requires com.io7m.anethum.api;
+  requires com.io7m.jmulticlose.core;
+  requires com.io7m.jxe.core;
+  requires com.io7m.lanark.core;
   requires com.io7m.trasco.api;
   requires com.io7m.trasco.vanilla;
-  requires com.io7m.lanark.core;
-  requires org.slf4j;
-  requires org.xerial.sqlitejdbc;
   requires io.opentelemetry.api;
   requires io.opentelemetry.context;
-  requires com.io7m.jmulticlose.core;
+  requires org.slf4j;
+  requires org.xerial.sqlitejdbc;
 
   exports com.io7m.darco.sqlite;
 }

com.io7m.darco.templating/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.darco</artifactId>
     <groupId>com.io7m.darco</groupId>
-    <version>1.0.0</version>
+    <version>2.0.0</version>
   </parent>
   <artifactId>com.io7m.darco.templating</artifactId>
 

com.io7m.darco.tests/pom.xml

@@ -9,7 +9,7 @@
   <parent>
     <artifactId>com.io7m.darco</artifactId>
     <groupId>com.io7m.darco</groupId>
-    <version>1.0.0</version>
+    <version>2.0.0</version>
   </parent>
   <artifactId>com.io7m.darco.tests</artifactId>
 

com.io7m.darco.tests/src/main/java/com/io7m/darco/tests/EPQDatabaseTest.java

@@ -37,6 +37,8 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+import java.util.Optional;
+
 import static com.io7m.darco.api.DDatabaseUnit.UNIT;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
@@ -68,6 +70,7 @@ public void setup()
     this.database =
       this.databases.open(
         new EPQDatabaseConfiguration(
+          Optional.empty(),
           DDatabaseTelemetryNoOp.get(),
           DDatabaseCreate.CREATE_DATABASE,
           DDatabaseUpgrade.UPGRADE_DATABASE,