Java Doc for WebappClassLoader.java in  » Web-Server » Rimfaxe-Web-Server » org » apache » catalina » loader » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Server » Rimfaxe Web Server » org.apache.catalina.loader 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.net.URLClassLoader
   org.apache.catalina.loader.WebappClassLoader

WebappClassLoader
public class WebappClassLoader extends URLClassLoader implements Reloader,Lifecycle(Code)
Specialized web application class loader.

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.
author:
   Remy Maucherat
author:
   Craig R. McClanahan
version:
   $Revision: 1.45 $ $Date: 2002/08/09 10:01:48 $


Inner Class :protected class PrivilegedFindResource implements PrivilegedAction

Field Summary
protected  ArrayListavailable
     The set of optional packages (formerly standard extensions) that are available in the repositories associated with this class loader.
protected  intdebug
     The debugging detail level of this component.
protected  booleandelegate
     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  booleanhasExternalRepositories
     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  StringjarPath
     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[]lastModifiedDates
     The list of JARs last modified dates, in the order they should be searched for locally loaded classes or resources.
protected  HashMapnotFoundResources
     The list of not found resources.
protected  String[]paths
     The list of resources which should be checked when checking for modifications.
protected  String[]repositories
     The list of local repositories, in the order they should be searched for locally loaded classes or resources.
protected  ArrayListrequired
     The set of optional packages (formerly standard extensions) that are required in the repositories associated with this class loader.
protected  HashMapresourceEntries
     The cache of ResourceEntry for classes and resources we have loaded, keyed by resource name.
protected  DirContextresources
     Associated directory context giving access to the resources in this webapp.
protected  booleanstarted
    

Constructor Summary
public  WebappClassLoader()
     Construct a new ClassLoader with no defined repositories and no parent ClassLoader.
public  WebappClassLoader(ClassLoader parent)
     Construct a new ClassLoader with no defined repositories and no parent ClassLoader.

Method Summary
synchronized  voidaddJar(String jar, JarFile jarFile, File file)
    
public  voidaddLifecycleListener(LifecycleListener listener)
     Add a lifecycle event listener to this component.
public  voidaddPermission(String path)
     If there is a Java SecurityManager create a read FilePermission or JndiPermission for the file directory path.
public  voidaddPermission(URL url)
     If there is a Java SecurityManager create a read FilePermission or JndiPermission for URL.
public  voidaddPermission(Permission permission)
     If there is a Java SecurityManager create a Permission.
public  voidaddRepository(String repository)
     Add a new repository to the set of places this ClassLoader can look for classes to be loaded.
synchronized  voidaddRepository(String repository, File file)
     Add a new repository to the set of places this ClassLoader can look for classes to be loaded.
protected  booleanfilter(String name)
     Filter classes.
public  Extension[]findAvailable()
     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  ClassfindClass(String name)
     Find the specified class in our local repositories, if possible.
protected  ClassfindClassInternal(String name)
     Find specified class in local repositories.
public  LifecycleListener[]findLifecycleListeners()
     Get the lifecycle listeners associated with this lifecycle.
