org.blojsom.plugin.weblogsping
Class WeblogsPingPlugin

java.lang.Object
  org.blojsom.plugin.weblogsping.WeblogsPingPlugin

All Implemented Interfaces:

Listener, Plugin

public class WeblogsPingPlugin

extends java.lang.Object

implements Listener, Plugin

WeblogsPingPlugin

Since:

blojsom 3.0

Version:

$Id: WeblogsPingPlugin.java,v 1.6 2007/01/17 02:35:15 czarneckid Exp $

Author:

David Czarnecki

Field Summary

static java.lang.String	BLOG_PING_URLS_IP
static java.lang.String	NO_PING_WEBLOGS_METADATA
static java.lang.String	PLUGIN_WEBLOGS_PING_FEED_URL_IP

Constructor Summary

WeblogsPingPlugin()
Default constructor

Method Summary

void	cleanup() Perform any cleanup for the plugin.
void	destroy() Called when BlojsomServlet is taken out of service
void	handleEvent(Event event) Handle an event broadcast from another component
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	processEvent(Event event) Process an event from another component
void	setEventBroadcaster(EventBroadcaster eventBroadcaster) Set the EventBroadcaster event broadcaster

Methods inherited from class java.lang.Object

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

Field Detail

BLOG_PING_URLS_IP

public static final java.lang.String BLOG_PING_URLS_IP

See Also:

Constant Field Values

NO_PING_WEBLOGS_METADATA

public static final java.lang.String NO_PING_WEBLOGS_METADATA

See Also:

Constant Field Values

PLUGIN_WEBLOGS_PING_FEED_URL_IP

public static final java.lang.String PLUGIN_WEBLOGS_PING_FEED_URL_IP

See Also:

Constant Field Values

Constructor Detail

WeblogsPingPlugin

public WeblogsPingPlugin()

Default constructor

Method Detail

setEventBroadcaster

public void setEventBroadcaster(EventBroadcaster eventBroadcaster)

Set the EventBroadcaster event broadcaster

Parameters:

eventBroadcaster - EventBroadcaster

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

handleEvent

public void handleEvent(Event event)

Handle an event broadcast from another component

Specified by:

handleEvent in interface Listener

Parameters:

event - Event to be handled

processEvent

public void processEvent(Event event)

Process an event from another component

Specified by:

processEvent in interface Listener

Parameters:

event - Event to be handled

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