org.blojsom.plugin
Interface Plugin

All Known Implementing Classes:

AbstractCalendarPlugin, AkismetModerationPlugin, ArrayToolPlugin, AutoTrackbackPlugin, BaseAdminPlugin, ChronoPlugin, CollectionUtilitiesPlugin, CommentModerationPlugin, ConditionalGetPlugin, ConvertLineBreaksPlugin, CountEntriesForCategoryPlugin, DateFormatPlugin, DateToolPlugin, DaysSincePostedPlugin, EnhancedEmoticonsPlugin, ExcerptPlugin, ExtendedListToolPlugin, FileAttachmentPlugin, FootnotePlugin, GoogleHighlightPlugin, GroovyPlugin, HyperlinkURLPlugin, ImportToolPlugin, InternalAggregatorPlugin, IPAddressModerationPlugin, IteratorToolPlugin, LanguageSelectionPlugin, LinkSpamModerationPlugin, ListToolPlugin, MacroExpansionPlugin, MarkdownPlugin, MarkupSelectionPlugin, MathToolPlugin, MetaPlugin, NoFollowPlugin, OpenProxyModerationPlugin, PermissionCheckPlugin, PingbackPlugin, PreviewPlugin, PreviousEntriesPlugin, RecentCommentsPlugin, RecentPingbacksPlugin, RecentTrackbacksPlugin, RenderToolPlugin, RSSEnclosurePlugin, ShowMeMorePlugin, SimpleObfuscationPlugin, SimpleSearchPlugin, SkipFilterHelperPlugin, SpamPhraseModerationPlugin, StandaloneVelocityPlugin, StringUtilitiesPlugin, TagCloudPlugin, TextilePlugin, TrackbackModerationPlugin, TwitterNotificationPlugin, WeatherPlugin, WeblogsPingPlugin, WidgetPlugin, WikiPlugin, WordCountPlugin, XPathPlugin, XSSFilterPlugin

public interface Plugin

Plugin

Since:

blojsom 3.0

Version:

$Id: Plugin.java,v 1.2 2007/01/17 02:35:18 czarneckid Exp $

Author:

David Czarnecki

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

Method Detail

init

public void init()
          throws PluginException

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

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

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[]).

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

Throws:

PluginException - If there is an error in finalizing this plugin