Package org.apache.catalina

Interface Loader

  • All Known Implementing Classes:
    WebappLoader
    public interface Loader
    A Loader represents a Java ClassLoader implementation that can be used by a Container to load class files (within a repository associated with the Loader) that are designed to be reloaded upon request, as well as a mechanism to detect whether changes have occurred in the underlying repository.

    In order for a Loader implementation to successfully operate with a Context implementation that implements reloading, it must obey the following constraints:

    • Must implement Lifecycle so that the Context can indicate that a new class loader is required.
    • The start() method must unconditionally create a new ClassLoader implementation.
    • The stop() method must throw away its reference to the ClassLoader previously utilized, so that the class loader, all classes loaded by it, and all objects of those classes, can be garbage collected.
    • Must allow a call to stop() to be followed by a call to start() on the same Loader instance.
    • Based on a policy chosen by the implementation, must call the Context.reload() method on the owning Context when a change to one or more of the class files loaded by this class loader is detected.
    Version:
    $Revision: 1.3 $ $Date: 2005/12/08 01:27:18 $
    Author:
    Craig R. McClanahan

    • Method Detail

      • getClassLoader

        ClassLoader getClassLoader()
        Return the Java class loader to be used by this Container.

      • getContainer

        Container getContainer()
        Return the Container with which this Loader has been associated.

      • setContainer

        void setContainer​(Container container)
        Set the Container with which this Loader has been associated.
        Parameters:
        container - The associated Container

      • getDelegate

        boolean getDelegate()
        Return the "follow standard delegation model" flag used to configure our ClassLoader.

      • setDelegate

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

      • getInfo

        String getInfo()
        Return descriptive information about this Loader implementation and the corresponding version number, in the format <description>/<version>.

      • getReloadable

        boolean getReloadable()
        Return the reloadable flag for this Loader.

      • setReloadable

        void setReloadable​(boolean reloadable)
        Set the reloadable flag for this Loader.
        Parameters:
        reloadable - The new reloadable flag

      • addPropertyChangeListener

        void addPropertyChangeListener​(PropertyChangeListener listener)
        Add a property change listener to this component.
        Parameters:
        listener - The listener to add

      • addRepository

        void addRepository​(String repository)
        Add a new repository to the set of repositories for this class loader.
        Parameters:
        repository - Repository to be added

      • findRepositories

        String[] findRepositories()
        Return the set of repositories defined for this class loader. If none are defined, a zero-length array is returned.

      • modified

        boolean modified()
        Has the internal repository associated with this Loader been modified, such that the loaded classes should be reloaded?

      • removePropertyChangeListener

        void removePropertyChangeListener​(PropertyChangeListener listener)
        Remove a property change listener from this component.
        Parameters:
        listener - The listener to remove

      • addOverridablePackage

        void addOverridablePackage​(String packageName)
        Adds the given package name to the list of packages that may always be overriden, regardless of whether they belong to a protected namespace

      • setIgnoreHiddenJarFiles

        void setIgnoreHiddenJarFiles​(boolean ignoreHiddenJarFiles)