com.dpslink.flash.servlet.admin

Class AdmTestSiteEmails

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.base.servlet.BaseServlet

com.dpslink.flash.servlet.FlashServlet

com.dpslink.flash.servlet.MainServlet

com.dpslink.flash.servlet.admin.AdmTestSiteEmails

All Implemented Interfaces:

FileUploadListener, java.io.Serializable, java.util.EventListener, javax.servlet.Servlet, javax.servlet.ServletConfig

public class AdmTestSiteEmails
extends MainServlet
implements FileUploadListener

Writes and processes the admin test site messages page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdmTestSiteEmails.Context Inner class used to store servlet context information.

Nested classes/interfaces inherited from class com.dpslink.flash.servlet.FlashServlet

FlashServlet.Stack

Field Summary

Fields

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

Fields inherited from class com.dpslink.flash.servlet.MainServlet

DISPLAY_MODE, SN_ADMINMODE, SN_CATEGORIES, SN_CATEGORIES_LISTONLY, SN_CATEGORIES_PATH, SN_CATEGORY, SN_CONTINUE_PAGEURL, SN_PRODUCTS, SN_PRODUCTS_INSTOCK, SN_PRODUCTS_NOSTOCK, SN_PRODUCTS_PAFILTERS, SN_PRODUCTS_PAGEHIST, SN_PRODUCTS_PAGENUM, SN_PRODUCTS_PAGEURL, SOURCE_CATALOG, SOURCE_FAVORITES, SOURCE_SEARCH, SOURCE_SHOPCART, SOURCE_SPECIAL

Fields inherited from class com.dpslink.flash.servlet.FlashServlet

SN_CART, SN_LOGON_STATUS, SN_SECPROFILE, SN_USER, SN_USERSFI

Fields inherited from class com.dpslink.base.servlet.BaseServlet

BROWSER_IE, BROWSER_NN, BROWSER_XX, RESP_NULL, RESP_REDIRECTED, RQST_AJAX, RQST_NULL

Constructor Summary

Constructors

Constructor and Description
AdmTestSiteEmails()

Method Summary

Modifier and Type	Method and Description
protected void	ajaxRequest(AdmTestSiteEmails.Context ctx) Handles processing for an AJAX request.
protected void	ajaxRequestUpdate(AdmTestSiteEmails.Context ctx) Handles processing for an AJAX request for user update.
protected void	ajaxRequestUserIds(AdmTestSiteEmails.Context ctx) Handles processing for an AJAX request for user ids.
protected void	ajaxRequestVersions(AdmTestSiteEmails.Context ctx) Handles processing for an AJAX request for template versions.
protected void	ajaxResponse(AdmTestSiteEmails.Context ctx, java.lang.String respdata) Handles sending a response for an AJAX request.
private boolean	configuredFileExists(java.lang.String type, java.lang.String extension) Answers if a file exists for the given message type and file extension based on configured values in properties.
protected MainServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected boolean	editFormFields(BaseServlet.Context baseCtx) Edits the values from the html template's form fields.
private java.io.File	getConfiguredFile(java.lang.String type, java.lang.String extension) Returns the file for the given message type and file extension based on configured values in properties.
private java.util.ArrayList<java.lang.String>	getConfiguredTypes() Returns a collection of the configured message type property keys.
private org.apache.velocity.VelocityContext	getMessageContent(AdmTestSiteEmails.Context ctx, java.lang.String type) Returns the content for a message type.
private void	getMessageContentExtra(AdmTestSiteEmails.Context ctx, java.lang.String type, org.apache.velocity.VelocityContext content) Retrieves and sets any extra content for a message type.
protected java.lang.String	getNextURL(BaseServlet.Context baseCtx) Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.).
private Customer	getSampleBillto(AdmTestSiteEmails.Context ctx) Returns a Customer object using values from the configured sample data spreadsheet file.
private Order	getSampleOrder(AdmTestSiteEmails.Context ctx) Returns an ERP Order object using values from the configured sample data spreadsheet file.
private RestockNotification	getSampleRestock(AdmTestSiteEmails.Context ctx, java.lang.String type) Returns a Restock Notification object using values from the configured sample data spreadsheet file.
private Shipper	getSampleShipper(AdmTestSiteEmails.Context ctx) Returns a Shipper object using values from the configured sample data spreadsheet file.
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
private java.util.ArrayList<java.lang.String>	getTemplateVersions(java.lang.String tmpid, java.lang.String dlvmeth) Returns the versions for a template id and delivery method (email,sms,push) from the Notification Framework.
private boolean	isValidSendRequest(AdmTestSiteEmails.Context ctx) Answers if a Send request is valid based on the known information at the time the request is made.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
protected void	resetFormFields(BaseServlet.Context baseCtx) Resets the values for the html template's form fields.
private boolean	sendConfiguredSample(AdmTestSiteEmails.Context ctx) Sends a sample message for a configured file.
private boolean	sendPlainTextSample(AdmTestSiteEmails.Context ctx) Sends a sample message for a plain text message type.
private boolean	sendSpecifiedSample(AdmTestSiteEmails.Context ctx, boolean upload) Sends a sample message for a specified file.
protected void	setCookieValues(BaseServlet.Context baseCtx) Adds one or more values to the http session cookies.
protected void	setSessionValues(BaseServlet.Context baseCtx) Adds one or more values to the http session object.
protected void	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
protected void	setTemplateDataNF(AdmTestSiteEmails.Context ctx) Sets the various data required by the html template when the notification framework is active.
protected boolean	setTemplateError(AdmTestSiteEmails.Context ctx, java.lang.String errName) Sets the html template error fields for the given error name.
void	uploadComplete(FileUploadEvent event) Handles a file upload completion event.

