org.apache.wiki.plugin

Class SessionsPlugin

java.lang.Object

org.apache.wiki.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.

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 and Description
static String	PARAM_PROP The parameter name for setting the property value.

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

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

Constructors

Constructor and Description
SessionsPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
String	execute(WikiContext context, Map<String,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 Detail

PARAM_PROP

public static final String PARAM_PROP

The parameter name for setting the property value.

See Also:

Constant Field Values

Constructor Detail

SessionsPlugin

public SessionsPlugin()

Method Detail

execute

public String execute(WikiContext context,
             Map<String,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 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.