com.dpslink.flash.servlet

Class EmailUser

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.flash.servlet.EmailUser

All Implemented Interfaces:

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

public class EmailUser
extends javax.servlet.http.HttpServlet

Internally used servlet for sending email to a web site user. This servlet is typically requested by the backend system to send order confirmation and shipment confirmation emails.

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
EmailUser()

Method Summary

Modifier and Type	Method and Description
protected void	addTemplateValues(org.apache.velocity.VelocityContext content, java.lang.String values) Parses values passed from the backend and places them into the email content data.
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 boolean	isValidOrder(java.lang.String userid, java.lang.String type, java.lang.String orderref, java.lang.String orderid, Order order) Answers if the email request is for a valid order or quote.
protected boolean	sendEmail(ThreadServletContext ctx, java.lang.String type, java.lang.String ref, java.lang.String shipNum, Order order, java.lang.String values, boolean copyReps, boolean debug) Sends email to the address specified by the user object.
protected boolean	setOrderConfirmationCC(ThreadServletContext ctx, Order order, FlashMailMessage email) Sets the CC (or BCC) recipients for an order confirmation.
protected boolean	setOrderConfirmationData(ThreadServletContext ctx, org.apache.velocity.VelocityContext content, Order order) Sets additional email content data for an order confirmation.
protected boolean	setShipConfirmationData(ThreadServletContext ctx, org.apache.velocity.VelocityContext content, Order order, java.lang.String shipNum) Sets additional email content data for a shipment confirmation.
protected void	updateOrderAudit(ThreadServletContext ctx, java.lang.String type, java.lang.String ref, java.lang.String orderId) Updates confirmation timestamp and order id in audit record, only for order and quote confirmations.

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

EmailUser

public EmailUser()

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. Should never be executed. If a get is called on this servlet, return a message that it is for internal use only.

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.

addTemplateValues

protected void addTemplateValues(org.apache.velocity.VelocityContext content,
                                 java.lang.String values)

Parses values passed from the backend and places them into the email content data.

Parameters:

content - (VelocityContext) The email content object.

values - (String) The values passed from backend containing data in the form: tag1=value1:tag2=value2:...

isValidOrder

protected boolean isValidOrder(java.lang.String userid,
                               java.lang.String type,
                               java.lang.String orderref,
                               java.lang.String orderid,
                               Order order)
                        throws java.lang.Exception

Answers if the email request is for a valid order or quote. An order/quote is considered invalid if 1) it does not exist in the backend system, 2) its status is invoiced, canceled or completed, 3) its order date is more than a year old.

Returns:

boolean - true if the order/quote is deemed valid, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while validating the order/quote.

sendEmail

protected boolean sendEmail(ThreadServletContext ctx,
                            java.lang.String type,
                            java.lang.String ref,
                            java.lang.String shipNum,
                            Order order,
                            java.lang.String values,
                            boolean copyReps,
                            boolean debug)
                     throws java.lang.Exception

Sends email to the address specified by the user object. Email text, subject, and other information are retrieved from properties.

Parameters:

ctx - (ThreadServletContext) The current context.

type - (String) The type of confirmation being sent.

ref - (String) The unique Flash assigned reference number for the order.

shipNum - (String) The shipment number for shipping confirmations.

order - (Order) The order created by the backend system.

values - (String) Template tag values passed from backend.

copyReps - (boolean) Flag to stop sales reps from being copied.

debug - (boolean) The debug flag.

Returns:

boolean - true if the email was send without error, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while sending the email.

setOrderConfirmationCC

protected boolean setOrderConfirmationCC(ThreadServletContext ctx,
                                         Order order,
                                         FlashMailMessage email)
                                  throws java.lang.Exception

Sets the CC (or BCC) recipients for an order confirmation.

Parameters:

ctx - (ThreadServletContext) The current context.

order - (Order) The order for the confirmation.

email - (FlashMailMessage) The order confirmation.

Returns:

boolean - true success or false failure.

Throws:

java.lang.Exception - - if an error occurs during processing.

setOrderConfirmationData

protected boolean setOrderConfirmationData(ThreadServletContext ctx,
                                           org.apache.velocity.VelocityContext content,
                                           Order order)

Sets additional email content data for an order confirmation.

Parameters:

ctx - (ThreadServletContext) The current context.

content - (VelocityContext) The email content object.

order - (Order) The order for the confirmation.

Returns:

boolean - true success or false failure.

setShipConfirmationData

protected boolean setShipConfirmationData(ThreadServletContext ctx,
                                          org.apache.velocity.VelocityContext content,
                                          Order order,
                                          java.lang.String shipNum)

Sets additional email content data for a shipment confirmation.

Parameters:

ctx - (ThreadServletContext) The current context.

content - (VelocityContext) The email content object.

order - (Order) The order for the confirmation.

shipNum - (String) Then shipment number for the shipment.

Returns:

boolean - true success or false failure.

updateOrderAudit

protected void updateOrderAudit(ThreadServletContext ctx,
                                java.lang.String type,
                                java.lang.String ref,
                                java.lang.String orderId)

Updates confirmation timestamp and order id in audit record, only for order and quote confirmations.

Parameters:

ctx - (ThreadServletContext) The current context.

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

ref - (String) The unique Flash assigned reference number for the order.

orderId - (String) The backend assigned order number.