org.blojsom.plugin.markup
Class MarkupSelectionPlugin

java.lang.Object
  org.blojsom.plugin.markup.MarkupSelectionPlugin

All Implemented Interfaces:

BlojsomListener, BlojsomPlugin

public class MarkupSelectionPlugin

extends java.lang.Object

implements BlojsomPlugin, BlojsomListener

Markup selection plugin allows an individual to select a markup filter to apply to their blog entry.

Since:

blojsom 2.24

Version:

$Id: MarkupSelectionPlugin.java,v 1.4 2006/01/04 16:53:12 czarneckid Exp $

Author:

David Czarnecki

Constructor Summary

MarkupSelectionPlugin()
Create a new instance of the markup selection plugin

Method Summary

void	cleanup() Perform any cleanup for the plugin.
void	destroy() Called when BlojsomServlet is taken out of service
void	handleEvent(BlojsomEvent event) Handle an event broadcast from another component
void	init(javax.servlet.ServletConfig servletConfig, BlojsomConfiguration blojsomConfiguration) Initialize this plugin.
BlogEntry[]	process(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, BlogUser user, java.util.Map context, BlogEntry[] entries) Process the blog entries
void	processEvent(BlojsomEvent event) Process an event from another component

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkupSelectionPlugin

public MarkupSelectionPlugin()

Create a new instance of the markup selection plugin

Method Detail

init

public void init(javax.servlet.ServletConfig servletConfig,
                 BlojsomConfiguration blojsomConfiguration)
          throws BlojsomPluginException

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

Specified by:

init in interface BlojsomPlugin

Parameters:

servletConfig - Servlet config object for the plugin to retrieve any initialization parameters

blojsomConfiguration - BlojsomConfiguration information

Throws:

BlojsomPluginException - If there is an error initializing the plugin

process

public BlogEntry[] process(javax.servlet.http.HttpServletRequest httpServletRequest,
                           javax.servlet.http.HttpServletResponse httpServletResponse,
                           BlogUser user,
                           java.util.Map context,
                           BlogEntry[] entries)
                    throws BlojsomPluginException

Process the blog entries

Specified by:

process in interface BlojsomPlugin

Parameters:

httpServletRequest - Request

httpServletResponse - Response

user - BlogUser instance

context - Context

entries - Blog entries retrieved for the particular request

Returns:

Modified set of blog entries

Throws:

BlojsomPluginException - If there is an error processing the blog entries

cleanup

public void cleanup()
             throws BlojsomPluginException

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

Specified by:

cleanup in interface BlojsomPlugin

Throws:

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

destroy

public void destroy()
             throws BlojsomPluginException

Called when BlojsomServlet is taken out of service

Specified by:

destroy in interface BlojsomPlugin

Throws:

BlojsomPluginException - If there is an error in finalizing this plugin

handleEvent

public void handleEvent(BlojsomEvent event)

Handle an event broadcast from another component

Specified by:

handleEvent in interface BlojsomListener

Parameters:

event - BlojsomEvent to be handled

processEvent

public void processEvent(BlojsomEvent event)

Process an event from another component

Specified by:

processEvent in interface BlojsomListener

Parameters:

event - BlojsomEvent to be handled

Since:

blojsom 2.24