Migrate from JAXB to Jakarta XML-Bind

Author: michael-simons

.github/workflows/maven.yml

@@ -11,11 +11,12 @@ jobs:
     name: build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Set up JDK
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v3
         with:
-          java-version: 11
+          distribution: 'zulu'
+          java-version: 17
       - name: Build with Maven
         run: ./mvnw --no-transfer-progress clean verify
 
@@ -24,10 +25,11 @@ jobs:
     runs-on: ubuntu-latest
     needs: build
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-java@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v3
         with:
-          java-version: 11
+          distribution: 'zulu'
+          java-version: 17
       - name: Run SonarCloud analyse
         run: >
           ./mvnw --batch-mode --no-transfer-progress clean

README.textile

@@ -20,7 +20,7 @@ Since version 0.7.1 I have changed the API of _OembedService_ and removed _Optio
 
 Since version 0.8.1 this project is Java 11 *only*.
 
-Since version 1.0.0 this project is Java 17 *only*.
+Since version 1.0.0 this project is Java 17 *only* and uses Jakarta XML Bind instead of JAXB for parsing XML.
 
 h2. Usage
 

pom.xml

@@ -76,6 +76,8 @@
 		<httpclient.version>4.5.14</httpclient.version>
 		<httpcore.version>4.4.16</httpcore.version>
 		<jackson.version>2.20.1</jackson.version>
+		<jakarta.xml.bind-api.version>3.0.1</jakarta.xml.bind-api.version>
+		<jaxb-impl.version>3.0.2</jaxb-impl.version>
 		<jsoup.version>1.21.2</jsoup.version>
 		<junit.version>6.0.1</junit.version>
 		<license-maven-plugin.version>5.0.0</license-maven-plugin.version>
@@ -167,28 +169,17 @@
 		</dependency>
 		<dependency>
 			<groupId>com.fasterxml.jackson.module</groupId>
-			<artifactId>jackson-module-jaxb-annotations</artifactId>
-			<exclusions>
-				<exclusion>
-					<groupId>javax.xml.bind</groupId>
-					<artifactId>jaxb-api</artifactId>
-				</exclusion>
-			</exclusions>
+			<artifactId>jackson-module-jakarta-xmlbind-annotations</artifactId>
 		</dependency>
 		<dependency>
 			<groupId>commons-beanutils</groupId>
 			<artifactId>commons-beanutils</artifactId>
 			<version>${commons-beanutils.version}</version>
 		</dependency>
 		<dependency>
-			<groupId>javax.activation</groupId>
-			<artifactId>javax.activation-api</artifactId>
-			<version>1.2.0</version>
-		</dependency>
-		<dependency>
-			<groupId>javax.xml.bind</groupId>
-			<artifactId>jaxb-api</artifactId>
-			<version>2.3.1</version>
+			<groupId>jakarta.xml.bind</groupId>
+			<artifactId>jakarta.xml.bind-api</artifactId>
+			<version>${jakarta.xml.bind-api.version}</version>
 		</dependency>
 		<dependency>
 			<groupId>net.sf.ehcache</groupId>
@@ -200,11 +191,6 @@
 			<artifactId>httpclient</artifactId>
 			<version>${httpclient.version}</version>
 		</dependency>
-		<dependency>
-			<groupId>org.glassfish.jaxb</groupId>
-			<artifactId>jaxb-runtime</artifactId>
-			<version>2.3.1</version>
-		</dependency>
 		<dependency>
 			<groupId>org.jsoup</groupId>
 			<artifactId>jsoup</artifactId>
@@ -214,6 +200,12 @@
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>com.sun.xml.bind</groupId>
+			<artifactId>jaxb-impl</artifactId>
+			<version>${jaxb-impl.version}</version>
+			<scope>runtime</scope>
+		</dependency>
 		<!-- Needed for HttpClient -->
 		<dependency>
 			<groupId>org.slf4j</groupId>

src/main/java/ac/simons/oembed/AutodiscoveredOembedEndpoint.java

@@ -41,7 +41,8 @@
  * This is an auto-discovered endpoint. It doesn't support api url generation but only
  * fixed api urls. The format is also fixed.
  *
- * @author Michael J. Simons, 2015-01-01
+ * @author Michael J. Simons
+ * @since 2015-01-01
  */
 final class AutodiscoveredOembedEndpoint extends OembedEndpoint {
 

src/main/java/ac/simons/oembed/OembedException.java

@@ -37,7 +37,8 @@
  * An exception for wrapping any checked exception that might happens due parsing of
  * responses etc.
  *
- * @author Michael J. Simons, 2010-12-24
+ * @author Michael J. Simons
+ * @since 2010-12-24
  */
 public class OembedException extends RuntimeException {
 

src/main/java/ac/simons/oembed/OembedJsonParser.java

@@ -42,14 +42,15 @@
 import com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair;
 import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector;
 import com.fasterxml.jackson.databind.type.TypeFactory;
-import com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector;
+import com.fasterxml.jackson.module.jakarta.xmlbind.JakartaXmlBindAnnotationIntrospector;
 
 /**
  * Provides JSON Parsing for {@link OembedResponse}s. This class uses a private
  * {@link ObjectMapper} to ensure that the JAXB annotation introspector is configured
  * correctly.
  *
- * @author Michael J. Simons, 2010-12-24
+ * @author Michael J. Simons
+ * @since 2010-12-24
  */
 public final class OembedJsonParser implements OembedParser {
 
@@ -64,7 +65,7 @@ public final class OembedJsonParser implements OembedParser {
 	public OembedJsonParser() {
 		this.objectMapper = new ObjectMapper()
 			.setAnnotationIntrospector(new AnnotationIntrospectorPair(new JacksonAnnotationIntrospector(),
-					new JaxbAnnotationIntrospector(TypeFactory.defaultInstance())))
+					new JakartaXmlBindAnnotationIntrospector(TypeFactory.defaultInstance())))
 			.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
 	}
 

src/main/java/ac/simons/oembed/OembedResponse.java

@@ -35,14 +35,13 @@
 
 import java.io.Serializable;
 
-import javax.xml.bind.annotation.XmlAccessType;
-import javax.xml.bind.annotation.XmlAccessorType;
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlRootElement;
-
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlRootElement;
 
 /**
  * This represents a valid OEmbed response according to the specs from

src/main/java/ac/simons/oembed/OembedXmlParser.java

@@ -36,8 +36,8 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 
-import javax.xml.bind.JAXBContext;
-import javax.xml.bind.JAXBException;
+import jakarta.xml.bind.JAXBContext;
+import jakarta.xml.bind.JAXBException;
 
 /**
  * Provides XML Parsing for {@link OembedResponse}s.

src/test/java/ac/simons/oembed/AutodiscoveredOembedEndpointTests.java

@@ -42,7 +42,8 @@
 import static org.assertj.core.api.Assertions.assertThat;
 
 /**
- * @author Michael J. Simons, 2015-01-09
+ * @author Michael J. Simons
+ * @since 2015-01-09
  */
 public class AutodiscoveredOembedEndpointTests {
 

src/test/java/ac/simons/oembed/BrokenRenderer.java

@@ -36,7 +36,8 @@
 import org.jsoup.nodes.Element;
 
 /**
- * @author Michael J. Simons, 2015-01-02
+ * @author Michael J. Simons
+ * @since 2015-01-02
  */
 class BrokenRenderer implements OembedResponseRenderer {