Plugin Configurations

A plugin is defined using the <plugin> element, which may appear inside the <plugins> element. It takes a mandatory class attribute, giving the name of a class implementing the Plugin interface.

The <plugin> element may contain any number of <param> elements.

A plugin configuration is reflected by the PluginConfig interface, which defines the getParamConfig() method to lookup parameters by name.

Example

Here's a plugin configuration for plugin class org.foo.bar.FooPlugin, passing parameter bar.

<plugin class="org.foo.bar.FooPlugin">
  <param name="bar" value="foobar"/>
</action>

The controller will instantiate an instance of FooPlugin during module load and call its

public void init(
  PluginConfig config,
  PluginContext context) throws Exception;

method. The PluginContext gains access to the module context and constains methods to register dispatchers and filter classes by name. See the general plugins section for details.