You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by re...@apache.org on 2001/06/19 04:12:41 UTC
cvs commit: jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loader WebappClassLoader.java
remm 01/06/18 19:12:40
Added: catalina/src/share/org/apache/catalina/loader
WebappClassLoader.java
Log:
- New classloader implementation, used for web applications only.
- Extends URLClassLoader (to preserve maximum compatibility).
- Does not require dynamic bindings to work.
- Supports reloading of classes in /WEB-INF/classes.
- Supports reloading of JARs. This is untested, and is only a convinience
feature (for example, when you forgot a JAR required by a webapp). In many
cases, a stop / start of the context (which destroys it and recreates it from
scratch) will be needed to avoid getting JVM linkage errors and class casts.
- Improved efficiency a lot : no more double tracking of the classes and
resources, unified loaded resources repository (classes + resources).
- Fixed lookup path : first classes repository, then JARs. It was impossible
to control the order of the repositories by directly using URLClassLoader.
- To the outside world (if getURLs() is called), it appears as a file-based
URLClassLoader.
- All the JARs in /WEB-INF/lib are extracted and copied to the work directory,
even if the resources are filesystem based. Otherwise, it is not possible to
actually manipulate the JARs which are in the webapp while they're open, at
least under Windows. This operation is relatively fast anyway.
- Tested with the examples webapp, Slide and Jasper.
- Note : Jasper reloading of the classes may still be broken.
Revision Changes Path
1.1 jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loader/WebappClassLoader.java
Index: WebappClassLoader.java
===================================================================
/*
* $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loader/WebappClassLoader.java,v 1.1 2001/06/19 02:12:39 remm Exp $
* $Revision: 1.1 $
* $Date: 2001/06/19 02:12:39 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.catalina.loader;
import java.io.File;
import java.io.FilePermission;
import java.io.InputStream;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.net.JarURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.net.URLConnection;
import java.net.URLStreamHandlerFactory;
import java.net.URLStreamHandler;
import java.security.AccessControlException;
import java.security.PrivilegedAction;
import java.security.PrivilegedExceptionAction;
import java.security.AccessController;
import java.security.AccessControlContext;
import java.security.CodeSource;
import java.security.PermissionCollection;
import java.security.Policy;
import java.security.cert.Certificate;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.jar.JarFile;
import java.util.jar.JarEntry;
import java.util.jar.JarInputStream;
import java.util.jar.Manifest;
import java.util.jar.Attributes;
import java.util.jar.Attributes.Name;
import javax.naming.directory.DirContext;
import javax.naming.NamingException;
import javax.naming.NamingEnumeration;
import javax.naming.NameClassPair;
import org.apache.naming.resources.ResourceAttributes;
import org.apache.naming.resources.Resource;
/**
* Specialized web application class loader.
* <p>
* <strong>IMPLEMENTATION NOTE</strong> - Local repositories are searched in
* the order they are added via the initial constructor and/or any subsequent
* calls to <code>addRepository()</code> or <code>addJar()</code>.
* <p>
* <strong>IMPLEMENTATION NOTE</strong> - No check for sealing violations or
* security is made unless a security manager is present.
* <p>
* <strong>FIXME</strong> - Implement findResources.
*
* @author Remy Maucherat
* @author Craig R. McClanahan
* @version $Revision: 1.1 $ $Date: 2001/06/19 02:12:39 $
*/
public class WebappClassLoader
extends URLClassLoader
implements Reloader {
// ----------------------------------------------------------- Constructors
/**
* Construct a new ClassLoader with no defined repositories and no
* parent ClassLoader.
*/
public WebappClassLoader(DirContext resources) {
super(new URL[0]);
this.resources = resources;
this.parent = getParent();
system = getSystemClassLoader();
securityManager = System.getSecurityManager();
}
/**
* Construct a new ClassLoader with no defined repositories and no
* parent ClassLoader.
*/
public WebappClassLoader(ClassLoader parent, DirContext resources) {
super(new URL[0], parent);
this.resources = resources;
this.parent = getParent();
system = getSystemClassLoader();
securityManager = System.getSecurityManager();
}
// ----------------------------------------------------- Instance Variables
/**
* Associated directory context giving access to the resources in this
* webapp.
*/
protected DirContext resources = null;
/**
* The set of optional packages (formerly standard extensions) that
* are available in the repositories associated with this class loader.
* Each object in this list is of type
* <code>org.apache.catalina.loader.Extension</code>.
*/
protected ArrayList available = new ArrayList();
/**
* The cache of ResourceEntry for classes and resources we have loaded,
* keyed by resource name.
*/
protected HashMap resourceEntries = new HashMap();
/**
* The list of not found resources.
*/
protected HashMap notFoundResources = new HashMap();
/**
* The debugging detail level of this component.
*/
protected int debug = 0;
/**
* Should this class loader delegate to the parent class loader
* <strong>before</strong> searching its own repositories (i.e. the
* usual Java2 delegation model)? If set to <code>false</code>,
* this class loader will search its own repositories first, and
* delegate to the parent only if the class or resource is not
* found locally.
*/
protected boolean delegate = false;
/**
* The list of local repositories, in the order they should be searched
* for locally loaded classes or resources.
*/
protected String[] repositories = new String[0];
/**
* Repositories translated as path in the work directory (for Jasper
* originally), but which is used to generate fake URLs should getURLs be
* called.
*/
protected File[] files = new File[0];
/**
* The list of JARs, in the order they should be searched
* for locally loaded classes or resources.
*/
protected JarFile[] jarFiles = new JarFile[0];
/**
* The list of JARs, in the order they should be searched
* for locally loaded classes or resources.
*/
protected File[] jarRealFiles = new File[0];
/**
* The path which will be monitored for added Jar files.
*/
protected String jarPath = null;
/**
* The list of JARs, in the order they should be searched
* for locally loaded classes or resources.
*/
protected String[] jarNames = new String[0];
/**
* The list of JARs last modified dates, in the order they should be
* searched for locally loaded classes or resources.
*/
protected long[] lastModifiedDates = new long[0];
/**
* The list of resources which should be checked when checking for
* modifications.
*/
protected String[] paths = new String[0];
/**
* The set of optional packages (formerly standard extensions) that
* are required in the repositories associated with this class loader.
* Each object in this list is of type
* <code>org.apache.catalina.loader.Extension</code>.
*/
protected ArrayList required = new ArrayList();
/**
* A list of read FilePermission's required if this loader
* is for a web application context.
*/
private ArrayList filePermissionList = new ArrayList();
/**
* The PermissionCollection for each CodeSource for a web
* application context.
*/
private HashMap loaderPC = new HashMap();
/**
* Instance of the SecurityManager installed.
*/
private SecurityManager securityManager = null;
/**
* Flag that the security policy has been refreshed from file.
*/
private boolean policy_refresh = false;
/**
* The parent class loader.
*/
private ClassLoader parent = null;
/**
* The system class loader.
*/
private ClassLoader system = null;
// ------------------------------------------------------------- Properties
/**
* Return the debugging detail level for this component.
*/
public int getDebug() {
return (this.debug);
}
/**
* Set the debugging detail level for this component.
*
* @param debug The new debugging detail level
*/
public void setDebug(int debug) {
this.debug = debug;
}
/**
* Return the "delegate first" flag for this class loader.
*/
public boolean getDelegate() {
return (this.delegate);
}
/**
* Set the "delegate first" flag for this class loader.
*
* @param delegate The new "delegate first" flag
*/
public void setDelegate(boolean delegate) {
this.delegate = delegate;
}
/**
* If there is a Java SecurityManager create a read FilePermission
* for the file directory path.
*
* @param path file directory path
*/
public void setPermissions(String path) {
if( securityManager != null ) {
filePermissionList.add(new FilePermission(path + "-","read"));
}
}
/**
* If there is a Java SecurityManager add a read FilePermission
* for URL.
*
* @param url URL for a file or directory on local system
*/
public void setPermissions(URL url) {
setPermissions(url.toString());
}
/**
* Return the JAR path.
*/
public String getJarPath() {
return this.jarPath;
}
/**
* Change the Jar path.
*/
public void setJarPath(String jarPath) {
this.jarPath = jarPath;
}
// ------------------------------------------------------- Reloader Methods
/**
* Add a new repository to the set of places this ClassLoader can look for
* classes to be loaded.
*
* @param repository Name of a source of classes to be loaded, such as a
* directory pathname, a JAR file pathname, or a ZIP file pathname
*
* @exception IllegalArgumentException if the specified repository is
* invalid or does not exist
*/
public void addRepository(String repository) {
addRepository(repository, new File(repository));
}
/**
* Add a new repository to the set of places this ClassLoader can look for
* classes to be loaded.
*
* @param repository Name of a source of classes to be loaded, such as a
* directory pathname, a JAR file pathname, or a ZIP file pathname
*
* @exception IllegalArgumentException if the specified repository is
* invalid or does not exist
*/
public synchronized void addRepository(String repository, File file) {
// Note : There should be only one (of course), but I think we should
// keep this a bit generic
if (repository == null)
return;
if (debug >= 1)
log("addRepository(" + repository + ")");
int i;
// Add this repository to our internal list
String[] result = new String[repositories.length + 1];
for (i = 0; i < repositories.length; i++) {
result[i] = repositories[i];
}
result[repositories.length] = repository;
repositories = result;
// Add the file to the list
File[] result2 = new File[files.length + 1];
for (i = 0; i < files.length; i++) {
result2[i] = files[i];
}
result2[files.length] = file;
files = result2;
}
public synchronized void addJar(String jar, JarFile jarFile, File file)
throws IOException {
if (jar == null)
return;
if (jarFile == null)
return;
if (file == null)
return;
if (debug >= 1)
log("addJar(" + jar + ")");
int i;
if ((jarPath != null) && (jar.startsWith(jarPath))) {
String jarName = jar.substring(jarPath.length());
while (jarName.startsWith("/"))
jarName = jarName.substring(1);
String[] result = new String[jarNames.length + 1];
for (i = 0; i < jarNames.length; i++) {
result[i] = jarNames[i];
}
result[jarNames.length] = jarName;
jarNames = result;
}
JarFile[] result2 = new JarFile[jarFiles.length + 1];
for (i = 0; i < jarFiles.length; i++) {
result2[i] = jarFiles[i];
}
result2[jarFiles.length] = jarFile;
jarFiles = result2;
try {
// Register the JAR for tracking
long lastModified =
((ResourceAttributes) resources.getAttributes(jar))
.getLastModified().getTime();
String[] result = new String[paths.length + 1];
for (i = 0; i < paths.length; i++) {
result[i] = paths[i];
}
result[paths.length] = jar;
paths = result;
long[] result3 = new long[lastModifiedDates.length + 1];
for (i = 0; i < lastModifiedDates.length; i++) {
result3[i] = lastModifiedDates[i];
}
result3[lastModifiedDates.length] = lastModified;
lastModifiedDates = result3;
} catch (NamingException e) {
}
// Add the file to the list
File[] result4 = new File[jarRealFiles.length + 1];
for (i = 0; i < jarRealFiles.length; i++) {
result4[i] = jarRealFiles[i];
}
result4[jarRealFiles.length] = file;
jarRealFiles = result4;
// Load manifest
Manifest manifest = jarFile.getManifest();
if (manifest != null) {
Iterator extensions = Extension.getAvailable(manifest).iterator();
while (extensions.hasNext()) {
available.add(extensions.next());
}
extensions = Extension.getRequired(manifest).iterator();
while (extensions.hasNext()) {
required.add(extensions.next());
}
}
}
/**
* Return a list of "optional packages" (formerly "standard extensions")
* that have been declared to be available in the repositories associated
* with this class loader, plus any parent class loader implemented with
* the same class.
*/
public Extension[] findAvailable() {
// Initialize the results with our local available extensions
ArrayList results = new ArrayList();
Iterator available = this.available.iterator();
while (available.hasNext())
results.add(available.next());
// Trace our parentage tree and add declared extensions when possible
ClassLoader loader = this;
while (true) {
loader = loader.getParent();
if (loader == null)
break;
if (!(loader instanceof StandardClassLoader))
continue;
Extension extensions[] =
((StandardClassLoader) loader).findAvailable();
for (int i = 0; i < extensions.length; i++)
results.add(extensions[i]);
}
// Return the results as an array
Extension extensions[] = new Extension[results.size()];
return ((Extension[]) results.toArray(extensions));
}
/**
* Return a String array of the current repositories for this class
* loader. If there are no repositories, a zero-length array is
* returned.
*/
public String[] findRepositories() {
return (repositories);
}
/**
* Return a list of "optional packages" (formerly "standard extensions")
* that have been declared to be required in the repositories associated
* with this class loader, plus any parent class loader implemented with
* the same class.
*/
public Extension[] findRequired() {
// Initialize the results with our local required extensions
ArrayList results = new ArrayList();
Iterator required = this.required.iterator();
while (required.hasNext())
results.add(required.next());
// Trace our parentage tree and add declared extensions when possible
ClassLoader loader = this;
while (true) {
loader = loader.getParent();
if (loader == null)
break;
if (!(loader instanceof StandardClassLoader))
continue;
Extension extensions[] =
((StandardClassLoader) loader).findRequired();
for (int i = 0; i < extensions.length; i++)
results.add(extensions[i]);
}
// Return the results as an array
Extension extensions[] = new Extension[results.size()];
return ((Extension[]) results.toArray(extensions));
}
/**
* Have one or more classes or resources been modified so that a reload
* is appropriate?
*/
public boolean modified() {
if (debug >= 2)
log("modified()");
// Checking for modified loaded resources
int length = paths.length;
for (int i = 0; i < length; i++) {
try {
long lastModified =
((ResourceAttributes) resources.getAttributes(paths[i]))
.getLastModified().getTime();
if (lastModified != lastModifiedDates[i]) {
if (debug > 2)
log(" Resource '" + paths[i] + "' was modified");
return (true);
}
} catch (NamingException e) {
log(" Resource '" + paths[i] + "' is missing");
return (true);
}
}
length = jarNames.length;
// Check if JARs have been added or removed
if (getJarPath() != null) {
try {
NamingEnumeration enum = resources.listBindings(getJarPath());
int i;
for (i = 0; enum.hasMoreElements() && (i < length); i++) {
NameClassPair ncPair = (NameClassPair) enum.nextElement();
if (!ncPair.getName().equals(jarNames[i])) {
// Missing JAR
if (debug > 2)
log(" Additional JARs have been added : '"
+ ncPair.getName() + "'");
return (true);
}
}
if (enum.hasMoreElements()) {
// There was more JARs
if (debug > 2)
log(" Additional JARs have been added");
return (true);
} else if (i < jarNames.length) {
// There was less JARs
if (debug > 2)
log(" Additional JARs have been added");
return (true);
}
} catch (NamingException e) {
if (debug >= 2)
log(" Failed tracking modifications of '"
+ getJarPath() + "'");
} catch (ClassCastException e) {
log(" Failed tracking modifications of '"
+ getJarPath() + "' : " + e.getMessage());
}
}
// No classes have been modified
return (false);
}
/**
* Render a String representation of this object.
*/
public String toString() {
StringBuffer sb = new StringBuffer("StandardClassLoader\r\n");
sb.append(" available:\r\n");
Iterator available = this.available.iterator();
while (available.hasNext()) {
sb.append(" ");
sb.append(available.next().toString());
sb.append("\r\n");
}
sb.append(" delegate: ");
sb.append(delegate);
sb.append("\r\n");
sb.append(" repositories:\r\n");
for (int i = 0; i < repositories.length; i++) {
sb.append(" ");
sb.append(repositories[i]);
sb.append("\r\n");
}
sb.append(" required:\r\n");
Iterator required = this.required.iterator();
while (required.hasNext()) {
sb.append(" ");
sb.append(required.next().toString());
sb.append("\r\n");
}
if (getParent() != null) {
sb.append("----------> Parent Classloader:\r\n");
sb.append(getParent().toString());
sb.append("\r\n");
}
return (sb.toString());
}
// ---------------------------------------------------- ClassLoader Methods
/**
* Find the specified class in our local repositories, if possible. If
* not found, throw <code>ClassNotFoundException</code>.
*
* @param name Name of the class to be loaded
*
* @exception ClassNotFoundException if the class was not found
*/
public Class findClass(String name) throws ClassNotFoundException {
if (debug >= 3)
log(" findClass(" + name + ")");
// (1) Permission to define this class when using a SecurityManager
if (securityManager != null) {
int i = name.lastIndexOf('.');
if (i >= 0) {
try {
if (debug >= 4)
log(" securityManager.checkPackageDefinition");
securityManager.checkPackageDefinition(name.substring(0,i));
} catch (Exception se) {
if (debug >= 4)
log(" -->Exception-->ClassNotFoundException", se);
throw new ClassNotFoundException(name);
}
}
}
// Ask our superclass to locate this class, if possible
// (throws ClassNotFoundException if it is not found)
Class clazz = null;
try {
if (debug >= 4)
log(" super.findClass(" + name + ")");
try {
clazz = findClassInternal(name);
} catch(AccessControlException ace) {
ace.printStackTrace();
throw new ClassNotFoundException(name);
} catch (RuntimeException e) {
if (debug >= 4)
log(" -->RuntimeException Rethrown", e);
throw e;
}
if (clazz == null) {
if (debug >= 3)
log(" --> Returning ClassNotFoundException");
throw new ClassNotFoundException(name);
}
} catch (ClassNotFoundException e) {
if (debug >= 3)
log(" --> Passing on ClassNotFoundException", e);
throw e;
}
// Return the class we have located
if (debug >= 4)
log(" Returning class " + clazz);
if ((debug >= 4) && (clazz != null))
log(" Loaded by " + clazz.getClassLoader());
return (clazz);
}
/**
* Find the specified resource in our local repository, and return a
* <code>URL</code> refering to it, or <code>null</code> if this resource
* cannot be found.
*
* @param name Name of the resource to be found
*/
public URL findResource(String name) {
if (debug >= 3)
log(" findResource(" + name + ")");
URL url = null;
ResourceEntry entry = (ResourceEntry) resourceEntries.get(name);
if (entry == null) {
entry = findResourceInternal(name, name);
}
if (entry != null) {
url = entry.source;
}
if (debug >= 3) {
if (url != null)
log(" --> Returning '" + url.toString() + "'");
else
log(" --> Resource not found, returning null");
}
return (url);
}
/**
* Return an enumeration of <code>URLs</code> representing all of the
* resources with the given name. If no resources with this name are
* found, return an empty enumeration.
*
* @param name Name of the resources to be found
*
* @exception IOException if an input/output error occurs
*/
public Enumeration findResources(String name) throws IOException {
if (debug >= 3)
log(" findResources(" + name + ")");
return (super.findResources(name));
}
/**
* Find the resource with the given name. A resource is some data
* (images, audio, text, etc.) that can be accessed by class code in a
* way that is independent of the location of the code. The name of a
* resource is a "/"-separated path name that identifies the resource.
* If the resource cannot be found, return <code>null</code>.
* <p>
* This method searches according to the following algorithm, returning
* as soon as it finds the appropriate URL. If the resource cannot be
* found, returns <code>null</code>.
* <ul>
* <li>If the <code>delegate</code> property is set to <code>true</code>,
* call the <code>getResource()</code> method of the parent class
* loader, if any.</li>
* <li>Call <code>findResource()</code> to find this resource in our
* locally defined repositories.</li>
* <li>Call the <code>getResource()</code> method of the parent class
* loader, if any.</li>
* </ul>
*
* @param name Name of the resource to return a URL for
*/
public URL getResource(String name) {
if (debug >= 2)
log("getResource(" + name + ")");
URL url = null;
// (1) Delegate to parent if requested
if (delegate) {
if (debug >= 3)
log(" Delegating to parent classloader");
ClassLoader loader = parent;
if (loader == null)
loader = system;
url = loader.getResource(name);
if (url != null) {
if (debug >= 2)
log(" --> Returning '" + url.toString() + "'");
return (url);
}
}
// (2) Search local repositories
if (debug >= 3)
log(" Searching local repositories");
url = findResource(name);
if (url != null) {
if (debug >= 2)
log(" --> Returning '" + url.toString() + "'");
return (url);
}
// (3) Delegate to parent unconditionally if not already attempted
if( !delegate ) {
ClassLoader loader = parent;
if (loader == null)
loader = system;
url = loader.getResource(name);
if (url != null) {
if (debug >= 2)
log(" --> Returning '" + url.toString() + "'");
return (url);
}
}
// (4) Resource was not found
if (debug >= 2)
log(" --> Resource not found, returning null");
return (null);
}
/**
* Find the resource with the given name, and return an input stream
* that can be used for reading it. The search order is as described
* for <code>getResource()</code>, after checking to see if the resource
* data has been previously cached. If the resource cannot be found,
* return <code>null</code>.
*
* @param name Name of the resource to return an input stream for
*/
public InputStream getResourceAsStream(String name) {
if (debug >= 2)
log("getResourceAsStream(" + name + ")");
InputStream stream = null;
// (0) Check for a cached copy of this resource
stream = findLoadedResource(name);
if (stream != null) {
if (debug >= 2)
log(" --> Returning stream from cache");
return (stream);
}
// (1) Delegate to parent if requested
if (delegate) {
if (debug >= 3)
log(" Delegating to parent classloader");
ClassLoader loader = parent;
if (loader == null)
loader = system;
stream = loader.getResourceAsStream(name);
if (stream != null) {
// FIXME - cache???
if (debug >= 2)
log(" --> Returning stream from parent");
return (stream);
}
}
// (2) Search local repositories
if (debug >= 3)
log(" Searching local repositories");
URL url = findResource(name);
if (url != null) {
// FIXME - cache???
if (debug >= 2)
log(" --> Returning stream from local");
try {
return (url.openStream());
} catch (IOException e) {
log("url.openStream(" + url.toString() + ")", e);
return (null);
}
}
// (3) Delegate to parent unconditionally
if (!delegate) {
if (debug >= 3)
log(" Delegating to parent classloader");
ClassLoader loader = parent;
if (loader == null)
loader = system;
stream = loader.getResourceAsStream(name);
if (stream != null) {
// FIXME - cache???
if (debug >= 2)
log(" --> Returning stream from parent");
return (stream);
}
}
// (4) Resource was not found
if (debug >= 2)
log(" --> Resource not found, returning null");
return (null);
}
/**
* Load the class with the specified name. This method searches for
* classes in the same manner as <code>loadClass(String, boolean)</code>
* with <code>false</code> as the second argument.
*
* @param name Name of the class to be loaded
*
* @exception ClassNotFoundException if the class was not found
*/
public Class loadClass(String name) throws ClassNotFoundException {
return (loadClass(name, false));
}
/**
* Load the class with the specified name, searching using the following
* algorithm until it finds and returns the class. If the class cannot
* be found, returns <code>ClassNotFoundException</code>.
* <ul>
* <li>Call <code>findLoadedClass(String)</code> to check if the
* class has already been loaded. If it has, the same
* <code>Class</code> object is returned.</li>
* <li>If the <code>delegate</code> property is set to <code>true</code>,
* call the <code>loadClass()</code> method of the parent class
* loader, if any.</li>
* <li>Call <code>findClass()</code> to find this class in our locally
* defined repositories.</li>
* <li>Call the <code>loadClass()</code> method of our parent
* class loader, if any.</li>
* </ul>
* If the class was found using the above steps, and the
* <code>resolve</code> flag is <code>true</code>, this method will then
* call <code>resolveClass(Class)</code> on the resulting Class object.
*
* @param name Name of the class to be loaded
* @param resolve If <code>true</code> then resolve the class
*
* @exception ClassNotFoundException if the class was not found
*/
public Class loadClass(String name, boolean resolve)
throws ClassNotFoundException {
if (debug >= 2)
log("loadClass(" + name + ", " + resolve + ")");
Class clazz = null;
// (0) Check our previously loaded local class cache
clazz = findLoadedClass0(name);
if (clazz != null) {
if (debug >= 3)
log(" Returning class from cache");
if (resolve)
resolveClass(clazz);
return (clazz);
}
// (0.1) Check our previously loaded class cache
clazz = findLoadedClass(name);
if (clazz != null) {
if (debug >= 3)
log(" Returning class from cache");
if (resolve)
resolveClass(clazz);
return (clazz);
}
// If a system class, use system class loader
if( name.startsWith("java.") ) {
ClassLoader loader = system;
clazz = loader.loadClass(name);
if (clazz != null) {
if (resolve)
resolveClass(clazz);
return (clazz);
}
throw new ClassNotFoundException(name);
}
// (.5) Permission to access this class when using a SecurityManager
if (securityManager != null) {
int i = name.lastIndexOf('.');
if (i >= 0) {
try {
securityManager.checkPackageAccess(name.substring(0,i));
} catch (SecurityException se) {
String error = "Security Violation, attempt to use " +
"Restricted Class: " + name;
System.out.println(error);
se.printStackTrace();
log(error);
throw new ClassNotFoundException(error);
}
}
}
// (1) Delegate to our parent if requested
if (delegate) {
if (debug >= 3)
log(" Delegating to parent classloader");
ClassLoader loader = parent;
if (loader == null)
loader = system;
try {
clazz = loader.loadClass(name);
if (clazz != null) {
if (debug >= 3)
log(" Loading class from parent");
if (resolve)
resolveClass(clazz);
return (clazz);
}
} catch (ClassNotFoundException e) {
;
}
}
// (2) Search local repositories
if (debug >= 3)
log(" Searching local repositories");
try {
clazz = findClass(name);
if (clazz != null) {
if (debug >= 3)
log(" Loading class from local repository");
if (resolve)
resolveClass(clazz);
return (clazz);
}
} catch (ClassNotFoundException e) {
;
}
// (3) Delegate to parent unconditionally
if (!delegate) {
if (debug >= 3)
log(" Delegating to parent classloader");
ClassLoader loader = parent;
if (loader == null)
loader = system;
try {
clazz = loader.loadClass(name);
if (clazz != null) {
if (debug >= 3)
log(" Loading class from parent");
if (resolve)
resolveClass(clazz);
return (clazz);
}
} catch (ClassNotFoundException e) {
;
}
}
// This class was not found
throw new ClassNotFoundException(name);
}
/**
* Get the Permissions for a CodeSource. If this instance
* of StandardClassLoader is for a web application context,
* add read FilePermissions for the base directory (if unpacked),
* the context URL, and jar file resources.
*
* @param CodeSource where the code was loaded from
* @return PermissionCollection for CodeSource
*/
protected PermissionCollection getPermissions(CodeSource codeSource) {
if (!policy_refresh) {
// Refresh the security policies
Policy policy = Policy.getPolicy();
policy.refresh();
policy_refresh = true;
}
String codeUrl = codeSource.getLocation().toString();
PermissionCollection pc;
if ((pc = (PermissionCollection)loaderPC.get(codeUrl)) == null) {
pc = super.getPermissions(codeSource);
if (pc != null) {
Iterator perms = filePermissionList.iterator();
while (perms.hasNext()) {
FilePermission fp = (FilePermission)perms.next();
pc.add(fp);
}
loaderPC.put(codeUrl,pc);
}
}
return (pc);
}
/**
* Returns the search path of URLs for loading classes and resources.
* This includes the original list of URLs specified to the constructor,
* along with any URLs subsequently appended by the addURL() method.
* @return the search path of URLs for loading classes and resources.
*/
public URL[] getURLs() {
int filesLength = files.length;
int jarFilesLength = jarRealFiles.length;
int length = filesLength + jarFilesLength;
int i;
try {
URL[] urls = new URL[length];
for (i = 0; i < length; i++) {
if (i < filesLength) {
urls[i] = files[i].toURL();
} else {
urls[i] = jarRealFiles[i - filesLength].toURL();
}
}
return urls;
} catch (MalformedURLException e) {
return (new URL[0]);
}
}
// ------------------------------------------------------ Protected Methods
/**
* Find specified class in local repositories.
*
* @return the loaded class, or null if the class isn't found
*/
protected Class findClassInternal(String name)
throws ClassNotFoundException {
String tempPath = name.replace('.', '/');
String classPath = tempPath + ".class";
ResourceEntry entry = findResourceInternal(name, classPath);
if (entry == null)
throw new ClassNotFoundException(name);
Class clazz = entry.loadedClass;
if (clazz != null)
return clazz;
// Looking up the package
String packageName = null;
int pos = name.lastIndexOf('.');
if (pos != -1)
packageName = name.substring(0, pos);
Package pkg = null;
if (packageName != null) {
pkg = getPackage(packageName);
// Define the package (if null)
if (pkg == null) {
if (entry.manifest == null) {
definePackage(packageName, null, null, null, null, null,
null, null);
} else {
definePackage(packageName, entry.manifest, entry.source);
}
}
}
// Create the code source object
CodeSource codeSource =
new CodeSource(entry.source, entry.certificates);
if (securityManager != null) {
// Checking sealing
if (pkg != null) {
boolean sealCheck = true;
if (pkg.isSealed()) {
sealCheck = pkg.isSealed(entry.source);
} else {
if (entry.manifest != null)
sealCheck = isPackageSealed
(packageName, entry.manifest);
}
if (!sealCheck)
throw new SecurityException("sealing violation");
}
/*
clazz = (Class)
AccessController.doPrivileged(new PrivilegedExceptionAction() {
public Object run() throws ClassNotFoundException {
return defineClass(name, entry.binaryContent, 0,
entry.binaryContent.length, codeSource);
}
}, accessController);
*/
}
clazz = defineClass(name, entry.binaryContent, 0,
entry.binaryContent.length, codeSource);
entry.loadedClass = clazz;
return clazz;
}
/**
* Find specified resource in local repositories.
*
* @return the loaded resource, or null if the resource isn't found
*/
protected ResourceEntry findResourceInternal(String name, String path) {
if ((name == null) || (path == null))
return null;
if (notFoundResources.containsKey(name))
return null;
ResourceEntry entry = (ResourceEntry) resourceEntries.get(name);
if (entry != null)
return entry;
int contentLength = -1;
InputStream binaryStream = null;
int jarFilesLength = jarFiles.length;
int repositoriesLength = repositories.length;
int i;
Resource resource = null;
for (i = 0; (entry == null) && (i < repositories.length); i++) {
try {
String fullPath = repositories[i] + path;
resource = (Resource) resources.lookup(fullPath);
// Note : Not getting an exception here means the resource was
// found
entry = new ResourceEntry();
try {
entry.source = new File(files[i], path).toURL();
} catch (MalformedURLException e) {
return null;
}
ResourceAttributes attributes =
(ResourceAttributes) resources.getAttributes(fullPath);
contentLength = (int) attributes.getContentLength();
entry.lastModified = attributes.getLastModified().getTime();
try {
binaryStream = resource.streamContent();
} catch (IOException e) {
return null;
}
// Register the full path for modification checking
synchronized (paths) {
int j;
String[] result = new String[paths.length + 1];
for (j = 0; j < paths.length; j++) {
result[j] = paths[j];
}
result[paths.length] = fullPath;
paths = result;
long[] result2 = new long[lastModifiedDates.length + 1];
for (j = 0; j < lastModifiedDates.length; j++) {
result2[j] = lastModifiedDates[j];
}
result2[lastModifiedDates.length] = entry.lastModified;
lastModifiedDates = result2;
}
} catch (NamingException e) {
}
}
JarEntry jarEntry = null;
for (i = 0; (entry == null) && (i < jarFiles.length); i++) {
jarEntry = jarFiles[i].getJarEntry(path);
if (jarEntry != null) {
entry = new ResourceEntry();
try {
String jarFakeUrl = jarRealFiles[i].toURL().toString();
jarFakeUrl = "jar:" + jarFakeUrl + "!/" + path;
entry.source = new URL(jarFakeUrl);
} catch (MalformedURLException e) {
e.printStackTrace();
return null;
}
entry.certificates = jarEntry.getCertificates();
contentLength = (int) jarEntry.getSize();
try {
entry.manifest = jarFiles[i].getManifest();
binaryStream = jarFiles[i].getInputStream(jarEntry);
} catch (IOException e) {
return null;
}
}
}
if (entry == null) {
synchronized (notFoundResources) {
notFoundResources.put(name, name);
}
return null;
}
byte[] binaryContent = new byte[contentLength];
try {
int pos = 0;
while (true) {
int n = binaryStream.read(binaryContent, pos,
binaryContent.length - pos);
if (n <= 0)
break;
pos += n;
}
binaryStream.close();
} catch (IOException e) {
return null;
} catch (Exception e) {
return null;
}
entry.binaryContent = binaryContent;
// Add the entry in the local resource repository
synchronized (resourceEntries) {
resourceEntries.put(name, entry);
}
return entry;
}
/**
* Returns true if the specified package name is sealed according to the
* given manifest.
*/
protected boolean isPackageSealed(String name, Manifest man) {
String path = name + "/";
Attributes attr = man.getAttributes(path);
String sealed = null;
if (attr != null) {
sealed = attr.getValue(Name.SEALED);
}
if (sealed == null) {
if ((attr = man.getMainAttributes()) != null) {
sealed = attr.getValue(Name.SEALED);
}
}
return "true".equalsIgnoreCase(sealed);
}
/**
* Finds the resource with the given name if it has previously been
* loaded and cached by this class loader, and return an input stream
* to the resource data. If this resource has not been cached, return
* <code>null</code>.
*
* @param name Name of the resource to return
*/
protected InputStream findLoadedResource(String name) {
ResourceEntry entry = (ResourceEntry) resourceEntries.get(name);
if (entry != null) {
if (entry.binaryContent != null)
return new ByteArrayInputStream(entry.binaryContent);
}
return (null);
}
/**
* Finds the class with the given name if it has previously been
* loaded and cached by this class loader, and return the Class object.
* If this class has not been cached, return <code>null</code>.
*
* @param name Name of the resource to return
*/
protected Class findLoadedClass0(String name) {
ResourceEntry entry = (ResourceEntry) resourceEntries.get(name);
if (entry != null) {
return entry.loadedClass;
}
return (null); // FIXME - findLoadedResource()
}
/**
* Log a debugging output message.
*
* @param message Message to be logged
*/
private void log(String message) {
System.out.println("StandardClassLoader: " + message);
}
/**
* Log a debugging output message with an exception.
*
* @param message Message to be logged
* @param throwable Exception to be logged
*/
private void log(String message, Throwable throwable) {
System.out.println("StandardClassLoader: " + message);
throwable.printStackTrace(System.out);
}
// ------------------------------------------------------ Protected Classes
/**
* Resource entry.
*/
protected static class ResourceEntry {
/**
* The "last modified" time of the origin file at the time this class
* was loaded, in milliseconds since the epoch.
*/
long lastModified;
/**
* Binary content of the resource.
*/
byte[] binaryContent;
/**
* Loaded class.
*/
Class loadedClass;
/**
* URL source from where the object was loaded.
*/
URL source;
/**
* Manifest (if the resource was loaded from a JAR).
*/
Manifest manifest = null;
/**
* Certificates (if the resource was loaded from a JAR).
*/
Certificate[] certificates = null;
}
}
Re:
cvscommit:jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loaderW
ebappClassLoader.java
Posted by Jon Stevens <jo...@latchkey.com>.
on 6/19/01 9:03 PM, "Remy Maucherat" <re...@apache.org> wrote:
> Do you have version 1.63 of StandardContext, as well as 1.4 (or 1.3, it's
> the same minus the traces mentioned below) of WebappLoader, and 1.2 of
> WebappClassLoader ?
>
> I added some e.printStackTrace() in WebappLoader to display if something bad
> happens when actually copying the files. It may be some platform specific
> file-related bug.
> I don't think I have hardcoded anything as work-only-on-windows, though ;-)
>
> Remy
I have 1.5 (your latest version) and the latest CVS update...
Scarab comes up just fine.
No errors are printed to the window that I run Tomcat from...just this...
Guessing CATALINA_HOME from catalina.sh to ./bin/..
Setting CATALINA_HOME to ./bin/..
Using CLASSPATH: ./bin/../bin/bootstrap.jar
Using CATALINA_HOME: ./bin/..
Starting service Tomcat-Standalone
Apache Tomcat/4.0-b6-dev
Nothing is in my work/localhost/scarab directory.
Love,
-jon
Re: Re:cvscommit:jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loaderWebappClassLoader.java
Posted by Remy Maucherat <re...@apache.org>.
> > And it's still loading the classes ?
>
> Yup, everything is running fine...
Weird.
> I'm serious...nothing is going into my work/localhost/scarab (the only
> directories in the work directory) directory...
Do you have version 1.63 of StandardContext, as well as 1.4 (or 1.3, it's
the same minus the traces mentioned below) of WebappLoader, and 1.2 of
WebappClassLoader ?
I added some e.printStackTrace() in WebappLoader to display if something bad
happens when actually copying the files. It may be some platform specific
file-related bug.
I don't think I have hardcoded anything as work-only-on-windows, though ;-)
Remy
Re:
cvscommit:jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loaderW
ebappClassLoader.java
Posted by Jon Stevens <jo...@latchkey.com>.
on 6/19/01 7:21 PM, "Remy Maucherat" <re...@apache.org> wrote:
>> Ok, I guess I can't complain because this doesn't seem to extract any
>> WEB-INF/lib jars into the work directory. :-)
>>
>> I'm using the latest cvs of tomcat...
>
> ...
> ...
>
> ?
> And it's still loading the classes ?
Yup, everything is running fine...
I'm serious...nothing is going into my work/localhost/scarab (the only
directories in the work directory) directory...
-jon
--
If you come from a Perl or PHP background, JSP is a way to take
your pain to new levels. --Anonymous
<http://jakarta.apache.org/velocity/ymtd/ymtd.html>
Re: cvscommit:jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loaderWebappClassLoader.java
Posted by Remy Maucherat <re...@apache.org>.
> on 6/18/01 7:30 PM, "Remy Maucherat" <re...@apache.org> wrote:
>
> > Obviously, the "side effect" is not that huge.
> >
> > Try it first, and complain later if it's really a problem :)
> >
> >> I'm not sure I like a hack like this that is clearly winblows specific.
> > Can
> >> you do this conditionally depending on platform?
> >
> > It's not a hack, it's just about robustness. Maybe it would be a problem
on
> > some other platform, I just don't know.
> >
> > Remy
>
> Ok, I guess I can't complain because this doesn't seem to extract any
> WEB-INF/lib jars into the work directory. :-)
>
> I'm using the latest cvs of tomcat...
...
...
?
And it's still loading the classes ?
When it's been proven that it's working as it should under Unix without
copying away the JARs, then we can consider not moving away the JARs. At
least under Windows, it's definitely needed, though.
We could also not copy the JARs when reloading is disabled.
Remy
Re: cvs
commit:jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loaderWeba
ppClassLoader.java
Posted by Jon Stevens <jo...@latchkey.com>.
on 6/18/01 7:30 PM, "Remy Maucherat" <re...@apache.org> wrote:
> Obviously, the "side effect" is not that huge.
>
> Try it first, and complain later if it's really a problem :)
>
>> I'm not sure I like a hack like this that is clearly winblows specific.
> Can
>> you do this conditionally depending on platform?
>
> It's not a hack, it's just about robustness. Maybe it would be a problem on
> some other platform, I just don't know.
>
> Remy
Ok, I guess I can't complain because this doesn't seem to extract any
WEB-INF/lib jars into the work directory. :-)
I'm using the latest cvs of tomcat...
-jon
Re: cvs commit:jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loaderWebappClassLoader.java
Posted by Remy Maucherat <re...@apache.org>.
> on 6/18/01 7:12 PM, "remm@apache.org" <re...@apache.org> wrote:
>
> > - All the JARs in /WEB-INF/lib are extracted and copied to the work
directory,
> > even if the resources are filesystem based. Otherwise, it is not
possible to
> > actually manipulate the JARs which are in the webapp while they're
open, at
> > least under Windows. This operation is relatively fast anyway.
>
> So, what is the side effect of this? Will that directory now grow without
> bounds?
Obviously, the "side effect" is not that huge.
Try it first, and complain later if it's really a problem :)
> I'm not sure I like a hack like this that is clearly winblows specific.
Can
> you do this conditionally depending on platform?
It's not a hack, it's just about robustness. Maybe it would be a problem on
some other platform, I just don't know.
Remy
Re: cvs commit:
jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/loader
WebappClassLoader.java
Posted by Jon Stevens <jo...@latchkey.com>.
on 6/18/01 7:12 PM, "remm@apache.org" <re...@apache.org> wrote:
> - All the JARs in /WEB-INF/lib are extracted and copied to the work directory,
> even if the resources are filesystem based. Otherwise, it is not possible to
> actually manipulate the JARs which are in the webapp while they're open, at
> least under Windows. This operation is relatively fast anyway.
So, what is the side effect of this? Will that directory now grow without
bounds?
I'm not sure I like a hack like this that is clearly winblows specific. Can
you do this conditionally depending on platform?
-jon