org.blojsom.plugin.referer
Class RefererLogPlugin

java.lang.Object
  org.blojsom.plugin.referer.RefererLogPlugin

All Implemented Interfaces:

BlojsomPlugin

public class RefererLogPlugin

extends java.lang.Object

implements BlojsomPlugin

Generic Referer Plugin

Version:

$Id: RefererLogPlugin.java,v 1.11 2006/02/17 16:53:09 czarneckid Exp $

Author:

Mark Lussier, David Czarnecki

Field Summary

static java.lang.String	REFERER_CONTEXT_MAX_LENGTH Key under which the "REFERER_MAX_LENGTH" will be placed into the context (example: on the request for the JSPDispatcher)
static java.lang.String	REFERER_CONTEXT_NAME Key under which the "REFERER_HISTORY" groups will be place into the context (example: on the request for the JSPDispatcher)
static java.lang.String	REFERER_DATE_FORMAT Format used to store last refer date for a given url

Constructor Summary

RefererLogPlugin()

Method Summary

void	cleanup() Perform any cleanup for the plugin.
void	destroy() Called when BlojsomServlet is taken out of service
static java.lang.String	getRefererDate(java.util.Date date) Converts a Date into a String for writing to the referer log
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

Methods inherited from class java.lang.Object

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

Field Detail

REFERER_DATE_FORMAT

public static final java.lang.String REFERER_DATE_FORMAT

Format used to store last refer date for a given url

See Also:

Constant Field Values

REFERER_CONTEXT_NAME

public static final java.lang.String REFERER_CONTEXT_NAME

Key under which the "REFERER_HISTORY" groups will be place into the context (example: on the request for the JSPDispatcher)

See Also:

Constant Field Values

REFERER_CONTEXT_MAX_LENGTH

public static final java.lang.String REFERER_CONTEXT_MAX_LENGTH

Key under which the "REFERER_MAX_LENGTH" will be placed into the context (example: on the request for the JSPDispatcher)

See Also:

Constant Field Values

Constructor Detail

RefererLogPlugin

public RefererLogPlugin()

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.

Specified by:

init in interface BlojsomPlugin

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

Specified by:

process in interface BlojsomPlugin

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

Specified by:

cleanup in interface BlojsomPlugin

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

Specified by:

destroy in interface BlojsomPlugin

Throws:

BlojsomPluginException - If there is an error in finalizing this plugin

getRefererDate

public static java.lang.String getRefererDate(java.util.Date date)

Converts a Date into a String for writing to the referer log

Parameters:

date - Date to write

Returns:

String verion of date in the format of yyyy-MM-dd