org.blojsom.plugin.textile
Class TextilePlugin

java.lang.Object
  extended byorg.blojsom.plugin.textile.TextilePlugin
All Implemented Interfaces:
BlojsomPlugin

public class TextilePlugin
extends java.lang.Object
implements BlojsomPlugin

Textile Plugin An implementation of the Textism's Textile. See http://www.textism.com/tools/textile

Since:
blojsom 1.9
Version:
$Id: TextilePlugin.java,v 1.7 2006/02/22 20:44:51 czarneckid Exp $
Author:
Mark Lussier

Field Summary
static java.lang.String METADATA_RUN_TEXTILE
          MetaData Key to identify a Textile post
static java.lang.String TEXTILE_EXTENSION
          Extension of Textile Post
 
Constructor Summary
TextilePlugin()
           
 
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.
 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

METADATA_RUN_TEXTILE

public static final java.lang.String METADATA_RUN_TEXTILE
MetaData Key to identify a Textile post

See Also:
Constant Field Values

TEXTILE_EXTENSION

public static final java.lang.String TEXTILE_EXTENSION
Extension of Textile Post

See Also:
Constant Field Values
Constructor Detail

TextilePlugin

public TextilePlugin()
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