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:51:10 UTC

svn commit: r1668606 - in /tomcat/tc8.0.x/trunk: ./ java/org/apache/catalina/startup/ContextConfig.java java/org/apache/catalina/startup/WebappServiceLoader.java test/org/apache/catalina/startup/TestWebappServiceLoader.java webapps/docs/changelog.xml

Author: violetagg
Date: Mon Mar 23 11:51:09 2015
New Revision: 1668606

URL: http://svn.apache.org/r1668606
Log:
Merged revision 1668596 from tomcat/trunk:
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/tc8.0.x/trunk/   (props changed)
    tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java
    tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java
    tomcat/tc8.0.x/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java
    tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml

Propchange: tomcat/tc8.0.x/trunk/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Mar 23 11:51:09 2015
@@ -1 +1 @@
-/tomcat/trunk:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,1644790,1644793,1644815,1644884,1644886,1644890,1644892
 ,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357-1645358,1645455,1645465,1645469,1645471,1645473,1645475,1645486-1645488,1645626,1645641,1645685,1645743,1645763,1645951-1645953,1645955,1645993,1646098-1646106,1646178,1646220,1646302,1646304,1646420,1646470-1646471,1646476,1646559,1646717-1646723,1646773,1647026,1647042,1647530,1647655,1648304,1648815,1648907,1650081,1650365,1651116,1651120,1651280,1651470,1652938,1652970,1653041,1653471,1653550,1653574,1653797,1653815-1653816,1653819,1653840,1653857,1653888,1653972,1654013,1654030,1654050,1654123,1654148,1654159,1654513,1654515,1654517,1654522,1654524,1654725,1654735,1654766,1654785,1654851-1654852,1654978,1655122-1655124,1655126-1655127,1655129-1655130,1655132-1655133,1655312,1655438,1655441,1655454,1655558,1656087,1656299,1656319,1656331,1656345,1656350,1656590,1656648-1656650,1656657,1657041,1657054,1657374,1657492,1657510,1657565,1657580,1657584,1657586,1657589,1657592,1657607,1657609,1657682,1657
 907,1658207,1658734,1658781,1658790,1658799,1658802,1658804,1658833,1658840,1658966,1659043,1659053,1659059,1659188-1659189,1659216,1659263,1659293,1659304,1659306-1659307,1659382,1659384,1659428,1659471,1659486,1659505,1659516,1659521,1659524,1659559,1659562,1659803,1659806,1659814,1659833,1659862,1659905,1659919,1659948,1659967,1659983-1659984,1660060,1660074,1660077,1660133,1660168,1660331-1660332,1660353,1660358,1660924,1661386,1661867,1661972,1661990,1662200,1662308-1662309,1662548,1662614,1662736,1662985,1662988-1662989,1663264,1663277,1663298,1663324,1663534,1663562,1663676,1663715,1663754,1663768,1663772,1663781,1663893,1663995,1664143,1664163,1664174,1664301,1664317,1664347,1664657,1664659,1664710,1664863-1664864,1664866,1665085,1665292,1665559,1665653,1665661,1665672,1665694,1665697,1665736,1665779,1665976-1665977,1665980-1665981,1665985-1665986,1665989,1665998,1666004,1666008,1666013,1666017,1666024,1666116,1666386-1666387,1666494,1666496,1666552,1666569,1666579,1666637,1
 666649,1666757,1666966,1666972,1666985,1666995,1666997,1667292,1667402,1667406,1667546,1667615,1667630,1667636,1667688,1667764,1667871,1668026,1668135,1668193,1668593
