Package org.apache.wiki.api.plugin

Interface WikiPlugin

All Superinterfaces:
Plugin
@Deprecated
public interface WikiPlugin
extends Plugin
Deprecated.
use Plugin instead
Defines an interface for plugins. Any instance of a wiki plugin should implement this interface.
See Also:
Plugin

  • Field Summary

    Fields inherited from interface org.apache.wiki.api.plugin.Plugin

    CORE_PLUGINS_RESOURCEBUNDLE

  • Method Summary

    Modifier and Type Method Description
    default java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.String> params)
    Deprecated.
    This is the main entry point for any plugin.
    java.lang.String execute​(WikiContext context, java.util.Map<java.lang.String,​java.lang.String> params)
    Deprecated.
     

  • Method Details

    • execute

      default java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.String> params) throws PluginException
      Deprecated.
      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.

      Specified by:
      execute in interface Plugin
      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.

    • execute

      java.lang.String execute​(WikiContext context, java.util.Map<java.lang.String,​java.lang.String> params) throws PluginException
      Deprecated.
      Throws:
      PluginException