Methods inherited from class com.dpslink.flash.servlet.MainServlet

confirmSession, getPreviousCategoryList, getPreviousCategoryPath, hasSubcategories, hasSubcategories, isOmitNoStock, isPreshopRequest, isUserHelpRequest, setTemplateCategoryPath, sortCategoryProductData, writePageImpl

Methods inherited from class com.dpslink.flash.servlet.FlashServlet

confirmCart, confirmRequest, confirmRetail, confirmWholesale, createNewCart, createNewSessionImpl, getPageTitle, getServletPath, getUser, initTemplateDataImpl, isLogonRequest, requestComplete, requiresLogon, resetCart, resetCategories, resetProducts, setDefaultUser, setSessionCart, setSFIShoppingUser, useExistingSessionImpl, writeCookie

Methods inherited from class com.dpslink.base.servlet.BaseServlet

createNewSession, determineBrowser, doGet, doPost, getCookie, getInvokerName, getInvokerName, getInvokerParams, getInvokerParams, getInvokerPath, getInvokerPath, getInvokerURL, getPageParams, getRequestURL, getServletName, getServletName, getServletParams, getServletParams, getServletPath, getServletURL, getServletURL, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, initTemplateData, isPrintable, isServerTomcat, log, qualifyURL, redirectURL, setP3PCompactPolicy, showSiteError, showSiteError, showSiteError, useExistingSession, writeCookie, writeTempCookie

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

AdmTestSiteEmails

public AdmTestSiteEmails()

Method Detail

editFormFields

protected boolean editFormFields(BaseServlet.Context baseCtx)

Edits the values from the html template's form fields. Invoked by the doPost method. Overrides editFormFields in BaseServlet.

Specified by:

editFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

boolean - true if all the edits are successful, otherwise false.

getNextURL

protected java.lang.String getNextURL(BaseServlet.Context baseCtx)

Returns the next URL (including parameters) to be processed when this servlet's processing has been successfully completed (no edit errors, etc.). Invoked by the writeURL method. Overrides getNextURL in BaseServlet.

Specified by:

getNextURL in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The URL.

getTemplateName

protected java.lang.String getTemplateName(BaseServlet.Context baseCtx)

Returns the name of the html template file used by the servlet. Invoked by the writePage method. Overrides getTemplateName in BaseServlet.

Specified by:

getTemplateName in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The html template's name.

readParameters

protected void readParameters(BaseServlet.Context baseCtx,
                              boolean post)

Reads the parameters passed to the servlet via the http request object. Invoked by the doGet and doPost method. Overrides readParameters in BaseServlet.

Specified by:

readParameters in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

