public abstract class WebappClassLoaderBase extends URLClassLoader implements Lifecycle, InstrumentableClassLoader, PermissionCheck
 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?
 IMPLEMENTATION NOTE - As of 7.0.64/8.0, this class
 loader implements InstrumentableClassLoader, permitting web
 application classes to instrument other classes in the same web
 application. It does not permit instrumentation of system or container
 classes or classes in other web apps.
| Modifier and Type | Class and Description | 
|---|---|
| protected class  | WebappClassLoaderBase.PrivilegedFindResourceByName | 
| protected static class  | WebappClassLoaderBase.PrivilegedGetClassLoader | 
Lifecycle.SingleUse| Modifier and Type | Field and Description | 
|---|---|
| protected Permission | allPermissionAll permission. | 
| protected String | canonicalLoaderDir | 
| protected boolean | delegateShould this class loader delegate to the parent class loader
 before searching its own repositories (i.e. the
 usual Java2 delegation model)? | 
| protected File[] | filesRepositories translated as path in the work directory (for Jasper
 originally), but which is used to generate fake URLs should getURLs be
 called. | 
| protected boolean | hasExternalRepositoriesHas external repositories. | 
| protected ClassLoader | j2seClassLoaderThe bootstrap class loader used to load the JavaSE classes. | 
| protected JarFile[] | jarFilesThe list of JARs, in the order they should be searched
 for locally loaded classes or resources. | 
| protected String[] | jarNamesThe list of JARs, in the order they should be searched
 for locally loaded classes or resources. | 
| protected int | jarOpenIntervalThe interval in milliseconds that we can keep jar files open. | 
| protected String | jarPathThe path which will be monitored for added Jar files. | 
| protected File[] | jarRealFilesThe list of JARs, in the order they should be searched
 for locally loaded classes or resources. | 
| protected long | lastJarAccessedLast time a JAR was accessed. | 
| protected long[] | lastModifiedDatesThe list of JARs last modified dates, in the order they should be
 searched for locally loaded classes or resources. | 
| protected File | loaderDirPath where resources loaded from JARs will be extracted. | 
| protected HashMap<String,PermissionCollection> | loaderPCThe PermissionCollection for each CodeSource for a web
 application context. | 
| protected boolean | needConvertneed conversion for properties files | 
| protected HashMap<String,String> | notFoundResourcesThe list of not found resources. | 
| protected static String[] | packageTriggersSet of package names which are not allowed to be loaded from a webapp
 class loader without delegating first. | 
| protected ClassLoader | parentThe parent class loader. | 
| protected String[] | pathsThe list of resources which should be checked when checking for
 modifications. | 
| protected ArrayList<Permission> | permissionListA list of read File and Jndi Permission's required if this loader
 is for a web application context. | 
| protected String[] | repositoriesThe list of local repositories, in the order they should be searched
 for locally loaded classes or resources. | 
| protected URL[] | repositoryURLsRepositories URLs, used to cache the result of getURLs. | 
| protected Map<String,ResourceEntry> | resourceEntriesThe cache of ResourceEntry for classes and resources we have loaded,
 keyed by resource path, not binary name. | 
| protected DirContext | resourcesAssociated directory context giving access to the resources in this
 webapp. | 
| protected boolean | searchExternalFirstSearch external repositories first | 
| protected SecurityManager | securityManagerInstance of the SecurityManager installed. | 
| protected static StringManager | sm | 
| protected boolean | startedHas this component been started? | 
| protected ClassLoader | systemDeprecated. 
 Unused. Always null. Will be removed in 8.0.x. | 
| protected static String[] | triggersThe 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. | 
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 and Description | 
|---|
| WebappClassLoaderBase()Construct a new ClassLoader with no defined repositories and no
 parent ClassLoader. | 
| WebappClassLoaderBase(ClassLoader parent)Construct a new ClassLoader with no defined repositories and the given
 parent ClassLoader. | 
