Package org.apache.catalina.loader

Class WebappLoader

  • All Implemented Interfaces:
    javax.management.MBeanRegistration, JmxEnabled, Lifecycle, Loader
    public class WebappLoader
extends LifecycleMBeanBase
implements Loader
    Classloader implementation which is specialized for handling web applications in the most efficient way, while being Catalina aware (all accesses to resources are made through WebResourceRoot). This class loader supports detection of modified Java classes, which can be used to implement auto-reload support.

    This class loader is configured via the Resources children of its Context prior to calling start(). When a new class is required, these Resources will be consulted first to locate the class. If it is not present, the system class loader will be used instead.

    Author:
    Craig R. McClanahan, Remy Maucherat

    • Field Detail

      • sm

        protected static final StringManager sm
        The string manager for this package.

      • support

        protected final java.beans.PropertyChangeSupport support
        The property change support for this component.

    • Constructor Detail

      • WebappLoader

        public WebappLoader()

    • Method Detail

      • getClassLoader

        public java.lang.ClassLoader getClassLoader()
        Return the Java class loader to be used by this Container.
        Specified by:
        getClassLoader in interface Loader
        Returns:
        the Java class loader to be used by this Container.

      • getContext

        public Context getContext()
        Specified by:
        getContext in interface Loader
        Returns:
        the Context with which this Loader has been associated.

      • setContext

        public void setContext​(Context context)
        Description copied from interface: Loader
        Set the Context with which this Loader has been associated.
        Specified by:
        setContext in interface Loader
        Parameters:
        context - The associated Context

      • getDelegate

        public boolean getDelegate()
        Return the "follow standard delegation model" flag used to configure our ClassLoader.
        Specified by:
        getDelegate in interface Loader
        Returns:
        the "follow standard delegation model" flag used to configure our ClassLoader.

      • setDelegate

        public void setDelegate​(boolean delegate)
        Set the "follow standard delegation model" flag used to configure our ClassLoader.
        Specified by:
        setDelegate in interface Loader
        Parameters:
        delegate - The new flag

      • getJakartaConverter

        public java.lang.String getJakartaConverter()
        Returns:
        a non null String if the loader will attempt to use the Jakarta converter. The String is the name of the profile used for conversion.

      • setJakartaConverter

        public void setJakartaConverter​(java.lang.String jakartaConverter)
        Set the Jakarta converter.
        Parameters:
        jakartaConverter - The profile name which will be used by the converter Any invalid profile value will default to the TOMCAT profile, which converts all packages used by Tomcat.

      • getLoaderClass

        public java.lang.String getLoaderClass()
        Returns:
        the ClassLoader class name.

      • setLoaderClass

        public void setLoaderClass​(java.lang.String loaderClass)
        Set the ClassLoader class name.
        Parameters:
        loaderClass - The new ClassLoader class name

      • setLoaderInstance

        public void setLoaderInstance​(WebappClassLoaderBase loaderInstance)
        Set the ClassLoader instance, without relying on reflection This method will also invoke setLoaderClass(String) with loaderInstance.getClass().getName() as an argument
        Parameters:
        loaderInstance - The new ClassLoader instance to use

      • addPropertyChangeListener

        public void addPropertyChangeListener​(java.beans.PropertyChangeListener listener)
        Add a property change listener to this component.
        Specified by:
        addPropertyChangeListener in interface Loader
        Parameters:
        listener - The listener to add

      • backgroundProcess

        public void backgroundProcess()
        Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.
        Specified by:
        backgroundProcess in interface Loader

      • getLoaderRepositories

        public java.lang.String[] getLoaderRepositories()

      • getLoaderRepositoriesString

        public java.lang.String getLoaderRepositoriesString()

      • getClasspath

        public java.lang.String getClasspath()
        Classpath, as set in org.apache.catalina.jsp_classpath context property
        Returns:
        The classpath

      • modified

        public boolean modified()
        Has the internal repository associated with this Loader been modified, such that the loaded classes should be reloaded?
        Specified by:
        modified in interface Loader
        Returns:
        true when the repository has been modified, false otherwise

      • removePropertyChangeListener

        public void removePropertyChangeListener​(java.beans.PropertyChangeListener listener)
        Remove a property change listener from this component.
        Specified by:
        removePropertyChangeListener in interface Loader
        Parameters:
        listener - The listener to remove

      • toString

        public java.lang.String toString()
        Return a String representation of this component.
        Overrides:
        toString in class java.lang.Object

      • getDomainInternal

        protected java.lang.String getDomainInternal()
        Description copied from class: LifecycleMBeanBase
        Method implemented by sub-classes to identify the domain in which MBeans should be registered.
        Specified by:
        getDomainInternal in class LifecycleMBeanBase
        Returns:
        The name of the domain to use to register MBeans.

      • getObjectNameKeyProperties

        protected java.lang.String getObjectNameKeyProperties()
        Description copied from class: LifecycleMBeanBase
        Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.
        Specified by:
        getObjectNameKeyProperties in class LifecycleMBeanBase
        Returns:
        The string representation of the key properties component of the desired ObjectName