Issue #4433 - Implement ServletContext.addJspFile (#4463)

* Issue #4433 Implement ServletContext.addJspFile

Signed-off-by: Jan Bartel <janb@webtide.com>

jetty-server/src/main/java/org/eclipse/jetty/server/handler/ContextHandler.java

@@ -2717,7 +2717,6 @@ public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
         @Override
         public ServletRegistration.Dynamic addJspFile(String servletName, String jspFile)
         {
-            // TODO new in 4.0
             LOG.warn(UNIMPLEMENTED_USE_SERVLET_CONTEXT_HANDLER, "addJspFile(String, String)");
             return null;
         }

jetty-servlet/src/main/java/org/eclipse/jetty/servlet/ServletContextHandler.java

@@ -39,6 +39,7 @@
 import javax.servlet.ServletContextListener;
 import javax.servlet.ServletException;
 import javax.servlet.ServletRegistration;
+import javax.servlet.ServletRegistration.Dynamic;
 import javax.servlet.ServletSecurityElement;
 import javax.servlet.SessionCookieConfig;
 import javax.servlet.SessionTrackingMode;
@@ -1256,6 +1257,33 @@ public ServletRegistration.Dynamic addServlet(String servletName, Servlet servle
             else
                 return null; //existing completed registration for servlet name
         }
+
+        @Override
+        public ServletRegistration.Dynamic addJspFile(String servletName, String jspFile)
+        {
+            checkDynamic(servletName);
+
+            final ServletHandler handler = ServletContextHandler.this.getServletHandler();
+            ServletHolder holder = handler.getServlet(servletName);
+            if (holder == null)
+            {
+                //new servlet
+                holder = handler.newServletHolder(Source.JAVAX_API);
+                holder.setName(servletName);
+                holder.setForcedPath(jspFile);
+                handler.addServlet(holder);
+                return dynamicHolderAdded(holder);
+            }
+
+            //complete a partial registration
+            if (holder.getClassName() == null && holder.getHeldClass() == null && holder.getForcedPath() == null)
+            {
+                holder.setForcedPath(jspFile);
+                return holder.getRegistration();
+            }
+            else
+                return null; //existing completed registration for servlet name
+        }
 
         @Override
         public boolean setInitParameter(String name, String value)

jetty-servlet/src/test/java/org/eclipse/jetty/servlet/ServletContextHandlerTest.java

@@ -59,6 +59,7 @@
 import javax.servlet.http.HttpSessionIdListener;
 import javax.servlet.http.HttpSessionListener;
 
+import org.eclipse.jetty.http.pathmap.MappedResource;
 import org.eclipse.jetty.security.ConstraintSecurityHandler;
 import org.eclipse.jetty.security.RoleInfo;
 import org.eclipse.jetty.security.SecurityHandler;
@@ -884,6 +885,117 @@ public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletExcepti
         assertThat("Response", response, containsString("Hello World"));
     }
 
