|
Apache Tomcat 7.0.28 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.lang.ClassLoader java.security.SecureClassLoader java.net.URLClassLoader org.apache.catalina.loader.WebappClassLoader
public class WebappClassLoader
Specialized web application class loader.
This class loader is a full reimplementation of the
URLClassLoader
from the JDK. It is designed to be fully
compatible with a normal URLClassLoader
, although its internal
behavior may be completely different.
IMPLEMENTATION NOTE - By default, this class loader follows
the delegation model required by 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 repositories. The delegate
property
allows an application to modify this behavior to move the parent class loader
ahead of the local repositories.
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.
TODO: Is there any requirement to provide a proper Lifecycle implementation rather than the current stubbed implementation?
Nested Class Summary | |
---|---|
protected class |
WebappClassLoader.PrivilegedFindResourceByName
|
protected static class |
WebappClassLoader.PrivilegedGetClassLoader
|
Field Summary | |
---|---|
protected Permission |
allPermission
All permission. |
protected String |
canonicalLoaderDir
|
protected boolean |
delegate
Should this class loader delegate to the parent class loader before searching its own repositories (i.e. the usual Java2 delegation model)? |
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 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 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,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 boolean |
searchExternalFirst
Search external repositories first |
protected SecurityManager |
securityManager
Instance of the SecurityManager installed. |
protected static 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. |
Fields inherited from interface org.apache.catalina.Lifecycle |
---|
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT |
Constructor Summary | |
---|---|
WebappClassLoader()
Construct a new ClassLoader with no defined repositories and no parent ClassLoader. |
|
WebappClassLoader(ClassLoader parent)
Construct a new ClassLoader with no defined repositories and the given parent ClassLoader. |
Method Summary | |
---|---|
void |
addLifecycleListener(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 filepath)
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. |
void |
destroy()
Prepare to discard the object. |
protected Class<?> |
doDefineClass(String name,
byte[] b,
int off,
int len,
ProtectionDomain protectionDomain)
Expose this method for use by the unit tests. |
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. |
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 referring to it, or null if this resource
cannot be found. |
protected ResourceEntry |
findResourceInternal(File file,
String path)
Find specified resource in local repositories. |
protected 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 |
getClearReferencesHttpClientKeepAliveThread()
Return the clearReferencesHttpClientKeepAliveThread flag for this Context. |
boolean |
getClearReferencesLogFactoryRelease()
Return the clearReferencesLogFactoryRelease flag for this Context. |
boolean |
getClearReferencesStatic()
Return the clearReferencesStatic flag for this Context. |
boolean |
getClearReferencesStopThreads()
Return the clearReferencesStopThreads flag for this Context. |
boolean |
getClearReferencesStopTimerThreads()
Return the clearReferencesStopTimerThreads flag for this Context. |
String |
getContextName()
Return the context name for this class loader. |
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. |
boolean |
getSearchExternalFirst()
|
LifecycleState |
getState()
Obtain the current state of the source component. |
String |
getStateName()
Obtain a textual representation of the current component state. |
protected URL |
getURI(File file)
Get URL. |
protected URL |
getURL(File file,
boolean encoded)
Get URL. |
URL[] |
getURLs()
Returns the search path of URLs for loading classes and resources. |
void |
init()
Prepare the component for starting. |
protected boolean |
isPackageSealed(String name,
Manifest man)
Returns true if the specified package name is sealed according to the given manifest. |
boolean |
isStarted()
|
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. |
boolean |
modified()
Have one or more classes or resources been modified so that a reload is appropriate? |
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(LifecycleListener listener)
Remove a lifecycle event listener from this component. |
void |
setAntiJARLocking(boolean antiJARLocking)
|
void |
setClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread)
Set the clearReferencesHttpClientKeepAliveThread feature for this Context. |
void |
setClearReferencesLogFactoryRelease(boolean clearReferencesLogFactoryRelease)
Set the clearReferencesLogFactoryRelease feature for this Context. |
void |
setClearReferencesStatic(boolean clearReferencesStatic)
Set the clearReferencesStatic feature for this Context. |
void |
setClearReferencesStopThreads(boolean clearReferencesStopThreads)
Set the clearReferencesStopThreads feature for this Context. |
void |
setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)
Set the clearReferencesStopTimerThreads feature for this Context. |
void |
setDelegate(boolean delegate)
Set the "delegate first" flag for this class loader. |
void |
setJarPath(String jarPath)
Change the Jar path. |
protected void |
setParentClassLoader(ClassLoader pcl)
Utility method for use in subclasses. |
void |
setResources(DirContext resources)
Set associated resources. |
void |
setSearchExternalFirst(boolean searchExternalFirst)
|
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 file)
Check the specified JAR file, and return true if it does
not contain any of the trigger classes. |
Methods inherited from class java.net.URLClassLoader |
---|
definePackage, newInstance, newInstance |
Methods inherited from class java.security.SecureClassLoader |
---|
defineClass, defineClass |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected static final String[] triggers
protected static final String[] packageTriggers
protected static final StringManager sm
protected DirContext resources
protected HashMap<String,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. Note that the default, false
, is
the behavior called for by the servlet specification.
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 String canonicalLoaderDir
protected HashMap<String,PermissionCollection> loaderPC
protected SecurityManager securityManager
protected ClassLoader parent
protected ClassLoader system
protected boolean started
protected boolean hasExternalRepositories
protected boolean searchExternalFirst
protected boolean needConvert
protected Permission allPermission
Constructor Detail |
---|
public WebappClassLoader()
public WebappClassLoader(ClassLoader parent)
parent
- Our parent class loaderMethod Detail |
---|
public DirContext getResources()
public void setResources(DirContext resources)
public String getContextName()
public boolean getDelegate()
public void setDelegate(boolean delegate)
false
(the default),
this class loader will search its own repositories first, and
delegate to the parent only if the class or resource is not
found locally, as per the servlet specification.
delegate
- The new "delegate first" flagpublic boolean getAntiJARLocking()
public void setAntiJARLocking(boolean antiJARLocking)
antiJARLocking
- The antiJARLocking to set.public boolean getSearchExternalFirst()
public void setSearchExternalFirst(boolean searchExternalFirst)
searchExternalFirst
- Whether external repositories should be searched firstpublic void addPermission(String filepath)
filepath
- 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)
protected void setParentClassLoader(ClassLoader pcl)
public boolean getClearReferencesStatic()
public void setClearReferencesStatic(boolean clearReferencesStatic)
clearReferencesStatic
- The new flag valuepublic boolean getClearReferencesStopThreads()
public void setClearReferencesStopThreads(boolean clearReferencesStopThreads)
clearReferencesStopThreads
- The new flag valuepublic boolean getClearReferencesStopTimerThreads()
public void setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)
clearReferencesStopTimerThreads
- The new flag valuepublic boolean getClearReferencesLogFactoryRelease()
public void setClearReferencesLogFactoryRelease(boolean clearReferencesLogFactoryRelease)
clearReferencesLogFactoryRelease
- The new flag valuepublic boolean getClearReferencesHttpClientKeepAliveThread()
public void setClearReferencesHttpClientKeepAliveThread(boolean clearReferencesHttpClientKeepAliveThread)
clearReferencesHttpClientKeepAliveThread
- The new flag valuepublic void addRepository(String repository)
repository
- Name of a source of classes to be loaded, such as a
directory pathname, a JAR file pathname, or a ZIP file pathname
IllegalArgumentException
- if the specified repository is
invalid or does not existpublic String[] findRepositories()
public boolean modified()
public String toString()
toString
in class Object
protected void addURL(URL url)
addURL
in class URLClassLoader
protected final Class<?> doDefineClass(String name, byte[] b, int off, int len, ProtectionDomain protectionDomain)
public Class<?> findClass(String name) throws ClassNotFoundException
ClassNotFoundException
.
findClass
in class URLClassLoader
name
- Name of the class to be loaded
ClassNotFoundException
- if the class was not foundpublic URL findResource(String name)
URL
referring to it, or null
if this resource
cannot be found.
findResource
in class URLClassLoader
name
- 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 URLClassLoader
name
- Name of the resources to be found
IOException
- 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 ClassLoader
name
- 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 ClassLoader
name
- 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 ClassLoader
name
- Name of the class to be loaded
ClassNotFoundException
- 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 ClassLoader
name
- Name of the class to be loadedresolve
- If true
then resolve the class
ClassNotFoundException
- if the class was not foundprotected PermissionCollection getPermissions(CodeSource codeSource)
getPermissions
in class URLClassLoader
codeSource
- where the code was loaded from
public URL[] getURLs()
getURLs
in class URLClassLoader
public void addLifecycleListener(LifecycleListener listener)
addLifecycleListener
in interface Lifecycle
listener
- The listener to addpublic LifecycleListener[] findLifecycleListeners()
findLifecycleListeners
in interface Lifecycle
public void removeLifecycleListener(LifecycleListener listener)
removeLifecycleListener
in interface Lifecycle
listener
- The listener to removepublic LifecycleState getState()
getState
in interface Lifecycle
public String getStateName()
getStateName
in interface Lifecycle
public void init()
Lifecycle
LifecycleEvent
s will be fired in the following order:
init
in interface Lifecycle
public void start() throws LifecycleException
start
in interface Lifecycle
LifecycleException
- if a lifecycle error occurspublic boolean isStarted()
public void stop() throws LifecycleException
stop
in interface Lifecycle
LifecycleException
- if a lifecycle error occurspublic void destroy()
Lifecycle
LifecycleEvent
s will
be fired in the following order:
destroy
in interface Lifecycle
public void closeJARs(boolean force)
protected void clearReferences()
protected boolean openJARs()
protected Class<?> findClassInternal(String name) throws ClassNotFoundException
ClassNotFoundException
protected ResourceEntry findResourceInternal(File file, String path)
protected 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 name
protected boolean validate(String name)
name
- class name
protected boolean validateJarFile(File file) throws IOException
true
if it does
not contain any of the trigger classes.
file
- The JAR file to be checked
IOException
- if an input/output error occursprotected URL getURL(File file, boolean encoded) throws MalformedURLException
MalformedURLException
protected URL getURI(File file) throws MalformedURLException
MalformedURLException
protected static void deleteDir(File dir)
dir
- File object representing the directory to be deleted
|
Apache Tomcat 7.0.28 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |