org.wandora.modules.servlet

Class SendEmailAction

java.lang.Object

org.wandora.modules.AbstractModule

org.wandora.modules.ScriptModule

org.wandora.modules.servlet.AbstractAction

org.wandora.modules.servlet.CachedAction

org.wandora.modules.servlet.GenericTemplateAction

org.wandora.modules.servlet.SendEmailAction

All Implemented Interfaces:

Module, ActionHandler, ServletModule.RequestListener

Direct Known Subclasses:

PasswordResendAction

public class SendEmailAction
extends GenericTemplateAction

Sends an email composed using a template. This action extends GenericTemplateAction but behaves a bit differently than most of them. The template is used to compose the email, not to send a response to the actual action. In fact, no response is ever sent to the http request, instead you have to use this action through a ChainedAction and respond in the next action in the chain. Also note that this action extends CachedAction via GenericTemplateAction but does not in fact support caching. If you try to turn on caching, a warning is written to the log and caching is turned off. In fact, handleAction is overridden in such a way that no caching will take place regardless of whether it's turned on or not.

Author:

olli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SendEmailAction.EmailContent

Nested classes/interfaces inherited from class org.wandora.modules.servlet.CachedAction

CachedAction.OutputProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected EmailModule	email
protected java.lang.String	from
protected boolean	parseFrom
protected boolean	parseRecipients
protected boolean	parseSubject
protected java.lang.String	recipients
protected java.lang.String	subject

Fields inherited from class org.wandora.modules.servlet.GenericTemplateAction

defaultRequestParameters, forwardRequestParameters, requestContextKey, staticContext, templateKey, templateManager

Fields inherited from class org.wandora.modules.servlet.CachedAction

cache, caching, threadPool

Fields inherited from class org.wandora.modules.servlet.AbstractAction

actionParamKey, handledActions, httpHeaders, isDefaultAction, replacements, replacementsInitialized, servletModule

Fields inherited from class org.wandora.modules.ScriptModule

engine, initScript, persistentObjects, scriptManager, startScript, stopScript

Fields inherited from class org.wandora.modules.AbstractModule

autoStart, isInitialized, isRunning, logging, loggingModule, moduleManager

Constructor Summary

Constructors

Constructor and Description
SendEmailAction()

Method Summary

Modifier and Type	Method and Description
protected boolean	doOutput(javax.servlet.http.HttpServletRequest req, ModulesServlet.HttpMethod method, java.lang.String action, CachedAction.OutputProvider out, User user) Does the output that might be either cached or returned directly.
java.util.Collection<Module>	getDependencies(ModuleManager manager) Returns all the modules this module depends on.
boolean	handleAction(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, ModulesServlet.HttpMethod method, java.lang.String action, User user) Handles this action.
void	init(ModuleManager manager, java.util.HashMap<java.lang.String,java.lang.Object> settings) Initialises the module.
static SendEmailAction.EmailContent	parseEmail(byte[] bytes, java.lang.String encoding, boolean parseRecipients, boolean parseSubject, boolean parseFrom)
protected boolean	parseOutputAndSend(byte[] bytes, java.lang.String contentType, java.lang.String encoding)
protected void	returnOutput(java.io.InputStream cacheIn, javax.servlet.http.HttpServletResponse resp) Writes a page read from an input stream into an HTTP servlet response.
void	start(ModuleManager manager) Starts the module.
void	stop(ModuleManager manager) Stops the module.

Methods inherited from class org.wandora.modules.servlet.GenericTemplateAction

getCacheKey, getCacheKeyParams, getForwardedParameters, getStaticTemplateContext, getTemplate, getTemplateContext, putStaticContext

Methods inherited from class org.wandora.modules.servlet.CachedAction

buildCacheKey, readMetadata, writeMetadata

Methods inherited from class org.wandora.modules.servlet.AbstractAction

addHandledAction, doReplacements, handleRequest, isHandleAction, setActionParamKey, setHttpHeaders

Methods inherited from class org.wandora.modules.ScriptModule

getScriptEngine

Methods inherited from class org.wandora.modules.AbstractModule

isInitialized, isRunning, requireLogging, toString

Methods inherited from class java.lang.Object

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

Field Detail

email

protected EmailModule email

from

protected java.lang.String from

subject

protected java.lang.String subject

recipients

protected java.lang.String recipients

parseSubject

protected boolean parseSubject

parseRecipients

protected boolean parseRecipients

parseFrom

protected boolean parseFrom

Constructor Detail

SendEmailAction

public SendEmailAction()

Method Detail

getDependencies

public java.util.Collection<Module> getDependencies(ModuleManager manager)
                                             throws ModuleException

Description copied from interface: Module

Returns all the modules this module depends on. This method will be called after init and the dependencies are allowed to depend on the parameters passed to init. The modules that this module depends on must be returned as a collection. In addition, if any required module is not present, a MissingDependencyException should be thrown. Typically you will use the requireModule and optionalModule methods of the manager to make sure that the modules exist and add them to the collection. requireModule will automatically throw the exception too if the module is not found whereas optionalModule does not.

Specified by:

getDependencies in interface Module

Overrides:

getDependencies in class GenericTemplateAction

Parameters:

manager - The module manager handling this module.

Returns:

A collection of modules this module depends on.

Throws:

ModuleException

init

public void init(ModuleManager manager,
                 java.util.HashMap<java.lang.String,java.lang.Object> settings)
          throws ModuleException

