org.diet4j.tomcat

Class TomcatModuleLoader

java.lang.Object

org.apache.catalina.util.LifecycleBase

org.apache.catalina.util.LifecycleMBeanBase

org.apache.catalina.loader.WebappLoader

org.diet4j.tomcat.TomcatModuleLoader

All Implemented Interfaces:

PropertyChangeListener, EventListener, MBeanRegistration, org.apache.catalina.JmxEnabled, org.apache.catalina.Lifecycle, org.apache.catalina.Loader

public class TomcatModuleLoader
extends org.apache.catalina.loader.WebappLoader

This Tomcat-specific class can be specified as a WebappLoader in a Tomcat context.xml file in order to make the entire Tomcat app use diet4j. Note that the diet4j JARs must be accessible to Tomcat. Apparently bundling them with a web app's WAR file is not sufficient, and they must be Tomcat's library path. Use as follows in context.xml:

 <Context path='/context-path'>
  <Loader className='org.diet4j.tomcat.TomcatModuleLoader'
          rootmodule='com.example.mywebapp'
          moduledirectory='/usr/share/java' />
 </Context>
 

where com.example.mywebapp is the the name of the root module for this app, and moduledirectory is the directory where JARs of Modules can be found.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_MODULEDIRECTORY The default directory in which the module JARs can be found.
protected String	theModuledirectory Directory in which the module JARs can be found.
protected ModuleRegistry	theModuleRegistry Keep a reference to the ModuleRegistries that we are using so they won't be garbage collected.
protected String	theRootmodule Name of the root module.
static String[]	TOMCAT_DO_NOT_LOAD_CLASS_PREFIXES Tomcat bundles certain libraries, so it needs a different set of class name prefixes not to load via diet4j.

Fields inherited from class org.apache.catalina.loader.WebappLoader

sm, support

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

mserver

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
TomcatModuleLoader() Public constructor.
TomcatModuleLoader(ClassLoader parent) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getModuledirectory() Get directory in which the module JARs can be found.
String	getRootmodule() Get name of root module.
void	setModuledirectory(String newValue) Set directory in which the module JARs can be found.
void	setRootmodule(String newValue) Set name of root module.
void	startInternal() Start it.
void	stopInternal() Stop it.
String	toString() Convert to String, for debugging.

Methods inherited from class org.apache.catalina.loader.WebappLoader

addPropertyChangeListener, backgroundProcess, getClassLoader, getClasspath, getContext, getDelegate, getDomainInternal, getLoaderClass, getLoaderRepositories, getLoaderRepositoriesString, getObjectNameKeyProperties, getReloadable, modified, propertyChange, removePropertyChangeListener, setContext, setDelegate, setLoaderClass, setReloadable

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

destroyInternal, getDomain, getObjectName, initInternal, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase

addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

theRootmodule

protected String theRootmodule

Name of the root module.

theModuledirectory

protected String theModuledirectory

Directory in which the module JARs can be found.

theModuleRegistry

protected ModuleRegistry theModuleRegistry

Keep a reference to the ModuleRegistries that we are using so they won't be garbage collected.

DEFAULT_MODULEDIRECTORY

public static final String DEFAULT_MODULEDIRECTORY

The default directory in which the module JARs can be found.

See Also:

Constant Field Values

TOMCAT_DO_NOT_LOAD_CLASS_PREFIXES

public static final String[] TOMCAT_DO_NOT_LOAD_CLASS_PREFIXES

Tomcat bundles certain libraries, so it needs a different set of class name prefixes not to load via diet4j.

Constructor Detail

TomcatModuleLoader

public TomcatModuleLoader()

Public constructor.

TomcatModuleLoader

public TomcatModuleLoader(ClassLoader parent)

Constructor.

Parameters:

parent - the parent ClassLoader

Method Detail

setRootmodule

public void setRootmodule(String newValue)

Set name of root module.

Parameters:

newValue - the value

See Also:

getRootmodule()

getRootmodule

public String getRootmodule()

Get name of root module.

Returns:

the value

See Also:

setRootmodule(java.lang.String)

setModuledirectory

public void setModuledirectory(String newValue)

Set directory in which the module JARs can be found.

Parameters:

newValue - the value

See Also:

getModuledirectory()

getModuledirectory

public String getModuledirectory()

Get directory in which the module JARs can be found.

Returns:

the value

See Also:

setModuledirectory(java.lang.String)

startInternal

public void startInternal()
                   throws org.apache.catalina.LifecycleException

Start it.

Overrides:

startInternal in class org.apache.catalina.loader.WebappLoader

Throws:

org.apache.catalina.LifecycleException - thrown if this TomcatModuleLoader cannot be started

stopInternal

public void stopInternal()
                  throws org.apache.catalina.LifecycleException

Stop it.

Overrides:

stopInternal in class org.apache.catalina.loader.WebappLoader

Throws:

org.apache.catalina.LifecycleException - thrown if this TomcatModuleLoader cannot be stopped

toString

public String toString()

Convert to String, for debugging.

Overrides:

toString in class org.apache.catalina.loader.WebappLoader

Returns:

String form