AVMWebappLoader (Alfresco Catalina Virtual 5.0.a API)

java.lang.Object
- org.alfresco.catalina.loader.AVMWebappLoader

All Implemented Interfaces:

PropertyChangeListener, EventListener, MBeanRegistration, org.apache.catalina.Lifecycle, org.apache.catalina.Loader
```
public class AVMWebappLoader
extends Object
implements org.apache.catalina.Lifecycle, org.apache.catalina.Loader, PropertyChangeListener, MBeanRegistration
```
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 the DirContext interface). This class loader supports detection of modified Java classes, which can be used to implement auto-reload support.
This class loader is configured by adding the pathnames of directories, JAR files, and ZIP files with the addRepository() method, prior to calling start(). When a new class is required, these repositories will be consulted first to locate the class. If it is not present, the system class loader will be used instead.

Version:

$Revision: 303352 $ $Date: 2004-10-05 13:12:52 -0400 (Tue, 05 Oct 2004) $

Author:

Craig R. McClanahan, Remy Maucherat

Field Summary

Fields
Modifier and Type	Field and Description
`protected org.apache.catalina.util.LifecycleSupport`	`lifecycle` The lifecycle event support for this component.
`protected static org.apache.catalina.util.StringManager`	`sm` The string manager for this package.
`protected PropertyChangeSupport`	`support` The property change support for this component.

Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors
Constructor and Description
`AVMWebappLoader()` Construct a new AVMWebappLoader with no defined parent class loader (so that the actual parent will be the system class loader).
`AVMWebappLoader(ClassLoader parent, Map<String,ClassLoader> context_classloader_registry, String context_path, String parent_context_path, int version, String avm_webapp_path)` Construct a new AVMWebappLoader with the specified class loader to be defined as the parent of the ClassLoader we ultimately create.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLifecycleListener(org.apache.catalina.LifecycleListener listener)` Add a lifecycle event listener to this component.
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add a property change listener to this component.
`void`	`addRepository(String repository)` Add a new repository to the set of repositories for this class loader.
`void`	`backgroundProcess()` Execute a periodic task, such as reloading, etc.
`void`	`closeJARs(boolean force)` Used to periodically signal to the classloader to release JAR resources.
`void`	`destroy()`
`org.apache.catalina.LifecycleListener[]`	`findLifecycleListeners()` Get the lifecycle listeners associated with this lifecycle.
`String[]`	`findRepositories()` Return the set of repositories defined for this class loader.
`ClassLoader`	`getClassLoader()` Return the Java class loader to be used by this Container.
`String`	`getClasspath()` Classpath, as set in org.apache.catalina.jsp_classpath context property
`org.apache.catalina.Container`	`getContainer()` Return the Container with which this AVMWebappLoader has been associated (i.e.: an AVMStandardContext).
`ObjectName`	`getController()`
`boolean`	`getDelegate()` Return the "follow standard delegation model" flag used to configure our ClassLoader.
`String`	`getInfo()` Return descriptive information about this Loader implementation and the corresponding version number, in the format `<description>/<version>`.
`String`	`getLoaderClass()` Return the ClassLoader class name.
`String[]`	`getLoaderRepositories()`
`String`	`getLoaderRepositoriesString()`
`boolean`	`getReloadable()` Return the reloadable flag for this Loader.
`String[]`	`getRepositories()`
`String`	`getRepositoriesString()` Extra repositories for this loader
`void`	`init()`
`boolean`	`modified()` Has the internal repository associated with this Loader been modified, such that the loaded classes should be reloaded?
`void`	`postDeregister()`
`void`	`postRegister(Boolean registrationDone)`
`void`	`preDeregister()`
`ObjectName`	`preRegister(MBeanServer server, ObjectName name)`
`void`	`propertyChange(PropertyChangeEvent event)` Process property change events from our associated Context.
`void`	`removeLifecycleListener(org.apache.catalina.LifecycleListener listener)` Remove a lifecycle event listener from this component.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Remove a property change listener from this component.
`void`	`setContainer(org.apache.catalina.Container container)` Set the Container with which this Logger has been associated.
`void`	`setController(ObjectName controller)`
`void`	`setDelegate(boolean delegate)` Set the "follow standard delegation model" flag used to configure our ClassLoader.
`void`	`setLoaderClass(String loaderClass)` Set the ClassLoader class name.
`void`	`setReloadable(boolean reloadable)` Set the reloadable flag for this Loader.
`void`	`start()` Start this component, initializing our associated class loader.
`void`	`stop()` Stop this component, finalizing our associated class loader.
`String`	`toString()` Return a String representation of this component.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - lifecycle
```
protected org.apache.catalina.util.LifecycleSupport lifecycle
```
    The lifecycle event support for this component.
  - sm
```
protected static final org.apache.catalina.util.StringManager sm
```
    The string manager for this package.
  - support
```
protected PropertyChangeSupport support
```
    The property change support for this component.
- Constructor Detail
  - AVMWebappLoader
```
public AVMWebappLoader()
```
    Construct a new AVMWebappLoader with no defined parent class loader (so that the actual parent will be the system class loader).
  - AVMWebappLoader
```
public AVMWebappLoader(ClassLoader parent,
               Map<String,ClassLoader> context_classloader_registry,
               String context_path,
               String parent_context_path,
               int version,
               String avm_webapp_path)
