org.blojsom.plugin.previous
Class PreviousEntriesPlugin

java.lang.Object
  org.blojsom.plugin.previous.PreviousEntriesPlugin

All Implemented Interfaces:

Plugin

public class PreviousEntriesPlugin

extends java.lang.Object

implements Plugin

Previous entries plugin

Since:

blojsom 3.2

Version:

$Id: PreviousEntriesPlugin.java,v 1.1 2007/04/02 23:46:29 czarneckid Exp $

Author:

David Czarnecki, Cliffano Subagio

Field Summary

static java.lang.String	PLUGIN_CONTEXT_PREVIOUS_ENTRIES Context name for the previous entries to pass to template.
static java.lang.String	PLUGIN_PREVIOUS_ENTRIES_NUM Plugin property for the number of previous entries to load.

Constructor Summary

PreviousEntriesPlugin()
Create a new instance of the plugin

Method Summary

void	cleanup() Perform any cleanup for the plugin.
void	destroy() Called when BlojsomServlet is taken out of service
void	init() Initialize this plugin.
Entry[]	process(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, Blog blog, java.util.Map context, Entry[] entries) Process the blog entries
void	setFetcher(Fetcher fetcher) Set the Fetcher

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_CONTEXT_PREVIOUS_ENTRIES

public static final java.lang.String PLUGIN_CONTEXT_PREVIOUS_ENTRIES

Context name for the previous entries to pass to template.

See Also:

Constant Field Values

PLUGIN_PREVIOUS_ENTRIES_NUM

public static final java.lang.String PLUGIN_PREVIOUS_ENTRIES_NUM

Plugin property for the number of previous entries to load.

See Also:

Constant Field Values

Constructor Detail

PreviousEntriesPlugin

public PreviousEntriesPlugin()

Create a new instance of the plugin

Method Detail

setFetcher

public void setFetcher(Fetcher fetcher)

Set the Fetcher

Parameters:

fetcher - Fetcher

init

public void init()
          throws PluginException

Initialize this plugin. This method only called when the plugin is instantiated.

Specified by:

init in interface Plugin

Throws:

PluginException - If there is an error initializing the plugin

process

public Entry[] process(javax.servlet.http.HttpServletRequest httpServletRequest,
                       javax.servlet.http.HttpServletResponse httpServletResponse,
                       Blog blog,
                       java.util.Map context,
                       Entry[] entries)
                throws PluginException

Process the blog entries

Specified by:

process in interface Plugin

Parameters:

httpServletRequest - Request

httpServletResponse - Response

blog - Blog instance

context - Context

entries - Blog entries retrieved for the particular request

Returns:

Modified set of blog entries

Throws:

PluginException - If there is an error processing the blog entries

cleanup

public void cleanup()
             throws PluginException

Perform any cleanup for the plugin. Called after process(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, org.blojsom.blog.Blog, java.util.Map, org.blojsom.blog.Entry[]).

Specified by:

cleanup in interface Plugin

Throws:

PluginException - If there is an error performing cleanup for this plugin

destroy

public void destroy()
             throws PluginException

Called when BlojsomServlet is taken out of service

Specified by:

destroy in interface Plugin

Throws:

PluginException - If there is an error in finalizing this plugin