org.blojsom.plugin.moderation.admin
Class IPAddressModerationAdminPlugin

java.lang.Object
  org.blojsom.plugin.admin.BaseAdminPlugin
      org.blojsom.plugin.admin.WebAdminPlugin
          org.blojsom.plugin.moderation.admin.IPAddressModerationAdminPlugin

All Implemented Interfaces:

PermissionedPlugin, Plugin

public class IPAddressModerationAdminPlugin

extends WebAdminPlugin

IP address moderation administration plugin

Since:

blojsom 3.0

Version:

$Id: IPAddressModerationAdminPlugin.java,v 1.3 2007/02/27 16:42:53 czarneckid Exp $

Author:

David Czarnecki

Field Summary

Fields inherited from class org.blojsom.plugin.admin.BaseAdminPlugin

_authorizationProvider, _ignoreParams, _resourceManager, _servletConfig, ACTION_PARAM, ADMIN_ADMINISTRATION_PAGE, ADMIN_AJAX_RESPONSE, ADMIN_LOGIN_PAGE, BLOJSOM_ADMIN_MESSAGES_RESOURCE, BLOJSOM_ADMIN_PLUGIN_AUTHENTICATED_KEY, BLOJSOM_ADMIN_PLUGIN_OPERATION_RESULT, BLOJSOM_ADMIN_PLUGIN_PASSWORD_PARAM, BLOJSOM_ADMIN_PLUGIN_USERNAME, BLOJSOM_ADMIN_PLUGIN_USERNAME_KEY, BLOJSOM_ADMIN_PLUGIN_USERNAME_PARAM, BLOJSOM_PERMISSION_CHECKER, BLOJSOM_USER_AUTHENTICATED, LOGIN_ACTION, LOGIN_ERROR_TEXT_KEY, LOGOUT_ACTION, PAGE_ACTION, PLUGIN_ADMIN_INHERIT_APACHE_CREDENTIALS, SUBACTION_PARAM

Constructor Summary

IPAddressModerationAdminPlugin()
Create a new instance of the IP address moderation administration plugin

Method Summary

java.lang.String	getDisplayName() Return the display name for the plugin
java.lang.String	getInitialPage() Return the name of the initial editing page for the plugin
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	setFetcher(Fetcher fetcher) Set the Fetcher

Methods inherited from class org.blojsom.plugin.admin.BaseAdminPlugin

addOperationResultMessage, authenticateUser, checkPermission, cleanup, destroy, formatAdminResource, getAdminResource, getUsernameFromSession, setAuthorizationProvider, setResourceManager, setServletConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

IPAddressModerationAdminPlugin

public IPAddressModerationAdminPlugin()

Create a new instance of the IP address moderation administration plugin

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Return the display name for the plugin

Specified by:

getDisplayName in class WebAdminPlugin

Returns:

Display name for the plugin

getInitialPage

public java.lang.String getInitialPage()

Return the name of the initial editing page for the plugin

Specified by:

getInitialPage in class WebAdminPlugin

Returns:

Name of the initial editing page for the plugin

setFetcher

public void setFetcher(Fetcher fetcher)

Set the Fetcher

Parameters:

fetcher - Fetcher

init

public void init()
          throws PluginException

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

Specified by:

init in interface Plugin

Overrides:

init in class BaseAdminPlugin

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

Overrides:

process in class WebAdminPlugin

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

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