Class SessionsPlugin

  • All Implemented Interfaces:
    Plugin

    public class SessionsPlugin
    extends java.lang.Object
    implements Plugin

    Displays information about active wiki sessions. The parameter property specifies what information is displayed. If omitted, the number of sessions is returned.

    Parameters :

    • property - specify what output to display, valid values are:
      • users - returns a comma-separated list of users
      • distinctUsers - will only show distinct users.
    Since:
    2.3.84
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PARAM_PROP
      The parameter name for setting the property value.
    • Constructor Summary

      Constructors 
      Constructor Description
      SessionsPlugin()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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
    • Method Detail

      • 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.