You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by ow...@apache.org on 2013/10/03 22:12:15 UTC

svn commit: r1528990 - in /cxf/fediz/trunk/plugins: core/src/main/java/org/apache/cxf/fediz/core/config/ core/src/main/java/org/apache/cxf/fediz/core/util/ jetty/src/main/java/org/apache/cxf/fediz/jetty/ tomcat/src/main/java/org/apache/cxf/fediz/tomcat/

Author: owulff
Date: Thu Oct  3 20:12:15 2013
New Revision: 1528990

URL: http://svn.apache.org/r1528990
Log:
Loading resources/classes improved

Added:
    cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java
Modified:
    cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationContext.java
    cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationProtocol.java
    cxf/fediz/trunk/plugins/jetty/src/main/java/org/apache/cxf/fediz/jetty/FederationAuthenticator.java
    cxf/fediz/trunk/plugins/tomcat/src/main/java/org/apache/cxf/fediz/tomcat/FederationAuthenticator.java

Modified: cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationContext.java
URL: http://svn.apache.org/viewvc/cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationContext.java?rev=1528990&r1=1528989&r2=1528990&view=diff
==============================================================================
--- cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationContext.java (original)
+++ cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationContext.java Thu Oct  3 20:12:15 2013
@@ -70,6 +70,7 @@ public class FederationContext implement
     private List<TrustManager> certificateStores;
     private KeyManager keyManager;
     private KeyManager decryptionKeyManager;
+    private ClassLoader classloader;
     
 
     public FederationContext(ContextConfig config) {
@@ -149,6 +150,7 @@ public class FederationContext implement
         ProtocolType type = config.getProtocol();
         if (type instanceof FederationProtocolType) {
             protocol = new FederationProtocol(type);
+            protocol.setClassloader(getClassloader());
         }
         return protocol;
     }
@@ -331,10 +333,12 @@ public class FederationContext implement
         Certificate cert = null;
         BufferedInputStream bis = null;
         try {
+            ClassLoader cl = getClassloader();
+            if (cl == null) {
+                cl = Thread.currentThread().getContextClassLoader();
+            }
+            InputStream is = Merlin.loadInputStream(cl, filename);
             
-            InputStream is = Merlin.loadInputStream(Thread.currentThread().getContextClassLoader(), filename);
-            
-            //FileInputStream fis = new FileInputStream(filename);
             bis = new BufferedInputStream(is);
 
             CertificateFactory cf = CertificateFactory.getInstance("X.509");
@@ -367,6 +371,14 @@ public class FederationContext implement
             }
         }
     }
+
+    public ClassLoader getClassloader() {
+        return classloader;
+    }
+
+    public void setClassloader(ClassLoader classloader) {
+        this.classloader = classloader;
+    }
     
     
 

Modified: cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationProtocol.java
URL: http://svn.apache.org/viewvc/cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationProtocol.java?rev=1528990&r1=1528989&r2=1528990&view=diff
==============================================================================
--- cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationProtocol.java (original)
+++ cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/config/FederationProtocol.java Thu Oct  3 20:12:15 2013
@@ -32,6 +32,7 @@ import org.apache.cxf.fediz.core.config.
 import org.apache.cxf.fediz.core.config.jaxb.FederationProtocolType;
 import org.apache.cxf.fediz.core.config.jaxb.ProtocolType;
 import org.apache.cxf.fediz.core.saml.SAMLTokenValidator;
+import org.apache.cxf.fediz.core.util.ClassLoaderUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -46,6 +47,8 @@ public class FederationProtocol extends 
     private Object signInQuery;
     private Object realm;
     private List<TokenValidator> validators = new ArrayList<TokenValidator>();