+/tomcat/trunk:1636524,1637156,1637176,1637188,1637331,1637684,1637695,1638720-1638725,1639653,1640010,1640083-1640084,1640088,1640275,1640322,1640347,1640361,1640365,1640403,1640410,1640652,1640655-1640658,1640688,1640700-1640883,1640903,1640976,1640978,1641000,1641026,1641038-1641039,1641051-1641052,1641058,1641064,1641300,1641369,1641374,1641380,1641486,1641634,1641656-1641692,1641704,1641707-1641718,1641720-1641722,1641735,1641981,1642233,1642280,1642554,1642564,1642595,1642606,1642668,1642679,1642697,1642699,1642766,1643002,1643045,1643054-1643055,1643066,1643121,1643128,1643206,1643209-1643210,1643216,1643249,1643270,1643283,1643309-1643310,1643323,1643365-1643366,1643370-1643371,1643465,1643474,1643536,1643570,1643634,1643649,1643651,1643654,1643675,1643731,1643733-1643734,1643761,1643766,1643814,1643937,1643963,1644017,1644169,1644201-1644203,1644321,1644323,1644516,1644523,1644529,1644535,1644730,1644768,1644784-1644785,1644790,1644793,1644815,1644884,1644886,1644890,1644892
 ,1644910,1644924,1644929-1644930,1644935,1644989,1645011,1645247,1645355,1645357-1645358,1645455,1645465,1645469,1645471,1645473,1645475,1645486-1645488,1645626,1645641,1645685,1645743,1645763,1645951-1645953,1645955,1645993,1646098-1646106,1646178,1646220,1646302,1646304,1646420,1646470-1646471,1646476,1646559,1646717-1646723,1646773,1647026,1647042,1647530,1647655,1648304,1648815,1648907,1650081,1650365,1651116,1651120,1651280,1651470,1652938,1652970,1653041,1653471,1653550,1653574,1653797,1653815-1653816,1653819,1653840,1653857,1653888,1653972,1654013,1654030,1654050,1654123,1654148,1654159,1654513,1654515,1654517,1654522,1654524,1654725,1654735,1654766,1654785,1654851-1654852,1654978,1655122-1655124,1655126-1655127,1655129-1655130,1655132-1655133,1655312,1655438,1655441,1655454,1655558,1656087,1656299,1656319,1656331,1656345,1656350,1656590,1656648-1656650,1656657,1657041,1657054,1657374,1657492,1657510,1657565,1657580,1657584,1657586,1657589,1657592,1657607,1657609,1657682,1657
 907,1658207,1658734,1658781,1658790,1658799,1658802,1658804,1658833,1658840,1658966,1659043,1659053,1659059,1659188-1659189,1659216,1659263,1659293,1659304,1659306-1659307,1659382,1659384,1659428,1659471,1659486,1659505,1659516,1659521,1659524,1659559,1659562,1659803,1659806,1659814,1659833,1659862,1659905,1659919,1659948,1659967,1659983-1659984,1660060,1660074,1660077,1660133,1660168,1660331-1660332,1660353,1660358,1660924,1661386,1661867,1661972,1661990,1662200,1662308-1662309,1662548,1662614,1662736,1662985,1662988-1662989,1663264,1663277,1663298,1663324,1663534,1663562,1663676,1663715,1663754,1663768,1663772,1663781,1663893,1663995,1664143,1664163,1664174,1664301,1664317,1664347,1664657,1664659,1664710,1664863-1664864,1664866,1665085,1665292,1665559,1665653,1665661,1665672,1665694,1665697,1665736,1665779,1665976-1665977,1665980-1665981,1665985-1665986,1665989,1665998,1666004,1666008,1666013,1666017,1666024,1666116,1666386-1666387,1666494,1666496,1666552,1666569,1666579,1666637,1
 666649,1666757,1666966,1666972,1666985,1666995,1666997,1667292,1667402,1667406,1667546,1667615,1667630,1667636,1667688,1667764,1667871,1668026,1668135,1668193,1668593,1668596

Modified: tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java?rev=1668606&r1=1668605&r2=1668606&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java Mon Mar 23 11:51:09 2015
@@ -1125,7 +1125,7 @@ public class ContextConfig implements Li
 
         // Step 3. Look for ServletContainerInitializer implementations
         if (ok) {
-            processServletContainerInitializers(sContext);
+            processServletContainerInitializers();
         }
 
         if  (!webXml.isMetadataComplete() || typeInitializerMap.size() > 0) {
@@ -1608,12 +1608,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/tc8.0.x/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java?rev=1668606&r1=1668605&r2=1668606&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java (original)
+++ tomcat/tc8.0.x/trunk/java/org/apache/catalina/startup/WebappServiceLoader.java Mon Mar 23 11:51:09 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/tc8.0.x/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java?rev=1668606&r1=1668605&r2=1668606&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java (original)
+++ tomcat/tc8.0.x/trunk/test/org/apache/catalina/startup/TestWebappServiceLoader.java Mon Mar 23 11:51:09 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;
+        }
+
+    }
 }

Modified: tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml?rev=1668606&r1=1668605&r2=1668606&view=diff
==============================================================================
--- tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml (original)
+++ tomcat/tc8.0.x/trunk/webapps/docs/changelog.xml Mon Mar 23 11:51:09 2015
@@ -145,6 +145,13 @@
         <bug>57724</bug>: Handle the case in the CORS filter where a user agent
         includes an origin header for a non-CORS request. (markt)
       </fix>
+      <fix>
+        When searching for SCIs
+        <code>o.a.catalina.Context.getParentClassLoader</code> will be used
+        instead of <code>java.lang.ClassLoader.getParent</code>. Thus one can
+        provide the correct parent class loader when running embedded Tomcat in
+        other environments such as OSGi. (violetagg)
+      </fix>
     </changelog>
   </subsection>
   <subsection name="Coyote">



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