post - (boolean) true if the method is invoked from doPost, otherwise false.

resetFormFields

protected void resetFormFields(BaseServlet.Context baseCtx)

Resets the values for the html template's form fields. Invoked by the doGet and doPost methods. Overrides resetFormFields in BaseServlet.

Specified by:

resetFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setCookieValues

protected void setCookieValues(BaseServlet.Context baseCtx)
                        throws java.io.IOException

Adds one or more values to the http session cookies. Invoked by the writeURL method. Calls should be made to writeCookie for each cookie that needs to be set. Overrides setCookieValues in BaseServlet.

Specified by:

setCookieValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs when adding the cookie to the response header.

setSessionValues

protected void setSessionValues(BaseServlet.Context baseCtx)

Adds one or more values to the http session object. Invoked by the writeURL method. Overrides setSessionValues in BaseServlet.

Specified by:

setSessionValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setTemplateData

protected void setTemplateData(BaseServlet.Context baseCtx)

Sets the various data required by the html template. Invoked by the writePage method. Overrides setTemplateData in BaseServlet.

Specified by:

setTemplateData in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setTemplateDataNF

protected void setTemplateDataNF(AdmTestSiteEmails.Context ctx)

Sets the various data required by the html template when the notification framework is active. Invoked by the setTemplateData method.

Parameters:

ctx - (Context) The current servlet context.

uploadComplete

public void uploadComplete(FileUploadEvent event)

Handles a file upload completion event. Sent to file upload event listeners when an attempt has been made to upload a file (success or failure).

Specified by:

uploadComplete in interface FileUploadListener

Parameters:

event - (FileUploadEvent) The upload event to process.

setTemplateError

protected boolean setTemplateError(AdmTestSiteEmails.Context ctx,
                                   java.lang.String errName)

Sets the html template error fields for the given error name.

Parameters:

ctx - (Context) The current servlet context.

errName - (String) The name of error that is to be set, used to determine which message (or messages) to retrieve from the message properties.

Returns:

boolean - Always returns false.

configuredFileExists

private boolean configuredFileExists(java.lang.String type,
                                     java.lang.String extension)

Answers if a file exists for the given message type and file extension based on configured values in properties.

Parameters:

type - (String) The message type to be checked.

extension - (String) The file extension to be checked.

Returns:

boolean - true if a file exists for the given message type and file extension, otherwise false.

getConfiguredFile

private java.io.File getConfiguredFile(java.lang.String type,
                                       java.lang.String extension)

Returns the file for the given message type and file extension based on configured values in properties.

Parameters:

type - (String) The message type for the configured file.

extension - (String) The file extension for the configured file.

Returns:

File - The configured file for the specified message type and file extension, or null if the specified message type has no configured file.

getConfiguredTypes

private java.util.ArrayList<java.lang.String> getConfiguredTypes()

Returns a collection of the configured message type property keys.

Returns:

ArrayList - The message type property keys (MailMessage.orderconf, MailMessage.shipconf, etc.).

getMessageContent

private org.apache.velocity.VelocityContext getMessageContent(AdmTestSiteEmails.Context ctx,
                                                              java.lang.String type)

Returns the content for a message type.

Parameters:

ctx - (Context) The current servlet context.

type - (String) The type of message for the desired content.

Returns:

VelocityContext - The message content.

getMessageContentExtra

private void getMessageContentExtra(AdmTestSiteEmails.Context ctx,
                                    java.lang.String type,
                                    org.apache.velocity.VelocityContext content)

Retrieves and sets any extra content for a message type. Extra content is defined as semicolon delimited name/value pairs in the customer's override properties using the "AdmTestSiteEmails.extra.[msgtype].n" properties key, where [msgtype] is the message type suffix (sans MailMessage.) and "n" is an incremented line number.

Parameters:

ctx - (Context) The current servlet context.

type - (String) The type of message for the desired content.

content - (VelocityContext) The current message content.

getSampleBillto

private Customer getSampleBillto(AdmTestSiteEmails.Context ctx)

Returns a Customer object using values from the configured sample data spreadsheet file.

Parameters:

ctx - (Context) The current servlet context.

Returns:

Customer - The Customer object.

getSampleOrder

private Order getSampleOrder(AdmTestSiteEmails.Context ctx)

