org.wandora.modules

Class ModuleManager

java.lang.Object

org.wandora.modules.ModuleManager

Direct Known Subclasses:

ScopedModuleManager

public class ModuleManager
extends java.lang.Object

Main manager for the modules framework. ModuleManager does all the work connecting modules with each other, solving dependencies, loading configuration and setting up the whole framework.

To use this, just make a new instance of ModuleManager and then either load a configuration file or add some modules manually, initialise them, and finally start the modules. You can also first add some modules manually and then load the rest with a configuration file. You typically do this to establish some kind of an attachment point for the modules or to add a logging module or some such beforehand.

You may also add variables before loading the configuration file, these can then be used in the configuration file. For example, if you know something about the environment, such as the network port the service is running, the working directory or something similar, you could add these as variables. Then the configuration file can use them instead of having them hardcoded.

After adding the modules, you have to initialise them. Initialisation of modules needs a map of module properties. If you read the modules from a configuration file, the properties will also have been read and are stored for later use. When you call initAllModules, all modules that are not yet initialised will be initialised with the parameters read from the configuration file. Prior to this, you can initialise modules manually if you wish.

After initialisation, you need to start the modules. Typically you will call autostartModules, which will start all modules that were configured to be started automatically. Alternatively, you can also use startAllModules which will start every single module that hasn't been started yet. Or you can always start modules individually too with startModule or startModuleWithDependencies. startModule will throw an exception if the dependencies haven't been started yet whereas the other method simply starts them too.

http://wandora.orgwiki/Wandora_modules_framework for additional documentation about the modules framework.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleManager.ModuleSettings A class that contains all the different module settings.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<Module,java.util.ArrayList<Module>>	isRequiredBy Modules that are used by some other running module are put here so that they cannot be stopped before the depending module is stopped.
protected org.apache.commons.logging.Log	log Logger used by the manager.
protected ListenerList<ModuleListener>	moduleListeners
protected java.util.HashMap<Module,java.util.HashMap<java.lang.String,java.lang.Object>>	moduleParams Initialisation parameters that will be passed to module init method, read from the config file.
protected java.util.ArrayList<Module>	modules A list containing all the modules this manager takes care of.
protected java.util.HashMap<Module,ModuleManager.ModuleSettings>	moduleSettings Other settings about modules besides the parameters.
protected java.util.LinkedHashMap<java.lang.String,java.lang.String>	variables Variables used in the configuration file.
private static javax.xml.xpath.XPath	xpath

Constructor Summary

Constructors

Constructor and Description
ModuleManager()

Method Summary

