Support JDK 8 with EE 9 Tyrus

Signed-off-by: jansupol <[email protected]>
jansupol · Jun 19, 2024 · 0fa344e · 0fa344e
1 parent 4c70258
commit 0fa344e
Show file tree

Hide file tree

Showing 29 changed files with 378 additions and 19 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 # maven noise
 target/
+target11
 target-*/
 
 # gradle noise

diff --git a/archetypes/echo/src/main/resources/archetype-resources/pom.xml b/archetypes/echo/src/main/resources/archetype-resources/pom.xml
@@ -65,7 +65,7 @@
         <java.version>1.8</java.version>
         <tyrus.version>${project.version}</tyrus.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <maven.compiler.plugin>3.11.0</maven.compiler.plugin>
+        <maven.compiler.plugin>3.13.0</maven.compiler.plugin>
         <maven.war.plugin.version>3.4.0</maven.war.plugin.version>
     </properties>
 </project>
diff --git a/client/src/main/java/module-info.java → client/src/main/java11/module-info.java b/client/src/main/java/module-info.java → client/src/main/java11/module-info.java
diff --git a/...ssfish/cdi/src/main/java/module-info.java → ...fish/cdi/src/main/java11/module-info.java b/...ssfish/cdi/src/main/java/module-info.java → ...fish/cdi/src/main/java11/module-info.java
diff --git a/...ssfish/ejb/src/main/java/module-info.java → ...fish/ejb/src/main/java11/module-info.java b/...ssfish/ejb/src/main/java/module-info.java → ...fish/ejb/src/main/java11/module-info.java
diff --git a/...zly-client/src/main/java/module-info.java → ...y-client/src/main/java11/module-info.java b/...zly-client/src/main/java/module-info.java → ...y-client/src/main/java11/module-info.java
diff --git a/...zly-server/src/main/java/module-info.java → ...y-server/src/main/java11/module-info.java b/...zly-server/src/main/java/module-info.java → ...y-server/src/main/java11/module-info.java
diff --git a/...s/inmemory/src/main/java/module-info.java → ...inmemory/src/main/java11/module-info.java b/...s/inmemory/src/main/java/module-info.java → ...inmemory/src/main/java11/module-info.java
diff --git a/...jdk-client/src/main/java/module-info.java → ...k-client/src/main/java11/module-info.java b/...jdk-client/src/main/java/module-info.java → ...k-client/src/main/java11/module-info.java
diff --git a/containers/servlet/src/main/java/org/glassfish/tyrus/servlet/TyrusHttpUpgradeHandler.java b/containers/servlet/src/main/java/org/glassfish/tyrus/servlet/TyrusHttpUpgradeHandler.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, 2022 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 2024 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
@@ -46,6 +46,14 @@
  */
 public class TyrusHttpUpgradeHandler implements HttpUpgradeHandler, ReadListener {
 
+    /**
+     * <p>
+     *     The size to precede OutOfMemory Exception and potentially DDoS attacks when buffering incoming WebSocket frames.
+     * </p>
+     * <p>
+     *     The default value is 4194315 bytes, which correspond to 4M plus few bytes to frame headers.
+     * </p>
+     */
     public static final String FRAME_BUFFER_SIZE = "org.glassfish.tyrus.servlet.incoming-buffer-size";
 
     private final CountDownLatch connectionLatch = new CountDownLatch(1);
@@ -98,6 +106,12 @@ public void close(CloseReason reason) {
         connectionLatch.countDown();
     }
 
+    /**
+     * Sets the required information before {@link #init(WebConnection)} is invoked.
+     * @param upgradeInfo The WebSocket UpgradeInfo.
+     * @param writer The Tyrus SPI Writer.
+     * @param authenticated Whether the authentication has been used.
+     */
     public void preInit(WebSocketEngine.UpgradeInfo upgradeInfo, Writer writer, boolean authenticated) {
         this.upgradeInfo = upgradeInfo;
         this.writer = writer;
@@ -249,6 +263,10 @@ public String toString() {
         return sb.toString();
     }
 
+    /**
+     * Override the default {@link #FRAME_BUFFER_SIZE}.
+     * @param incomingBufferSize The new incoming frame buffer size value.
+     */
     public void setIncomingBufferSize(int incomingBufferSize) {
         this.incomingBufferSize = incomingBufferSize;
     }

diff --git a/...rs/servlet/src/main/java/module-info.java → .../servlet/src/main/java11/module-info.java b/...rs/servlet/src/main/java/module-info.java → .../servlet/src/main/java11/module-info.java
diff --git a/core/src/main/java/module-info.java → core/src/main/java11/module-info.java b/core/src/main/java/module-info.java → core/src/main/java11/module-info.java
diff --git a/etc/jenkins/Jenkinsfile_ci_build b/etc/jenkins/Jenkinsfile_ci_build
@@ -8,12 +8,12 @@ pipeline {
     stages {
         stage('Jersey build') {
             parallel {
-                stage('JDK 11 ') {
+                stage('JDK 8 ') {
                     agent {
                         label 'centos-7'
                     }
                     tools {
-                        jdk 'openjdk-jdk11-latest'
+                        jdk 'oracle-jdk8-latest'
                         maven 'apache-maven-latest'
                     }
                     steps {

diff --git a/...client-cli/src/main/java/module-info.java → ...ient-cli/src/main/java11/module-info.java b/...client-cli/src/main/java/module-info.java → ...ient-cli/src/main/java11/module-info.java
diff --git a/...ient-java8/src/main/java/module-info.java → ...nt-java8/src/main/java11/module-info.java b/...ient-java8/src/main/java/module-info.java → ...nt-java8/src/main/java11/module-info.java
diff --git a/...on-deflate/src/main/java/module-info.java → ...-deflate/src/main/java11/module-info.java b/...on-deflate/src/main/java/module-info.java → ...-deflate/src/main/java11/module-info.java
diff --git a/...toring-jmx/src/main/java/module-info.java → ...ring-jmx/src/main/java11/module-info.java b/...toring-jmx/src/main/java/module-info.java → ...ring-jmx/src/main/java11/module-info.java
diff --git a/pom.xml b/pom.xml
@@ -117,12 +117,17 @@
         <json-impl.version>1.0.5</json-impl.version>
         <servlet.api.version>5.0.0</servlet.api.version>
         <spring.boot.version>2.6.7</spring.boot.version>
+        <glassfish.container.version>6.2.5</glassfish.container.version>
 
+        <java.version>1.8</java.version>
+        <java11.build.outputDirectory>${project.basedir}/target11/classes</java11.build.outputDirectory>
+        <java11.sourceDirectory>${project.basedir}/src/main/java11</java11.sourceDirectory>
 
-        <maven.compiler.plugin>3.11.0</maven.compiler.plugin>
-        <maven-javadoc-plugin.version>3.6.2</maven-javadoc-plugin.version>
+        <maven.compiler.plugin>3.13.0</maven.compiler.plugin>
+        <maven-javadoc-plugin.version>3.7.0</maven-javadoc-plugin.version>
         <maven.surefire.plugin.version>3.2.1</maven.surefire.plugin.version>
         <maven.war.plugin.version>3.4.0</maven.war.plugin.version>
+        <cyclonedx.mvn.plugin.version>2.8.0</cyclonedx.mvn.plugin.version>
 
         <api_package>jakarta.websocket</api_package>
         <impl_namespace>org.glassfish</impl_namespace>
@@ -171,15 +176,15 @@
                 </plugin>
                 <plugin>
                     <artifactId>maven-assembly-plugin</artifactId>
-                    <version>3.6.0</version>
+                    <version>3.7.1</version>
                 </plugin>
                 <plugin>
                     <artifactId>maven-source-plugin</artifactId>
                     <version>3.3.0</version>
                 </plugin>
                 <plugin>
                     <artifactId>maven-compiler-plugin</artifactId>
-                    <version>3.11.0</version>
+                    <version>${maven.compiler.plugin}</version>
                 </plugin>
                 <plugin>
                     <artifactId>maven-release-plugin</artifactId>
@@ -314,11 +319,14 @@
                         <doctitle>Tyrus ${project.version} API Documentation</doctitle>
                         <windowtitle>Tyrus ${project.version} API</windowtitle>
                         <links>
-                            <link>https://projects.eclipse.org/projects/ee4j.tyrus</link>
+                            <link>https://eclipse-ee4j.github.io/tyrus-project.github.io/apidocs/latest20x/</link>
                         </links>
                         <excludePackageNames>
                             *.core.l10n.*:*.internal.*:org.glassfish.tyrus.core.wsadl.model
                         </excludePackageNames>
+                        <sourceFileExcludes>
+                            <sourceFileExclude>**/module-info.java</sourceFileExclude>
+                        </sourceFileExcludes>
                     </configuration>
                     <executions>
                         <execution>
@@ -378,8 +386,8 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <configuration>
-                    <source>11</source>
-                    <target>11</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
                     <encoding>UTF-8</encoding>
                 </configuration>
             </plugin>
@@ -592,6 +600,185 @@
                 </plugins>
             </build>
         </profile>
+
+        <profile>
+            <id>sbom</id>
+            <activation>
+                <property>
+                    <name>!skipSBOM</name>
+                </property>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.cyclonedx</groupId>
+                        <artifactId>cyclonedx-maven-plugin</artifactId>
+                        <version>${cyclonedx.mvn.plugin.version}</version>
+                        <inherited>true</inherited>
+                        <executions>
+                            <execution>
+                                <phase>package</phase>
+                                <goals>
+                                    <goal>makeAggregateBom</goal>
+                                </goals>
+                                <configuration>
+                                    <!--                            <schemaVersion>1.4</schemaVersion>-->
+                                    <projectType>framework</projectType>
+                                    <excludeTestProject>true</excludeTestProject>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+
+        <profile>
+            <id>jdk11+</id>
+            <activation>
+                <jdk>[11,)</jdk>
+                <file><exists>src/main/java11/module-info.java</exists></file>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.codehaus.mojo</groupId>
+                        <artifactId>build-helper-maven-plugin</artifactId>
+                        <executions>
+                            <execution>
+                                <id>add.java11</id>
+                                <phase>generate-sources</phase>
+                                <goals>
+                                    <goal>add-source</goal>
+                                </goals>
+                                <configuration>
+                                    <sources>
+                                        <source>src/main/java11</source>
+                                    </sources>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                    <plugin>
+                        <artifactId>maven-compiler-plugin</artifactId>
+                        <configuration>
+                            <source>11</source>
+                            <target>11</target>
+                            <encoding>UTF-8</encoding>
+                        </configuration>
+                    </plugin>
+                    <plugin>
+                        <artifactId>maven-antrun-plugin</artifactId>
+                        <executions>
+                            <execution>
+                                <phase>test</phase>
+                                <configuration>
+                                    <target>
+                                        <mkdir dir="${java11.build.outputDirectory}" />
+                                        <copy todir="${java11.build.outputDirectory}">
+                                            <fileset dir="${project.build.outputDirectory}/" includes="module-info.class" />
+                                        </copy>
+                                    </target>
+                                </configuration>
+                                <goals>
+                                    <goal>run</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+        <profile>
+            <id>clean11</id>
+            <build>
+                <plugins>
+                    <plugin>
+                        <artifactId>maven-clean-plugin</artifactId>
+                        <configuration>
+                            <filesets>
+                                <fileset>
+                                    <directory>${java11.build.outputDirectory}</directory>
+                                </fileset>
+                            </filesets>
+                        </configuration>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+        <profile>
+            <id>copyJDK11FilesToMultiReleaseJar</id>
+            <activation>
+                <file>
+                    <!-- ${java11.build.outputDirectory} does not work here -->
+                    <exists>target11/classes/module-info.class</exists>
+                </file>
+            </activation>
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-resources-plugin</artifactId>
+                        <inherited>true</inherited>
+                        <executions>
+                            <execution>
+                                <id>copy-module-info-source</id>
+                                <phase>prepare-package</phase>
+                                <goals>
+                                    <goal>copy-resources</goal>
+                                </goals>
+                                <configuration>
+                                    <outputDirectory>${project.build.directory}/generated-sources/rsrc-gen/META-INF/versions/11/</outputDirectory>
+                                    <resources>
+                                        <resource>
+                                            <directory>${java11.sourceDirectory}/</directory>
+                                        </resource>
+                                    </resources>
+                                </configuration>
+                            </execution>
+                            <execution>
+                                <id>copy-module-info-class</id>
+                                <phase>prepare-package</phase>
+                                <goals>
+                                    <goal>copy-resources</goal>
+                                </goals>
+                                <configuration>
+                                    <outputDirectory>${project.build.outputDirectory}/META-INF/versions/11</outputDirectory>
+                                    <resources>
+                                        <resource>
+                                            <directory>${java11.build.outputDirectory}</directory>
+                                        </resource>
+                                    </resources>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                    <plugin>
+                        <groupId>org.apache.felix</groupId>
+                        <artifactId>maven-bundle-plugin</artifactId>
+                        <version>5.1.4</version> <!-- 5.1.5  brings dependencies on JDK packages -->
+                        <extensions>true</extensions>
+                        <configuration>
+                            <instructions>
+                                <_versionpolicy>[$(version;==;$(@)),$(version;+;$(@)))</_versionpolicy>
+                                <_nodefaultversion>false</_nodefaultversion>
+                                <Include-Resource>{maven-resources},${project.build.directory}/legal</Include-Resource>
+                                <Multi-Release>true</Multi-Release>
+                            </instructions>
+                        </configuration>
+                        <executions>
+                            <execution>
+                                <id>osgi-bundle</id>
+                                <phase>package</phase>
+                                <goals>
+                                    <goal>bundle</goal>
+                                </goals>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
     </profiles>
 
     <reporting>
@@ -767,7 +954,7 @@
             <dependency>
                 <groupId>org.glassfish.main.extras</groupId>
                 <artifactId>glassfish-embedded-all</artifactId>
-                <version>6.2.1</version>
+                <version>${glassfish.container.version}</version>
             </dependency>
             <dependency>
                 <groupId>jakarta.xml.bind</groupId>

diff --git a/server/src/main/java/module-info.java → server/src/main/java11/module-info.java b/server/src/main/java/module-info.java → server/src/main/java11/module-info.java
diff --git a/spi/src/main/java/module-info.java → spi/src/main/java11/module-info.java b/spi/src/main/java/module-info.java → spi/src/main/java11/module-info.java
diff --git a/tests/containers/pom.xml b/tests/containers/pom.xml
@@ -36,6 +36,14 @@
 
     <modules>
         <module>jdk-client</module>
-        <module>servlet</module>
     </modules>
+    <profiles>
+        <profile>
+            <id>JDK11+</id>
+            <activation><jdk>[11,)</jdk></activation>
+            <modules>
+                <module>servlet</module>
+            </modules>
+        </profile>
+    </profiles>
 </project>
diff --git a/tests/containers/servlet/pom.xml b/tests/containers/servlet/pom.xml
@@ -47,4 +47,16 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>11</source>
+                    <target>11</target>
+                    <encoding>UTF-8</encoding>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
 </project>
diff --git a/...ion-config/src/test/java/module-info.java → ...n-config/src/test/java11/module-info.java b/...ion-config/src/test/java/module-info.java → ...n-config/src/test/java11/module-info.java
diff --git a/...s/e2e/jdk8/src/test/java/module-info.java → ...e2e/jdk8/src/test/java11/module-info.java b/...s/e2e/jdk8/src/test/java/module-info.java → ...e2e/jdk8/src/test/java11/module-info.java
diff --git a/...ard-config/src/test/java/module-info.java → ...d-config/src/test/java11/module-info.java b/...ard-config/src/test/java/module-info.java → ...d-config/src/test/java11/module-info.java