org.apache.wiki.plugin

Class WeblogEntryPlugin

java.lang.Object

org.apache.wiki.plugin.WeblogEntryPlugin

All Implemented Interfaces:

Plugin

public class WeblogEntryPlugin
extends java.lang.Object
implements Plugin

Builds a simple weblog.

Parameters :

• entrytext - text of the link
• page - if set, the entry is added to the named blog page. The default is the current page.

Since:

1.9.21

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_BLOGNAME Parameter name for setting the page Value is "page".
static java.lang.String	PARAM_ENTRYTEXT Parameter name for setting the entrytext Value is "entrytext".

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

CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

Constructors

Constructor and Description
WeblogEntryPlugin()

Method Summary

Modifier and Type	Method and Description
java.lang.String	execute(Context context, java.util.Map<java.lang.String,java.lang.String> params)
java.lang.String	getNewEntryPage(Engine engine, java.lang.String blogName) Returns a new page name for entries.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_ENTRYTEXT

public static final java.lang.String PARAM_ENTRYTEXT

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

See Also:

Constant Field Values

PARAM_BLOGNAME

public static final java.lang.String PARAM_BLOGNAME

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

See Also:

Constant Field Values

Constructor Detail

WeblogEntryPlugin

public WeblogEntryPlugin()

Method Detail

getNewEntryPage

public java.lang.String getNewEntryPage(Engine engine,
                                        java.lang.String blogName)
                                 throws ProviderException

Returns a new page name for entries. It goes through the list of all blog pages, and finds out the next in line.

Parameters:

engine - A Engine

blogName - The page (or blog) name.

Returns:

A new name.

Throws:

ProviderException - If something goes wrong.

execute

public java.lang.String execute(Context context,
                                java.util.Map<java.lang.String,java.lang.String> params)
                         throws PluginException

Specified by:

execute in interface Plugin

Throws:

PluginException