Merge pull request #36 from OP-TED/release/1.4.0

Release 1.4.0

Author: bertrand-lorentz

.github/workflows/build.yml

@@ -0,0 +1,21 @@
+name: Build and run unit tests
+on:
+  push:
+  pull_request:
+
+  # Allows to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '11'
+          distribution: 'adopt'
+      - name: Build and run unit tests
+        run: mvn --batch-mode clean install

.github/workflows/publish.yml

@@ -18,14 +18,14 @@ jobs:
       contents: read
       packages: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Import GPG Key
-        uses: crazy-max/ghaction-import-gpg@v5
+        uses: crazy-max/ghaction-import-gpg@v6
         with:
           gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.GPG_PASSPHRASE }}
       - name: Set up Java for publishing to Maven Central Repository
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           java-version: '11'
           distribution: 'adopt'

CHANGELOG.md

@@ -1,10 +1,12 @@
-# eForms Core Library 1.3.0 Release Notes
+# eForms Core Library 1.4.0 Release Notes
 
 The eForms Core Library is a collection of utilities that are used by our sample applications as well as the EFX Toolkit for Java Developers.
 
 ## In this release
 
-This release improves XPathProcessor contextualisation by fixing an issue that caused unnecessary back-steps to be inserted in the contextualised output when both XPaths contain predicates.
+This release adds the option to indicate a qualifier for SDK components. If there are 2 or more classes that have an @SdkComponent annotation with the same version and component type, this allows you to differentiate them and load the component with the matching qualifier.
+
+The versions of various dependencies was updated: ANTLR 4.13.1, JAXB 4.0.4, logback 1.5.3, ph-genericode 7.1.1.
 
 ## Download
 

pom.xml

@@ -3,7 +3,7 @@
 
   <groupId>eu.europa.ted.eforms</groupId>
   <artifactId>eforms-core-java</artifactId>
-  <version>1.3.0</version>
+  <version>1.4.0</version>
 
   <name>eForms Core Library</name>
   <description>API and tools for eForms applications.</description>
@@ -44,7 +44,7 @@
   </distributionManagement>
 
   <properties>
-    <project.build.outputTimestamp>2023-11-17T15:30:31Z</project.build.outputTimestamp>
+    <project.build.outputTimestamp>2024-08-02T09:11:15Z</project.build.outputTimestamp>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 
     <sonatype.server.url>s01.oss.sonatype.org</sonatype.server.url>
@@ -55,18 +55,18 @@
     <maven.compiler.target>${java.version}</maven.compiler.target>
 
     <!-- Versions - Third-party libraries -->
-    <version.antlr4>4.9.3</version.antlr4>
+    <version.antlr4>4.13.1</version.antlr4>
     <version.commons-collections>3.2.2</version.commons-collections>
     <version.commons-io>2.11.0</version.commons-io>
     <version.commons-lang3>3.12.0</version.commons-lang3>
     <version.jackson>2.15.1</version.jackson>
+    <version.jaxb-impl>4.0.4</version.jaxb-impl>
     <version.jool>0.9.15</version.jool>
-    <version.jsr305>3.0.2</version.jsr305>
     <version.junit>5.7.2</version.junit>
-    <version.logback>1.4.4</version.logback>
+    <version.logback>1.5.3</version.logback>
     <version.maven>3.8.6</version.maven>
-    <version.ph>10.0.0</version.ph>
-    <version.ph-genericode>6.2.0</version.ph-genericode>
+    <version.ph-jaxb>11.1.3</version.ph-jaxb>
+    <version.ph-genericode>7.1.1</version.ph-genericode>
     <version.reflections>0.10.2</version.reflections>
     <version.resolver>1.8.2</version.resolver>
     <version.semver4j>3.1.0</version.semver4j>
@@ -78,10 +78,11 @@
     <version.gpg.plugin>1.5</version.gpg.plugin>
     <version.install.plugin>2.5.2</version.install.plugin>
     <version.jacoco.plugin>0.8.10</version.jacoco.plugin>
+    <version.japicmp.plugin>0.20.0</version.japicmp.plugin>
     <version.javadoc.plugin>3.4.0</version.javadoc.plugin>
     <version.source.plugin>3.2.1</version.source.plugin>
     <version.jar.plugin>3.3.0</version.jar.plugin>
-    <version.surefire.plugin>3.0.0-M7</version.surefire.plugin> <!-- Versions prior to 3.0.x do not pick up Junit 5 tests correctly. -->
+    <version.surefire.plugin>3.2.5</version.surefire.plugin>
     <version.nexus-staging.plugin>1.6.7</version.nexus-staging.plugin>
   </properties>
 
@@ -179,10 +180,16 @@
       </dependency>
 
       <!-- PH -->
+      <dependency>
+        <groupId>com.sun.xml.bind</groupId>
+        <artifactId>jaxb-impl</artifactId>
+        <version>${version.jaxb-impl}</version>
+        <scope>runtime</scope>
+      </dependency>
       <dependency>
         <groupId>com.helger.commons</groupId>