+    private ClassLoader classloader;
+    
     
     public FederationProtocol(ProtocolType protocolType) {
         super(protocolType);
@@ -55,7 +58,11 @@ public class FederationProtocol extends 
             for (String validatorClassname : fp.getTokenValidators().getValidator()) {
                 Object obj = null;
                 try {
-                    obj = Thread.currentThread().getContextClassLoader().loadClass(validatorClassname).newInstance();
+                    if (this.classloader == null) {
+                        obj = ClassLoaderUtils.loadClass(validatorClassname, this.getClass()).newInstance();
+                    } else {
+                        obj = this.classloader.loadClass(validatorClassname).newInstance();
+                    }
                 } catch (Exception ex) {
                     LOG.error("Failed to instantiate TokenValidator implementation class: '"
                               + validatorClassname + "'\n" + ex.getClass().getCanonicalName() + ": " + ex.getMessage());
@@ -99,8 +106,11 @@ public class FederationProtocol extends 
             this.realm = new String(cbt.getValue());
         } else if (cbt.getType().equals(ArgumentType.CLASS)) {
             try {
-                this.realm =
-                    Thread.currentThread().getContextClassLoader().loadClass(cbt.getValue()).newInstance();
+                if (this.classloader == null) {
+                    this.realm = ClassLoaderUtils.loadClass(cbt.getValue(), this.getClass()).newInstance();
+                } else {
+                    this.realm = this.classloader.loadClass(cbt.getValue()).newInstance();
+                }
             } catch (Exception e) {
                 LOG.error("Failed to create instance of " + cbt.getValue(), e);
                 throw new IllegalStateException("Failed to create instance of " + cbt.getValue());
@@ -164,8 +174,11 @@ public class FederationProtocol extends 
             this.authenticationType = new String(cbt.getValue());
         } else if (cbt.getType().equals(ArgumentType.CLASS)) {
             try {
-                this.authenticationType = 
-                    Thread.currentThread().getContextClassLoader().loadClass(cbt.getValue()).newInstance();
+                if (this.classloader == null) {
+                    this.authenticationType = ClassLoaderUtils.loadClass(cbt.getValue(), this.getClass()).newInstance();
+                } else {
+                    this.authenticationType = this.classloader.loadClass(cbt.getValue()).newInstance();
+                }
             } catch (Exception e) {
                 LOG.error("Failed to create instance of " + cbt.getValue(), e);
                 throw new IllegalStateException("Failed to create instance of " + cbt.getValue());
@@ -201,8 +214,11 @@ public class FederationProtocol extends 
             this.homeRealm = new String(cbt.getValue());
         } else if (cbt.getType().equals(ArgumentType.CLASS)) {
             try {
-                this.homeRealm =
-                    Thread.currentThread().getContextClassLoader().loadClass(cbt.getValue()).newInstance();
+                if (this.classloader == null) {
+                    this.homeRealm = ClassLoaderUtils.loadClass(cbt.getValue(), this.getClass()).newInstance();
+                } else {
+                    this.homeRealm = this.classloader.loadClass(cbt.getValue()).newInstance();
+                }
             } catch (Exception e) {
                 LOG.error("Failed to create instance of " + cbt.getValue(), e);
                 throw new IllegalStateException("Failed to create instance of " + cbt.getValue());
@@ -235,8 +251,11 @@ public class FederationProtocol extends 
             this.issuer = new String(cbt.getValue());
         } else if (cbt.getType().equals(ArgumentType.CLASS)) {
             try {
-                this.issuer = 
-                    Thread.currentThread().getContextClassLoader().loadClass(cbt.getValue()).newInstance();
+                if (this.classloader == null) {
+                    this.issuer = ClassLoaderUtils.loadClass(cbt.getValue(), this.getClass()).newInstance();
+                } else {
+                    this.issuer = this.classloader.loadClass(cbt.getValue()).newInstance();
+                }
             } catch (Exception e) {
                 LOG.error("Failed to create instance of " + cbt.getValue(), e);
                 throw new IllegalStateException("Failed to create instance of " + cbt.getValue());
@@ -272,8 +291,11 @@ public class FederationProtocol extends 
             this.freshness = new String(cbt.getValue());
         } else if (cbt.getType().equals(ArgumentType.CLASS)) {
             try {
-                this.freshness =
-                    Thread.currentThread().getContextClassLoader().loadClass(cbt.getValue()).newInstance();
+                if (this.classloader == null) {
+                    this.freshness = ClassLoaderUtils.loadClass(cbt.getValue(), this.getClass()).newInstance();
+                } else {
+                    this.freshness = this.classloader.loadClass(cbt.getValue()).newInstance();
+                }
             } catch (Exception e) {
                 LOG.error("Failed to create instance of " + cbt.getValue(), e);
                 throw new IllegalStateException("Failed to create instance of " + cbt.getValue());
@@ -309,8 +331,11 @@ public class FederationProtocol extends 
             this.signInQuery = new String(cbt.getValue());
         } else if (cbt.getType().equals(ArgumentType.CLASS)) {
             try {
-                this.signInQuery =
-                    Thread.currentThread().getContextClassLoader().loadClass(cbt.getValue()).newInstance();
+                if (this.classloader == null) {
+                    this.signInQuery = ClassLoaderUtils.loadClass(cbt.getValue(), this.getClass()).newInstance();
+                } else {
+                    this.signInQuery = this.classloader.loadClass(cbt.getValue()).newInstance();
+                }
             } catch (Exception e) {
                 LOG.error("Failed to create instance of " + cbt.getValue(), e);
                 throw new IllegalStateException("Failed to create instance of " + cbt.getValue());
@@ -378,5 +403,13 @@ public class FederationProtocol extends 
     public String toString() {
         return getFederationProtocol().toString();
     }
+    
+    public ClassLoader getClassloader() {
+        return classloader;
+    }
+
+    public void setClassloader(ClassLoader classloader) {
+        this.classloader = classloader;
+    }
 
 }

Added: cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java
URL: http://svn.apache.org/viewvc/cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java?rev=1528990&view=auto
==============================================================================
--- cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java (added)
+++ cxf/fediz/trunk/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java Thu Oct  3 20:12:15 2013
@@ -0,0 +1,295 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.cxf.fediz.core.util;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.security.AccessController;
+import java.security.PrivilegedAction;
+import java.util.ArrayList;
+import java.util.Enumeration;
+import java.util.List;
+
+/**
+ * This class is extremely useful for loading resources and classes in a fault
+ * tolerant manner that works across different applications servers. Do not
+ * touch this unless you're a grizzled classloading guru veteran who is going to
+ * verify any change on 6 different application servers.
+ * 
+ * Original: org.apache.cxf.common.classloader.ClassLoaderUtils
+ */
+public final class ClassLoaderUtils {
+    
+    private ClassLoaderUtils() {
+    }
+    
+    public static class ClassLoaderHolder {
+        ClassLoader loader;
+        ClassLoaderHolder(ClassLoader c) {
+            loader = c;
+        }
+        
+        public void reset() {
+            ClassLoaderUtils.setThreadContextClassloader(loader);
+        }
+    }
+    public static ClassLoaderHolder setThreadContextClassloader(final ClassLoader newLoader) {
+        return AccessController.doPrivileged(new PrivilegedAction<ClassLoaderHolder>() {
+            public ClassLoaderHolder run() {
+                ClassLoader l = Thread.currentThread().getContextClassLoader();
+                Thread.currentThread().setContextClassLoader(newLoader);
+                return new ClassLoaderHolder(l);
+            }
+        });
+    }
+    
+    public static ClassLoader getURLClassLoader(
+        final URL[] urls, final ClassLoader parent
+    ) {
+        return AccessController.doPrivileged(new PrivilegedAction<ClassLoader>() {
+            public ClassLoader run() {
+                return new URLClassLoader(urls, parent);
+            }
+        });
+    }
+
+    public static ClassLoader getURLClassLoader(
+        final List<URL> urlList, final ClassLoader parent
+    ) {
+        return getURLClassLoader(urlList.toArray(new URL[urlList.size()]), parent);
+    }
+    
+    /**
+     * Load a given resource. <p/> This method will try to load the resource
+     * using the following methods (in order):
+     * <ul>
+     * <li>From Thread.currentThread().getContextClassLoader()
+     * <li>From ClassLoaderUtil.class.getClassLoader()
+     * <li>callingClass.getClassLoader()
+     * </ul>
+     * 
+     * @param resourceName The name of the resource to load
+     * @param callingClass The Class object of the calling object
+     */
+    public static URL getResource(String resourceName, Class<?> callingClass) {
+        URL url = Thread.currentThread().getContextClassLoader().getResource(resourceName);
+        if (url == null && resourceName.startsWith("/")) {
+            //certain classloaders need it without the leading /
+            url = Thread.currentThread().getContextClassLoader()
+                .getResource(resourceName.substring(1));
+        }
+
+        ClassLoader cluClassloader = ClassLoaderUtils.class.getClassLoader();
+        if (cluClassloader == null) {
+            cluClassloader = ClassLoader.getSystemClassLoader();
+        }
+        if (url == null) {
+            url = cluClassloader.getResource(resourceName);
+        }
+        if (url == null && resourceName.startsWith("/")) {
+            //certain classloaders need it without the leading /
+            url = cluClassloader.getResource(resourceName.substring(1));
+        }
+
+        if (url == null) {
+            ClassLoader cl = callingClass.getClassLoader();
+
+            if (cl != null) {
+                url = cl.getResource(resourceName);
+            }
+        }
+
+        if (url == null) {
+            url = callingClass.getResource(resourceName);
+        }
+        
+        if ((url == null) && (resourceName != null) && (resourceName.charAt(0) != '/')) {
+            return getResource('/' + resourceName, callingClass);
+        }
+
+        return url;
+    }
+    
+    /**
+     * Load a given resources. <p/> This method will try to load the resources
+     * using the following methods (in order):
+     * <ul>
+     * <li>From Thread.currentThread().getContextClassLoader()
+     * <li>From ClassLoaderUtil.class.getClassLoader()
+     * <li>callingClass.getClassLoader()
+     * </ul>
+     * 
+     * @param resourceName The name of the resource to load
+     * @param callingClass The Class object of the calling object
+     */
+    public static List<URL> getResources(String resourceName, Class<?> callingClass) {
+        List<URL> ret = new ArrayList<URL>();
+        Enumeration<URL> urls = new Enumeration<URL>() {
+            public boolean hasMoreElements() {
+                return false;
+            }
+            public URL nextElement() {
+                return null;
+            }
+            
+        };
+        try {
+            urls = Thread.currentThread().getContextClassLoader()
+                .getResources(resourceName);
+        } catch (IOException e) {
+            //ignore
+        }
+        if (!urls.hasMoreElements() && resourceName.startsWith("/")) {
+            //certain classloaders need it without the leading /
+            try {
+                urls = Thread.currentThread().getContextClassLoader()
+                    .getResources(resourceName.substring(1));
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+
+        ClassLoader cluClassloader = ClassLoaderUtils.class.getClassLoader();
+        if (cluClassloader == null) {
+            cluClassloader = ClassLoader.getSystemClassLoader();
+        }
+        if (!urls.hasMoreElements()) {
+            try {
+                urls = cluClassloader.getResources(resourceName);
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+        if (!urls.hasMoreElements() && resourceName.startsWith("/")) {
+            //certain classloaders need it without the leading /
+            try {
+                urls = cluClassloader.getResources(resourceName.substring(1));
+            } catch (IOException e) {
+                // ignore
+            }
+        }
+
+        if (!urls.hasMoreElements()) {
+            ClassLoader cl = callingClass.getClassLoader();
+
+            if (cl != null) {
+                try {
+                    urls = cl.getResources(resourceName);
+                } catch (IOException e) {
+                    // ignore
+                }
+            }
+        }
+
+        if (!urls.hasMoreElements()) {
+            URL url = callingClass.getResource(resourceName);
+            if (url != null) {
+                ret.add(url);
+            }
+        }
+        while (urls.hasMoreElements()) {
+            ret.add(urls.nextElement());
+        }
+
+        
+        if (ret.isEmpty() && (resourceName != null) && (resourceName.charAt(0) != '/')) {
+            return getResources('/' + resourceName, callingClass);
+        }
+        return ret;
+    }
+
+
+    /**
+     * This is a convenience method to load a resource as a stream. <p/> The
+     * algorithm used to find the resource is given in getResource()
+     * 
+     * @param resourceName The name of the resource to load
+     * @param callingClass The Class object of the calling object
+     */
+    public static InputStream getResourceAsStream(String resourceName, Class<?> callingClass) {
+        URL url = getResource(resourceName, callingClass);
+
+        try {
+            return (url != null) ? url.openStream() : null;
+        } catch (IOException e) {
+            return null;
+        }
+    }
+
+    /**
+     * Load a class with a given name. <p/> It will try to load the class in the
+     * following order:
+     * <ul>
+     * <li>From Thread.currentThread().getContextClassLoader()
+     * <li>Using the basic Class.forName()
+     * <li>From ClassLoaderUtil.class.getClassLoader()
+     * <li>From the callingClass.getClassLoader()
+     * </ul>
+     * 
+     * @param className The name of the class to load
+     * @param callingClass The Class object of the calling object
+     * @throws ClassNotFoundException If the class cannot be found anywhere.
+     */
+    public static Class<?> loadClass(String className, Class<?> callingClass)
+        throws ClassNotFoundException {
+        try {
+            ClassLoader cl = Thread.currentThread().getContextClassLoader();
+
+            if (cl != null) {
+                return cl.loadClass(className);
+            }            
+        } catch (ClassNotFoundException e) {
+            //ignore
+        }
+        return loadClass2(className, callingClass);
+    }
+    public static <T> Class<? extends T> loadClass(String className, Class<?> callingClass, Class<T> type)
+        throws ClassNotFoundException {
+        try {
+            ClassLoader cl = Thread.currentThread().getContextClassLoader();
+
+            if (cl != null) {
+                return cl.loadClass(className).asSubclass(type);
+            }            
+        } catch (ClassNotFoundException e) {
+            //ignore
+        }
+        return loadClass2(className, callingClass).asSubclass(type);
+    }
+    private static Class<?> loadClass2(String className, Class<?> callingClass)
+        throws ClassNotFoundException {
+        try {
+            return Class.forName(className);
+        } catch (ClassNotFoundException ex) {
+            try {
+                if (ClassLoaderUtils.class.getClassLoader() != null) {
+                    return ClassLoaderUtils.class.getClassLoader().loadClass(className);
+                }
+            } catch (ClassNotFoundException exc) {
+                if (callingClass != null && callingClass.getClassLoader() != null) {
+                    return callingClass.getClassLoader().loadClass(className);
+                }
+            }
+            throw ex;
+        }
+    }
+}

Modified: cxf/fediz/trunk/plugins/jetty/src/main/java/org/apache/cxf/fediz/jetty/FederationAuthenticator.java
URL: http://svn.apache.org/viewvc/cxf/fediz/trunk/plugins/jetty/src/main/java/org/apache/cxf/fediz/jetty/FederationAuthenticator.java?rev=1528990&r1=1528989&r2=1528990&view=diff
==============================================================================
--- cxf/fediz/trunk/plugins/jetty/src/main/java/org/apache/cxf/fediz/jetty/FederationAuthenticator.java (original)
+++ cxf/fediz/trunk/plugins/jetty/src/main/java/org/apache/cxf/fediz/jetty/FederationAuthenticator.java Thu Oct  3 20:12:15 2013
@@ -93,7 +93,7 @@ public class FederationAuthenticator ext
     public void setConfiguration(AuthConfiguration configuration) {
         super.setConfiguration(configuration);
         // is called after the bean setting -> do initialization here
-        System.out.println(configuration.getInitParameterNames());
+        LOG.debug(configuration.getInitParameterNames().toString());
         try {
             File f = new File(getConfigFile());
             if (!f.exists()) {

Modified: cxf/fediz/trunk/plugins/tomcat/src/main/java/org/apache/cxf/fediz/tomcat/FederationAuthenticator.java
URL: http://svn.apache.org/viewvc/cxf/fediz/trunk/plugins/tomcat/src/main/java/org/apache/cxf/fediz/tomcat/FederationAuthenticator.java?rev=1528990&r1=1528989&r2=1528990&view=diff
==============================================================================
--- cxf/fediz/trunk/plugins/tomcat/src/main/java/org/apache/cxf/fediz/tomcat/FederationAuthenticator.java (original)
+++ cxf/fediz/trunk/plugins/tomcat/src/main/java/org/apache/cxf/fediz/tomcat/FederationAuthenticator.java Thu Oct  3 20:12:15 2013
@@ -134,7 +134,7 @@ public class FederationAuthenticator ext
         super.stopInternal();
     }
 
-    private FederationContext getContextConfiguration(String contextName) {
+    protected FederationContext getContextConfiguration(String contextName) {
         if (configurator == null) {
             throw new IllegalStateException("No Fediz configuration available");
         }