Tomcat 10.1.19 · org.apache.catalina.Loader · APIdia, the JavaDoc alternative

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.

Method Summary

Modifier and Type	Method and Description
public void	addPropertyChangeListener(PropertyChangeListener The listener to add listener) Add a property change listener to this component.
public void	backgroundProcess() Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container.
public ClassLoader	Returns: the Java class loader to be used by this Container. getClassLoader()
public Context	Returns: the Context with which this Loader has been associated. getContext()
public boolean	Returns: the "follow standard delegation model" flag used to configure our ClassLoader. getDelegate()
public boolean	Returns: `true` when the repository has been modified, `false` otherwise modified() Has the internal repository associated with this Loader been modified, such that the loaded classes should be reloaded?
public void	removePropertyChangeListener(PropertyChangeListener The listener to remove listener) Remove a property change listener from this component.
public void	setContext(Context The associated Context context) Set the Context with which this Loader has been associated.
public void	setDelegate(boolean The new flag delegate) Set the "follow standard delegation model" flag used to configure our ClassLoader.

Method Detail

addPropertyChangeListener	back to summary
public void addPropertyChangeListener(PropertyChangeListener listener) Add a property change listener to this component. Parameters listener:PropertyChangeListener The listener to add

addPropertyChangeListener

back to summary

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a property change listener to this component.

Parameters

listener:PropertyChangeListener: The listener to add

backgroundProcess	back to summary
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.

getClassLoader	back to summary
public ClassLoader getClassLoader() Returns:ClassLoader the Java class loader to be used by this Container.

getContext	back to summary
public Context getContext() Returns:Context the Context with which this Loader has been associated.

getDelegate	back to summary
public boolean getDelegate() Returns:boolean the "follow standard delegation model" flag used to configure our ClassLoader.

modified back to summary

modified	back to summary
public boolean modified() Has the internal repository associated with this Loader been modified, such that the loaded classes should be reloaded? Returns:boolean `true` when the repository has been modified, `false` otherwise

public boolean modified()

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

Returns:boolean: true when the repository has been modified, false otherwise

removePropertyChangeListener	back to summary
public void removePropertyChangeListener(PropertyChangeListener listener) Remove a property change listener from this component. Parameters listener:PropertyChangeListener The listener to remove

removePropertyChangeListener

back to summary

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a property change listener from this component.

Parameters

listener:PropertyChangeListener: The listener to remove

setContext	back to summary
public void setContext(Context context) Set the Context with which this Loader has been associated. Parameters context:Context The associated Context

setContext

back to summary

public void setContext(Context context)

Set the Context with which this Loader has been associated.

Parameters

context:Context: The associated Context

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

setDelegate

back to summary

public void setDelegate(boolean delegate)

Set the "follow standard delegation model" flag used to configure our ClassLoader.

Parameters

delegate:boolean: The new flag

public Interface Loader

Method Summary

Method Detail