com.ecyrd.jspwiki.plugin
Interface WikiPlugin

All Known Implementing Classes:

AbstractReferralPlugin, Counter, CurrentTimePlugin, Image, IndexPlugin, ListLocksPlugin, RecentChangesPlugin, WeblogEntryPlugin, WeblogPlugin

public interface WikiPlugin

Defines an interface for plugins. Any instance of a wiki plugin should implement this interface.

Author:

Janne Jalkanen

Method Summary

java.lang.String

execute(WikiContext context, java.util.Map params) This is the main entry point for any plugin.

Method Detail

execute

public java.lang.String execute(WikiContext context,
                                java.util.Map params)
                         throws PluginException

This is the main entry point for any plugin. The parameters are parsed, and a special parameter called "_body" signifies the name of the plugin body, i.e. the part of the plugin that is not a parameter of the form "key=value". This has been separated using an empty line.

Note that it is preferred that the plugin returns XHTML-compliant HTML (i.e. close all tags, use <br /> instead of <br>, etc.

Parameters:

context - The current WikiContext.

params - A Map which contains key-value pairs. Any parameter that the user has specified on the wiki page will contain String-String parameters, but it is possible that at some future date, JSPWiki will give you other things that are not Strings.

Returns:

HTML, ready to be included into the rendered page.

Throws:

PluginException - In case anything goes wrong.