com.ecyrd.jspwiki.plugin
Class WeblogEntryPlugin

java.lang.Object
  extended by com.ecyrd.jspwiki.plugin.WeblogEntryPlugin
All Implemented Interfaces:
WikiPlugin

public class WeblogEntryPlugin
extends Object
implements WikiPlugin

Builds a simple weblog.

Since:
1.9.21

Field Summary
static int MAX_BLOG_ENTRIES
           
static String PARAM_ENTRYTEXT
           
 
Constructor Summary
WeblogEntryPlugin()
           
 
Method Summary
 String execute(WikiContext context, Map params)
          This is the main entry point for any plugin.
 String getNewEntryPage(WikiEngine engine, String blogName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAX_BLOG_ENTRIES

public static final int MAX_BLOG_ENTRIES
See Also:
Constant Field Values

PARAM_ENTRYTEXT

public static final String PARAM_ENTRYTEXT
See Also:
Constant Field Values
Constructor Detail

WeblogEntryPlugin

public WeblogEntryPlugin()
Method Detail

getNewEntryPage

public String getNewEntryPage(WikiEngine engine,
                              String blogName)
                       throws ProviderException
Throws:
ProviderException

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.