org.wandora.modules

Interface XMLOptionsHandler

All Known Implementing Classes:

ModuleBundle, ModuleGroup, ScopedModuleManager, WandoraModuleManager

public interface XMLOptionsHandler

An interface indicating that your module will process the contents of the module element instead of relying on the automatic processing of ModuleManager. When you implement this interface, ModuleManager will give your module a chance to process the contents of the module element on its own instead of the module manager parsing the parameters. It's completely up to the module then what to do with the contents. However, some common elements, like useService elements, should be allowed to still be present and they will still be processed by the module manager. Also, any module you derive from may expect some parameters, you will have to accommodate these somehow. Note that you can still use the parseXMLOptionsElement method in module manager to do standard parameters parsing in addition to any custom handling.

Author:

olli

Method Summary

Modifier and Type	Method and Description
java.util.HashMap<java.lang.String,java.lang.Object>	parseXMLOptionsElement(ModuleManager manager, org.w3c.dom.Element e, java.lang.String source) Parses the given module element and returns a map containing the module parameters.

Method Detail

parseXMLOptionsElement

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

Parses the given module element and returns a map containing the module parameters. The module parameters will later be passed to your module again in init method. You may of course retain parsed information outside this map as well and refer to it later in the initialisation.

Parameters:

manager - The module manager handling this module.

e - The module element which is to be parsed.

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

Returns:

The parsed module parameters which will be passed to the init method of your module later.

Throws:

java.lang.ReflectiveOperationException

javax.script.ScriptException