+    @Test
+    public void testAddJspFile() throws Exception
+    {
+        ContextHandlerCollection contexts = new ContextHandlerCollection();
+        _server.setHandler(contexts);
+
+        ServletContextHandler root = new ServletContextHandler(contexts, "/");
+        ServletHolder jspServlet = new ServletHolder();
+        jspServlet.setName("jsp");
+        jspServlet.setHeldClass(FakeJspServlet.class);
+        root.addServlet(jspServlet, "*.jsp");
+        class JSPAddingSCI implements ServletContainerInitializer
+        {
+            @Override
+            public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException
+            {
+                try
+                {
+                    ServletRegistration rego = ctx.addJspFile("some.jsp", "/path/to/some.jsp");
+                    rego.addMapping("/somejsp/*");
+                }
+                catch (Exception e)
+                {
+                    fail(e);
+                }
+            }
+        }
+
+        root.addBean(new MySCIStarter(root.getServletContext(), new JSPAddingSCI()), true);
+        _server.start();
+        MappedResource<ServletHolder> mappedServlet = root.getServletHandler().getMappedServlet("/somejsp/xxx");
+        assertNotNull(mappedServlet.getResource());
+        assertEquals("some.jsp", mappedServlet.getResource().getName());
+    }
+
+    @Test
+    public void testAddJspFileWithExistingRegistration() throws Exception
+    {
+        ContextHandlerCollection contexts = new ContextHandlerCollection();
+        _server.setHandler(contexts);
+
+        ServletContextHandler root = new ServletContextHandler(contexts, "/");
+        ServletHolder jspServlet = new ServletHolder();
+        jspServlet.setName("jsp");
+        jspServlet.setHeldClass(FakeJspServlet.class);
+        root.addServlet(jspServlet, "*.jsp");
+        //add a full registration so that the addJspFile will fail
+        ServletHolder barServlet = new ServletHolder();
+        barServlet.setName("some.jsp");
+        barServlet.setHeldClass(HelloServlet.class);
+        root.addServlet(barServlet, "/bar/*");
+        class JSPAddingSCI implements ServletContainerInitializer
+        {
+            @Override
+            public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException
+            {
+                try
+                {
+                    ServletRegistration rego = ctx.addJspFile("some.jsp", "/path/to/some.jsp");
+                    assertNull(rego);
+                }
+                catch (Exception e)
+                {
+                    fail(e);
+                }
+            }
+        }
+
+        root.addBean(new MySCIStarter(root.getServletContext(), new JSPAddingSCI()), true);
+        _server.start();
+    }
+
+    @Test
+    public void testAddJspFileWithPartialRegistration() throws Exception
+    {
+        ContextHandlerCollection contexts = new ContextHandlerCollection();
+        _server.setHandler(contexts);
+
+        ServletContextHandler root = new ServletContextHandler(contexts, "/");
+        ServletHolder jspServlet = new ServletHolder();
+        jspServlet.setName("jsp");
+        jspServlet.setHeldClass(FakeJspServlet.class);
+        root.addServlet(jspServlet, "*.jsp");
+        //add a preliminary registration so that the addJspFile will complete it
+        ServletHolder barServlet = new ServletHolder();
+        barServlet.setName("some.jsp");
+        root.addServlet(barServlet, "/bar/*");
+        class JSPAddingSCI implements ServletContainerInitializer
+        {
+            @Override
+            public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException
+            {
+                try
+                {
+                    ServletRegistration rego = ctx.addJspFile("some.jsp", "/path/to/some.jsp");
+                    assertNotNull(rego);
+                }
+                catch (Exception e)
+                {
+                    fail(e);
+                }
+            }
+        }
+
+        root.addBean(new MySCIStarter(root.getServletContext(), new JSPAddingSCI()), true);
+        _server.start();
+        MappedResource<ServletHolder> mappedServlet = root.getServletHandler().getMappedServlet("/bar/xxx");
+        assertNotNull(mappedServlet.getResource());
+        assertEquals("some.jsp", mappedServlet.getResource().getName());
+    }
+
     @Test
     public void testAddServletAfterStart() throws Exception
     {
@@ -1391,6 +1503,11 @@ protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws Se
             }
         }
     }
+
+    public static class FakeJspServlet extends HttpServlet
+    {
+
+    }
 
     public static class ServletAddingServlet extends HttpServlet
     {

tests/test-distribution/src/test/java/org/eclipse/jetty/tests/distribution/DemoBaseTests.java

@@ -139,10 +139,21 @@ public void testSpec() throws Exception
             assertTrue(run1.awaitConsoleLogsFor("Started Server@", 20, TimeUnit.SECONDS));
 
             startHttpClient();
+
+            //test the async listener
             ContentResponse response = client.POST("http://localhost:" + httpPort + "/test-spec/asy/xx").send();
             assertEquals(HttpStatus.OK_200, response.getStatus());
             assertThat(response.getContentAsString(), containsString("<span class=\"pass\">PASS</span>"));
             assertThat(response.getContentAsString(), not(containsString("<span class=\"fail\">FAIL</span>")));
+
+            //test the servlet 3.1/4 features
+            response = client.POST("http://localhost:" + httpPort + "/test-spec/test/xx").send();
+            assertThat(response.getContentAsString(), containsString("<span class=\"pass\">PASS</span>"));
+            assertThat(response.getContentAsString(), not(containsString("<span class=\"fail\">FAIL</span>")));
+
+            //test dynamic jsp
+            response = client.POST("http://localhost:" + httpPort + "/test-spec/dynamicjsp/xx").send();
+            assertThat(response.getContentAsString(), containsString("Programmatically Added Jsp File"));
         }
     }
 