| Modifier and Type | Method and Description | 
|---|---|
| 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. | 
| void | addTransformer(ClassFileTransformer transformer)Adds the specified class file transformer to this class loader. | 
| protected void | addURL(URL url)Add the specified URL to the classloader. | 
| boolean | check(Permission permission)Does this component have the given permission? | 
| protected void | clearReferences()Clear references. | 
| void | closeJARs(boolean force)Used to periodically signal to the classloader to release
 JAR resources. | 
| protected void | copyStateWithoutTransformers(WebappClassLoaderBase base) | 
| 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
  URLreferring to it, ornullif 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,
                    boolean manifestRequired)Find specified resource in local repositories. | 
| Enumeration<URL> | findResources(String name)Return an enumeration of  URLsrepresenting 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 | getClearReferencesObjectStreamClassCaches() | 
| boolean | getClearReferencesRmiTargets() | 
| boolean | getClearReferencesStatic()Deprecated. 
 Will be removed in 8.5 | 
| boolean | getClearReferencesStopThreads()Return the clearReferencesStopThreads flag for this Context. | 
| boolean | getClearReferencesStopTimerThreads()Return the clearReferencesStopTimerThreads flag for this Context. | 
| boolean | getClearReferencesThreadLocals() | 
| String | getContextName()Return the context name for this class loader. | 
| boolean | getDelegate()Return the "delegate first" flag for this class loader. | 
| int | getJarOpenInterval()Return the interval to keep all jar files open if no jar is accessed | 
| String | getJarPath()Return the JAR path. | 
| protected ClassLoader | getJavaseClassLoader() | 
| 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. | 
| Enumeration<URL> | getResources(String name) | 
| 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 the URI for the given file. | 
| protected URL | getURL(File file,
      boolean encoded)Deprecated. 
 Use  getURI(File)instead | 
| 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 | removeTransformer(ClassFileTransformer transformer)Removes the specified class file transformer from this class loader. | 
| 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 | setClearReferencesObjectStreamClassCaches(boolean clearReferencesObjectStreamClassCaches) | 
| void | setClearReferencesRmiTargets(boolean clearReferencesRmiTargets) | 
| void | setClearReferencesStatic(boolean clearReferencesStatic)Deprecated. 
 Will be removed in 8.5 | 
| void | setClearReferencesStopThreads(boolean clearReferencesStopThreads)Set the clearReferencesStopThreads feature for this Context. | 
| void | setClearReferencesStopTimerThreads(boolean clearReferencesStopTimerThreads)Set the clearReferencesStopTimerThreads feature for this Context. | 
| void | setClearReferencesThreadLocals(boolean clearReferencesThreadLocals) | 
| void | setDelegate(boolean delegate)Set the "delegate first" flag for this class loader. | 
| void | setJarOpenInterval(int jarOpenInterval)Set the interval to keep all jar files open | 
| void | setJarPath(String jarPath)Change the Jar path. | 
| protected void | setJavaseClassLoader(ClassLoader classLoader) | 
| protected void | setParentClassLoader(ClassLoader pcl)Deprecated. 
 Will be removed in 8.0.x onwards. | 
| 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  trueif 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, getSystemClassLoader, getSystemResource, getSystemResourceAsStream, getSystemResources, registerAsParallelCapable, resolveClass, setClassAssertionStatus, setDefaultAssertionStatus, setPackageAssertionStatus, setSignersclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcopyWithoutTransformersprotected static final StringManager sm
protected static final String[] triggers
protected static final String[] packageTriggers
protected DirContext resources
protected Map<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 int jarOpenInterval
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
@Deprecated protected ClassLoader system
protected ClassLoader j2seClassLoader
null and in
 those cases ClassLoader.getParent() will be called recursively on
 the system class loader and the last non-null result used.protected boolean started
protected boolean hasExternalRepositories
protected boolean searchExternalFirst
protected boolean needConvert
protected Permission allPermission
public WebappClassLoaderBase()
public WebappClassLoaderBase(ClassLoader parent)
 Method is used via reflection -
 see WebappLoader.createClassLoader()
