org.blojsom.plugin.admin
Class EditBlogTemplatesPlugin

java.lang.Object
  org.blojsom.plugin.admin.BaseAdminPlugin
      org.blojsom.plugin.admin.EditBlogTemplatesPlugin

All Implemented Interfaces:

PermissionedPlugin, Plugin

public class EditBlogTemplatesPlugin

extends BaseAdminPlugin

EditBlogTemplatesPlugin

Since:

blojsom 3.0

Version:

$Id: EditBlogTemplatesPlugin.java,v 1.6 2007/01/17 02:35:05 czarneckid Exp $

Author:

David Czarnecki

Field Summary

Fields inherited from class org.blojsom.plugin.admin.BaseAdminPlugin

_authorizationProvider, _ignoreParams, _resourceManager, _servletConfig, ACTION_PARAM, ADMIN_ADMINISTRATION_PAGE, ADMIN_AJAX_RESPONSE, ADMIN_LOGIN_PAGE, BLOJSOM_ADMIN_MESSAGES_RESOURCE, BLOJSOM_ADMIN_PLUGIN_AUTHENTICATED_KEY, BLOJSOM_ADMIN_PLUGIN_OPERATION_RESULT, BLOJSOM_ADMIN_PLUGIN_PASSWORD_PARAM, BLOJSOM_ADMIN_PLUGIN_USERNAME, BLOJSOM_ADMIN_PLUGIN_USERNAME_KEY, BLOJSOM_ADMIN_PLUGIN_USERNAME_PARAM, BLOJSOM_PERMISSION_CHECKER, BLOJSOM_USER_AUTHENTICATED, LOGIN_ACTION, LOGIN_ERROR_TEXT_KEY, LOGOUT_ACTION, PAGE_ACTION, PLUGIN_ADMIN_INHERIT_APACHE_CREDENTIALS, SUBACTION_PARAM

Constructor Summary

EditBlogTemplatesPlugin()
Default constructor.

Method Summary

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
protected void	putTemplateDirectoriesInContext(java.io.File templatesDirectory, java.util.Map context) Put the list of template directories in the context
protected void	putTemplatesInContext(java.io.File templatesDirectory, java.util.Map context) Put the list of template files in the context
protected java.lang.String	sanitizeFilename(java.lang.String blogTemplate) Sanitize a filename
void	setBlojsomProperties(java.util.Properties blojsomProperties) Set the default blojsom properties
void	setTemplateEditProperties(java.util.Properties templateEditProperties) Set the template editing properties

Methods inherited from class org.blojsom.plugin.admin.BaseAdminPlugin

addOperationResultMessage, authenticateUser, checkPermission, cleanup, destroy, formatAdminResource, getAdminResource, getUsernameFromSession, setAuthorizationProvider, setResourceManager, setServletConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

EditBlogTemplatesPlugin

public EditBlogTemplatesPlugin()

Default constructor.

Method Detail

setTemplateEditProperties

public void setTemplateEditProperties(java.util.Properties templateEditProperties)

Set the template editing properties

Parameters:

templateEditProperties - Template editing properties

setBlojsomProperties

public void setBlojsomProperties(java.util.Properties blojsomProperties)

Set the default blojsom properties

Parameters:

blojsomProperties - Default blojsom properties

init

public void init()
          throws PluginException

Initialize this plugin. This method only called when the plugin is instantiated.

Specified by:

init in interface Plugin

Overrides:

init in class BaseAdminPlugin

Throws:

PluginException - If there is an error initializing the plugin

sanitizeFilename

protected java.lang.String sanitizeFilename(java.lang.String blogTemplate)

Sanitize a filename

Parameters:

blogTemplate - Blog template filename

Returns:

Sanitized filename or null if error in sanitizing

putTemplatesInContext

protected void putTemplatesInContext(java.io.File templatesDirectory,
                                     java.util.Map context)

Put the list of template files in the context

Parameters:

templatesDirectory - Templates directory

context - Context

putTemplateDirectoriesInContext

protected void putTemplateDirectoriesInContext(java.io.File templatesDirectory,
                                               java.util.Map context)

Put the list of template directories in the context

Parameters:

templatesDirectory - Templates directory

context - Context

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

Overrides:

process in class BaseAdminPlugin

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