You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by vi...@apache.org on 2015/03/23 12:37:29 UTC

svn commit: r1668596 - in /tomcat/trunk: java/org/apache/catalina/startup/ContextConfig.java java/org/apache/catalina/startup/WebappServiceLoader.java test/org/apache/catalina/startup/TestWebappServiceLoader.java

Author: violetagg
Date: Mon Mar 23 11:37:28 2015
New Revision: 1668596

URL: http://svn.apache.org/r1668596
Log:
When searching for SCIs use Context.getParentClassLoader instead of ClassLoader.getParent. 
Thus one can provide the correct parent class loader when running embedded Tomcat in other environments such as OSGi.

Modified:
    tomcat/trunk/java/org/apache/catalina/startup/ContextConfig.java
    tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java
    tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java

Modified: tomcat/trunk/java/org/apache/catalina/startup/ContextConfig.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/startup/ContextConfig.java?rev=1668596&r1=1668595&r2=1668596&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/startup/ContextConfig.java (original)
+++ tomcat/trunk/java/org/apache/catalina/startup/ContextConfig.java Mon Mar 23 11:37:28 2015
@@ -1124,7 +1124,7 @@ public class ContextConfig implements Li
 
         // Step 3. Look for ServletContainerInitializer implementations
         if (ok) {
-            processServletContainerInitializers(sContext);
+            processServletContainerInitializers();
         }
 
         if  (!webXml.isMetadataComplete() || typeInitializerMap.size() > 0) {
@@ -1607,12 +1607,11 @@ public class ContextConfig implements Li
     /**
      * Scan JARs for ServletContainerInitializer implementations.
      */
-    protected void processServletContainerInitializers(ServletContext servletContext) {
+    protected void processServletContainerInitializers() {
 
         List<ServletContainerInitializer> detectedScis;
         try {
-            WebappServiceLoader<ServletContainerInitializer> loader =
-                    new WebappServiceLoader<>(servletContext, context.getContainerSciFilter());
+            WebappServiceLoader<ServletContainerInitializer> loader = new WebappServiceLoader<>(context);
             detectedScis = loader.load(ServletContainerInitializer.class);
         } catch (IOException e) {
             log.error(sm.getString(

Modified: tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java?rev=1668596&r1=1668595&r2=1668596&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java (original)
+++ tomcat/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java Mon Mar 23 11:37:28 2015
@@ -33,6 +33,8 @@ import java.util.regex.Pattern;
 
 import javax.servlet.ServletContext;
 
+import org.apache.catalina.Context;
+
 /**
  * A variation of Java's JAR ServiceLoader that respects exclusion rules for
  * web applications.
@@ -56,7 +58,8 @@ public class WebappServiceLoader<T> {
     private static final String LIB = "/WEB-INF/lib/";
     private static final String SERVICES = "META-INF/services/";
 
-    private final ServletContext context;
+    private final Context context;
+    private final ServletContext servletContext;
     private final Pattern containerSciFilterPattern;
 
     /**
@@ -64,8 +67,10 @@ public class WebappServiceLoader<T> {
      *
      * @param context the context to use
      */
-    public WebappServiceLoader(ServletContext context, String containerSciFilter) {
+    public WebappServiceLoader(Context context) {
         this.context = context;
+        this.servletContext = context.getServletContext();
+        String containerSciFilter = context.getContainerSciFilter();
         if (containerSciFilter != null && containerSciFilter.length() > 0) {
             containerSciFilterPattern = Pattern.compile(containerSciFilter);
         } else {
@@ -86,17 +91,17 @@ public class WebappServiceLoader<T> {
         LinkedHashSet<String> applicationServicesFound = new LinkedHashSet<>();
         LinkedHashSet<String> containerServicesFound = new LinkedHashSet<>();
 
-        ClassLoader loader = context.getClassLoader();
+        ClassLoader loader = servletContext.getClassLoader();
 
         // if the ServletContext has ORDERED_LIBS, then use that to specify the
         // set of JARs from WEB-INF/lib that should be used for loading services
         @SuppressWarnings("unchecked")
         List<String> orderedLibs =
-                (List<String>) context.getAttribute(ServletContext.ORDERED_LIBS);
+                (List<String>) servletContext.getAttribute(ServletContext.ORDERED_LIBS);
         if (orderedLibs != null) {
             // handle ordered libs directly, ...
             for (String lib : orderedLibs) {
-                URL jarUrl = context.getResource(LIB + lib);
+                URL jarUrl = servletContext.getResource(LIB + lib);
                 if (jarUrl == null) {
                     // should not happen, just ignore
                     continue;
@@ -117,7 +122,7 @@ public class WebappServiceLoader<T> {
             }
 
             // and the parent ClassLoader for all others
-            loader = loader.getParent();
+            loader = context.getParentClassLoader();
         }
 
         Enumeration<URL> resources;
@@ -174,7 +179,7 @@ public class WebappServiceLoader<T> {
 
     List<T> loadServices(Class<T> serviceType, LinkedHashSet<String> servicesFound)
             throws IOException {
-        ClassLoader loader = context.getClassLoader();
+        ClassLoader loader = servletContext.getClassLoader();
         List<T> services = new ArrayList<>(servicesFound.size());
         for (String serviceClass : servicesFound) {
             try {

Modified: tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java?rev=1668596&r1=1668595&r2=1668596&view=diff
==============================================================================
--- tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java (original)
+++ tomcat/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java Mon Mar 23 11:37:28 2015
@@ -31,6 +31,8 @@ import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Test;
 
+import org.apache.catalina.Context;
+import org.apache.catalina.core.TesterContext;
 import org.easymock.EasyMock;
 import org.easymock.IMocksControl;
 
@@ -40,7 +42,8 @@ public class TestWebappServiceLoader {
     private IMocksControl control;
     private ClassLoader cl;
     private ClassLoader parent;
-    private ServletContext context;
+    private Context context;
+    private ServletContext servletContext;
     private WebappServiceLoader<ServletContainerInitializer> loader;
 
     @Before
@@ -51,14 +54,15 @@ public class TestWebappServiceLoader {
                 .withConstructor(parent)
                 .addMockedMethod("loadClass", String.class)
                 .createMock(control);
-        context = control.createMock(ServletContext.class);
-        EasyMock.expect(context.getClassLoader()).andStubReturn(cl);
+        servletContext = control.createMock(ServletContext.class);
+        EasyMock.expect(servletContext.getClassLoader()).andStubReturn(cl);
+        context = new ExtendedTesterContext(servletContext, parent);
     }
 
     @Test
     public void testNoInitializersFound() throws IOException {
-        loader = new WebappServiceLoader<>(context, null);
-        EasyMock.expect(context.getAttribute(ServletContext.ORDERED_LIBS))
+        loader = new WebappServiceLoader<>(context);
+        EasyMock.expect(servletContext.getAttribute(ServletContext.ORDERED_LIBS))
                 .andReturn(null);
         EasyMock.expect(cl.getResources(CONFIG_FILE))
                 .andReturn(Collections.<URL>emptyEnumeration());
@@ -73,8 +77,8 @@ public class TestWebappServiceLoader {
         URL url = new URL("file://test");
         loader = EasyMock.createMockBuilder(WebappServiceLoader.class)
                 .addMockedMethod("parseConfigFile", LinkedHashSet.class, URL.class)
-                .withConstructor(context, "").createMock(control);
-        EasyMock.expect(context.getAttribute(ServletContext.ORDERED_LIBS))
+                .withConstructor(context).createMock(control);
+        EasyMock.expect(servletContext.getAttribute(ServletContext.ORDERED_LIBS))
                 .andReturn(null);
         EasyMock.expect(cl.getResources(CONFIG_FILE))
                 .andReturn(Collections.enumeration(Collections.singleton(url)));
@@ -93,14 +97,14 @@ public class TestWebappServiceLoader {
         URL sci2 = new URL("file://dir/" + CONFIG_FILE);
         loader = EasyMock.createMockBuilder(WebappServiceLoader.class)
                 .addMockedMethod("parseConfigFile", LinkedHashSet.class, URL.class)
-                .withConstructor(context, "").createMock(control);
+                .withConstructor(context).createMock(control);
         List<String> jars = Arrays.asList("jar1.jar", "dir/");
-        EasyMock.expect(context.getAttribute(ServletContext.ORDERED_LIBS))
+        EasyMock.expect(servletContext.getAttribute(ServletContext.ORDERED_LIBS))
                 .andReturn(jars);
-        EasyMock.expect(context.getResource("/WEB-INF/lib/jar1.jar"))
+        EasyMock.expect(servletContext.getResource("/WEB-INF/lib/jar1.jar"))
                 .andReturn(url1);
         loader.parseConfigFile(EasyMock.isA(LinkedHashSet.class), EasyMock.eq(sci1));
-        EasyMock.expect(context.getResource("/WEB-INF/lib/dir/"))
+        EasyMock.expect(servletContext.getResource("/WEB-INF/lib/dir/"))
                 .andReturn(url2);
         loader.parseConfigFile(EasyMock.isA(LinkedHashSet.class), EasyMock.eq(sci2));
         EasyMock.expect(parent.getResources(CONFIG_FILE))
@@ -114,7 +118,7 @@ public class TestWebappServiceLoader {
     @Test
     public void testParseConfigFile() throws IOException {
         LinkedHashSet<String> found = new LinkedHashSet<>();
-        loader = new WebappServiceLoader<>(context, null);
+        loader = new WebappServiceLoader<>(context);
         loader.parseConfigFile(found, getClass().getResource("service-config.txt"));
         Assert.assertEquals(Collections.singleton("provider1"), found);
     }
@@ -122,7 +126,7 @@ public class TestWebappServiceLoader {
     @Test
     public void testLoadServices() throws Exception {
         Class<?> sci = TesterServletContainerInitializer1.class;
-        loader = new WebappServiceLoader<>(context, null);
+        loader = new WebappServiceLoader<>(context);
         cl.loadClass(sci.getName());
         EasyMock.expectLastCall()
                 .andReturn(sci);
@@ -139,7 +143,7 @@ public class TestWebappServiceLoader {
     @Test
     public void testServiceIsNotExpectedType() throws Exception {
         Class<?> sci = Object.class;
-        loader = new WebappServiceLoader<>(context, null);
+        loader = new WebappServiceLoader<>(context);
         cl.loadClass(sci.getName());
         EasyMock.expectLastCall()
                 .andReturn(sci);
@@ -158,7 +162,7 @@ public class TestWebappServiceLoader {
     @Test
     public void testServiceCannotBeConstructed() throws Exception {
         Class<?> sci = Integer.class;
-        loader = new WebappServiceLoader<>(context, null);
+        loader = new WebappServiceLoader<>(context);
         cl.loadClass(sci.getName());
         EasyMock.expectLastCall()
                 .andReturn(sci);
@@ -173,4 +177,30 @@ public class TestWebappServiceLoader {
             control.verify();
         }
     }
+
+    private static class ExtendedTesterContext extends TesterContext {
+        private final ServletContext servletContext;
+        private final ClassLoader parent;
+
+        public ExtendedTesterContext(ServletContext servletContext, ClassLoader parent) {
+            this.servletContext = servletContext;
+            this.parent = parent;
+        }
+
+        @Override
+        public ServletContext getServletContext() {
+            return servletContext;
+        }
+
+        @Override
+        public String getContainerSciFilter() {
+            return "";
+        }
+
+        @Override
+        public ClassLoader getParentClassLoader() {
+            return parent;
+        }
+
+    }
 }



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