org.apache.wiki.api.plugin

Interface WikiPlugin

All Known Implementing Classes:

AbstractReferralPlugin, BugReportHandler, Counter, CurrentTimePlugin, Denounce, FormClose, FormElement, FormInput, FormOpen, FormOutput, FormSelect, FormSet, FormTextarea, Groups, IfPlugin, Image, IndexPlugin, InsertPage, ListLocksPlugin, Note, PageViewPlugin, RecentChangesPlugin, ReferredPagesPlugin, ReferringPagesPlugin, ReferringUndefinedPagesPlugin, SampleAjaxPlugin, Search, SessionsPlugin, TableOfContents, UndefinedPagesPlugin, UnusedPagesPlugin, WeblogArchivePlugin, WeblogEntryPlugin, WeblogPlugin

public interface WikiPlugin

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CORE_PLUGINS_RESOURCEBUNDLE Name of the default plugin resource bundle.

Method Summary

Modifier and Type	Method and Description
String	execute(WikiContext context, Map<String,String> params) This is the main entry point for any plugin.

Field Detail

CORE_PLUGINS_RESOURCEBUNDLE

static final String CORE_PLUGINS_RESOURCEBUNDLE

Name of the default plugin resource bundle.

See Also:

Constant Field Values

Method Detail

execute

String execute(WikiContext context,
               Map<String,String> 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.