Add basic support for servlet 4.0

Author: chadlwilson

History.md

@@ -1,10 +1,11 @@
 ## 1.3.0 (UNRELEASED) 
 
+- Require Java 11 or later
+- Support Javax Servlet API 4.0 (JEE 8)
 - Adds basic compatibility with JRuby 10.0
+- Drop support for JRuby 9.3
 - Drop unnecessary jruby.compat.version and RackConfig.getCompatVersion() API
 - Drop JMS support
-- Drop support for JRuby 9.3
-- Require Java 11 or later
 - update (bundled) rack to 2.2.17
 
 ## 1.2.4 (UNRELEASED)

pom.xml

@@ -23,7 +23,7 @@
     <jruby.maven.plugins.version>3.0.6</jruby.maven.plugins.version>
     <gem.home>${project.build.directory}/rubygems</gem.home>
     <slf4j.version>2.0.17</slf4j.version>
-    <spring.version>4.3.30.RELEASE</spring.version>
+    <spring.version>5.3.39</spring.version>
   </properties>
 
   <issueManagement>
@@ -99,9 +99,9 @@
       <scope>provided</scope>
     </dependency>
     <dependency>
-      <groupId>javax.servlet</groupId>
-      <artifactId>javax.servlet-api</artifactId>
-      <version>3.0.1</version>
+      <groupId>jakarta.servlet</groupId>
+      <artifactId>jakarta.servlet-api</artifactId>
+      <version>4.0.4</version>
       <scope>provided</scope>
     </dependency>
     <dependency>

src/main/java/org/jruby/rack/servlet/DefaultServletRackContext.java

@@ -270,57 +270,97 @@ public void declareRoles(String... roleNames) {
         context.declareRoles(roleNames);
     }
 
