org.blojsom.plugin.common
Class FileAttachmentPlugin

java.lang.Object
  org.blojsom.plugin.common.FileAttachmentPlugin

All Implemented Interfaces:

Listener, Plugin

public class FileAttachmentPlugin

extends java.lang.Object

implements Plugin, Listener

FileAttachmentPlugin-The idea behind this plugin is taken from RSSEnclosure plugin.

Since:

Blojsom Version 3.0

Version:

1.0

Author:

Sopan Shewale

Nested Class Summary

class

FileAttachmentPlugin.FileAttachment File Attachment

Field Summary

protected java.util.Properties	_blojsomProperties
protected EventBroadcaster	_eventBroadcaster
protected java.lang.String	_resourcesDirectory
protected javax.servlet.ServletConfig	_servletConfig

Constructor Summary

FileAttachmentPlugin()
Default constructor

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.
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	setBlojsomProperties(java.util.Properties blojsomProperties) Set the default blojsom properties
void	setEventBroadcaster(EventBroadcaster eventBroadcaster) Set the EventBroadcaster
void	setServletConfig(javax.servlet.ServletConfig servletConfig) Set the ServletConfig

Methods inherited from class java.lang.Object

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

Field Detail

_eventBroadcaster

protected EventBroadcaster _eventBroadcaster

_servletConfig

protected javax.servlet.ServletConfig _servletConfig

_blojsomProperties

protected java.util.Properties _blojsomProperties

_resourcesDirectory

protected java.lang.String _resourcesDirectory

Constructor Detail

FileAttachmentPlugin

public FileAttachmentPlugin()

Default constructor

Method Detail

setBlojsomProperties

public void setBlojsomProperties(java.util.Properties blojsomProperties)

Set the default blojsom properties

Parameters:

blojsomProperties - Default blojsom properties

setServletConfig

public void setServletConfig(javax.servlet.ServletConfig servletConfig)

Set the ServletConfig

Parameters:

servletConfig - ServletConfig

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

processEvent

public void processEvent(Event event)

Process an event from another component

Specified by:

processEvent in interface Listener

Parameters:

event - Event to be handled