Migrate to jakarta namespace

.github/workflows/maven.yml

@@ -13,28 +13,12 @@ jobs:
     strategy:
       matrix:
        include:
-         - HTTPCLIENT_VERSION: 4.3.6
-           HTTPCLIENT_TEST_VERSION: 4.3.6
-           JDOC: ""
-         - HTTPCLIENT_VERSION: 4.4.1
-           HTTPCLIENT_TEST_VERSION: 4.3.6
-           JDOC: ""
          - HTTPCLIENT_VERSION: 4.5.13
            HTTPCLIENT_TEST_VERSION: 4.3.6
            JDOC: "site"           
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up JDK 1.8
-      uses: actions/setup-java@v1
-      with:
-        java-version: 1.8
-    - name: Build with Maven
-      env:
-          HTTPCLIENT_VERSION: ${{ matrix.HTTPCLIENT_VERSION }}
-          HTTPCLIENT_TEST_VERSION: ${{ matrix.HTTPCLIENT_TEST_VERSION }}
-          JDOC: ${{ matrix.JDOC }}
-      run: mvn -B -Dhttpclient.version=$HTTPCLIENT_VERSION -Dhttpclient.test.version=$HTTPCLIENT_TEST_VERSION verify $JDOC
     - name: Set up JDK 11
       uses: actions/setup-java@v1
       with:

CHANGES.md

@@ -1,7 +1,9 @@
-# Version 1.13 (unreleased)
+# Version 2.0 (unreleased)
 
 \#231: Added support of preserveCookiePath configuration parameter. It allows to keep cookie path unchanged in Set-Cookie server response header.
 
+\#237: Switched to the `jakarta servlet-api`.  However, legacy `javax servlet-api` support is still available via the `javax` classifier.
+
 # Version 1.12.1 released on 2021-12-28
 
 \#215: '[' and ']' should be encoded as they are unsafe characters. https://www.ietf.org/rfc/rfc1738.txt

README.md

@@ -27,8 +27,20 @@ In the meantime, you'll have to add the jar files for this and its dependencies:
         |  +- commons-logging:commons-logging:jar:1.2:compile
         |  \- commons-codec:commons-codec:jar:1.11:compile
 
-This proxy supports HttpClient 4.3, and newer version too.
-If you need to support _older_ HttpClient versions, namely 4.1 and 4.2, then use  the 1.8 version of this proxy.
+This proxy supports HttpClient 4.5, and newer version too.
+If you need to support _older_ HttpClient versions:
+* use 1.8 version of this proxy for HttpClient versions 4.1 and 4.2
+* use 1.12 version of this proxy for HttpClient versions 4.3 and 4.4
+
+As of version 2.0 of the proxy, the proxy switched to the `jakarta servlet-api`, while nonetheless retaining support for the `javax servlet-api` version for those that need it.  To use that, specify the `javax` classifier on the dependency declaration as follows:
+```xml
+<dependency>
+    <groupId>org.mitre.dsmiley.httpproxy</groupId>
+    <artifactId>smiley-http-proxy-servlet</artifactId>
+    <version>${smiley-http-proxy-servlet.version}</version>
+    <classifier>javax</classifier>
+</dependency>
+```
 
 As of version 1.5 of the proxy, there is the ability to parameterize your proxy URL, allowing you to use
 the same web.xml servlet specification for multiple target servers. It follows the

pom.xml

@@ -3,7 +3,7 @@
 
   <groupId>org.mitre.dsmiley.httpproxy</groupId>
   <artifactId>smiley-http-proxy-servlet</artifactId>
-  <version>1.13-SNAPSHOT</version>
+  <version>2.0-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>Smiley's HTTP Proxy Servlet</name>
@@ -54,11 +54,10 @@
 
   <dependencies>
 
-    <!-- Probably works with 3.0 as well -->
     <dependency>
-      <groupId>javax.servlet</groupId>
-      <artifactId>javax.servlet-api</artifactId>
-      <version>3.1.0</version>
+      <groupId>jakarta.servlet</groupId>
+      <artifactId>jakarta.servlet-api</artifactId>
+      <version>5.0.0</version>
       <scope>provided</scope>
     </dependency>
 
@@ -84,9 +83,9 @@
     </dependency>
 
     <dependency>
-      <groupId>httpunit</groupId>
+      <groupId>com.github.hazendaz.httpunit</groupId>
       <artifactId>httpunit</artifactId>
-      <version>1.7</version>
+      <version>2.0.0</version>
       <scope>test</scope>
     </dependency>
 
@@ -106,7 +105,7 @@
     <dependency>
       <groupId>org.eclipse.jetty</groupId>
       <artifactId>jetty-servlet</artifactId>
-      <version>9.4.30.v20200611</version>
+      <version>11.0.13</version>
       <scope>test</scope>
     </dependency>
   </dependencies>
@@ -147,8 +146,8 @@
  org.apache.http.util; version="0",
  org.apache.http.client.utils;version="0",
  org.apache.http.client.methods;version="0",
