Examples of com.ecyrd.jspwiki.plugin.PluginManager

Manages plugin classes. There exists a single instance of PluginManager per each instance of WikiEngine, that is, each JSPWiki instance.

A plugin is defined to have three parts:

The plugin class
The plugin parameters
The plugin body

For example, in the following line of code:

 [{INSERT com.ecyrd.jspwiki.plugin.FunnyPlugin  foo='bar' blob='goo' abcdefghijklmnopqrstuvw 01234567890}]

The plugin class is "com.ecyrd.jspwiki.plugin.FunnyPlugin", the parameters are "foo" and "blob" (having values "bar" and "goo", respectively), and the plugin body is then "abcdefghijklmnopqrstuvw\n01234567890". The plugin body is accessible via a special parameter called "_body".

If the parameter "debug" is set to "true" for the plugin, JSPWiki will output debugging information directly to the page if there is an exception.

The class name can be shortened, and marked without the package. For example, "FunnyPlugin" would be expanded to "com.ecyrd.jspwiki.plugin.FunnyPlugin" automatically. It is also possible to define other packages, by setting the "jspwiki.plugin.searchPath" property. See the included jspwiki.properties file for examples.

Even though the nominal way of writing the plugin is

 [{INSERT pluginclass WHERE param1=value1...}],

it is possible to shorten this quite a lot, by skipping the INSERT, and WHERE words, and dropping the package name. For example:

 [{INSERT com.ecyrd.jspwiki.plugin.Counter WHERE name='foo'}]

is the same as

 [{Counter name='foo'}]

Plugin property files

Since 2.3.25 you can also define a generic plugin XML properties file per each JAR file.

   Janne Jalkanen  foo.css code   Janne Jalkanen

Plugin lifecycle

Plugin can implement multiple interfaces to let JSPWiki know at which stages they should be invoked:

InitializablePlugin: If your plugin implements this interface, the initialize()-method is called once for this class before any actual execute() methods are called. You should use the initialize() for e.g. precalculating things. But notice that this method is really called only once during the entire WikiEngine lifetime. The InitializablePlugin is available from 2.5.30 onwards.
ParserStagePlugin: If you implement this interface, the executeParse() method is called when JSPWiki is forming the DOM tree. You will receive an incomplete DOM tree, as well as the regular parameters. However, since JSPWiki caches the DOM tree to speed up later places, which means that whatever this method returns would be irrelevant. You can do some DOM tree manipulation, though. The ParserStagePlugin is available from 2.5.30 onwards.
WikiPlugin: The regular kind of plugin which is executed at every rendering stage. Each new page load is guaranteed to invoke the plugin, unlike with the ParserStagePlugins.

@since 1.6.1