org.apache.wiki.plugin

Class WeblogArchivePlugin

java.lang.Object

org.apache.wiki.plugin.WeblogArchivePlugin

All Implemented Interfaces:

WikiPlugin

public class WeblogArchivePlugin
extends Object
implements WikiPlugin

Creates a list of all weblog entries on a monthly basis.

Parameters :

• page - the page name

Since:

1.9.21

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_PAGE Parameter name for setting the page.

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

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

Constructors

Constructor and Description
WeblogArchivePlugin()

Method Summary

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_PAGE

public static final String PARAM_PAGE

Parameter name for setting the page. Value is "page".

See Also:

Constant Field Values

Constructor Detail

WeblogArchivePlugin

public WeblogArchivePlugin()

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.