org.blojsom.plugin.comment
Class CommentModerationPlugin

java.lang.Object
  org.blojsom.plugin.comment.CommentModerationPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

MathCommentAuthenticationPlugin

public class CommentModerationPlugin

extends java.lang.Object

implements Plugin

Comment moderation plugin

Since:

blojsom 3.0

Version:

$Id: CommentModerationPlugin.java,v 1.3 2007/01/17 02:35:08 czarneckid Exp $

Author:

David Czarnecki

Field Summary

static java.lang.String	BLOJSOM_COMMENT_MODERATION_PLUGIN_APPROVED
static java.lang.String	COMMENT_MODERATION_ENABLED

Constructor Summary

CommentModerationPlugin()
Construct a new comment moderation 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.
protected void	moderateComment(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, Blog blog, java.util.Map context, Entry[] entries) Simple check to see if comment moderation is enabled
Entry[]	process(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse, Blog blog, java.util.Map context, Entry[] entries) Process the blog entries

Methods inherited from class java.lang.Object

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

Field Detail

COMMENT_MODERATION_ENABLED

public static final java.lang.String COMMENT_MODERATION_ENABLED

See Also:

Constant Field Values

BLOJSOM_COMMENT_MODERATION_PLUGIN_APPROVED

public static final java.lang.String BLOJSOM_COMMENT_MODERATION_PLUGIN_APPROVED

See Also:

Constant Field Values

Constructor Detail

CommentModerationPlugin

public CommentModerationPlugin()

Construct a new comment moderation plugin

Method Detail

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

moderateComment

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

Simple check to see if comment moderation is enabled

Parameters:

httpServletRequest - Request

httpServletResponse - Response

context - Context

entries - Blog entries retrieved for the particular request

Throws:

PluginException - If there is an error in moderating a comment

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