Returns an ERP Order object using values from the configured sample data spreadsheet file.

Parameters:

ctx - (Context) The current servlet context.

Returns:

Order - The ERP Order object.

getSampleRestock

private RestockNotification getSampleRestock(AdmTestSiteEmails.Context ctx,
                                             java.lang.String type)

Returns a Restock Notification object using values from the configured sample data spreadsheet file.

Parameters:

ctx - (Context) The current servlet context.

type - (String) The current message type being processed. Will either be MailMessage.LOWSTOCK or MailMessage.RESTOCK.

Returns:

RestockNotification - The Restock Notification object.

getSampleShipper

private Shipper getSampleShipper(AdmTestSiteEmails.Context ctx)

Returns a Shipper object using values from the configured sample data spreadsheet file.

Parameters:

ctx - (Context) The current servlet context.

Returns:

Shipper - The Shipper object.

getTemplateVersions

private java.util.ArrayList<java.lang.String> getTemplateVersions(java.lang.String tmpid,
                                                                  java.lang.String dlvmeth)

Returns the versions for a template id and delivery method (email,sms,push) from the Notification Framework.

Parameters:

tmpid - (String) The template id for the desired versions.

dlvmeth - (String) The delivery method for the desired versions.

Returns:

ArrayList - The retrieved versions.

isValidSendRequest

private boolean isValidSendRequest(AdmTestSiteEmails.Context ctx)

Answers if a Send request is valid based on the known information at the time the request is made.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the request is valid, otherwise false.

sendConfiguredSample

private boolean sendConfiguredSample(AdmTestSiteEmails.Context ctx)
                              throws java.lang.Exception

Sends a sample message for a configured file.

Parameters:

ctx - (Context) The current servlet context.

Returns:

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

Throws:

java.lang.Exception - - if an error occurs while attempting to send the sample.

sendSpecifiedSample

private boolean sendSpecifiedSample(AdmTestSiteEmails.Context ctx,
                                    boolean upload)
                             throws java.lang.Exception

Sends a sample message for a specified file.

Parameters:

ctx - (Context) The current servlet context.

upload - (boolean) true to perform the file upload processing, otherwise false to send the sample message.

Returns:

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

Throws:

java.lang.Exception - - if an error occurs while attempting to send the sample.

sendPlainTextSample

private boolean sendPlainTextSample(AdmTestSiteEmails.Context ctx)
                             throws java.lang.Exception

Sends a sample message for a plain text message type.

Parameters:

ctx - (Context) The current servlet context.

Returns:

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

Throws:

java.lang.Exception - - if an error occurs while attempting to send the sample.

ajaxRequest

protected void ajaxRequest(AdmTestSiteEmails.Context ctx)

Handles processing for an AJAX request.

Parameters:

ctx - (Context) The current servlet context.

ajaxRequestUserIds

protected void ajaxRequestUserIds(AdmTestSiteEmails.Context ctx)

Handles processing for an AJAX request for user ids.

THIS METHOD IS NEVER INVOKED. IT WAS ORGINALLY CREATED WHEN A DIFFERENT APPROACH TO DEFINING A USER ID FOR TESTING WAS PLANNED.

Parameters:

ctx - (Context) The current servlet context.

ajaxRequestUpdate

protected void ajaxRequestUpdate(AdmTestSiteEmails.Context ctx)

Handles processing for an AJAX request for user update.

Parameters:

ctx - (Context) The current servlet context.

ajaxRequestVersions

protected void ajaxRequestVersions(AdmTestSiteEmails.Context ctx)

Handles processing for an AJAX request for template versions.

Parameters:

ctx - (Context) The current servlet context.

ajaxResponse

protected void ajaxResponse(AdmTestSiteEmails.Context ctx,
                            java.lang.String respdata)

Handles sending a response for an AJAX request.

Parameters:

ctx - (Context) The current servlet context.

respdata - (String) The response data as a string.

createContext

protected MainServlet.Context createContext(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)

Creates the servlet context inner class. Overrides createContext in MainServlet. Invoked by doPost and doGet methods.

Overrides:

createContext in class MainServlet

Parameters:

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

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

Returns:

Context - The servlet context.