org.blojsom.plugin.moderation
Class IPAddressModerationPlugin

java.lang.Object
  extended byorg.blojsom.plugin.moderation.IPAddressModerationPlugin
All Implemented Interfaces:
Listener, Plugin

public class IPAddressModerationPlugin
extends java.lang.Object
implements Plugin, Listener

IP address moderation plugin

Since:
blojsom 3.0
Version:
$Id: IPAddressModerationPlugin.java,v 1.2 2007/01/17 02:35:12 czarneckid Exp $
Author:
David Czarnecki

Constructor Summary
IPAddressModerationPlugin()
          Create a new instance of the IP address moderation plugin
 
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.
protected  java.util.List loadIPList(Blog blog, java.lang.String property)
          Load the list of IP addresses from whitelist or blacklist from the blog properties
 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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IPAddressModerationPlugin

public IPAddressModerationPlugin()
Create a new instance of the IP address moderation plugin

Method Detail

setEventBroadcaster

public void setEventBroadcaster(EventBroadcaster eventBroadcaster)
Set the EventBroadcaster

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

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

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

loadIPList

protected java.util.List loadIPList(Blog blog,
                                    java.lang.String property)
Load the list of IP addresses from whitelist or blacklist from the blog properties

Parameters:
blog - Blog
property - Whitelist or Blacklist property
Returns:
List of IP addresses

processEvent

public void processEvent(Event event)
Process an event from another component

Specified by:
processEvent in interface Listener
Parameters:
event - Event to be handled