Modifier and Type	Method and Description
void	addModule(Module module) Adds a module to this manager with default settings and no module parameters.
void	addModule(Module module, java.util.HashMap<java.lang.String,java.lang.Object> params) Adds a module to this manager with the given module parameters and default settings.
void	addModule(Module module, java.util.HashMap<java.lang.String,java.lang.Object> params, ModuleManager.ModuleSettings settings) Adds a module to this manager with the given module parameters and settings.
void	addModule(Module module, ModuleManager.ModuleSettings settings) Adds a module to this manager with the given module settings but empty module parameters.
void	addModule(Module module, java.lang.String name) Adds a module to this manager with default settings and no module parameters but with the provided name.
void	addModuleListener(ModuleListener l) Add a listener that will be notified about changes in modules in this manager.
void	autostartModules() Starts all modules that have not yet been started and that were set to start automatically in module settings.
void	autostartModules(java.util.Collection<Module> modules) In a given modules collection, starts all modules that have not yet been started and that were set to start automatically in module settings.
<A extends Module> A	findModule(java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> A	findModule(Module context, java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> A	findModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> A	findModule(java.lang.String instanceName, java.lang.Class<A> cls) Finds a module that is of the specified class or one extending it.
<A extends Module> java.util.ArrayList<A>	findModules(java.lang.Class<A> cls) Finds all modules that are of the specified class or one extending it.
java.util.ArrayList<Module>	getAllModules() Returns a list of all modules added to this manager.
org.apache.commons.logging.Log	getLogger() Returns the logger used for manager logging.
java.lang.String	getModuleName(Module m) Gets the module name.
ModuleManager.ModuleSettings	getModuleSettings(Module m) Gets module settings.
java.lang.String	getVariable(java.lang.String key) Gets the value of a defined variable.
void	initAllModules() Initialises all modules that have not yet been initialised.
boolean	isModuleAutoStart(Module m) Checks if module is to be started automatically.
java.lang.String	moduleToString(java.lang.Class<?> cls, java.lang.String instanceName) Creates a string representation of a module class.
java.lang.String	moduleToString(Module module) Creates a string representation of a module.
<A extends Module> A	optionalModule(java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	optionalModule(Module context, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	optionalModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> A	optionalModule(java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Look for a module that will be used if found but is not required.
<A extends Module> java.util.ArrayList<A>	optionalModules(java.lang.Class<A> cls, java.util.Collection<Module> dependencies)
java.util.Collection<Module>	parseXMLConfigElement(org.w3c.dom.Node doc, java.lang.String source) Parses an XML element as if it was the root element of a full configuration file.
java.util.Collection<Module>	parseXMLInclude(org.w3c.dom.Element e) Parses an handles include element.
Tuples.T3<Module,java.util.HashMap<java.lang.String,java.lang.Object>,ModuleManager.ModuleSettings>	parseXMLModuleElement(org.w3c.dom.Element e, java.lang.String source) Reads a module element and returns the module, its module parameters and module settings.
static ModuleManager.ModuleSettings	parseXMLModuleSettings(org.w3c.dom.Element e, java.lang.String source) Reads module settings from a module element.
java.util.HashMap<java.lang.String,java.lang.Object>	parseXMLOptionsElement(org.w3c.dom.Element e) Reads all the options inside the module element.
java.lang.Object	parseXMLParamElement(org.w3c.dom.Element e) Parses a single param element and returns its value.
void	parseXMLVariable(org.w3c.dom.Element e, java.util.HashMap<java.lang.String,java.lang.String> variables) Parses a variable element and defines that variable for future use.
java.util.Collection<Module>	readXMLOptionsFile(java.lang.String optionsFileName) Reads and parses a whole xml configuration file.
void	removeModule(Module module) Removes a module from the manager.
void	removeModuleListener(ModuleListener l) Removes a previously registered module listener.
java.lang.String	replaceVariables(java.lang.String value, java.util.HashMap<java.lang.String,java.lang.String> variables) Performs variable replacement on a string.
<A extends Module> A	requireModule(java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	requireModule(Module context, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	requireModule(Module context, java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
<A extends Module> A	requireModule(java.lang.String instanceName, java.lang.Class<A> cls, java.util.Collection<Module> dependencies) Find a required module and throw a MissingDependencyException if one cannot be found.
void	setLogging(org.apache.commons.logging.Log log) Sets the logging for the module manager itself.
void	setVariable(java.lang.String key, java.lang.String value) Sets a variable.
void	startAllModules() Starts all modules that have not yet been started.
void	startModule(Module module) Starts a module.
void	startModuleWithDependencies(Module module) Starts a module as well as all modules it depends on.
void	stopAllModules() Stops all running modules.
void	stopCascading(Module module) Stops a single module along with all modules that depend on it.
void	stopModule(Module module) Stops a single module, but fails if other modules depend on it.

Methods inherited from class java.lang.Object

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

Field Detail

modules

protected java.util.ArrayList<Module> modules

A list containing all the modules this manager takes care of.

moduleParams

protected java.util.HashMap<Module,java.util.HashMap<java.lang.String,java.lang.Object>> moduleParams

Initialisation parameters that will be passed to module init method, read from the config file.

moduleSettings

protected java.util.HashMap<Module,ModuleManager.ModuleSettings> moduleSettings

Other settings about modules besides the parameters. Includes things like auto restart, priority, name, and explicit services used.

log

protected org.apache.commons.logging.Log log

Logger used by the manager. Can be set with setLog, otherwise it's automatically captured by addModule when a logging module is first added.

moduleListeners

protected ListenerList<ModuleListener> moduleListeners

isRequiredBy

protected java.util.HashMap<Module,java.util.ArrayList<Module>> isRequiredBy

Modules that are used by some other running module are put here so that they cannot be stopped before the depending module is stopped.

variables

protected java.util.LinkedHashMap<java.lang.String,java.lang.String> variables

Variables used in the configuration file.

xpath

private static javax.xml.xpath.XPath xpath

Constructor Detail

ModuleManager

public ModuleManager()

Method Detail

getModuleSettings

public ModuleManager.ModuleSettings getModuleSettings(Module m)

Gets module settings. The settings include everything else about the module except the implementation specific parameters. For example, module name, autostart status, priority and explicitly specified dependencies.

isModuleAutoStart

public boolean isModuleAutoStart(Module m)

Checks if module is to be started automatically.

getModuleName

public java.lang.String getModuleName(Module m)

Gets the module name.

addModuleListener

public void addModuleListener(ModuleListener l)

Add a listener that will be notified about changes in modules in this manager.

removeModuleListener

public void removeModuleListener(ModuleListener l)

Removes a previously registered module listener.

setLogging

public void setLogging(org.apache.commons.logging.Log log)

Sets the logging for the module manager itself. Modules will typically get a logging module as a dependency instead of using the manager logger directly. If no manager logging is set when a logging module is first added, that module will automatically be used for manager logging as well.

getLogger

public org.apache.commons.logging.Log getLogger()

Returns the logger used for manager logging. Modules should not use this logger, instead they should depend on a logging module and use the logging module for logging.

getAllModules

public java.util.ArrayList<Module> getAllModules()

Returns a list of all modules added to this manager.

findModule

public <A extends Module> A findModule(java.lang.Class<A> cls)

Finds a module that is of the specified class or one extending it. Typically you look for modules with an interface and will then get a module that implements the interface. In case several such modules exist, the one with the highest priority is selected. In case there is a tie, one of them is arbitrarily selected.

Parameters:

cls - The class or interface that the module has to implement or extend or be a direct instance of.

Returns:

The module found or null if no such module exists.

findModule

public <A extends Module> A findModule(Module context,
                                       java.lang.Class<A> cls)

Finds a module that is of the specified class or one extending it. Typically you look for modules with an interface and will then get a module that implements the interface. This method takes a module as context, the context is the module requesting another module. It may affect what module is returned. With the default implementation this will happen if module dependencies were explicitly defined in the config file. But in future, other selection methods may be added which also depend on the requesting module.

Parameters:

context - The module which is requesting the module. This may affect what module is returned.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

Returns:

The module found or null if no such module exists.

findModule

public <A extends Module> A findModule(Module context,
                                       java.lang.String instanceName,
                                       java.lang.Class<A> cls)

Finds a module that is of the specified class or one extending it. Typically you look for modules with an interface and will then get a module that implements the interface. This method takes the name of the module requested. No other module will be returned except the module named such.

Parameters:

context - The module which is requesting the module. This may affect what module is returned.

instanceName - The instance name of the requested module.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

Returns:

The module found or null if no such module exists.

findModule

public <A extends Module> A findModule(java.lang.String instanceName,
                                       java.lang.Class<A> cls)

Finds a module that is of the specified class or one extending it. Typically you look for modules with an interface and will then get a module that implements the interface. This method takes the name of the module requested. No other module will be returned except the module named such.

Parameters:

instanceName - The instance name of the requested module.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

Returns:

The module found or null if no such module exists.

findModules

public <A extends Module> java.util.ArrayList<A> findModules(java.lang.Class<A> cls)

Finds all modules that are of the specified class or one extending it.

Parameters:

cls - The class or interface that the module has to implement or extend or be a direct instance of.

Returns:

The found modules or an empty list if no such modules exist.

requireModule

public <A extends Module> A requireModule(java.lang.Class<A> cls,
                                          java.util.Collection<Module> dependencies)
                                   throws MissingDependencyException

Find a required module and throw a MissingDependencyException if one cannot be found. This method is usually used in the getDependencies method of modules. If a dependency isn't found, it'll automatically throw a suitable exception. If the module i found, it will be added to the provided collection which getDependencies needs to return later.

Parameters:

cls - The class or interface that the module has to implement or extend or be a direct instance of.

dependencies - The collection where all dependencies are gathered and where the found module is added.

Returns:

The found module.

Throws:

MissingDependencyException

requireModule

public <A extends Module> A requireModule(Module context,
                                          java.lang.Class<A> cls,
                                          java.util.Collection<Module> dependencies)
                                   throws MissingDependencyException

Find a required module and throw a MissingDependencyException if one cannot be found. This method is usually used in the getDependencies method of modules. If a dependency isn't found, it'll automatically throw a suitable exception. If the module i found, it will be added to the provided collection which getDependencies needs to return later. This method takes a module as context, the context is the module requesting another module. It may affect what module is returned. With the default implementation this will happen if module dependencies were explicitly defined in the config file. But in future, other selection methods may be added which also depend on the requesting module.

Parameters:

context - The module which is requesting the module. This may affect what module is returned.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

dependencies - The collection where all dependencies are gathered and where the found module is added.

Returns:

The found module.

Throws:

MissingDependencyException

requireModule

public <A extends Module> A requireModule(Module context,
                                          java.lang.String instanceName,
                                          java.lang.Class<A> cls,
                                          java.util.Collection<Module> dependencies)
                                   throws MissingDependencyException

Find a required module and throw a MissingDependencyException if one cannot be found. This method is usually used in the getDependencies method of modules. If a dependency isn't found, it'll automatically throw a suitable exception. If the module i found, it will be added to the provided collection which getDependencies needs to return later. This method takes the name of the module requested. No other module will be returned except the module named such.

Parameters:

context - The module which is requesting the module. This may affect what module is returned.

instanceName - The instance name of the requested module.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

dependencies - The collection where all dependencies are gathered and where the found module is added.

Returns:

The found module.

Throws:

MissingDependencyException

requireModule

public <A extends Module> A requireModule(java.lang.String instanceName,
                                          java.lang.Class<A> cls,
                                          java.util.Collection<Module> dependencies)
                                   throws MissingDependencyException

Find a required module and throw a MissingDependencyException if one cannot be found. This method is usually used in the getDependencies method of modules. If a dependency isn't found, it'll automatically throw a suitable exception. If the module i found, it will be added to the provided collection which getDependencies needs to return later. This method takes the name of the module requested. No other module will be returned except the module named such.

Parameters:

instanceName - The instance name of the requested module.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

dependencies - The collection where all dependencies are gathered and where the found module is added.

Returns:

The found module.

Throws:

MissingDependencyException

optionalModule

public <A extends Module> A optionalModule(java.lang.Class<A> cls,
                                           java.util.Collection<Module> dependencies)

Look for a module that will be used if found but is not required. Unlike requireModule, no exception is thrown if the module is not found. If it is found, then this method behaves like requireModule and the module is added in the provided dependencies collection as well as returned from the method.

Parameters:

cls - The class or interface that the module has to implement or extend or be a direct instance of.

dependencies - The collection where all dependencies are gathered and where the found module is added.

Returns:

The found module or null if one cannot be found.

optionalModule

public <A extends Module> A optionalModule(Module context,
                                           java.lang.Class<A> cls,
                                           java.util.Collection<Module> dependencies)

Look for a module that will be used if found but is not required. Unlike requireModule, no exception is thrown if the module is not found. If it is found, then this method behaves like requireModule and the module is added in the provided dependencies collection as well as returned from the method. This method takes a module as context, the context is the module requesting another module. It may affect what module is returned. With the default implementation this will happen if module dependencies were explicitly defined in the config file. But in future, other selection methods may be added which also depend on the requesting module.

Parameters:

context - The module which is requesting the module. This may affect what module is returned.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

dependencies - The collection where all dependencies are gathered and where the found module is added.

Returns:

The found module or null if one cannot be found.

optionalModule

public <A extends Module> A optionalModule(Module context,
                                           java.lang.String instanceName,
                                           java.lang.Class<A> cls,
                                           java.util.Collection<Module> dependencies)

Look for a module that will be used if found but is not required. Unlike requireModule, no exception is thrown if the module is not found. If it is found, then this method behaves like requireModule and the module is added in the provided dependencies collection as well as returned from the method. This method takes the name of the module requested. No other module will be returned except the module named such.

Parameters:

context - The module which is requesting the module. This may affect what module is returned.

instanceName - The instance name of the requested module.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

dependencies - The collection where all dependencies are gathered and where the found module is added.

Returns:

The found module or null if one cannot be found.

optionalModule

public <A extends Module> A optionalModule(java.lang.String instanceName,
                                           java.lang.Class<A> cls,
                                           java.util.Collection<Module> dependencies)

Look for a module that will be used if found but is not required. Unlike requireModule, no exception is thrown if the module is not found. If it is found, then this method behaves like requireModule and the module is added in the provided dependencies collection as well as returned from the method. This method takes the name of the module requested. No other module will be returned except the module named such.

Parameters:

instanceName - The instance name of the requested module.

cls - The class or interface that the module has to implement or extend or be a direct instance of.

dependencies - The collection where all dependencies are gathered and where the found module is added.

Returns:

The found module or null if one cannot be found.

optionalModules

public <A extends Module> java.util.ArrayList<A> optionalModules(java.lang.Class<A> cls,
                                                                 java.util.Collection<Module> dependencies)

addModule

public void addModule(Module module)

Adds a module to this manager with default settings and no module parameters.

Parameters:

module - The module to be added.

addModule

public void addModule(Module module,
                      java.lang.String name)

Adds a module to this manager with default settings and no module parameters but with the provided name.

Parameters:

module - The module to be added.

name - The module name;

addModule

public void addModule(Module module,
                      ModuleManager.ModuleSettings settings)

Adds a module to this manager with the given module settings but empty module parameters. Settings are general module settings, like module name, priority etc. whereas module parameters are module options specific to the implementation and used only by the module, not the module manager.

Parameters:

module - The module to be added.

settings - The settings for the module.

addModule

public void addModule(Module module,
                      java.util.HashMap<java.lang.String,java.lang.Object> params)

Adds a module to this manager with the given module parameters and default settings. Settings are general module settings, like module name, priority etc. whereas module parameters are module options specific to the implementation and used only by the module, not the module manager.

Parameters:

module - The module to be added.

params - The module parameters.

addModule

public void addModule(Module module,
                      java.util.HashMap<java.lang.String,java.lang.Object> params,
                      ModuleManager.ModuleSettings settings)

Adds a module to this manager with the given module parameters and settings. Settings are general module settings, like module name, priority etc. whereas module parameters are module options specific to the implementation and used only by the module, not the module manager.

Parameters:

module - The module to be added.

params - The module parameters.

settings - The module settings.

removeModule

public void removeModule(Module module)
                  throws ModuleException

Removes a module from the manager. Tries to stop the module first if it is running. This can potentially lead to different kinds of exceptions, notably a ModuleInUseException if some other module is using the module being removed.

Parameters:

module - The module to be removed.

Throws:

ModuleInUseException

ModuleException

moduleToString

public java.lang.String moduleToString(java.lang.Class<?> cls,
                                       java.lang.String instanceName)

Creates a string representation of a module class. Mostly intended for debugging and logging.

Parameters:

cls - The class of the module.

instanceName - The instance name of the module or null.

Returns:

moduleToString

public java.lang.String moduleToString(Module module)

Creates a string representation of a module. Mostly intended for debugging and logging.

Parameters:

module - The module.

Returns:

initAllModules

public void initAllModules()
                    throws ModuleException

Initialises all modules that have not yet been initialised. If the module information was read from a configuration file along with module parameters, those parameters will be used for the initialisation.

Throws:

ModuleException

autostartModules

public void autostartModules()
                      throws ModuleException

Starts all modules that have not yet been started and that were set to start automatically in module settings. Will also start all the dependencies of such modules, even if they themselves were not set to be started automatically.

Throws:

ModuleException

autostartModules

public void autostartModules(java.util.Collection<Module> modules)
                      throws ModuleException

In a given modules collection, starts all modules that have not yet been started and that were set to start automatically in module settings. Will also start all the dependencies of such modules, even if they themselves were not set to be started automatically.

Throws:

ModuleException

startAllModules

public void startAllModules()
                     throws ModuleException

Starts all modules that have not yet been started.

Throws:

ModuleException

stopAllModules

public void stopAllModules()

Stops all running modules.

stopCascading

public void stopCascading(Module module)
                   throws ModuleException

Stops a single module along with all modules that depend on it.

Parameters:

module - The module to be stopped.

Throws:

ModuleException

stopModule

public void stopModule(Module module)
                throws ModuleException

Stops a single module, but fails if other modules depend on it. A ModuleInUseException will be throw if some other running module depends on the module to be stopped.

Parameters:

module - The module to be stopped.

Throws:

ModuleException

startModuleWithDependencies

public void startModuleWithDependencies(Module module)
                                 throws ModuleException

Starts a module as well as all modules it depends on.

Parameters:

module - The module to be started.

Throws:

ModuleException

startModule

public void startModule(Module module)
                 throws ModuleException

Starts a module. If any dependencies haven't yet been started, will throw a MissingDependencyException. use startModuleWithDependencies to automatically start all dependencies as well.

Parameters:

module - The module to be started.

Throws:

ModuleException

parseXMLParamElement

public java.lang.Object parseXMLParamElement(org.w3c.dom.Element e)
                                      throws java.lang.ReflectiveOperationException,
                                             java.lang.IllegalArgumentException,
                                             javax.script.ScriptException

Parses a single param element and returns its value. Handles all the different cases of how a param elements value can be determined.

Parameters:

e - The xml param element.

Returns:

The value of the parameter.

Throws:

java.lang.ReflectiveOperationException

java.lang.IllegalArgumentException

javax.script.ScriptException

parseXMLOptionsElement

public java.util.HashMap<java.lang.String,java.lang.Object> parseXMLOptionsElement(org.w3c.dom.Element e)
                                                                            throws java.lang.ReflectiveOperationException,
                                                                                   javax.script.ScriptException

Reads all the options inside the module element. Currently only processing params elements but in the future could handle other elements too.

Parameters:

e - The module element contents of which are to be processed.

Returns:

The parameters defined in the element.

Throws:

java.lang.ReflectiveOperationException

javax.script.ScriptException

parseXMLModuleSettings

public static ModuleManager.ModuleSettings parseXMLModuleSettings(org.w3c.dom.Element e,
                                                                  java.lang.String source)
                                                           throws java.lang.ClassNotFoundException

Reads module settings from a module element. The settings include autostarting, priority, name read from attributes of the element and useService elements defined inside the module element.

Parameters:

e - The module element.

source - The source identifier for the module, could be the file name where the module comes from or something else.

Returns:

Parsed module settings.

Throws:

java.lang.ClassNotFoundException

parseXMLModuleElement

public Tuples.T3<Module,java.util.HashMap<java.lang.String,java.lang.Object>,ModuleManager.ModuleSettings> parseXMLModuleElement(org.w3c.dom.Element e,
                                                                                                                                 java.lang.String source)
                                                                                                                          throws java.lang.ReflectiveOperationException,
                                                                                                                                 javax.script.ScriptException

Reads a module element and returns the module, its module parameters and module settings. Basically handles everything about a module element.

Parameters:

e - The module element.

source - The source identifier for the module, could be the file name where the module comes from or something else.

Returns:

A tuple containing the module itself, parsed module parameters and parsed module settings.

Throws:

java.lang.ReflectiveOperationException

javax.script.ScriptException

getVariable

public java.lang.String getVariable(java.lang.String key)

Gets the value of a defined variable. The variable may have been defined explicitly with setVariable or parsed from a configuration file.

Parameters:

key - The name of the variable.

Returns:

The value of the variable or null if it is undefined.

replaceVariables

public java.lang.String replaceVariables(java.lang.String value,
                                         java.util.HashMap<java.lang.String,java.lang.String> variables)

Performs variable replacement on a string. All occurrences of "${variableName}" where variableName is a defined variable will be replaced with the value of the variable.

Parameters:

value - The string in which variable replacement will be done.

variables - A map containing all the defined variables.

Returns:

setVariable

public void setVariable(java.lang.String key,
                        java.lang.String value)

Sets a variable. Use null value to remove a variable definition. Will overwrite old value if the variable had already been set.

Parameters:

key - The name of the variable to set.

value - The value of the variable or null to remove the definition.

parseXMLVariable

public void parseXMLVariable(org.w3c.dom.Element e,
                             java.util.HashMap<java.lang.String,java.lang.String> variables)

Parses a variable element and defines that variable for future use.

Parameters:

e - The variable element.

variables - The variable map into which the variable is defined.

parseXMLInclude

public java.util.Collection<Module> parseXMLInclude(org.w3c.dom.Element e)

Parses an handles include element. This may add a large number of modules or do other changes in the module manager.

Parameters:

e - The include element.

Returns:

A list of all the modules added.

parseXMLConfigElement

public java.util.Collection<Module> parseXMLConfigElement(org.w3c.dom.Node doc,
                                                          java.lang.String source)

Parses an XML element as if it was the root element of a full configuration file. Creates all the modules defined in the element. Also sets whatever variables are defined and uses those when parsing the rest of the element.

Parameters:

doc - The element which contains the config definitions.

source - The source identifier, e.g. file name, where this element came from.

Returns:

A list of all the modules added.

readXMLOptionsFile

public java.util.Collection<Module> readXMLOptionsFile(java.lang.String optionsFileName)

Reads and parses a whole xml configuration file. Creates all the modules defined in the file. Also sets whatever variables are defined in the file and uses those when parsing the rest of the file.

Parameters:

optionsFileName -

Returns:

A list of all the modules added.