org.blojsom.plugin
Interface BlojsomPlugin

All Known Implementing Classes:

AbstractCalendarPlugin, AkismetModerationPlugin, AllEntriesPlugin, ArrayToolPlugin, AssociatedCategoriesPlugin, AutoTrackbackPlugin, BaseAdminPlugin, CategoryTemplatePlugin, ChronoPlugin, CollectionUtilitiesPlugin, CommentModerationPlugin, ConditionalGetPlugin, ConvertLineBreaksPlugin, CrosspostPlugin, DateFormatPlugin, DateToolPlugin, DaysSincePostedPlugin, EmoticonsPlugin, EnhancedEmoticonsPlugin, EntriesLimiterPlugin, ExcerptPlugin, ExtendedListToolPlugin, FetcherHelperPlugin, FootnotePlugin, GoogleHighlightPlugin, GroovyPlugin, HyperlinkURLPlugin, ImportToolPlugin, InternalAggregatorPlugin, IPAddressModerationPlugin, IPBanningPlugin, IteratorToolPlugin, LanguageSelectionPlugin, LinkSpamModerationPlugin, ListToolPlugin, MacroExpansionPlugin, MarkdownPlugin, MarkupSelectionPlugin, MathToolPlugin, MetaPlugin, NoFollowPlugin, OpenProxyModerationPlugin, PermissionCheckPlugin, PingbackPlugin, PluginHelperPlugin, PreviewPlugin, RecentCommentsPlugin, RefererLogPlugin, RenderToolPlugin, RSSEnclosurePlugin, SendEmailPlugin, ShowMeMorePlugin, SimpleObfuscationPlugin, SimpleSearchPlugin, SpamPhraseModerationPlugin, StandaloneVelocityPlugin, StringUtilitiesPlugin, TagCloudPlugin, TextilePlugin, ThemeUploadPlugin, TrackbackModerationPlugin, WeatherPlugin, WeblogsPingPlugin, WikiPlugin, WordCountPlugin, XPathPlugin, XSSFilterPlugin

public interface BlojsomPlugin

BlojsomPlugin

Version:

$Id: BlojsomPlugin.java,v 1.5 2006/01/04 16:59:54 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(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

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.

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

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

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

Throws:

BlojsomPluginException - If there is an error in finalizing this plugin