```
    Construct a new AVMWebappLoader with the specified class loader to be defined as the parent of the ClassLoader we ultimately create.
    
    Parameters:
    parent - The parent class loader
- Method Detail
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Return the Java class loader to be used by this Container.
    
    Specified by:
    
    getClassLoader in interface org.apache.catalina.Loader
  - getContainer
```
public org.apache.catalina.Container getContainer()
```
    Return the Container with which this AVMWebappLoader has been associated (i.e.: an AVMStandardContext).
    
    Specified by:
    
    getContainer in interface org.apache.catalina.Loader
  - setContainer
```
public void setContainer(org.apache.catalina.Container container)
```
    Set the Container with which this Logger has been associated.
    
    Specified by:
    
    setContainer in interface org.apache.catalina.Loader
    
    Parameters:
    container - The associated Container
  - getDelegate
```
public boolean getDelegate()
```
    Return the "follow standard delegation model" flag used to configure our ClassLoader.
    
    Specified by:
    
    getDelegate in interface org.apache.catalina.Loader
  - setDelegate
```
public void setDelegate(boolean delegate)
```
    Set the "follow standard delegation model" flag used to configure our ClassLoader.
    
    Specified by:
    
    setDelegate in interface org.apache.catalina.Loader
    
    Parameters:
    delegate - The new flag
  - getInfo
```
public String getInfo()
```
    Return descriptive information about this Loader implementation and the corresponding version number, in the format <description>/<version>.
    
    Specified by:
    
    getInfo in interface org.apache.catalina.Loader
  - getLoaderClass
```
public String getLoaderClass()
```
    Return the ClassLoader class name.
  - setLoaderClass
```
public void setLoaderClass(String loaderClass)
```
    Set the ClassLoader class name.
    
    Parameters:
    loaderClass - The new ClassLoader class name
  - getReloadable
```
public boolean getReloadable()
```
    Return the reloadable flag for this Loader.
    
    Specified by:
    
    getReloadable in interface org.apache.catalina.Loader
  - setReloadable
```
public void setReloadable(boolean reloadable)
```
    Set the reloadable flag for this Loader.
    
    Specified by:
    
    setReloadable in interface org.apache.catalina.Loader
    
    Parameters:
    reloadable - The new reloadable flag
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Add a property change listener to this component.
    
    Specified by:
    
    addPropertyChangeListener in interface org.apache.catalina.Loader
    
    Parameters:
    listener - The listener to add
  - addRepository
```
public void addRepository(String repository)
```
    Add a new repository to the set of repositories for this class loader.
    
    Specified by:
    
    addRepository in interface org.apache.catalina.Loader
    
    Parameters:
    repository - Repository to be added
  - 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 org.apache.catalina.Loader
  - findRepositories
```
public String[] findRepositories()
```
    Return the set of repositories defined for this class loader. If none are defined, a zero-length array is returned. For security reason, returns a clone of the Array (since String are immutable).
    
    Specified by:
    
    findRepositories in interface org.apache.catalina.Loader
  - getRepositories
```
public String[] getRepositories()
```
  - getRepositoriesString
```
public String getRepositoriesString()
```
    Extra repositories for this loader
  - getLoaderRepositories
```
public String[] getLoaderRepositories()
```
  - getLoaderRepositoriesString
```
public String getLoaderRepositoriesString()
```
  - getClasspath
```
public 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 org.apache.catalina.Loader
  - closeJARs
