Describe Java SE compatibility and Jetty modules compatibility
Signed-off-by: jansupol <jan.supol@oracle.com>
diff --git a/docs/src/main/docbook/dependencies.xml b/docs/src/main/docbook/dependencies.xml
index 94c62e8..53bdfae 100644
--- a/docs/src/main/docbook/dependencies.xml
+++ b/docs/src/main/docbook/dependencies.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
- Copyright (c) 2010, 2021 Oracle and/or its affiliates. All rights reserved.
+ Copyright (c) 2010, 2023 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
@@ -29,7 +29,7 @@
xml:id="modules-and-dependencies">
<title>Modules and dependencies</title>
- <section>
+ <section xml:id="se_compatibility">
<title>Java SE Compatibility</title>
<para>
@@ -39,11 +39,24 @@
<para>This user guide refers only to version 3 and above of Jersey, its compatibility is described below</para>
</listitem>
<listitem>
- <para>Since version 3.0.0* all Jersey components are compiled with Java SE 1.8 target.
+ <para>Since version 3.0.0 all Jersey components are compiled with Java SE 1.8 target.
It means, that you will need at least Java SE 1.8 to be able to compile and run your application
- which uses the latest Jersey 3.x.
- All modules however are fully compatible with JDK 11 and above. So, it's possible to use JDK 11+ to
- build your app.
+ which uses the latest Jersey 3.0.x.
+ Some modules, however, are fully compatible with JDK 11 and above (Jetty modules based on Jetty 11).
+ Some modules (Helidon Connector, Spring 6) require JDK 17.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Since version 3.1.0 all Jersey components are compiled with Java SE 11 target.
+ It means, that you will need at least Java SE 11 to be able to compile and run your application
+ which uses the latest Jersey 3.1.x.
+ Some modules, however, are fully compatible with JDK 17 and above (Jetty modules based on Jetty 12
+ [since 3.1.4], Helidon Connector, Spring 6).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Please see <xref linkend="migration"/> for additional compatibility information.
</para>
</listitem>
</itemizedlist>
diff --git a/docs/src/main/docbook/migration.xml b/docs/src/main/docbook/migration.xml
index b999c44..e13990c 100644
--- a/docs/src/main/docbook/migration.xml
+++ b/docs/src/main/docbook/migration.xml
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<!--
- Copyright (c) 2012, 2021 Oracle and/or its affiliates. All rights reserved.
+ Copyright (c) 2012, 2023 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
@@ -40,10 +40,13 @@
Since Jakarta EE 9 the <literal>jakarta.</literal> namespace is introduced as a replacement
for javax namespace from Java EE.
</para>
+ </listitem>
+ <listitem>
<para>
- Due to required jakartification several modules where omitted (because of not satisfied dependencies).
- Or require higher JDK (11+).
+ Some Jersey modules require higher versions of Java SE. See <xref linkend="se_compatibility"/>.
</para>
+ </listitem>
+ <listitem>
<para>
Examples and tests are reduced in quantity (so you probably will not find all those examples which were available
in the 2.32 version).
@@ -95,6 +98,9 @@
Jakarta EE 10. Jakarta EE 10 defines the minimum JDK 11 requirement and hence Jersey no longer
supports JDK 8.
</para>
+ <para>
+ Some Jersey modules require higher versions of Java SE. See <xref linkend="se_compatibility"/>.
+ </para>
</listitem>
<listitem>
<para>
@@ -114,6 +120,24 @@
where the annotation used to be ignored by previous versions of Jersey.
</para>
</section>
+ <section xml:id="mig-3.1.4-jetty-modules">
+ <title>Jetty Modules</title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Jersey 3.0.x, and 3.1.0 - 3.1.3 Jetty modules (jersey-jetty-connector, jersey-container-jetty-http,
+ jersey-container-jetty-servlet, jersey-test-framework-provider-jetty) are based on Jetty 11,
+ which is Jakarta EE 9 related.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Jersey 3.1.4 modules use Jetty 12 which is Jakarta EE 10 related (as well as Jersey 3.1.x).
+ Jetty 12 dependencies use modules names different from Jetty 11.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
</section>
</chapter>
