FileDocCategorySizeDatePackage
ASURLClassLoader.javaAPI DocGlassfish v2 API7396Fri May 04 22:32:54 BST 2007com.sun.appserv.server.util

ASURLClassLoader.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.appserv.server.util;

import com.sun.enterprise.server.PELaunch;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

/**
 * <code>ASURLClassLoader</code> represents a individual component
 * in the <code>ASClassLoaderChain</code>.
 * 
 * Since it is a subclass of <code>URLClassLoader</code> it can contain a 
 * search path of one or more URLs 
 * 
 * @author Harsha RA, Sivakumar Thyagarajan
 */

public class ASURLClassLoader extends URLClassLoader {
    /** List of URLs that this classloader checks for a class */
    private URL[] classLoaderList = new URL[]{}; 
    /** Name of this classloader - primarily used in the string 
        representation of the classloader - for debugging */
    private String nameOfCL = null;
    /** The classloader chain this classloader is a component of */
    private ClassLoader parentChain = null;
    /** toString() representation of parent - to prevent recursion */
    private String parentToString = null;
    
    //A local cache for keeping track of all classes that were not found 
    //using this classloader
    private Set<String> notFoundClasses = 
        Collections.synchronizedSet(new HashSet<String>());
    
    //A local cache for keeping track of all classes that were loaded 
    //using this classloader
    private java.util.Hashtable<String,Class> loadedClasses =
        new java.util.Hashtable<String,Class>();
    
/*
    public ASURLClassLoader(URL[] urls) {
        super(urls); //Parent: System ClassLoader.
        this.classLoaderList = urls;
    }
*/

    public ASURLClassLoader(URL[] urls, ClassLoader parent) {
        //The parent of the classloader chain component
        //is either the SystemClassLoader (if shared chain is null!) 
        //or the Shared Chain.
        //super(urls, PELaunch.getSharedChain());
        super(urls, PELaunch.getSharedChain()!=null ?PELaunch.getSharedChain()
                : ClassLoader.getSystemClassLoader());
        this.parentChain = parent;
        
        if(this.parentChain instanceof ClassLoaderChain) {
            //Computed earlier to prevent recursion in toString of this 
            //class
            this.parentToString = 
                         ((ClassLoaderChain)this.parentChain).getName();
        } else {
            this.parentToString = this.parentChain.toString();
        }
        this.classLoaderList = urls;
    }
    
    public void setName(String n) {
        this.nameOfCL = n;
    }
    
    public String getName() {
        return this.nameOfCL;
    }
    
   /**
    * The loading strategy is:
    * - check self first and
    * - then delegate to parent chain if one exists. This is done to prevent recursion
    *   while referring to the chain. One issue with this approach is that when class load
    *   requests come via this component classloader, it might override a duplicate class in 
    *   a peer present earlier in the chain. 
    */
    @Override
    public Class<?> loadClass(String name, boolean resolve) 
                                            throws ClassNotFoundException {
        try {
            //perf optimization
            //check notFoundClasses cache first
            if (notFoundClasses.contains(name)) {
                throw new ClassNotFoundException(name);
            }
            
            Class cls = null;
            
            //perf optimization
            //check loadedClasses cache first
            cls = loadedClasses.get(name);
            if (cls != null) {
                return cls;
            }

            //Hands over to URLClassLoader.loadClass. First attempt to delegate
            //to parent and then check for the class in the 
            //<code>classLoaderList</code>.
            cls = super.loadClass(name, resolve);
            if (cls != null) {
                loadedClasses.put(name, cls);
                return cls;
            }
            //Class not in this chain component.
            throw new ClassNotFoundException(name);
        } catch(ClassNotFoundException e) {
            //If the parent is a ClassLoaderChain, check in the ClassLoaderChain
            //ignoring this classloader component instance. Failure to do this 
            //would result in an infinte recursive call.
            if ((parentChain != null) && 
                             (parentChain instanceof ClassLoaderChain)) {
                ClassLoaderChain chain = (ClassLoaderChain)parentChain;
                //Ask parent chain to load class, skipping self
                Class c = chain.loadClass(name,this);
                //Resolve if required.
                if (c != null) {
                    if(resolve) {
                        resolveClass(c);
                    }
                    loadedClasses.put(name, c);
                    return c;
                }
            }
            
            //perf optimization
            if (!(notFoundClasses.contains(name))) {
                    notFoundClasses.add(name);
            }
            throw e;
        }

    }

    @Override
    public String toString() {
        String s = this.nameOfCL + " parentCL :: " + 
                             this.parentToString + " URLs :: \n";
        for(URL u:classLoaderList){
            s += ", " + u;
        }
        s +="\n";
        return s;
    }
}