You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by fs...@apache.org on 2015/01/12 16:22:16 UTC

svn commit: r1651116 - in /tomcat/trunk: java/org/apache/catalina/startup/Tomcat.java test/org/apache/catalina/startup/TestTomcat.java webapps/docs/changelog.xml

Author: fschumacher
Date: Mon Jan 12 15:22:16 2015
New Revision: 1651116

URL: http://svn.apache.org/r1651116
Log:
Enable custom context class when using embedded tomcat

Modified:
    tomcat/trunk/java/org/apache/catalina/startup/Tomcat.java
    tomcat/trunk/test/org/apache/catalina/startup/TestTomcat.java
    tomcat/trunk/webapps/docs/changelog.xml

Modified: tomcat/trunk/java/org/apache/catalina/startup/Tomcat.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/startup/Tomcat.java?rev=1651116&r1=1651115&r2=1651116&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/startup/Tomcat.java (original)
+++ tomcat/trunk/java/org/apache/catalina/startup/Tomcat.java Mon Jan 12 15:22:16 2015
@@ -18,6 +18,7 @@ package org.apache.catalina.startup;
 
 import java.io.File;
 import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.security.Principal;
@@ -495,7 +496,7 @@ public class Tomcat {
     public Context addContext(Host host, String contextPath, String contextName,
             String dir) {
         silence(host, contextPath);
-        Context ctx = new StandardContext();
+        Context ctx = createContext(host, contextPath);
         ctx.setName(contextName);
         ctx.setPath(contextPath);
         ctx.setDocBase(dir);
@@ -522,7 +523,7 @@ public class Tomcat {
     public Context addWebapp(Host host, String url, String name, String path) {
         silence(host, url);
 
-        Context ctx = new StandardContext();
+        Context ctx = createContext(host, url);
         ctx.setName(name);
         ctx.setPath(url);
         ctx.setDocBase(path);
@@ -688,6 +689,40 @@ public class Tomcat {
     }
 
     /**
+     * Create the configured {@link Context} for the given <code>host</code>.
+     * The default constructor of the class that was configured with
+     * {@link StandardHost#setContextClass(String)} will be used
+     *
+     * @param host
+     *            host for which the {@link Context} should be created, or
+     *            <code>null</code> if default host should be used
+     * @param url
+     *            path of the webapp which should get the {@link Context}
+     * @return newly created {@link Context}
+     */
+    private Context createContext(Host host, String url) {
+        String contextClass = StandardContext.class.getName();
+        if (host == null) {
+            host = this.getHost();
+        }
+        if (host instanceof StandardHost) {
+            contextClass = ((StandardHost) host).getContextClass();
+        }
+        try {
+            return (Context) Class.forName(contextClass).getConstructor()
+                    .newInstance();
+        } catch (InstantiationException | IllegalAccessException
+                | IllegalArgumentException | InvocationTargetException
+                | NoSuchMethodException | SecurityException
+                | ClassNotFoundException e) {
+            throw new IllegalArgumentException(
+                    "Can't instantiate context-class " + contextClass
+                            + " for host " + host + " and url "
+                            + url, e);
+        }
+    }
+
+    /**
      * Enables JNDI naming which is disabled by default. Server must implement
      * {@link Lifecycle} in order for the {@link NamingContextListener} to be
      * used.

Modified: tomcat/trunk/test/org/apache/catalina/startup/TestTomcat.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/test/org/apache/catalina/startup/TestTomcat.java?rev=1651116&r1=1651115&r2=1651116&view=diff
==============================================================================
--- tomcat/trunk/test/org/apache/catalina/startup/TestTomcat.java (original)
+++ tomcat/trunk/test/org/apache/catalina/startup/TestTomcat.java Mon Jan 12 15:22:16 2015
@@ -38,10 +38,13 @@ import static org.junit.Assert.assertEqu
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
 
 import org.junit.Test;
-
+import org.apache.catalina.Host;
 import org.apache.catalina.core.StandardContext;
+import org.apache.catalina.core.StandardHost;
+import org.apache.catalina.ha.context.ReplicatedContext;
 import org.apache.tomcat.util.buf.ByteChunk;
 import org.apache.tomcat.util.descriptor.web.ContextEnvironment;
 import org.apache.tomcat.util.descriptor.web.ContextResourceLink;
@@ -417,4 +420,109 @@ public class TestTomcat extends TomcatBa
 
         assertEquals("WAR_CONTEXT", context.getSessionCookieName());
     }
+
+    @Test
+    public void testGetDefaultContextPerAddWebapp() {
+        Tomcat tomcat = getTomcatInstance();
+
+        File appFile = new File("test/deployment/context.war");
+        org.apache.catalina.Context context = tomcat.addWebapp(null,
+                "/test", appFile.getAbsolutePath());
+
+        assertEquals(StandardContext.class.getName(), context.getClass()
+                .getName());
+    }
+
+    @Test
+    public void testGetBrokenContextPerAddWepapp() {
+        Tomcat tomcat = getTomcatInstance();
+        Host host = tomcat.getHost();
+        if (host instanceof StandardHost) {
+            ((StandardHost) host).setContextClass("InvalidContextClassName");
+        }
+
+        try {
+            File appFile = new File("test/deployment/context.war");
+            tomcat.addWebapp(null, "/test", appFile.getAbsolutePath());
+            fail();
+        } catch (IllegalArgumentException e) {
+            // OK
+        }
+    }
+
+    @Test
+    public void testGetCustomContextPerAddWebappWithNullHost() {
+        Tomcat tomcat = getTomcatInstance();
+        Host host = tomcat.getHost();
+        if (host instanceof StandardHost) {
+            ((StandardHost) host).setContextClass(ReplicatedContext.class
+                    .getName());
+        }
+
+        File appFile = new File("test/deployment/context.war");
+        org.apache.catalina.Context context = tomcat.addWebapp(null, "/test",
+                appFile.getAbsolutePath());
+
+        assertEquals(ReplicatedContext.class.getName(), context.getClass()
+                .getName());
+    }
+
+    @Test
+    public void testGetCustomContextPerAddWebappWithHost() {
+        Tomcat tomcat = getTomcatInstance();
+        Host host = tomcat.getHost();
+        if (host instanceof StandardHost) {
+            ((StandardHost) host).setContextClass(ReplicatedContext.class
+                    .getName());
+        }
+
+        File appFile = new File("test/deployment/context.war");
+        org.apache.catalina.Context context = tomcat.addWebapp(host, "/test",
+                appFile.getAbsolutePath());
+
+        assertEquals(ReplicatedContext.class.getName(), context.getClass()
+                .getName());
+    }
+
+        @Test
+    public void testGetDefaultContextPerAddContext() {
+        Tomcat tomcat = getTomcatInstance();
+
+        // No file system docBase required
+        org.apache.catalina.Context ctx = tomcat.addContext(null, "", null);
+        assertEquals(StandardContext.class.getName(), ctx.getClass().getName());
+    }
+
+    @Test
+    public void testGetBrokenContextPerAddContext() {
+        Tomcat tomcat = getTomcatInstance();
+        Host host = tomcat.getHost();
+        if (host instanceof StandardHost) {
+            ((StandardHost) host).setContextClass("InvalidContextClassName");
+        }
+
+        // No file system docBase required
+        try {
+            tomcat.addContext(null, "", null);
+            fail();
+        } catch (IllegalArgumentException e) {
+            // OK
+        }
+    }
+
+    @Test
+    public void testGetCustomContextPerAddContextWithHost() {
+        Tomcat tomcat = getTomcatInstance();
+        Host host = tomcat.getHost();
+        if (host instanceof StandardHost) {
+            ((StandardHost) host).setContextClass(ReplicatedContext.class
+                    .getName());
+        }
+
+        // No file system docBase required
+        org.apache.catalina.Context ctx = tomcat.addContext(host, "", null);
+        assertEquals(ReplicatedContext.class.getName(), ctx.getClass()
+                .getName());
+    }
+
 }

Modified: tomcat/trunk/webapps/docs/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/changelog.xml?rev=1651116&r1=1651115&r2=1651116&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/trunk/webapps/docs/changelog.xml Mon Jan 12 15:22:16 2015
@@ -60,6 +60,13 @@
       </update>
     </changelog>
   </subsection>
+  <subsection name="Catalina">
+    <changelog>
+      <add>
+        <bug>57431</bug> Enable usage of custom class for context creation when using embedded tomcat. (fschumacher)
+      </add>
+    </changelog>
+  </subsection>
   <subsection name="Coyote">
     <changelog>
       <update>



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org