+    @Override
+    public String getVirtualServerName() {
+        return context.getVirtualServerName();
+    }
+
+    @Override
+    public int getSessionTimeout() {
+        return context.getSessionTimeout();
+    }
+
+    @Override
+    public void setSessionTimeout(int sessionTimeout) {
+        context.setSessionTimeout(sessionTimeout);
+    }
+
+    @Override
+    public String getRequestCharacterEncoding() {
+        return context.getRequestCharacterEncoding();
+    }
+
+    @Override
+    public void setRequestCharacterEncoding(String encoding) {
+        context.setRequestCharacterEncoding(encoding);
+    }
+
+    @Override
+    public String getResponseCharacterEncoding() {
+        return context.getResponseCharacterEncoding();
+    }
+
+    @Override
+    public void setResponseCharacterEncoding(String encoding) {
+        context.setResponseCharacterEncoding(encoding);
+    }
+
     @Override
     public <T extends Servlet> T createServlet(Class<T> type) throws ServletException {
         return context.createServlet(type);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public ServletRegistration.Dynamic addServlet(String servletName, String className) throws IllegalArgumentException, IllegalStateException {
         return context.addServlet(servletName, className);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet) throws IllegalArgumentException, IllegalStateException {
         return context.addServlet(servletName, servlet);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public ServletRegistration.Dynamic addServlet(String servletName, Class<? extends Servlet> servletClass) throws IllegalArgumentException, IllegalStateException {
         return context.addServlet(servletName, servletClass);
     }
 
-    @Override // 3.0 in method signature
+    @Override
+    public ServletRegistration.Dynamic addJspFile(String servletName, String jspFile) {
+        return context.addJspFile(servletName, jspFile);
+    }
+
+    @Override
     public ServletRegistration getServletRegistration(String servletName) {
         return context.getServletRegistration(servletName);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public Map<String, ? extends ServletRegistration> getServletRegistrations() {
         return context.getServletRegistrations();
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public <T extends Filter> T createFilter(Class<T> type) throws ServletException {
         return context.createFilter(type);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public FilterRegistration.Dynamic addFilter(String filterName, String className) throws IllegalArgumentException, IllegalStateException {
         return context.addFilter(filterName, className);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public FilterRegistration.Dynamic addFilter(String filterName, Filter filter) throws IllegalArgumentException, IllegalStateException {
         return context.addFilter(filterName, filter);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public FilterRegistration.Dynamic addFilter(String filterName, Class<? extends Filter> filterClass) throws IllegalArgumentException, IllegalStateException {
         return context.addFilter(filterName, filterClass);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public FilterRegistration getFilterRegistration(String filterName) {
         return context.getFilterRegistration(filterName);
     }
@@ -350,7 +390,7 @@ public <T extends EventListener> T createListener(Class<T> listenerClass) throws
         return context.createListener(listenerClass);
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public SessionCookieConfig getSessionCookieConfig() {
         return context.getSessionCookieConfig();
     }
@@ -370,7 +410,7 @@ public Set<SessionTrackingMode> getEffectiveSessionTrackingModes() {
         return context.getEffectiveSessionTrackingModes();
     }
 
-    @Override // 3.0 in method signature
+    @Override
     public JspConfigDescriptor getJspConfigDescriptor() {
         return context.getJspConfigDescriptor();
     }

src/main/java/org/jruby/rack/servlet/ResponseCapture.java

@@ -19,6 +19,7 @@
 import java.util.Set;
 
 import javax.servlet.ServletOutputStream;
+import javax.servlet.WriteListener;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import javax.servlet.http.HttpServletResponseWrapper;
@@ -166,7 +167,17 @@ public ServletOutputStream getOutputStream() throws IOException {
             // backwards compatibility with isError() :
             return new ServletOutputStream() {
                 @Override
-                public void write(int b) throws IOException {
+                public boolean isReady() {
+                    return true;
+                }
+
+                @Override
+                public void setWriteListener(WriteListener writeListener) {
+                    // swallow listeners, as we're also going to swallow output
+                }
+
+                @Override
+                public void write(int b) {
                     // swallow output, because we're going to discard it
                 }
             };

src/main/java/org/jruby/rack/servlet/RewindableInputStream.java

@@ -13,6 +13,7 @@
 import java.io.RandomAccessFile;
 import java.nio.ByteBuffer;
 
+import javax.servlet.ReadListener;
 import javax.servlet.ServletInputStream;
 
 /**
@@ -401,5 +402,27 @@ public int getCurrentBufferSize() {
     public int getMaximumBufferSize() {
         return bufferMax;
     }
-    
+
+    @Override
+    public boolean isFinished() {
+        try {
+            return input.available() <= 0;
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    @Override
+    public boolean isReady() {
+        try {
+            return input.available() >= 0;
+        } catch (IOException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    @Override
+    public void setReadListener(ReadListener readListener) {
+        throw new UnsupportedOperationException("readListener not supported");
+    }
 }

src/main/java/org/jruby/rack/servlet/ServletRackIncludedResponse.java

@@ -16,6 +16,7 @@
 
 import javax.servlet.ServletOutputStream;
 import javax.servlet.ServletResponse;
+import javax.servlet.WriteListener;
 import javax.servlet.http.HttpServletResponse;
 import javax.servlet.http.HttpServletResponseWrapper;
 
@@ -158,7 +159,7 @@ private void initializeOutputStream() {
 	 */
 	private static class ByteArrayServletOutputStream extends ServletOutputStream {
 
-		private final static String LINE_SEPARATOR = System.getProperty("line.separator");
+		private final static String LINE_SEPARATOR = System.lineSeparator();
 		private final DataOutputStream dataOutputStream;
 		private final String charSet;
 
@@ -169,23 +170,33 @@ public ByteArrayServletOutputStream(ByteArrayOutputStream byteOutputStream, Stri
 		}
 
 		@Override
-		public void print(boolean b) throws IOException {
-			dataOutputStream.writeBoolean(b);
+		public void write(byte[] b, int off, int len) throws IOException {
+			dataOutputStream.write(b, off, len);
 		}
 
 		@Override
-		public void print(char c) throws IOException {
-			dataOutputStream.writeChar(c);
+		public void write(byte[] b) throws IOException {
+			dataOutputStream.write(b);
 		}
 
 		@Override
-		public void print(double d) throws IOException {
-			dataOutputStream.writeDouble(d);
+		public void write(int i) throws IOException {
+			dataOutputStream.write(i);
 		}
 
 		@Override
-		public void print(float f) throws IOException {
-			dataOutputStream.writeFloat(f);
+		public void print(String s) throws IOException {
+			dataOutputStream.write(s.getBytes(charSet));
+		}
+
+		@Override
+		public void print(boolean b) throws IOException {
+			dataOutputStream.writeBoolean(b);
+		}
+
+		@Override
+		public void print(char c) throws IOException {
+			dataOutputStream.writeChar(c);
 		}
 
 		@Override
@@ -199,36 +210,34 @@ public void print(long l) throws IOException {
 		}
 
 		@Override
-		public void print(String s) throws IOException {
-			dataOutputStream.write(s.getBytes(charSet));
+		public void print(float f) throws IOException {
+			dataOutputStream.writeFloat(f);
 		}
 
 		@Override
-		public void println() throws IOException {
-			dataOutputStream.write(LINE_SEPARATOR.getBytes(charSet));
+		public void print(double d) throws IOException {
+			dataOutputStream.writeDouble(d);
 		}
 
 		@Override
-		public void println(boolean b) throws IOException {
-			print(b);
-			println();
+		public void println() throws IOException {
+			dataOutputStream.write(LINE_SEPARATOR.getBytes(charSet));
 		}
 
 		@Override
-		public void println(char c) throws IOException {
-			print(c);
-			println();
+		public void println(String s) throws IOException {
+			print(s);
 		}
 
 		@Override
-		public void println(double d) throws IOException {
-			print(d);
+		public void println(boolean b) throws IOException {
+			print(b);
 			println();
 		}
 
 		@Override
-		public void println(float f) throws IOException {
-			print(f);
+		public void println(char c) throws IOException {
+			print(c);
 			println();
 		}
 
@@ -245,23 +254,25 @@ public void println(long l) throws IOException {
 		}
 
 		@Override
-		public void println(String s) throws IOException {
-			print(s);
+		public void println(float f) throws IOException {
+			print(f);
+			println();
 		}
 
 		@Override
-		public void write(byte[] b, int off, int len) throws IOException {
-			dataOutputStream.write(b, off, len);
+		public void println(double d) throws IOException {
+			print(d);
+			println();
 		}
 
 		@Override
-		public void write(byte[] b) throws IOException {
-			dataOutputStream.write(b);
+		public boolean isReady() {
+			return true;
 		}
 
 		@Override
-		public void write(int i) throws IOException {
-			dataOutputStream.write(i);
+		public void setWriteListener(WriteListener writeListener) {
+			throw new UnsupportedOperationException("writeListener not supported");
 		}
 	}
 }