tests/test-webapps/test-servlet-spec/test-container-initializer/src/main/java/com/acme/initializer/FooInitializer.java

@@ -103,5 +103,10 @@ public void onStartup(Set<Class<?>> classes, ServletContext context)
         ServletRegistration.Dynamic reg = context.addServlet("AnnotationTest", "com.acme.AnnotationTest");
         context.setAttribute("com.acme.AnnotationTest.complete", (reg == null));
         context.addListener(new FooListener());
+
+        //test adding jsp file dynamically
+        ServletRegistration.Dynamic jspFile = context.addJspFile("dynamic.jsp", "/dynamic.jsp");
+        context.setAttribute("com.acme.jsp.file", (jspFile != null));
+        jspFile.addMapping("/dynamicjsp/*");
     }
 }

tests/test-webapps/test-servlet-spec/test-spec-webapp/src/main/java/com/acme/test/AnnotationTest.java

@@ -262,7 +262,11 @@ else if (!classNames.containsAll(__HandlesTypes))
             out.println("<h2>ServletContextListener Registration Prevented from ServletContextListener</h2>");
             Boolean webListenerPrevention = (Boolean)config.getServletContext().getAttribute("com.acme.AnnotationTest.sclFromSclRegoTest");
             out.println("<p><b>Result: " + (webListenerPrevention.booleanValue() ? "<span class=\"pass\">PASS" : "<span class=\"fail\">FAIL") + "</span></b></p>");
-
+
+            out.println("<h2>Add Jsp File Registration</h2>");
+            complete = (Boolean)config.getServletContext().getAttribute("com.acme.jsp.file");
+            out.println("<p><b>Result: " + (complete.booleanValue() ? "<span class=\"pass\">PASS" : "<span class=\"fail\">FAIL") + "</span></b></p>");
+
             out.println("<h2>ServletContextListener In web.xml Injected</h2>");
             Boolean listenerInject = (Boolean)config.getServletContext().getAttribute("com.acme.AnnotationTest.sclInjectTest");
             out.println("<p><b>Result: " + (listenerInject.booleanValue() ? "<span class=\"pass\">PASS" : "<span class=\"fail\">FAIL") + "</span></b></p>");

tests/test-webapps/test-servlet-spec/test-spec-webapp/src/main/webapp/dynamic.jsp

@@ -0,0 +1,16 @@
+<%@ page contentType="text/html; charset=UTF-8" %>
+<%@ page import="java.util.*"%>
+<%@ page import="javax.servlet.*" %>
+<%@ page import="javax.servlet.http.*" %>
+<html>
+<head>
+<title>Dynamic</title>
+</head>
+
+<body>
+
+   <h1>Programmatically Added Jsp File</h1>
+    Success.
+</body>
+
+</html>

tests/test-webapps/test-servlet-spec/test-spec-webapp/src/main/webapp/index.html

@@ -30,6 +30,10 @@ <h3>Test Defaults, Annotations, Fragments and Initializers</h3>
   <button type="submit">Test</button>
 </form>
 
+<h3>Test Dynamically Added Jsp File</h3>
+<p>Click the link to test accessing a programmatically added jsp file</p>
+<a href="dynamicjsp/x">Dynamically added jsp </a>
+
 <h3>Test Static Content from Fragment </h3>
 <p>Click the link to test accessing static content from a fragment's META-INF/resources</p>
 <a href="fragmentA/index.html">Static resource from a fragment </a>