Description copied from interface: Module

Initialises the module. After constructor, this is the first method called in the life cycle of a module. It should not perform anything time consuming or anything with notable outside side effects. It should only read the parameters and initialise the module so that it can later be started. Note that a module being initialised doesn't mean that it necessarily will ever be started.

A ModuleException may be thrown if something vital is missing from the parameters or they are not sensible. In some cases you may not want to throw an exception even if vital initialisation information is missing. If, for example, it is possible that the module is initialised in some other way between the init and the start method calls. A ModuleException may also be thrown at the start method if the module is still not initialised.

Specified by:

init in interface Module

Overrides:

init in class GenericTemplateAction

Parameters:

manager - The module manager handling this module. You may keep a reference to it if needed.

Throws:

ModuleException

start

public void start(ModuleManager manager)
           throws ModuleException

Description copied from interface: Module

Starts the module. This will be called after init and getDependencies and signals that the module should now begin to perform whatever it was designed to do. This method call however should not block for long, so any time consuming tasks should be started in their own threads. You will typically get references to the required modules again in start using the findModule method of the manager and then store those references to instance variables for later use. You may throw a ModuleException if the module is not in a state where it can be started or it immediately becomes obvious that it cannot be started with the provided settings.

Specified by:

start in interface Module

Overrides:

start in class GenericTemplateAction

Parameters:

manager - The module manager handling this module.

Throws:

ModuleException

stop

public void stop(ModuleManager manager)

Description copied from interface: Module

Stops the module. Should stop all threads used by the module, free any large data structures and perform other cleanup. It is possible that the module will be started again later with a start method call (and foregoing init and getDependencies calls). The module should be left in a state where this is possible.

Specified by:

stop in interface Module

Overrides:

stop in class GenericTemplateAction

Parameters:

manager - The module manager handling this module.

parseEmail

public static SendEmailAction.EmailContent parseEmail(byte[] bytes,
                                                      java.lang.String encoding,
                                                      boolean parseRecipients,
                                                      boolean parseSubject,
                                                      boolean parseFrom)
                                               throws java.io.IOException

Throws:

java.io.IOException

parseOutputAndSend

protected boolean parseOutputAndSend(byte[] bytes,
                                     java.lang.String contentType,
                                     java.lang.String encoding)
                              throws java.io.IOException

Throws:

java.io.IOException

handleAction

public boolean handleAction(javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse resp,
                            ModulesServlet.HttpMethod method,
                            java.lang.String action,
                            User user)
                     throws javax.servlet.ServletException,
                            java.io.IOException,
                            ActionException

Description copied from class: AbstractAction

Handles this action. Prior to calling this action, it's already been determined that this action should try to handle the action by either matching the action request parameter with the action id of this action, or this being the default action. Perform any operations needed here and then write the response into the response object. You will typically want to call setHttpHeaders to set the HTTP headers in the response after you know that you definitely will handle the request but before you write anything else into the response stream. If for whatever reason this method shouldn't handle the request after all, return false. Otherwise return true.

Overrides:

handleAction in class CachedAction

Parameters:

req - The HTTP Request.

resp - The HTTP response.

method - The HTTP method of the request.

action - The parsed action id.

user - The logged in user, or null if not applicable.

Returns:

True if the action was handled and a response sent. False otherwise in which case other actions may try to handle this action.

Throws:

javax.servlet.ServletException

java.io.IOException

ActionException

returnOutput

protected void returnOutput(java.io.InputStream cacheIn,
                            javax.servlet.http.HttpServletResponse resp)
                     throws java.io.IOException

Description copied from class: CachedAction

Writes a page read from an input stream into an HTTP servlet response. The input stream might be coming from a cached file, or directly from the doOutput method if caching is not in use. In any case, the contents of it need to be written to the response object. Note that any HTTP headers must be set before writing anything else.

If you used writeMetadata in doOutput, you have to override this method and use readMetadata correspondingly to read the metadata from the start of the stream. You can then, for example, set any HTTP headers you read from the metadata. After this, you can call this super implementation which will do the rest of the stream copying.

Make absolutely certain that the input stream is closed before returning from this method. Failing to do so may cause the caching service to become locked which can then lock the whole application. It is best to put the contents in a try-finally block and then call cacheIn.close in the finally part. Do this even if you call the super implementation as your code could possibly fail before reaching that part.

Overrides:

returnOutput in class GenericTemplateAction

Throws:

java.io.IOException

doOutput

protected boolean doOutput(javax.servlet.http.HttpServletRequest req,
                           ModulesServlet.HttpMethod method,
                           java.lang.String action,
                           CachedAction.OutputProvider out,
                           User user)
                    throws javax.servlet.ServletException,
                           java.io.IOException

Description copied from class: CachedAction

Does the output that might be either cached or returned directly. The OutputProvider is used to get the output stream where the output should be written. Before you get this stream, you may abort the action by returning false but after the output stream is retrieved, you are committed to outputting the page that then might be cached for future use. Therefore you should do all the preparations first, and only then get the output stream when you know that you will be able to output something sensible.

If you opened the output stream using the output provider, you must make sure that the stream is properly closed. It is best to place all your code after this in a try-finally block and close the stream in the finally part. Failing to do this may cause the caching service to become locked, which in turn could potentially lock the whole application.

Overrides:

doOutput in class GenericTemplateAction

Throws:

javax.servlet.ServletException

java.io.IOException