org.blojsom.plugin.nofollow
Class NoFollowPlugin

java.lang.Object
  extended byorg.blojsom.plugin.nofollow.NoFollowPlugin
All Implemented Interfaces:
BlojsomPlugin

public class NoFollowPlugin
extends java.lang.Object
implements BlojsomPlugin

NoFollow plugin adds support for the rel="nofollow" attribute on links added to comments and trackbacks.

Since:
blojsom 2.23
Version:
$Id: NoFollowPlugin.java,v 1.3 2006/01/04 16:53:12 czarneckid Exp $
Author:
David Czarnecki

Constructor Summary
NoFollowPlugin()
          Construct a new instance of the NoFollow plugin
 
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.
protected  java.lang.String noFollowFy(java.lang.String text)
          Take a string and add rel="nofollow" attributes to the <a href/> links if they are not already on the links.
 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
 

Constructor Detail

NoFollowPlugin

public NoFollowPlugin()
Construct a new instance of the NoFollow plugin

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

noFollowFy

protected java.lang.String noFollowFy(java.lang.String text)
Take a string and add rel="nofollow" attributes to the <a href/> links if they are not already on the links.

Parameters:
text - Text to look for hyperlinks
Returns:
Text with rel="nofollow" attributes added to the hyperlinks

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