org.wandora.modules.servlet

Class StaticTemplateContextProvider

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.servlet.StaticTemplateContextProvider

All Implemented Interfaces:

Module, TemplateContextProvider

public class StaticTemplateContextProvider
extends AbstractModule
implements TemplateContextProvider

This class can be used to define a default context for template managers. See TemplateManager for more details.

The context for this module is defined in the initialisation parameters the same way as in TemplateManager or templates. Parameters with the prefix "context." are added to the context with the prefix removed from the parameter name.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	context

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
StaticTemplateContextProvider()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getTemplateBaseContext()
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.

Methods inherited from class org.wandora.modules.AbstractModule

getDependencies, isInitialized, isRunning, requireLogging, start, stop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wandora.modules.Module

getDependencies, isInitialized, isRunning, start, stop

Field Detail

context

protected java.util.Map<java.lang.String,java.lang.Object> context

Constructor Detail

StaticTemplateContextProvider

public StaticTemplateContextProvider()

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

getTemplateBaseContext

public java.util.Map<java.lang.String,java.lang.Object> getTemplateBaseContext()

Specified by:

getTemplateBaseContext in interface TemplateContextProvider