- javax.servlet;version="0",
- javax.servlet.http;version="0",
+ jakarta.servlet;version="0",
+ jakarta.servlet.http;version="0",
  javax.net.ssl;version="0", org.apache.http.client.config;version="0"</Import-Package>
             </manifestEntries>
           </archive>
@@ -191,6 +190,41 @@
         <version>3.9.1</version>
       </plugin>
 
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-shade-plugin</artifactId>
+        <version>3.2.2</version>
+        <executions>
+          <execution>
+            <id>javax</id>
+            <phase>package</phase>
+            <goals>
+              <goal>shade</goal>
+            </goals>
+            <configuration>
+              <shadedClassifierName>javax</shadedClassifierName>
+              <shadedArtifactAttached>true</shadedArtifactAttached>
+              <createDependencyReducedPom>false</createDependencyReducedPom>
+              <artifactSet>
+                <includes>
+                  <include>${project.groupId}:${project.artifactId}</include>
+                </includes>
+              </artifactSet>
+              <relocations>
+                <relocation>
+                  <pattern>jakarta.servlet</pattern>
+                  <shadedPattern>javax.servlet</shadedPattern>
+                </relocation>
+                <relocation>
+                  <pattern>jakarta.annotation</pattern>
+                  <shadedPattern>javax.annotation</shadedPattern>
+                </relocation>
+              </relocations>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+
     </plugins>
   </build>
 

src/main/java/org/mitre/dsmiley/httpproxy/ProxyServlet.java

@@ -37,11 +37,11 @@
 import org.apache.http.message.HeaderGroup;
 import org.apache.http.util.EntityUtils;
 
-import javax.servlet.ServletException;
-import javax.servlet.http.Cookie;
-import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.Cookie;
+import jakarta.servlet.http.HttpServlet;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 import java.io.Closeable;
 import java.io.IOException;
 import java.io.InputStream;
@@ -272,7 +272,7 @@ protected void initTarget() throws ServletException {
   }
 
   /**
-   * Called from {@link #init(javax.servlet.ServletConfig)}.
+   * Called from {@link #init(jakarta.servlet.ServletConfig)}.
    * HttpClient offers many opportunities for customization.
    * In any case, it should be thread-safe.
    */
@@ -374,11 +374,8 @@ protected void service(HttpServletRequest servletRequest, HttpServletResponse se
 
       // Process the response:
 
-      // Pass the response code. This method with the "reason phrase" is deprecated but it's the
-      //   only way to pass the reason along too.
       int statusCode = proxyResponse.getStatusLine().getStatusCode();
-      //noinspection deprecation
-      servletResponse.setStatus(statusCode, proxyResponse.getStatusLine().getReasonPhrase());
+      servletResponse.setStatus(statusCode);
 
       // Copying response headers to make sure SESSIONID or other Cookie which comes from the remote
       // server will be saved in client when the proxied url was redirected to another one.
@@ -751,7 +748,7 @@ protected String rewriteQueryStringFromRequest(HttpServletRequest servletRequest
   }
 
   /**
-   * Allow overrides of {@link javax.servlet.http.HttpServletRequest#getPathInfo()}.
+   * Allow overrides of {@link jakarta.servlet.http.HttpServletRequest#getPathInfo()}.
    * Useful when url-pattern of servlet-mapping (web.xml) requires manipulation.
    */
   protected String rewritePathInfoFromRequest(HttpServletRequest servletRequest) {

src/main/java/org/mitre/dsmiley/httpproxy/URITemplateProxyServlet.java

@@ -20,9 +20,9 @@
 import org.apache.http.client.utils.URIUtils;
 import org.apache.http.client.utils.URLEncodedUtils;
 
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;

src/test/java/org/mitre/dsmiley/httpproxy/AcceptEncodingTest.java

@@ -15,15 +15,17 @@
  */
 package org.mitre.dsmiley.httpproxy;
 
+import static org.junit.Assert.assertEquals;
+
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServlet;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.HashSet;
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpGet;
 import org.apache.http.impl.client.CloseableHttpClient;
@@ -34,7 +36,6 @@
 import org.eclipse.jetty.servlet.ServletHandler;
 import org.eclipse.jetty.servlet.ServletHolder;
 import org.junit.After;
-import static org.junit.Assert.assertEquals;
 import org.junit.Before;
 import org.junit.Test;
 

src/test/java/org/mitre/dsmiley/httpproxy/ChunkedTransferTest.java

@@ -23,10 +23,10 @@
 import java.util.List;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.TimeUnit;
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServlet;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 import org.apache.http.MalformedChunkCodingException;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpGet;

src/test/java/org/mitre/dsmiley/httpproxy/ModifyHeadersProxyServletTest.java

@@ -25,8 +25,8 @@
 import org.apache.http.protocol.HttpContext;
 import org.junit.Test;
 
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 import java.io.IOException;
 
 import static org.junit.Assert.assertEquals;

src/test/java/org/mitre/dsmiley/httpproxy/ParallelConnectionsTest.java

@@ -31,10 +31,10 @@
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
+import jakarta.servlet.ServletException;
+import jakarta.servlet.http.HttpServlet;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
 
 import org.eclipse.jetty.server.Server;
 import org.eclipse.jetty.server.ServerConnector;