org.wandora.modules

Class ScriptModule

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.ScriptModule

All Implemented Interfaces:

Module

Direct Known Subclasses:

AbstractAction, ModuleGroup

public class ScriptModule
extends AbstractModule

A base module implementation that adds some scripting functionality into the module. Most of the other modules derive from this instead of from AbstractModule directly, and it may be a good idea for you to do so as well, even if you don't immediately need any of the scripting functions. By deriving from ScriptModule, you can later add scripts in the configuration file that are executed when your module is initialised, started or stopped.

To add scripts in the configuration file, define them in parameters with names startScript, stopScript or initScript. The scripts will then be ran at module start, stop or init, respectively. You may also specify the script engine to use with scriptEngine parameter, otherwise the default engine will be used, which is probably Mozilla Rhino ECMA Script.

Some variables are added to the script's environment before it's executed. moduleManager will contain the module manager, scriptModule contains this module object and persistentObjects contains a HashMap where you can store any other objects you would like to refer to later. The persistentObjects is created at module init and will not be cleared during the lifetime of the module. However, the objects stored in there are not saved to disk or any other persistent storage, they are persistent only during the lifetime of the module object.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	engine
protected java.lang.String	initScript
protected java.util.HashMap<java.lang.String,java.lang.Object>	persistentObjects
protected ScriptManager	scriptManager
protected java.lang.String	startScript
protected java.lang.String	stopScript

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
ScriptModule()

Method Summary

Modifier and Type	Method and Description
protected javax.script.ScriptEngine	getScriptEngine()
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
void	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.

Methods inherited from class org.wandora.modules.AbstractModule

getDependencies, isInitialized, isRunning, requireLogging, toString

Methods inherited from class java.lang.Object

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

Field Detail

engine

protected java.lang.String engine

startScript

protected java.lang.String startScript

stopScript

protected java.lang.String stopScript

initScript

protected java.lang.String initScript

scriptManager

protected ScriptManager scriptManager

persistentObjects

protected java.util.HashMap<java.lang.String,java.lang.Object> persistentObjects

Constructor Detail

ScriptModule

public ScriptModule()

Method Detail

init

public void init(ModuleManager manager,
                 java.util.HashMap<java.lang.String,java.lang.Object> settings)
          throws ModuleException

Description copied from interface: Module

Initialises the module. After constructor, this is the first method called in the life cycle of a module. It should not perform anything time consuming or anything with notable outside side effects. It should only read the parameters and initialise the module so that it can later be started. Note that a module being initialised doesn't mean that it necessarily will ever be started.

A ModuleException may be thrown if something vital is missing from the parameters or they are not sensible. In some cases you may not want to throw an exception even if vital initialisation information is missing. If, for example, it is possible that the module is initialised in some other way between the init and the start method calls. A ModuleException may also be thrown at the start method if the module is still not initialised.

Specified by:

init in interface Module

Overrides:

init in class AbstractModule

Parameters:

manager - The module manager handling this module. You may keep a reference to it if needed.

Throws:

ModuleException

getScriptEngine

protected javax.script.ScriptEngine getScriptEngine()

start

public void start(ModuleManager manager)
           throws ModuleException

Description copied from interface: Module

Starts the module. This will be called after init and getDependencies and signals that the module should now begin to perform whatever it was designed to do. This method call however should not block for long, so any time consuming tasks should be started in their own threads. You will typically get references to the required modules again in start using the findModule method of the manager and then store those references to instance variables for later use. You may throw a ModuleException if the module is not in a state where it can be started or it immediately becomes obvious that it cannot be started with the provided settings.

Specified by:

start in interface Module

Overrides:

start in class AbstractModule

Parameters:

manager - The module manager handling this module.

Throws:

ModuleException

stop

public void stop(ModuleManager manager)

Description copied from interface: Module

Stops the module. Should stop all threads used by the module, free any large data structures and perform other cleanup. It is possible that the module will be started again later with a start method call (and foregoing init and getDependencies calls). The module should be left in a state where this is possible.

Specified by:

stop in interface Module

Overrides:

stop in class AbstractModule

Parameters:

manager - The module manager handling this module.