Class BugReportHandler

All Implemented Interfaces:

public class BugReportHandler
extends java.lang.Object
implements Plugin
Provides a handler for bug reports. Still under construction.

Parameters :

  • title - title of the bug, this is required. If it is empty (as in "") it is a signal to the handler to return quietly.
  • description - description of the bug.
  • version - version
  • map - I have no idea
  • page - The name of the page to be created for this bug report
  • Field Summary

    Modifier and Type Field Description
    static java.lang.String PARAM_DESCRIPTION
    Parameter name for setting the description.
    static java.lang.String PARAM_MAPPINGS
    Parameter name for setting the map.
    static java.lang.String PARAM_PAGE
    Parameter name for setting the page.
    static java.lang.String PARAM_TITLE
    Parameter name for setting the title.
    static java.lang.String PARAM_VERSION
    Parameter name for setting the version.

    Fields inherited from interface

  • Constructor Summary

    Constructor Description
  • Method Summary

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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

  • Method Details

    • execute

      public java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.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.

      Specified by:
      execute in interface Plugin
      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.
      HTML, ready to be included into the rendered page.
      PluginException - In case anything goes wrong.