com.dpslink.flash.servlet

Class EmailForm

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.flash.servlet.EmailForm

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class EmailForm
extends javax.servlet.http.HttpServlet

Accepts generic HTML form data and emails the data to a configured recipient.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
EmailForm()

Method Summary

Modifier and Type	Method and Description
protected void	doForm(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Processes the form.
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP GET requests.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP POST requests.
protected java.lang.String	getString(java.lang.String type, java.lang.String key) Returns a String value for the given properties key.
protected java.lang.String[]	getStringArray(java.lang.String type, java.lang.String key, java.lang.String delim) Returns a String array for the given properties key.
protected void	sendError(javax.servlet.http.HttpServletResponse response, java.lang.String errcode) Sends an error page to the user because the form cannot be processed.
protected boolean	sendMail(java.lang.String type, java.io.File template, org.apache.velocity.VelocityContext data) Creates and sends a form's data to the form type's configured recipient.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

EmailForm

public EmailForm()

Method Detail

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws java.io.IOException,
                  javax.servlet.ServletException

Handles HTTP GET requests. Invoked by the servlet API.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException,
                   javax.servlet.ServletException

Handles HTTP POST requests. Invoked by the servlet API.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

doForm

protected void doForm(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.io.IOException,
                      javax.servlet.ServletException

Processes the form.

Parameters:

request - (HttpServletRequest) The servlet's incoming request.

response - (HttpServletResponse) The servlet's outgoing response.

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

javax.servlet.ServletException - - if an error occurs while processing the request or response.

sendMail

protected boolean sendMail(java.lang.String type,
                           java.io.File template,
                           org.apache.velocity.VelocityContext data)

Creates and sends a form's data to the form type's configured recipient.

Parameters:

type - (String) The type of form being processed.

template - (File) The email template to use for the email.

data - (VelocityContext) The variable data to merge into the template.

Returns:

boolean - true if the email is successfully sent, otherwise false.

sendError

protected void sendError(javax.servlet.http.HttpServletResponse response,
                         java.lang.String errcode)
                  throws java.io.IOException

Sends an error page to the user because the form cannot be processed.

Parameters:

response - (HttpServletResponse) The servlet's outgoing response.

errcode - (String) The error code to show on the error page.

Throws:

java.io.IOException - - if an error occurs while processing the request or response.

getString

protected java.lang.String getString(java.lang.String type,
                                     java.lang.String key)

Returns a String value for the given properties key.

Parameters:

type - (String) The form type for the desired property value.

key - (String) The key for the desired property value.

Returns:

String - The property value for the given key or the key itself if missing.

getStringArray

protected java.lang.String[] getStringArray(java.lang.String type,
                                            java.lang.String key,
                                            java.lang.String delim)

Returns a String array for the given properties key.

Parameters:

type - (String) The form type for the desired property value.

key - (String) The key for the desired property value.

delim - (String) The delimiter to be used for the parsing.

Returns:

String[] - The property array for the given key or the key itself if missing.