Merge pull request #434 from roycpro/jakarta-migration

Jakarta/Tomcat migration

Author: jacomago

README.md

@@ -73,7 +73,7 @@ gradle unitTests
 
 #### Integration Tests
 
-Integration tests require an installation of Tomcat (the Archiver Appliance only support up to version 9).
+Integration tests require an installation of Tomcat (the Archiver Appliance only support up to version 11).
 The environment variable `TOMCAT_HOME` where a "conf" folder exists must then be set.
 
 To run tests requiring a local installation of [EPICS](https://epics-controls.org/).
@@ -120,12 +120,12 @@ For a quick deploy of a single appliance:
 
 1. Download the latest [release](https://github.com/archiver-appliance/epicsarchiverap/releases)
 	and unpack the war files to a folder "archiver".
-2. In the same folder, download a release of [tomcat 9](https://tomcat.apache.org/download-90.cgi) without unpacking.
+2. In the same folder, download a release of [tomcat 11](https://tomcat.apache.org/download-11.cgi) without unpacking.
 3. Copy the quickstart.sh file from the extracted release to the folder.
 4. Run the quickstart script:
 
 ```bash
-./quickstart.sh  apache-tomcat-9.*.tar.gz
+./quickstart.sh  apache-tomcat-11.*.tar.gz
 ```
 
 For more information see the [quickstart documentation](https://epicsarchiver.readthedocs.io/en/latest/sysadmin/quickstart.html). For more complicated

build.gradle.kts

@@ -96,7 +96,7 @@ dependencies {
 	viewer("archiver-appliance:svg_viewer:v1.2.1@zip")
 
 	// Provided by Servlet Container (e.g., Tomcat)
-	implementation("org.apache.tomcat:tomcat-servlet-api:9.0.74")
+	implementation("org.apache.tomcat:tomcat-servlet-api:11.0.12")
 
 	// Core Libraries
 	implementation("org.epics:jca:2.4.7")
@@ -106,15 +106,17 @@ dependencies {
 	implementation("org.python:jython-standalone:2.7.3")
 	implementation("com.google.protobuf:protobuf-java:3.23.0")
 	implementation("org.phoebus:core-pva:5.0.2")
+	implementation("jakarta.servlet:jakarta.servlet-api:6.0.0")
 
 	// Apache Commons
 	implementation("commons-codec:commons-codec:1.15")
-	implementation("commons-fileupload:commons-fileupload:1.6.0")
+	implementation("org.apache.commons:commons-fileupload2-jakarta-servlet6:2.0.0-M3")
 	implementation("commons-io:commons-io:2.14.0")
 	implementation("org.apache.commons:commons-lang3:3.18.0")
 	implementation("org.apache.commons:commons-math3:3.6.1")
 	implementation("commons-validator:commons-validator:1.7")
 
+
 	// HTTP Clients
 	implementation("org.apache.httpcomponents:httpclient:4.5.14")
 	implementation("org.apache.httpcomponents:httpcore:4.4.16")
@@ -146,7 +148,7 @@ dependencies {
 	testImplementation(files("lib/test/BPLTaglets.jar"))
 	testImplementation(project.files("lib/pbrawclient-0.2.1.jar"))
 	testImplementation(":pbrawclient:0.2.1")
-	testImplementation("org.apache.tomcat:tomcat-servlet-api:9.0.74")
+	testImplementation("org.apache.tomcat:tomcat-servlet-api:11.0.12")
 }
 
 // =================================================================
@@ -635,7 +637,7 @@ configure<SpotlessExtension> {
 		removeUnusedImports()
 		// apply a specific flavor of google-java-format
 		palantirJavaFormat()
-		importOrder("", "java|javax", "#")
+		importOrder("", "java|javax|jakarta", "#")
 		// fix formatting of type annotations
 		formatAnnotations()
 	}

docker/Dockerfile.dev

@@ -47,11 +47,11 @@ RUN cd base && make -j$(nproc)
 # Stage: Download and extract Tomcat
 # This stage is responsible only for getting the Tomcat binaries.
 FROM --platform=$BUILDPLATFORM debian:bookworm-slim AS tomcat-download-extract
-ARG TOMCAT_VERSION=9.0.79
+ARG TOMCAT_VERSION=11.0.12
 SHELL ["/bin/bash", "-c"]
 RUN apt-get update && apt-get install -y --no-install-recommends wget ca-certificates \
     && mkdir /tomcat \
-    && wget -q --show-progress "https://archive.apache.org/dist/tomcat/tomcat-9/v${TOMCAT_VERSION}/bin/apache-tomcat-${TOMCAT_VERSION}.tar.gz" -O /tmp/tomcat.tar.gz \
+    && wget -q --show-progress "https://archive.apache.org/dist/tomcat/tomcat-11/v${TOMCAT_VERSION}/bin/apache-tomcat-${TOMCAT_VERSION}.tar.gz" -O /tmp/tomcat.tar.gz \
     # Use --strip-components=1 to avoid the nested apache-tomcat-* directory
     && tar -xf /tmp/tomcat.tar.gz -C /tomcat --strip-components=1 \
     && rm /tmp/tomcat.tar.gz \

docs/docs/source/developer/details.md

@@ -50,7 +50,7 @@ These are the prerequisites for the EPICS archiver appliance.
   systems. If using RedHat, we should aim for RedHat 6.1.
 - JDK 1.16+ - definitely the 64 bit version for production systems. We
   need the JDK, **not** the JRE.
-- A recent version of Tomcat 9.x; preferably `apache-tomcat-9.0.20` or
+- A recent version of Tomcat 11.x; preferably `apache-tomcat-11.0.12` or
   later.
 - The management UI works best with a recent version of Firefox or
   Chrome.

docs/docs/source/samples/quickstart.sh

@@ -148,7 +148,7 @@ fi
 mkdir quickstart_tomcat
 tar -C quickstart_tomcat -zxf  "${TOMCAT_DISTRIBUTION}"
 cd quickstart_tomcat
-# eg. "apache-tomcat-9.0.20"
+# eg. "apache-tomcat-11.0.12"
 TOMCAT_VERSION_FOLDER=`ls -d apache-tomca* | head -1`
 
 # Make sure we have a valid server.xml

docs/docs/source/sysadmin/installguide.md

@@ -443,12 +443,12 @@ argument that identifies the parent folder of the individual Tomcat
 containers.
 
 ```bash
-$ export TOMCAT_HOME=/arch/single_machine_install/tomcats/apache-tomcat-9.0.20
+$ export TOMCAT_HOME=/arch/single_machine_install/tomcats/apache-tomcat-11.0.12
 $ export ARCHAPPL_APPLIANCES=/arch/single_machine_install/sample_appliances.xml
 $ export ARCHAPPL_MYIDENTITY=appliance0
 $ ./install_scripts/deployMultipleTomcats.py /arch/single_machine_install/tomcats
 Using
-    tomcat installation at /arch/single_machine_install/tomcats/apache-tomcat-9.0.20
+    tomcat installation at /arch/single_machine_install/tomcats/apache-tomcat-11.0.12
     to generate deployments for appliance appliance0
     using configuration info from /arch/single_machine_install/sample_appliances.xml
     into folder /arch/single_machine_install/tomcats

docs/docs/source/sysadmin/quickstart.md

@@ -65,7 +65,7 @@ Here are the steps to get started quickly.
 5. Run the script like so
 
    ```bash
-   $ ./quickstart.sh apache-tomcat-9.0.20.tar.gz
+   $ ./quickstart.sh apache-tomcat-11.0.12.tar.gz
    ```
 
 6. This should start the Tomcat process in the foreground. Once all the

src/main/org/epics/archiverappliance/common/ArchivedPVsInList.java

@@ -1,5 +1,11 @@
 package org.epics.archiverappliance.common;
 
+import com.hazelcast.projection.Projection;
+import com.hazelcast.query.Predicates;
+import org.epics.archiverappliance.config.ConfigService;
+import org.epics.archiverappliance.config.PVNames;
+import org.epics.archiverappliance.config.PVTypeInfo;
+
 import java.io.IOException;
 import java.io.Serializable;
 import java.util.Arrays;
@@ -8,75 +14,80 @@
 import java.util.Map;
 import java.util.stream.Collectors;
 
-import javax.servlet.http.HttpServletRequest;
-
-import org.epics.archiverappliance.config.ConfigService;
-import org.epics.archiverappliance.config.PVNames;
-import org.epics.archiverappliance.config.PVTypeInfo;
-import org.epics.archiverappliance.mgmt.bpl.PVsMatchingParameter;
-
-import com.hazelcast.projection.Projection;
-import com.hazelcast.query.Predicates;
-
 /*
  * Use a Hz query to determine the PV's that are being archived in this cluster.
  */
 public class ArchivedPVsInList {
 
-    private static record OnlyFields ( String pvName, String[] archiveFields ) implements Serializable {};
+    private static record OnlyFields(String pvName, String[] archiveFields) implements Serializable {}
+    ;
+
     private static class FieldsProjection implements Projection<Map.Entry<String, PVTypeInfo>, OnlyFields> {
         @Override
         public OnlyFields transform(Map.Entry<String, PVTypeInfo> entry) {
             String pvName = entry.getKey();
             PVTypeInfo value = entry.getValue();
-            return new OnlyFields(pvName, value.getArchiveFields()) ;
+            return new OnlyFields(pvName, value.getArchiveFields());
         }
     }
 
-	public static List<String> getArchivedPVs(List<String> pvNames, ConfigService configService) throws IOException {
-		record PVNameParts(String pvName, String plainPVName, boolean isField, String fieldName){};
-		LinkedList<PVNameParts> pvnps = new LinkedList<>();
-		for(String pvName : pvNames) {
-        	boolean isField = PVNames.isFieldOrFieldModifier(pvName);
-        	String plainPVName = PVNames.channelNamePVName(pvName);
-        	String fieldName = PVNames.getFieldName(pvName);
-			String realName = configService.getRealNameForAlias(plainPVName);
-			if(realName != null) {
-				plainPVName = realName;
-			}
-			pvnps.add(new PVNameParts(pvName, plainPVName, isField, fieldName));
-		}
+    public static List<String> getArchivedPVs(List<String> pvNames, ConfigService configService) throws IOException {
+        record PVNameParts(String pvName, String plainPVName, boolean isField, String fieldName) {}
+        ;
+        LinkedList<PVNameParts> pvnps = new LinkedList<>();
+        for (String pvName : pvNames) {
+            boolean isField = PVNames.isFieldOrFieldModifier(pvName);
+            String plainPVName = PVNames.channelNamePVName(pvName);
+            String fieldName = PVNames.getFieldName(pvName);
+            String realName = configService.getRealNameForAlias(plainPVName);
+            if (realName != null) {
+                plainPVName = realName;
+            }
+            pvnps.add(new PVNameParts(pvName, plainPVName, isField, fieldName));
+        }
+
+        Map<String, String[]> pvFieldsForPVNames = configService
+                .queryPVTypeInfos(
+                        Predicates.in(
+                                "__key",
+                                pvnps.stream()
+                                        .map((x) -> x.pvName)
+                                        .collect(Collectors.toList())
+                                        .toArray(new String[0])),
+                        new FieldsProjection())
+                .stream()
+                .collect(Collectors.toMap(OnlyFields::pvName, OnlyFields::archiveFields));
 
-        Map<String, String[]> pvFieldsForPVNames = configService.queryPVTypeInfos(
-			Predicates.in("__key", pvnps.stream().map((x) -> x.pvName).collect(Collectors.toList()).toArray(new String[0])),
-            new FieldsProjection())
-			.stream().collect(Collectors.toMap(OnlyFields::pvName, OnlyFields::archiveFields));
+        Map<String, String[]> pvFieldsForPlainPVNames = configService
+                .queryPVTypeInfos(
+                        Predicates.in(
+                                "__key",
+                                pvnps.stream()
+                                        .map((x) -> x.plainPVName)
+                                        .collect(Collectors.toList())
+                                        .toArray(new String[0])),
+                        new FieldsProjection())
+                .stream()
+                .collect(Collectors.toMap(OnlyFields::pvName, OnlyFields::archiveFields));
 
-		Map<String, String[]> pvFieldsForPlainPVNames = configService.queryPVTypeInfos(
-            Predicates.in("__key", pvnps.stream().map((x) -> x.plainPVName).collect(Collectors.toList()).toArray(new String[0])),
-            new FieldsProjection())
-			.stream().collect(Collectors.toMap(OnlyFields::pvName, OnlyFields::archiveFields));
-		
-		String[] emptyFields = new String[0];
-		LinkedList<String> archivedPVs = new LinkedList<String>();
-		for(PVNameParts pvnp : pvnps) {
-			if(pvnp.isField) {
-				if(pvFieldsForPVNames.containsKey(pvnp.pvName)
-				|| Arrays.asList(pvFieldsForPVNames.getOrDefault(pvnp.pvName, emptyFields)).contains(pvnp.fieldName)
-				|| pvFieldsForPlainPVNames.containsKey(pvnp.pvName)
-				|| Arrays.asList(pvFieldsForPlainPVNames.getOrDefault(pvnp.pvName, emptyFields)).contains(pvnp.fieldName)
-				) {
-					archivedPVs.add(pvnp.pvName);
-				}
-			} else {
-				if(pvFieldsForPVNames.containsKey(pvnp.pvName)
-				|| pvFieldsForPlainPVNames.containsKey(pvnp.pvName)
-				) {
-					archivedPVs.add(pvnp.pvName);
-				}	
-			}
-		}
-		return archivedPVs;
-	}
-    
+        String[] emptyFields = new String[0];
+        LinkedList<String> archivedPVs = new LinkedList<String>();
+        for (PVNameParts pvnp : pvnps) {
+            if (pvnp.isField) {
+                if (pvFieldsForPVNames.containsKey(pvnp.pvName)
+                        || Arrays.asList(pvFieldsForPVNames.getOrDefault(pvnp.pvName, emptyFields))
+                                .contains(pvnp.fieldName)
+                        || pvFieldsForPlainPVNames.containsKey(pvnp.pvName)
+                        || Arrays.asList(pvFieldsForPlainPVNames.getOrDefault(pvnp.pvName, emptyFields))
+                                .contains(pvnp.fieldName)) {
+                    archivedPVs.add(pvnp.pvName);
+                }
+            } else {
+                if (pvFieldsForPVNames.containsKey(pvnp.pvName) || pvFieldsForPlainPVNames.containsKey(pvnp.pvName)) {
+                    archivedPVs.add(pvnp.pvName);
+                }
+            }
+        }
+        return archivedPVs;
+    }
 }

src/main/org/epics/archiverappliance/common/BPLAction.java

@@ -7,23 +7,23 @@
  *******************************************************************************/
 package org.epics.archiverappliance.common;
 
-import java.io.IOException;
-
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-
 import org.epics.archiverappliance.config.ConfigService;
 
+import java.io.IOException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
 /**
- * A very simple struts like action for business processes. 
+ * A very simple struts like action for business processes.
  * Responses are typically JSON though this is not enforced.
  * We are not too far away from the servlet container here.
  * A handle to the configservice is passed in as part of the execute method.
- * The BPLAction is extected to handle all servlet container traffic like HTTP error codes etc. 
+ * The BPLAction is extected to handle all servlet container traffic like HTTP error codes etc.
  * If an exception is thrown, the servlet that calls BPLActions will send a Internal Server Error to the caller.
  * @author mshankar
  *
  */
 public interface BPLAction {
-	public void execute(HttpServletRequest req, HttpServletResponse resp, ConfigService configService) throws IOException;
+    public void execute(HttpServletRequest req, HttpServletResponse resp, ConfigService configService)
+            throws IOException;
 }

src/main/org/epics/archiverappliance/common/BasicDispatcher.java

@@ -16,12 +16,12 @@
 import org.epics.archiverappliance.utils.ui.MimeTypeConstants;
 import org.json.simple.JSONObject;
 
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.util.HashMap;
 import java.util.Map;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 
 /**
  * Glue code that is in all the BPL servlets.
@@ -31,10 +31,14 @@
 public class BasicDispatcher {
     private static final Logger logger = LogManager.getLogger(BasicDispatcher.class);
 
-    private BasicDispatcher() {
-    }
+    private BasicDispatcher() {}
 
-    public static void dispatch(HttpServletRequest req, HttpServletResponse resp, ConfigService configService, Map<String, Class<? extends BPLAction>> actions) throws IOException {
+    public static void dispatch(
+            HttpServletRequest req,
+            HttpServletResponse resp,
+            ConfigService configService,
+            Map<String, Class<? extends BPLAction>> actions)
+            throws IOException {
         String requestPath = req.getPathInfo();
         if (requestPath == null || requestPath.equals("")) {
             logger.warn("Request path is empty.");
@@ -46,21 +50,25 @@ public static void dispatch(HttpServletRequest req, HttpServletResponse resp, Co
             case "/ping" -> ping(resp, "pong");
             case "/postStartup" -> postStartup(resp, configService);
             case "/startupState" -> startupState(resp, configService);
-            default ->
-                    handleBPLAction(req, resp, configService, actions, requestPath);
+            default -> handleBPLAction(req, resp, configService, actions, requestPath);
         }
-
     }
 
-    private static void handleBPLAction(HttpServletRequest req, HttpServletResponse resp, ConfigService configService, Map<String, Class<? extends BPLAction>> actions, String requestPath) throws IOException {
+    private static void handleBPLAction(
+            HttpServletRequest req,
+            HttpServletResponse resp,
+            ConfigService configService,
+            Map<String, Class<? extends BPLAction>> actions,
+            String requestPath)
+            throws IOException {
         if (!configService.isStartupComplete()) {
             logger.warn("We do not let the other actions complete until the config service startup is complete...");
             resp.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
             return;
         }
 
-
-        if (configService.getWarFile() == WAR_FILE.MGMT && !configService.getMgmtRuntimeState().haveChildComponentsStartedUp()) {
+        if (configService.getWarFile() == WAR_FILE.MGMT
+                && !configService.getMgmtRuntimeState().haveChildComponentsStartedUp()) {
             String header = req.getHeader(GetUrlContent.ARCHAPPL_COMPONENT);
             if (header == null || !header.equals("true")) {
                 logger.error("We do not let the actions complete until all the components have started up");
@@ -71,7 +79,8 @@ private static void handleBPLAction(HttpServletRequest req, HttpServletResponse
 
         Class<? extends BPLAction> actionClass = actions.get(requestPath);
         if (actionClass == null) {
-            logger.error("Do not have a appropriate BPL action for " + requestPath + ". Please register the appropriate business method in getActions.");
+            logger.error("Do not have a appropriate BPL action for " + requestPath
+                    + ". Please register the appropriate business method in getActions.");
             resp.sendError(HttpServletResponse.SC_NOT_FOUND);
             return;
         }
@@ -113,6 +122,6 @@ private static void ping(HttpServletResponse resp, String pong) throws IOExcepti
         resp.setContentType("text/plain");
         try (PrintWriter out = resp.getWriter()) {
             out.println(pong);
-		}
+        }
     }
 }