parent - Our parent class loaderpublic 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 void setJarOpenInterval(int jarOpenInterval)
jarOpenInterval - the interval in milliseconds to keep jar files openpublic int getJarOpenInterval()
public boolean getAntiJARLocking()
public void setAntiJARLocking(boolean antiJARLocking)
antiJARLocking - The antiJARLocking to set.public boolean getSearchExternalFirst()
public boolean getClearReferencesRmiTargets()
public void setClearReferencesRmiTargets(boolean clearReferencesRmiTargets)
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)
@Deprecated protected void setParentClassLoader(ClassLoader pcl)
@Deprecated public boolean getClearReferencesStatic()
@Deprecated 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 boolean getClearReferencesObjectStreamClassCaches()
public void setClearReferencesObjectStreamClassCaches(boolean clearReferencesObjectStreamClassCaches)
public boolean getClearReferencesThreadLocals()
public void setClearReferencesThreadLocals(boolean clearReferencesThreadLocals)
public void addTransformer(ClassFileTransformer transformer)
addTransformer in interface InstrumentableClassLoadertransformer - The transformer to add to the class loaderpublic void removeTransformer(ClassFileTransformer transformer)
removeTransformer in interface InstrumentableClassLoadertransformer - The transformer to removeprotected void copyStateWithoutTransformers(WebappClassLoaderBase base)
public 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 pathnameIllegalArgumentException - if the specified repository is
  invalid or does not existpublic String[] findRepositories()
public boolean modified()
public String toString()
protected void addURL(URL url)
addURL in class URLClassLoaderprotected final Class<?> doDefineClass(String name, byte[] b, int off, int len, ProtectionDomain protectionDomain)
public 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 referring 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 Enumeration<URL> getResources(String name) throws IOException
getResources in class ClassLoaderIOExceptionpublic 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 boolean check(Permission permission)
PermissionCheckcheck in interface PermissionCheckpermission - The permission to testfalse if a SecurityManager is enabled and the component
         does not have the given permission, otherwise truepublic URL[] getURLs()
getURLs in class URLClassLoaderpublic void addLifecycleListener(LifecycleListener listener)
addLifecycleListener in interface Lifecyclelistener - The listener to addpublic LifecycleListener[] findLifecycleListeners()
findLifecycleListeners in interface Lifecyclepublic void removeLifecycleListener(LifecycleListener listener)
removeLifecycleListener in interface Lifecyclelistener - The listener to removepublic LifecycleState getState()
public String getStateName()
Lifecycle.getState().getStateName in interface Lifecyclepublic void init()
LifecycleLifecycleEvents will be fired in the following order:
 public void start()
           throws LifecycleException
start in interface LifecycleLifecycleException - if a lifecycle error occurspublic boolean isStarted()
public void stop()
          throws LifecycleException
stop in interface LifecycleLifecycleException - if a lifecycle error occurspublic void destroy()
LifecycleLifecycleEvents will
 be fired in the following order:
 public void closeJARs(boolean force)
protected ClassLoader getJavaseClassLoader()
protected void setJavaseClassLoader(ClassLoader classLoader)
protected void clearReferences()
protected boolean openJARs()
protected Class<?> findClassInternal(String name) throws ClassNotFoundException
ClassNotFoundExceptionprotected ResourceEntry findResourceInternal(File file, String path)
protected ResourceEntry findResourceInternal(String name, String path, boolean manifestRequired)
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 file) throws IOException
true if it does
 not contain any of the trigger classes.file - The JAR file to be checkedIOException - if an input/output error occurs@Deprecated protected URL getURL(File file, boolean encoded) throws MalformedURLException
getURI(File) insteadMalformedURLExceptionprotected URL getURI(File file) throws MalformedURLException
MalformedURLExceptionprotected static void deleteDir(File dir)
dir - File object representing the directory to be deletedCopyright © 2000-2020 Apache Software Foundation. All Rights Reserved.