protected  ClassfindLoadedClass0(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  InputStreamfindLoadedResource(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.
public  String[]findRepositories()
     Return a String array of the current repositories for this class loader.
public  Extension[]findRequired()
     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  URLfindResource(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  ResourceEntryfindResourceInternal(String name, String path)
     Find specified resource in local repositories.
public  EnumerationfindResources(String name)
     Return an enumeration of URLs representing all of the resources with the given name.
public  intgetDebug()
     Return the debugging detail level for this component.
public  booleangetDelegate()
     Return the "delegate first" flag for this class loader.
public  StringgetJarPath()
     Return the JAR path.
protected  PermissionCollectiongetPermissions(CodeSource codeSource)
     Get the Permissions for a CodeSource.
public  URLgetResource(String name)
     Find the resource with the given name.
public  InputStreamgetResourceAsStream(String name)
     Find the resource with the given name, and return an input stream that can be used for reading it.
public  DirContextgetResources()
     Get associated resources.
protected  URLgetURL(File file)
     Get URL.
public  URL[]getURLs()
     Returns the search path of URLs for loading classes and resources.
protected  booleanisPackageSealed(String name, Manifest man)
     Returns true if the specified package name is sealed according to the given manifest.
public  ClassloadClass(String name)
     Load the class with the specified name.
public  ClassloadClass(String name, boolean resolve)
     Load the class with the specified name, searching using the following algorithm until it finds and returns the class.
public  booleanmodified()
    
protected  voidrefreshPolicy()
     Refresh the system policy file, to pick up eventual changes.
public  voidremoveLifecycleListener(LifecycleListener listener)
     Remove a lifecycle event listener from this component.
public  voidsetDebug(int debug)
     Set the debugging detail level for this component.
public  voidsetDelegate(boolean delegate)
     Set the "delegate first" flag for this class loader.
public  voidsetJarPath(String jarPath)
     Change the Jar path.
public  voidsetResources(DirContext resources)
     Set associated resources.
public  voidstart()
     Start the class loader.
public  voidstop()
     Stop the class loader.
public  StringtoString()
     Render a String representation of this object.
protected  booleanvalidate(String name)
     Validate a classname.

Field Detail
available
protected ArrayList available(Code)
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 org.apache.catalina.loader.Extension.



debug
protected int debug(Code)
The debugging detail level of this component.



delegate
protected boolean delegate(Code)
Should this class loader delegate to the parent class loader before searching its own repositories (i.e. the usual Java2 delegation model)? If set to 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.



files
protected File[] files(Code)
Repositories translated as path in the work directory (for Jasper originally), but which is used to generate fake URLs should getURLs be called.



hasExternalRepositories
protected boolean hasExternalRepositories(Code)
Has external repositories.



jarFiles
protected JarFile[] jarFiles(Code)
The list of JARs, in the order they should be searched for locally loaded classes or resources.



jarNames
protected String[] jarNames(Code)
The list of JARs, in the order they should be searched for locally loaded classes or resources.



jarPath
protected String jarPath(Code)
The path which will be monitored for added Jar files.



jarRealFiles
protected File[] jarRealFiles(Code)
The list of JARs, in the order they should be searched for locally loaded classes or resources.



lastModifiedDates
protected long[] lastModifiedDates(Code)
The list of JARs last modified dates, in the order they should be searched for locally loaded classes or resources.



notFoundResources
protected HashMap notFoundResources(Code)
The list of not found resources.



paths
protected String[] paths(Code)
The list of resources which should be checked when checking for modifications.



repositories
protected String[] repositories(Code)
The list of local repositories, in the order they should be searched for locally loaded classes or resources.



required
protected ArrayList required(Code)
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 org.apache.catalina.loader.Extension.



resourceEntries
protected HashMap resourceEntries(Code)
The cache of ResourceEntry for classes and resources we have loaded, keyed by resource name.



resources
protected DirContext resources(Code)
Associated directory context giving access to the resources in this webapp.



started
protected boolean started(Code)
Has this component been started?




Constructor Detail
WebappClassLoader
public WebappClassLoader()(Code)
Construct a new ClassLoader with no defined repositories and no parent ClassLoader.



WebappClassLoader
public WebappClassLoader(ClassLoader parent)(Code)
Construct a new ClassLoader with no defined repositories and no parent ClassLoader.




Method Detail
addJar
synchronized void addJar(String jar, JarFile jarFile, File file) throws IOException(Code)



addLifecycleListener
public void addLifecycleListener(LifecycleListener listener)(Code)
Add a lifecycle event listener to this component.
Parameters:
  listener - The listener to add



addPermission
public void addPermission(String path)(Code)
If there is a Java SecurityManager create a read FilePermission or JndiPermission for the file directory path.
Parameters:
  path - file directory path



addPermission
public void addPermission(URL url)(Code)
If there is a Java SecurityManager create a read FilePermission or JndiPermission for URL.
Parameters:
  url - URL for a file or directory on local system



addPermission
public void addPermission(Permission permission)(Code)
If there is a Java SecurityManager create a Permission.
Parameters:
  url - URL for a file or directory on local system



addRepository
public void addRepository(String repository)(Code)
Add a new repository to the set of places this ClassLoader can look for classes to be loaded.
Parameters:
  repository - Name of a source of classes to be loaded, such as adirectory pathname, a JAR file pathname, or a ZIP file pathname
exception:
  IllegalArgumentException - if the specified repository isinvalid or does not exist



addRepository
synchronized void addRepository(String repository, File file)(Code)
Add a new repository to the set of places this ClassLoader can look for classes to be loaded.
Parameters:
  repository - Name of a source of classes to be loaded, such as adirectory pathname, a JAR file pathname, or a ZIP file pathname
exception:
  IllegalArgumentException - if the specified repository isinvalid or does not exist



filter
protected boolean filter(String name)(Code)
Filter classes.
Parameters:
  name - class name true if the class should be filtered



findAvailable
public Extension[] findAvailable()(Code)
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.



findClass
public Class findClass(String name) throws ClassNotFoundException(Code)
Find the specified class in our local repositories, if possible. If not found, throw ClassNotFoundException.
Parameters:
  name - Name of the class to be loaded
exception:
  ClassNotFoundException - if the class was not found



findClassInternal
protected Class findClassInternal(String name) throws ClassNotFoundException(Code)
Find specified class in local repositories. the loaded class, or null if the class isn't found



findLifecycleListeners
public LifecycleListener[] findLifecycleListeners()(Code)
Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.



findLoadedClass0
protected Class findLoadedClass0(String name)(Code)
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 null.
Parameters:
  name - Name of the resource to return



findLoadedResource
protected InputStream findLoadedResource(String name)(Code)
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 null.
Parameters:
  name - Name of the resource to return



findRepositories
public String[] findRepositories()(Code)
Return a String array of the current repositories for this class loader. If there are no repositories, a zero-length array is returned.



findRequired
public Extension[] findRequired()(Code)
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.



findResource
public URL findResource(String name)(Code)
Find the specified resource in our local repository, and return a URL refering to it, or null if this resource cannot be found.
Parameters:
  name - Name of the resource to be found



findResourceInternal
protected ResourceEntry findResourceInternal(String name, String path)(Code)
Find specified resource in local repositories. the loaded resource, or null if the resource isn't found



findResources
public Enumeration findResources(String name) throws IOException(Code)
Return an enumeration of URLs representing all of the resources with the given name. If no resources with this name are found, return an empty enumeration.
Parameters:
  name - Name of the resources to be found
exception:
  IOException - if an input/output error occurs



getDebug
public int getDebug()(Code)
Return the debugging detail level for this component.



getDelegate
public boolean getDelegate()(Code)
Return the "delegate first" flag for this class loader.



getJarPath
public String getJarPath()(Code)
Return the JAR path.



getPermissions
protected PermissionCollection getPermissions(CodeSource codeSource)(Code)
Get the Permissions for a CodeSource. If this instance of WebappClassLoader is for a web application context, add read FilePermission or JndiPermissions for the base directory (if unpacked), the context URL, and jar file resources.
Parameters:
  CodeSource - where the code was loaded from PermissionCollection for CodeSource



getResource
public URL getResource(String name)(Code)
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 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.

  • If the delegate property is set to true, call the getResource() method of the parent class loader, if any.
  • Call findResource() to find this resource in our locally defined repositories.
  • Call the getResource() method of the parent class loader, if any.

Parameters:
  name - Name of the resource to return a URL for



getResourceAsStream
public InputStream getResourceAsStream(String name)(Code)
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 getResource(), after checking to see if the resource data has been previously cached. If the resource cannot be found, return null.
Parameters:
  name - Name of the resource to return an input stream for



getResources
public DirContext getResources()(Code)
Get associated resources.



getURL
protected URL getURL(File file) throws MalformedURLException(Code)
Get URL.



getURLs
public URL[] getURLs()(Code)
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. the search path of URLs for loading classes and resources.



isPackageSealed
protected boolean isPackageSealed(String name, Manifest man)(Code)
Returns true if the specified package name is sealed according to the given manifest.



loadClass
public Class loadClass(String name) throws ClassNotFoundException(Code)
Load the class with the specified name. This method searches for classes in the same manner as loadClass(String, boolean) with false as the second argument.
Parameters:
  name - Name of the class to be loaded
exception:
  ClassNotFoundException - if the class was not found



loadClass
public Class loadClass(String name, boolean resolve) throws ClassNotFoundException(Code)
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 ClassNotFoundException.
  • Call findLoadedClass(String) to check if the class has already been loaded. If it has, the same Class object is returned.
  • If the delegate property is set to true, call the loadClass() method of the parent class loader, if any.
  • Call findClass() to find this class in our locally defined repositories.
  • Call the loadClass() method of our parent class loader, if any.
If the class was found using the above steps, and the resolve flag is true, this method will then call resolveClass(Class) on the resulting Class object.
Parameters:
  name - Name of the class to be loaded
Parameters:
  resolve - If true then resolve the class
exception:
  ClassNotFoundException - if the class was not found



modified
public boolean modified()(Code)
Have one or more classes or resources been modified so that a reload is appropriate?



refreshPolicy
protected void refreshPolicy()(Code)
Refresh the system policy file, to pick up eventual changes.



removeLifecycleListener
public void removeLifecycleListener(LifecycleListener listener)(Code)
Remove a lifecycle event listener from this component.
Parameters:
  listener - The listener to remove



setDebug
public void setDebug(int debug)(Code)
Set the debugging detail level for this component.
Parameters:
  debug - The new debugging detail level



setDelegate
public void setDelegate(boolean delegate)(Code)
Set the "delegate first" flag for this class loader.
Parameters:
  delegate - The new "delegate first" flag



setJarPath
public void setJarPath(String jarPath)(Code)
Change the Jar path.



setResources
public void setResources(DirContext resources)(Code)
Set associated resources.



start
public void start() throws LifecycleException(Code)
Start the class loader.
exception:
  LifecycleException - if a lifecycle error occurs



stop
public void stop() throws LifecycleException(Code)
Stop the class loader.
exception:
  LifecycleException - if a lifecycle error occurs



toString
public String toString()(Code)
Render a String representation of this object.



validate
protected boolean validate(String name)(Code)
Validate a classname. As per SRV.9.7.2, we must restict loading of classes from J2SE (java.*) and classes of the servlet API (javax.servlet.*). That should enhance robustness and prevent a number of user error (where an older version of servlet.jar would be present in /WEB-INF/lib).
Parameters:
  name - class name true if the name is valid



Methods inherited from java.net.URLClassLoader
protected void addURL(URL url)(Code)(Java Doc)
protected Package definePackage(String name, Manifest man, URL url) throws IllegalArgumentException(Code)(Java Doc)
protected Class findClass(String name) throws ClassNotFoundException(Code)(Java Doc)
public URL findResource(String name)(Code)(Java Doc)
public Enumeration<URL> findResources(String name) throws IOException(Code)(Java Doc)
protected PermissionCollection getPermissions(CodeSource codesource)(Code)(Java Doc)
public URL[] getURLs()(Code)(Java Doc)
public static URLClassLoader newInstance(URL[] urls, ClassLoader parent)(Code)(Java Doc)
public static URLClassLoader newInstance(URL[] urls)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.