```
public void closeJARs(boolean force)
```
    Used to periodically signal to the classloader to release JAR resources.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
    Remove a property change listener from this component.
    
    Specified by:
    
    removePropertyChangeListener in interface org.apache.catalina.Loader
    
    Parameters:
    listener - The listener to remove
  - toString
```
public String toString()
```
    Return a String representation of this component.
    
    Overrides:
    
    toString in class Object
  - addLifecycleListener
```
public void addLifecycleListener(org.apache.catalina.LifecycleListener listener)
```
    Add a lifecycle event listener to this component.
    
    Specified by:
    
    addLifecycleListener in interface org.apache.catalina.Lifecycle
    
    Parameters:
    listener - The listener to add
  - findLifecycleListeners
```
public org.apache.catalina.LifecycleListener[] findLifecycleListeners()
```
    Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.
    
    Specified by:
    
    findLifecycleListeners in interface org.apache.catalina.Lifecycle
  - removeLifecycleListener
```
public void removeLifecycleListener(org.apache.catalina.LifecycleListener listener)
```
    Remove a lifecycle event listener from this component.
    
    Specified by:
    
    removeLifecycleListener in interface org.apache.catalina.Lifecycle
    
    Parameters:
    listener - The listener to remove
  - init
```
public void init()
```
  - destroy
```
public void destroy()
```
  - start
```
public void start()
           throws org.apache.catalina.LifecycleException
```
    Start this component, initializing our associated class loader.
    
    Specified by:
    
    start in interface org.apache.catalina.Lifecycle
    
    Throws:
    
    org.apache.catalina.LifecycleException - if a lifecycle error occurs
  - stop
```
public void stop()
          throws org.apache.catalina.LifecycleException
```
    Stop this component, finalizing our associated class loader.
    
    Specified by:
    
    stop in interface org.apache.catalina.Lifecycle
    
    Throws:
    
    org.apache.catalina.LifecycleException - if a lifecycle error occurs
  - propertyChange
```
public void propertyChange(PropertyChangeEvent event)
```
    Process property change events from our associated Context.
    
    Specified by:
    
    propertyChange in interface PropertyChangeListener
    
    Parameters:
    event - The property change event that has occurred
  - preRegister
```
public ObjectName preRegister(MBeanServer server,
                     ObjectName name)
                       throws Exception
```
    Specified by:
    
    preRegister in interface MBeanRegistration
    
    Throws:
    
    Exception
  - postRegister
```
public void postRegister(Boolean registrationDone)
```
    Specified by:
    
    postRegister in interface MBeanRegistration
  - preDeregister
```
public void preDeregister()
                   throws Exception
```
    Specified by:
    
    preDeregister in interface MBeanRegistration
    
    Throws:
    
    Exception
  - postDeregister
```
public void postDeregister()
```
    Specified by:
    
    postDeregister in interface MBeanRegistration
  - getController
```
public ObjectName getController()
```
  - setController
```
public void setController(ObjectName controller)
```

Class AVMWebappLoader

Field Summary

Fields inherited from interface org.apache.catalina.Lifecycle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

lifecycle

sm

support

Constructor Detail

AVMWebappLoader

AVMWebappLoader

Method Detail

getClassLoader

getContainer

setContainer

getDelegate

setDelegate

getInfo

getLoaderClass

setLoaderClass

getReloadable

setReloadable

addPropertyChangeListener

addRepository

backgroundProcess

findRepositories

getRepositories

getRepositoriesString

getLoaderRepositories

getLoaderRepositoriesString

getClasspath

modified

closeJARs

removePropertyChangeListener

toString

addLifecycleListener

findLifecycleListeners

removeLifecycleListener

init

destroy

start

stop

propertyChange

preRegister

postRegister

preDeregister

postDeregister

getController

setController