-        <artifactId>ph-commons</artifactId>
-        <version>${version.ph}</version>
+        <artifactId>ph-jaxb</artifactId>
+        <version>${version.ph-jaxb}</version>
       </dependency>
       <dependency>
         <!-- For genericode .gc files (SDK codelist related) -->
@@ -209,11 +216,6 @@
         <artifactId>logback-core</artifactId>
         <version>${version.logback}</version>
       </dependency>
-      <dependency>
-        <groupId>com.google.code.findbugs</groupId>
-        <artifactId>jsr305</artifactId>
-        <version>${version.jsr305}</version>
-      </dependency>
       <dependency>
         <groupId>org.antlr</groupId>
         <artifactId>antlr4-runtime</artifactId>
@@ -320,9 +322,13 @@
     </dependency>
 
     <!-- PH -->
+    <dependency>
+      <groupId>com.sun.xml.bind</groupId>
+      <artifactId>jaxb-impl</artifactId>
+    </dependency>
     <dependency>
       <groupId>com.helger.commons</groupId>
-      <artifactId>ph-commons</artifactId>
+      <artifactId>ph-jaxb</artifactId>
     </dependency>
     <dependency>
       <!-- For genericode .gc files (SDK codelist related) -->
@@ -341,11 +347,6 @@
       <artifactId>logback-core</artifactId>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>com.google.code.findbugs</groupId>
-      <artifactId>jsr305</artifactId>
-      <scope>provided</scope>
-    </dependency>
     <dependency>
       <groupId>org.antlr</groupId>
       <artifactId>antlr4-runtime</artifactId>
@@ -414,6 +415,11 @@
           <artifactId>jacoco-maven-plugin</artifactId>
           <version>${version.jacoco.plugin}</version>
         </plugin>
+        <plugin>
+          <groupId>com.github.siom79.japicmp</groupId>
+          <artifactId>japicmp-maven-plugin</artifactId>
+          <version>${version.japicmp.plugin}</version>
+        </plugin>
         <plugin>
           <groupId>org.sonatype.plugins</groupId>
           <artifactId>nexus-staging-maven-plugin</artifactId>
@@ -478,6 +484,28 @@
           </execution>
         </executions>
       </plugin>
+
+      <plugin>
+        <groupId>com.github.siom79.japicmp</groupId>
+        <artifactId>japicmp-maven-plugin</artifactId>
+        <configuration>
+          <!-- Old and new versions are not specified, so we compare the latest released version with the build artefact -->
+          <parameter>
+            <!-- Break the build in case the semantic versioning is violated -->
+            <breakBuildBasedOnSemanticVersioning>true</breakBuildBasedOnSemanticVersioning>
+            <!-- Output only modified classes/methods in the report -->
+            <onlyModified>true</onlyModified>
+          </parameter>
+        </configuration>
+        <executions>
+          <execution>
+            <phase>verify</phase>
+            <goals>
+              <goal>cmp</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

src/main/java/eu/europa/ted/eforms/sdk/component/SdkComponent.java

@@ -13,4 +13,6 @@
   public String[] versions();
 
   public SdkComponentType componentType();
+
+  public String qualifier() default "";
 }

src/main/java/eu/europa/ted/eforms/sdk/component/SdkComponentDescriptor.java

@@ -23,12 +23,20 @@ public class SdkComponentDescriptor<T> implements Serializable {
 
   private SdkComponentType componentType;
 
+  private String qualifier;
+
   private Class<T> implType;
 
   public SdkComponentDescriptor(String sdkVersion, SdkComponentType componentType,
       Class<T> implType) {
+    this(sdkVersion, componentType, "", implType);
+  }
+
+  public SdkComponentDescriptor(String sdkVersion, SdkComponentType componentType, String qualifier,
+      Class<T> implType) {
     this.sdkVersion = Validate.notBlank(sdkVersion, "Undefined SDK version");
     this.componentType = Validate.notNull(componentType, "Undefined component type");
+    this.qualifier = Validate.notNull(qualifier, "Undefined qualifier");
     this.implType = Validate.notNull(implType, "Undefined implementation type");
   }
 
@@ -94,7 +102,7 @@ private boolean constructorHasExpectedParameters(Constructor<?> constructor,
 
   @Override
   public int hashCode() {
-    return Objects.hash(componentType, sdkVersion);
+    return Objects.hash(componentType, sdkVersion, qualifier, implType);
   }
 
   @Override
@@ -106,7 +114,10 @@ public boolean equals(Object obj) {
     if (getClass() != obj.getClass())
       return false;
     SdkComponentDescriptor<?> other = (SdkComponentDescriptor<?>) obj;
-    return componentType == other.componentType && Objects.equals(sdkVersion, other.sdkVersion);
+    return componentType == other.componentType
+        && Objects.equals(sdkVersion, other.sdkVersion)
+        && Objects.equals(qualifier, other.qualifier)
+        && Objects.equals(implType, other.implType);
   }
 
   public Class<T> getImplType() {