org.blojsom.plugin.admin
Class ThemeUploadPlugin

java.lang.Object
  org.blojsom.plugin.admin.ThemeUploadPlugin

All Implemented Interfaces:

BlojsomListener, BlojsomPlugin

public class ThemeUploadPlugin

extends java.lang.Object

implements BlojsomPlugin, BlojsomListener

ThemeUploadPlugin

Since:

blojsom 2.26

Version:

$Id: ThemeUploadPlugin.java,v 1.3 2006/01/04 16:52:59 czarneckid Exp $

Author:

David Czarnecki

Field Summary

protected static java.lang.String

BLOJSOM_ADMIN_PLUGIN_OPERATION_RESULT

Constructor Summary

ThemeUploadPlugin()
Create a new instance of the theme upload plugin

Method Summary

protected void	addOperationResultMessage(java.util.Map context, java.lang.String message) Adds a message to the context under the BLOJSOM_ADMIN_PLUGIN_OPERATION_RESULT key
void	cleanup() Perform any cleanup for the plugin.
protected java.lang.String	createThemeOutputFilename(java.lang.String theme, java.lang.String file) Create an appropriate filename for a theme file
void	destroy() Called when BlojsomServlet is taken out of service
void	handleEvent(BlojsomEvent event) Handle an event broadcast from another component
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
void	processEvent(BlojsomEvent event) Process an event from another component
protected void	writeThemeFile(java.lang.String themeFilename, java.io.InputStream themeFileInputStream) Write a theme file

Methods inherited from class java.lang.Object

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

Field Detail

BLOJSOM_ADMIN_PLUGIN_OPERATION_RESULT

protected static final java.lang.String BLOJSOM_ADMIN_PLUGIN_OPERATION_RESULT

See Also:

Constant Field Values

Constructor Detail

ThemeUploadPlugin

public ThemeUploadPlugin()

Create a new instance of the theme upload 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

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

handleEvent

public void handleEvent(BlojsomEvent event)

Handle an event broadcast from another component

Specified by:

handleEvent in interface BlojsomListener

Parameters:

event - BlojsomEvent to be handled

addOperationResultMessage

protected void addOperationResultMessage(java.util.Map context,
                                         java.lang.String message)

Adds a message to the context under the BLOJSOM_ADMIN_PLUGIN_OPERATION_RESULT key

Parameters:

context - Context

message - Message to add

processEvent

public void processEvent(BlojsomEvent event)

Process an event from another component

Specified by:

processEvent in interface BlojsomListener

Parameters:

event - BlojsomEvent to be handled

Since:

blojsom 2.24

writeThemeFile

protected void writeThemeFile(java.lang.String themeFilename,
                              java.io.InputStream themeFileInputStream)
                       throws java.io.IOException

Write a theme file

Parameters:

themeFilename - Theme filename

themeFileInputStream - Theme filename input stream

Throws:

java.io.IOException - If there is an error writing the theme file

createThemeOutputFilename

protected java.lang.String createThemeOutputFilename(java.lang.String theme,
                                                     java.lang.String file)

Create an appropriate filename for a theme file

Parameters:

theme - Theme name

file - Theme filename

Returns:

File appropriate for a theme file