com.ecyrd.jspwiki.plugin
Class SessionsPlugin
java.lang.Object
com.ecyrd.jspwiki.plugin.SessionsPlugin
- All Implemented Interfaces:
- WikiPlugin
public class SessionsPlugin
- extends Object
- implements WikiPlugin
Displays information about active wiki sessions. The parameter
property
specifies what information is displayed.
If omitted, the number of sessions is returned.
Valid values for the property
parameter
include:
users
- returns a comma-separated list of
users
- Since:
- 2.3.84
- Author:
- Andrew Jaquith
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PARAM_PROP
public static final String PARAM_PROP
- See Also:
- Constant Field Values
SessionsPlugin
public SessionsPlugin()
execute
public String execute(WikiContext context,
Map params)
throws PluginException
- Description copied from interface:
WikiPlugin
- 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 WikiPlugin
- 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.