Class PageViewPlugin

java.lang.Object
org.apache.wiki.plugin.AbstractReferralPlugin
org.apache.wiki.plugin.PageViewPlugin
All Implemented Interfaces:
InitializablePlugin, Plugin

public class PageViewPlugin
extends AbstractReferralPlugin
implements Plugin, InitializablePlugin
This plugin counts the number of times a page has been viewed.
Parameters:
  • count=yes|no
  • show=none|count|list
  • entries=maximum number of list entries to be returned
  • min=minimum page count to be listed
  • max=maximum page count to be listed
  • sort=name|count
Default values:
show=none sort=name
Since:
2.8
  • Constructor Details

  • Method Details

    • initialize

      public void initialize​(Engine engine)
      Initialize the PageViewPlugin and its singleton.
      Specified by:
      initialize in interface InitializablePlugin
      Parameters:
      engine - The wiki engine.
    • 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
      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.