feat: Bump JVM target to Java 17. Upgrade Jetty. (#638)

* Bump JVM target to Java 17.

* Bump Jetty version.

* Update jicoco.

* Squash: restore removed docs.

Author: JonathanLennox

.github/workflows/maven.yml

@@ -11,7 +11,7 @@ on:
 
 env:
   # Java version to use for the release
-  RELEASE_JAVA_VERSION: 11
+  RELEASE_JAVA_VERSION: 17
 
 jobs:
   build:
@@ -20,7 +20,7 @@ jobs:
 
     strategy:
       matrix:
-        java: [ 11, 17, 21 ]
+        java: [ 17, 21 ]
 
     name: Java ${{ matrix.java }}
 

pom.xml

@@ -21,9 +21,9 @@
     <junit.version>5.8.2</junit.version>
     <smack.version>4.4.8-jitsi-4</smack.version>
     <jxmppVersion>1.0.3</jxmppVersion>
+    <jicoco.version>1.1-170-g3f48c50</jicoco.version>
     <!-- Match jicoco's jetty version. -->
-    <jicoco.version>1.1-159-gf9c2712</jicoco.version>
-    <jetty.version>11.0.21</jetty.version>
+    <jetty.version>12.0.35</jetty.version>
     <oci-sdk.version>3.86.1</oci-sdk.version>
   </properties>
 
@@ -112,7 +112,7 @@
     <!-- Used by the Vosk transcription service -->
     <dependency>
       <groupId>org.eclipse.jetty.websocket</groupId>
-      <artifactId>websocket-jetty-client</artifactId>
+      <artifactId>jetty-websocket-jetty-client</artifactId>
       <version>${jetty.version}</version>
     </dependency>
     <!-- Used by the Vosk transcription service -->
@@ -440,7 +440,7 @@
         <artifactId>maven-compiler-plugin</artifactId>
         <version>3.10.1</version>
         <configuration>
-          <release>11</release>
+          <release>17</release>
           <compilerArgs>
             <arg>-Xlint:all</arg>
           </compilerArgs>

src/main/java/org/jitsi/jigasi/rest/AbstractJSONHandler.java

@@ -16,8 +16,6 @@
 package org.jitsi.jigasi.rest;
 
 import net.java.sip.communicator.util.osgi.*;
-import org.eclipse.jetty.server.*;
-import org.eclipse.jetty.server.handler.*;
 import org.jitsi.utils.version.*;
 import org.jivesoftware.smack.packet.*;
 import org.json.simple.*;
@@ -28,21 +26,14 @@
 import java.io.*;
 
 /**
- * Implements an abstract Jetty {@code Handler} which provides content in JSON
- * format.
+ * Implements an abstract Jetty servlet which provides content in JSON format.
  *
  * @author Lyubomir Marinov
  * @author Pawel Domas
  */
 public abstract class AbstractJSONHandler
-    extends AbstractHandler
+    extends HttpServlet
 {
-    /**
-     * The default suffix/extension of the HTTP resources which provide access
-     * to JSON representations.
-     */
-    private static final String DEFAULT_JSON_TARGET = null;
-
     /**
      * The HTTP GET method.
      */
@@ -105,12 +96,6 @@ else if (StanzaError.Condition.service_unavailable.equals(
      */
     protected final BundleContext bundleContext;
 
-    /**
-     * The suffix/extension of the HTTP resources which provide access to JSON
-     * representations.
-     */
-    private final String jsonTarget;
-
     /**
      * Initializes a new {@code AbstractJSONHandler} instance within a specific
      * {@code BundleContext}.
@@ -121,35 +106,19 @@ else if (StanzaError.Condition.service_unavailable.equals(
     protected AbstractJSONHandler(BundleContext bundleContext)
     {
         this.bundleContext = bundleContext;
-
-        // jsonTarget
-        String jsonTarget = DEFAULT_JSON_TARGET;
-
-        if (jsonTarget != null && !jsonTarget.startsWith("."))
-            jsonTarget = "." + jsonTarget;
-        this.jsonTarget = jsonTarget;
     }
 
     /**
      * Begins an {@link HttpServletResponse} the handling of which appears to
      * have chances of success.
-     *
-     * @param target the target of the request
-     * @param baseRequest the original unwrapped {@link Request} object
-     * @param request the request either as the {@code Request} object or a
-     * wrapper of that request
-     * @param response the response either as the {@code Response} object or a
-     * wrapper of that response
      */
     protected void beginResponse(
         String target,
-        Request baseRequest,
         HttpServletRequest request,
         HttpServletResponse response)
     {
         beginResponse(
             target,
-            baseRequest,
             request,
             response,
             RESTUtil.JSON_CONTENT_TYPE_WITH_CHARSET);
@@ -158,19 +127,9 @@ protected void beginResponse(
     /**
      * Begins an {@link HttpServletResponse} the handling of which appears to
      * have chances of success.
-     *
-     * @param target the target of the request
-     * @param baseRequest the original unwrapped {@link Request} object
-     * @param request the request either as the {@code Request} object or a
-     * wrapper of that request
-     * @param response the response either as the {@code Response} object or a
-     * wrapper of that response
-     * @param contentType the MIME type of the content to be set on
-     * {@code response}
      */
     protected void beginResponse(
         String target,
-        Request baseRequest,
         HttpServletRequest request,
         HttpServletResponse response,
         String contentType)
@@ -184,17 +143,8 @@ protected void beginResponse(
      * Gets a JSON representation of the health (status) of the associated
      * server/service. The default implementation does nothing because it serves
      * as a placeholder for extenders.
-     *
-     * @param baseRequest the original unwrapped {@link Request} object
-     * @param request the request either as the {@code Request} object or a
-     * wrapper of that request
-     * @param response the response either as the {@code Response} object or a
-     * wrapper of that response
-     * @throws IOException
-     * @throws ServletException
      */
     protected void doGetHealthJSON(
-        Request baseRequest,
         HttpServletRequest request,
         HttpServletResponse response)
         throws IOException,
@@ -205,23 +155,14 @@ protected void doGetHealthJSON(
     /**
      * Gets a JSON representation of the {@code Version} of the associated
      * server/service.
-     *
-     * @param baseRequest the original unwrapped {@link Request} object
-     * @param request the request either as the {@code Request} object or a
-     * wrapper of that request
-     * @param response the response either as the {@code Response} object or a
-     * wrapper of that response
-     * @throws IOException
-     * @throws ServletException
      */
     protected void doGetVersionJSON(
-        Request baseRequest,
         HttpServletRequest request,
         HttpServletResponse response)
         throws IOException,
         ServletException
     {
-        beginResponse(/*target*/ null, baseRequest, request, response);
+        beginResponse(/*target*/ null, request, response);
 
         BundleContext bundleContext = getBundleContext();
         int status = HttpServletResponse.SC_SERVICE_UNAVAILABLE;
@@ -252,32 +193,6 @@ protected void doGetVersionJSON(
 
         if (response.getStatus() != status)
             response.setStatus(status);
-
-        endResponse(/*target*/ null, baseRequest, request, response);
-    }
-
-    /**
-     * Ends an {@link HttpServletResponse}.
-     *
-     * @param target the target of the request
-     * @param baseRequest the original unwrapped {@link Request} object
-     * @param request the request either as the {@code Request} object or a
-     * wrapper of that request
-     * @param response the response either as the {@code Response} object or a
-     * wrapper of that response
-     */
-    protected void endResponse(
-        String target,
-        Request baseRequest,
-        HttpServletRequest request,
-        HttpServletResponse response)
-    {
-        if (!baseRequest.isHandled())
-        {
-            if (response.getStatus() == 0)
-                response.setStatus(HttpServletResponse.SC_NOT_FOUND);
-            baseRequest.setHandled(true);
-        }
     }
 
     /**
@@ -315,43 +230,28 @@ public <T> T getService(Class<T> serviceClass)
      * {@inheritDoc}
      */
     @Override
-    public void handle(
-        String target,
-        Request baseRequest,
+    protected void service(
         HttpServletRequest request,
         HttpServletResponse response)
-        throws IOException,
-        ServletException
+        throws IOException, ServletException
     {
-        if (target != null)
-        {
-            // The target ends with ".json".
-            int jsonTargetLength
-                = (jsonTarget == null) ? 0 : jsonTarget.length();
+        String target = request.getRequestURI();
 
-            if (jsonTargetLength == 0 || target.endsWith(jsonTarget))
+        if (!handleJSON(target, request, response))
+        {
+            if (response.getStatus() == 0
+                || response.getStatus() == HttpServletResponse.SC_OK)
             {
-                target
-                    = target.substring(0, target.length() - jsonTargetLength);
-
-                handleJSON(target, baseRequest, request, response);
+                response.setStatus(HttpServletResponse.SC_NOT_FOUND);
             }
         }
     }
 
     /**
      * Handles an HTTP request for a {@link #HEALTH_TARGET}-related resource.
-     *
-     * @param target the target of the request
-     * @param baseRequest the original unwrapped {@link Request} object
-     * @param request the request either as the {@code Request} object or a
-     * wrapper of that request
-     * @param response the response either as the {@code Response} object or a
-     * wrapper of that response
      */
     protected void handleHealthJSON(
         String target,
-        Request baseRequest,
         HttpServletRequest request,
         HttpServletResponse response)
         throws IOException,
@@ -360,7 +260,7 @@ protected void handleHealthJSON(
         if (GET_HTTP_METHOD.equals(request.getMethod()))
         {
             // Check/get the health (status) of the associated server/service.
-            doGetHealthJSON(baseRequest, request, response);
+            doGetHealthJSON(request, response);
         }
         else
         {
@@ -369,45 +269,34 @@ protected void handleHealthJSON(
     }
 
     /**
-     * Handles a specific HTTP request for JSON content.
+     * Handles a specific HTTP request for JSON content. Returns {@code true}
+     * if the request was handled.
      */
-    protected void handleJSON(
+    protected boolean handleJSON(
         String target,
-        Request baseRequest,
         HttpServletRequest request,
         HttpServletResponse response)
         throws IOException,
         ServletException
     {
         if (HEALTH_TARGET.equals(target))
         {
-            target = target.substring(HEALTH_TARGET.length());
-
-            handleHealthJSON(target, baseRequest, request, response);
+            handleHealthJSON(target, request, response);
+            return true;
         }
         else if (VERSION_TARGET.equals(target))
         {
-            target = target.substring(VERSION_TARGET.length());
-
-            handleVersionJSON(target, baseRequest, request, response);
+            handleVersionJSON(target, request, response);
+            return true;
         }
+        return false;
     }
 
     /**
      * Handles an HTTP request for a {@link #VERSION_TARGET}-related resource.
-     *
-     * @param target the target of the request
-     * @param baseRequest the original unwrapped {@link Request} object
-     * @param request the request either as the {@code Request} object or a
-     * wrapper of that request
-     * @param response the response either as the {@code Response} object or a
-     * wrapper of that response
-     * @throws IOException
-     * @throws ServletException
      */
     protected void handleVersionJSON(
         String target,
-        Request baseRequest,
         HttpServletRequest request,
         HttpServletResponse response)
         throws IOException,
@@ -416,7 +305,7 @@ protected void handleVersionJSON(
         if (GET_HTTP_METHOD.equals(request.getMethod()))
         {
             // Get the Version of the associated server/service.
-            doGetVersionJSON(baseRequest, request, response);
+            doGetVersionJSON(request, response);
         }
         else
         {