public class AVMWebappClassLoader extends URLClassLoader implements org.apache.catalina.loader.Reloader, org.apache.catalina.Lifecycle
This class loader is a full reimplementation of the
URLClassLoader from the JDK. It is desinged to be fully
compatible with a normal URLClassLoader, although its internal
behavior may be completely different.
IMPLEMENTATION NOTE - This class loader faithfully follows the delegation model recommended in the specification. The system class loader will be queried first, then the local repositories, and only then delegation to the parent class loader will occur. This allows the web application to override any shared class except the classes from J2SE. Special handling is provided from the JAXP XML parser interfaces, the JNDI interfaces, and the classes from the servlet API, which are never loaded from the webapp repository.
IMPLEMENTATION NOTE - Due to limitations in Jasper compilation technology, any repository which contains classes from the servlet API will be ignored by the class loader.
IMPLEMENTATION NOTE - The class loader generates source URLs which include the full JAR URL when a class is loaded from a JAR file, which allows setting security permission at the class level, even when a class is contained inside a JAR.
IMPLEMENTATION NOTE - Local repositories are searched in
the order they are added via the initial constructor and/or any subsequent
calls to addRepository() or addJar().
IMPLEMENTATION NOTE - No check for sealing violations or security is made unless a security manager is present.
| Modifier and Type | Class and Description |
|---|---|
protected class |
AVMWebappClassLoader.PrivilegedFindResource |
| Modifier and Type | Field and Description |
|---|---|
protected Permission |
allPermission
All permission.
|
protected boolean |
delegate
Should this class loader delegate to the parent class loader
before searching its own repositories (i.e.
|
protected File[] |
files
Repositories translated as path in the work directory (for Jasper
originally), but which is used to generate fake URLs should getURLs be
called.
|
protected boolean |
hasExternalRepositories
Has external repositories.
|
protected JarFile[] |
jarFiles
The list of JARs, in the order they should be searched
for locally loaded classes or resources.
|
protected String[] |
jarNames
The list of JARs, in the order they should be searched
for locally loaded classes or resources.
|
protected String |
jarPath
The path which will be monitored for added Jar files.
|
protected File[] |
jarRealFiles
The list of JARs, in the order they should be searched
for locally loaded classes or resources.
|
protected static org.apache.tomcat.util.compat.JdkCompat |
jdkCompat
Jdk Compatibility Support.
|
protected long |
lastJarAccessed
Last time a JAR was accessed.
|
protected long[] |
lastModifiedDates
The list of JARs last modified dates, in the order they should be
searched for locally loaded classes or resources.
|
protected File |
loaderDir
Path where resources loaded from JARs will be extracted.
|
protected HashMap<String,PermissionCollection> |
loaderPC
The PermissionCollection for each CodeSource for a web
application context.
|
protected static org.apache.commons.logging.Log |
log |
protected boolean |
needConvert
need conversion for properties files
|
protected HashMap<String,String> |
notFoundResources
The list of not found resources.
|
protected static String[] |
packageTriggers
Set of package names which are not allowed to be loaded from a webapp
class loader without delegating first.
|
protected ClassLoader |
parent
The parent class loader.
|
protected String[] |
paths
The list of resources which should be checked when checking for
modifications.
|
protected ArrayList<Permission> |
permissionList
A list of read File and Jndi Permission's required if this loader
is for a web application context.
|
protected String[] |
repositories
The list of local repositories, in the order they should be searched
for locally loaded classes or resources.
|
protected URL[] |
repositoryURLs
Repositories URLs, used to cache the result of getURLs.
|
protected HashMap<String,org.apache.catalina.loader.ResourceEntry> |
resourceEntries
The cache of ResourceEntry for classes and resources we have loaded,
keyed by resource name.
|
protected DirContext |
resources
Associated directory context giving access to the resources in this
webapp.
|
protected SecurityManager |
securityManager
Instance of the SecurityManager installed.
|
protected static org.apache.catalina.util.StringManager |
sm
The string manager for this package.
|
protected boolean |
started
Has this component been started?
|
protected ClassLoader |
system
The system class loader.
|
protected static String[] |
triggers
The set of trigger classes that will cause a proposed repository not
to be added if this class is visible to the class loader that loaded
this factory class.
|
| Constructor and Description |
|---|
AVMWebappClassLoader()
Construct a new ClassLoader with no defined repositories and no
parent ClassLoader.
|
AVMWebappClassLoader(ClassLoader parent)
Construct a new ClassLoader with no defined repositories and no
parent ClassLoader.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addLifecycleListener(org.apache.catalina.LifecycleListener listener)
Add a lifecycle event listener to this component.
|
void |
addPermission(Permission permission)
If there is a Java SecurityManager create a Permission.
|
void |
addPermission(String path)
If there is a Java SecurityManager create a read FilePermission
or JndiPermission for the file directory path.
|
void |
addPermission(URL url)
If there is a Java SecurityManager create a read FilePermission
or JndiPermission for URL.
|
void |
addRepository(String repository)
Add a new repository to the set of places this ClassLoader can look for
classes to be loaded.
|
protected void |
addURL(URL url)
Add the specified URL to the classloader.
|
protected void |
clearReferences()
Clear references.
|
void |
closeJARs(boolean force)
Used to periodically signal to the classloader to release
JAR resources.
|
protected static void |
deleteDir(File dir)
Delete the specified directory, including all of its contents and
subdirectories recursively.
|
protected boolean |
filter(String name)
Filter classes.
|
Class |
findClass(String name)
Find the specified class in our local repositories, if possible.
|
protected Class |
findClassInternal(String name)
Find specified class in local repositories.
|
org.apache.catalina.LifecycleListener[] |
findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle.
|
protected Class |
findLoadedClass0(String name)
Finds the class with the given name if it has previously been
loaded and cached by this class loader, and return the Class object.
|
protected InputStream |
findLoadedResource(String name)
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.
|
String[] |
findRepositories()
Return a String array of the current repositories for this class
loader.
|
URL |
findResource(String name)
Find the specified resource in our local repository, and return a
URL refering to it, or null if this resource
cannot be found. |
protected org.apache.catalina.loader.ResourceEntry |
findResourceInternal(File file,
String path)
Find specified resource in local repositories.
|
protected org.apache.catalina.loader.ResourceEntry |
findResourceInternal(String name,
String path)
Find specified resource in local repositories.
|
Enumeration<URL> |
findResources(String name)
Return an enumeration of
URLs representing all of the
resources with the given name. |
boolean |
getAntiJARLocking() |
boolean |
getDelegate()
Return the "delegate first" flag for this class loader.
|
String |
getJarPath()
Return the JAR path.
|
protected PermissionCollection |
getPermissions(CodeSource codeSource)
Get the Permissions for a CodeSource.
|
URL |
getResource(String name)
Find the resource with the given name.
|
InputStream |
getResourceAsStream(String name)
Find the resource with the given name, and return an input stream
that can be used for reading it.
|
DirContext |
getResources()
Get associated resources.
|
protected URL |
getURI(File file)
Get URL.
|
protected URL |
getURL(File file)
Get URL.
|
URL[] |
getURLs()
Returns the search path of URLs for loading classes and resources.
|
protected boolean |
isPackageSealed(String name,
Manifest man)
Returns true if the specified package name is sealed according to the
given manifest.
|
Class |
loadClass(String name)
Load the class with the specified name.
|
Class |
loadClass(String name,
boolean resolve)
Load the class with the specified name, searching using the following
algorithm until it finds and returns the class.
|
protected boolean |
loadedByThisOrChild(Class clazz)
Determine whether a class was loaded by this class loader or one of
its child class loaders.
|
boolean |
modified()
Have one or more classes or resources been modified so that a reload
is appropriate?
|
protected void |
nullInstance(Object instance) |
protected boolean |
openJARs()
Used to periodically signal to the classloader to release JAR resources.
|
protected void |
refreshPolicy()
Refresh the system policy file, to pick up eventual changes.
|
void |
removeLifecycleListener(org.apache.catalina.LifecycleListener listener)
Remove a lifecycle event listener from this component.
|
void |
setAntiJARLocking(boolean antiJARLocking) |
void |
setDelegate(boolean delegate)
Set the "delegate first" flag for this class loader.
|
void |
setJarPath(String jarPath)
Change the Jar path.
|
void |
setResources(DirContext resources)
Set associated resources.
|
void |
setWorkDir(File workDir)
Change the work directory.
|
void |
start()
Start the class loader.
|
void |
stop()
Stop the class loader.
|
String |
toString()
Render a String representation of this object.
|
protected boolean |
validate(String name)
Validate a classname.
|
protected boolean |
validateJarFile(File jarfile)
Check the specified JAR file, and return
true if it does
not contain any of the trigger classes. |
close, definePackage, newInstance, newInstancedefineClass, defineClassclearAssertionStatus, defineClass, defineClass, defineClass, defineClass, definePackage, findLibrary, findLoadedClass, findSystemClass, getClassLoadingLock, getPackage, getPackages, getParent, getResources, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSignersprotected static org.apache.commons.logging.Log log
protected static final String[] triggers
protected static org.apache.tomcat.util.compat.JdkCompat jdkCompat
protected static final String[] packageTriggers
protected static final org.apache.catalina.util.StringManager sm
protected DirContext resources
protected HashMap<String,org.apache.catalina.loader.ResourceEntry> resourceEntries
protected HashMap<String,String> notFoundResources
protected boolean delegate
false,
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 long lastJarAccessed
protected String[] repositories
protected URL[] repositoryURLs
protected File[] files
protected JarFile[] jarFiles
protected File[] jarRealFiles
protected String jarPath
protected String[] jarNames
protected long[] lastModifiedDates
protected String[] paths
protected ArrayList<Permission> permissionList
protected File loaderDir
protected HashMap<String,PermissionCollection> loaderPC
protected SecurityManager securityManager
protected ClassLoader parent
protected ClassLoader system
protected boolean started
protected boolean hasExternalRepositories
protected boolean needConvert
protected Permission allPermission
public AVMWebappClassLoader()
public AVMWebappClassLoader(ClassLoader parent)
public DirContext getResources()
public void setResources(DirContext resources)
public boolean getDelegate()
public void setDelegate(boolean delegate)
delegate - The new "delegate first" flagpublic boolean getAntiJARLocking()
public void setAntiJARLocking(boolean antiJARLocking)
antiJARLocking - The antiJARLocking to set.public void addPermission(String path)
path - file directory pathpublic void addPermission(URL url)
url - URL for a file or directory on local systempublic void addPermission(Permission permission)
permission - The permissionpublic String getJarPath()
public void setJarPath(String jarPath)
public void setWorkDir(File workDir)
public void addRepository(String repository)
addRepository in interface org.apache.catalina.loader.Reloaderrepository - Name of a source of classes to be loaded, such as a
directory pathname, a JAR file pathname, or a ZIP file pathnameIllegalArgumentException - if the specified repository is
invalid or does not existpublic String[] findRepositories()
findRepositories in interface org.apache.catalina.loader.Reloaderpublic boolean modified()
modified in interface org.apache.catalina.loader.Reloaderpublic String toString()
protected void addURL(URL url)
addURL in class URLClassLoaderpublic Class findClass(String name) throws ClassNotFoundException
ClassNotFoundException.findClass in class URLClassLoadername - Name of the class to be loadedClassNotFoundException - if the class was not foundpublic URL findResource(String name)
URL refering to it, or null if this resource
cannot be found.findResource in class URLClassLoadername - Name of the resource to be foundpublic Enumeration<URL> findResources(String name) throws IOException
URLs representing all of the
resources with the given name. If no resources with this name are
found, return an empty enumeration.findResources in class URLClassLoadername - Name of the resources to be foundIOException - if an input/output error occurspublic URL getResource(String name)
null.
This method searches according to the following algorithm, returning
as soon as it finds the appropriate URL. If the resource cannot be
found, returns null.
delegate property is set to true,
call the getResource() method of the parent class
loader, if any.findResource() to find this resource in our
locally defined repositories.getResource() method of the parent class
loader, if any.getResource in class ClassLoadername - Name of the resource to return a URL forpublic InputStream getResourceAsStream(String name)
getResource(), after checking to see if the resource
data has been previously cached. If the resource cannot be found,
return null.getResourceAsStream in class URLClassLoadername - Name of the resource to return an input stream forpublic Class loadClass(String name) throws ClassNotFoundException
loadClass(String, boolean)
with false as the second argument.loadClass in class ClassLoadername - Name of the class to be loadedClassNotFoundException - if the class was not foundpublic Class loadClass(String name, boolean resolve) throws ClassNotFoundException
ClassNotFoundException.
findLoadedClass(String) to check if the
class has already been loaded. If it has, the same
Class object is returned.delegate property is set to true,
call the loadClass() method of the parent class
loader, if any.findClass() to find this class in our locally
defined repositories.loadClass() method of our parent
class loader, if any.resolve flag is true, this method will then
call resolveClass(Class) on the resulting Class object.loadClass in class ClassLoadername - Name of the class to be loadedresolve - If true then resolve the classClassNotFoundException - if the class was not foundprotected PermissionCollection getPermissions(CodeSource codeSource)
getPermissions in class URLClassLoadercodeSource - where the code was loaded frompublic URL[] getURLs()
getURLs in class URLClassLoaderpublic void addLifecycleListener(org.apache.catalina.LifecycleListener listener)
addLifecycleListener in interface org.apache.catalina.Lifecyclelistener - The listener to addpublic org.apache.catalina.LifecycleListener[] findLifecycleListeners()
findLifecycleListeners in interface org.apache.catalina.Lifecyclepublic void removeLifecycleListener(org.apache.catalina.LifecycleListener listener)
removeLifecycleListener in interface org.apache.catalina.Lifecyclelistener - The listener to removepublic void start()
throws org.apache.catalina.LifecycleException
start in interface org.apache.catalina.Lifecycleorg.apache.catalina.LifecycleException - if a lifecycle error occurspublic void stop()
throws org.apache.catalina.LifecycleException
stop in interface org.apache.catalina.Lifecycleorg.apache.catalina.LifecycleException - if a lifecycle error occurspublic void closeJARs(boolean force)
protected void clearReferences()
protected void nullInstance(Object instance)
protected boolean loadedByThisOrChild(Class clazz)
protected boolean openJARs()
protected Class findClassInternal(String name) throws ClassNotFoundException
ClassNotFoundExceptionprotected org.apache.catalina.loader.ResourceEntry findResourceInternal(File file, String path)
protected org.apache.catalina.loader.ResourceEntry findResourceInternal(String name, String path)
protected boolean isPackageSealed(String name, Manifest man)
protected InputStream findLoadedResource(String name)
null.name - Name of the resource to returnprotected Class findLoadedClass0(String name)
null.name - Name of the resource to returnprotected void refreshPolicy()
protected boolean filter(String name)
name - class nameprotected boolean validate(String name)
name - class nameprotected boolean validateJarFile(File jarfile) throws IOException
true if it does
not contain any of the trigger classes.jarfile - The JAR file to be checkedIOException - if an input/output error occursprotected URL getURL(File file) throws MalformedURLException
MalformedURLExceptionprotected URL getURI(File file) throws MalformedURLException
MalformedURLExceptionprotected static void deleteDir(File dir)
dir - File object representing the directory to be deletedCopyright © 2005–2014 Alfresco Software. All rights reserved.