org.blojsom.plugin.admin
Class ForgottenPasswordPlugin

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

All Implemented Interfaces:

PermissionedPlugin, Plugin

public class ForgottenPasswordPlugin

extends BaseAdminPlugin

Forgotten password plugin

Since:

blojsom 3.0

Version:

$Id: ForgottenPasswordPlugin.java,v 1.4 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

ForgottenPasswordPlugin()
Default constructor.

Method Summary

void	cleanup() Perform any cleanup for the plugin.
void	destroy() Called when BlojsomServlet is taken out of service
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	setFetcher(Fetcher fetcher) Set the Fetcher
protected void	setupEmail(Blog blog, User user, org.apache.commons.mail.Email email) Setup the comment e-mail

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

addOperationResultMessage, authenticateUser, checkPermission, 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

ForgottenPasswordPlugin

public ForgottenPasswordPlugin()

Default constructor.

Method Detail

setFetcher

public void setFetcher(Fetcher fetcher)

Set the Fetcher

Parameters:

fetcher - Fetcher

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

setupEmail

protected void setupEmail(Blog blog,
                          User user,
                          org.apache.commons.mail.Email email)
                   throws org.apache.commons.mail.EmailException

Setup the comment e-mail

Parameters:

blog - Blog information

user - User

email - Email message

Throws:

org.apache.commons.mail.EmailException - If there is an error preparing the e-mail message

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

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

Overrides:

cleanup in class BaseAdminPlugin

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

Overrides:

destroy in class BaseAdminPlugin

Throws:

PluginException - If there is an error in finalizing this plugin