com.dpslink.flash.servlet

Class FlashServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.base.servlet.BaseServlet

com.dpslink.flash.servlet.FlashServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

Logoff, MainServlet, ScriptRequest

public abstract class FlashServlet
extends BaseServlet

An abstract extension of BaseServlet that provides default functionality for Flash-specific servlet processing and defines method signatures for specific servlet requirements.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FlashServlet.Context Inner class used to store servlet context information.
class	FlashServlet.Stack Inner class used to store servlet request information.

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.
protected static java.lang.String	SN_CART The session's key for the shopping cart.
protected static java.lang.String	SN_LOGON_STATUS The session's key for the logon status.
protected static java.lang.String	SN_SECPROFILE The session's key for the current security profile.
protected static java.lang.String	SN_USER The session's key for the current user.
protected static java.lang.String	SN_USERSFI The session's key for the current SFI/CSR selected user.

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

Method Summary

Modifier and Type	Method and Description
protected boolean	confirmCart(FlashServlet.Context ctx) Determines if a shopping cart is associated with the current user session.
protected int	confirmRequest(FlashServlet.Context ctx) Determines if a servlet is being accessed with a valid request id.
protected int	confirmRetail(FlashServlet.Context ctx) Determines if the servlet is being accessed within the context of a valid retail user session.
protected int	confirmSession(BaseServlet.Context baseCtx) Determines if the servlet is being accessed within the context of a valid user session.
protected int	confirmWholesale(FlashServlet.Context ctx) Determines if the servlet is being accessed within the context of a valid wholesale user session.
protected BaseServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected void	createNewCart(FlashServlet.Context ctx) Creates a new shopping cart and attaches it to the current session.
protected void	createNewSessionImpl(BaseServlet.Context baseCtx) Provides additional application-specific functionality for creating a new session.
protected java.lang.String	getPageTitle(BaseServlet.Context baseCtx) Returns the title of the servlet page to be displayed to the user.
protected java.lang.String	getServletPath(BaseServlet.Context ctx, boolean inclSlash) Returns the current servlet's path.
protected User	getUser(FlashServlet.Context ctx, java.lang.String userid) Returns a User object for the given user id.
protected void	initTemplateDataImpl(BaseServlet.Context baseCtx, org.apache.velocity.VelocityContext vc, boolean cookies) Provides additional application-specific functionality for initializing a new set of Velocity template data.
protected boolean	isLogonRequest(FlashServlet.Context ctx) Answers if the current request is for a logon servlet.
protected void	requestComplete(BaseServlet.Context baseCtx, boolean post) Handles completion processing for a request, such as any housekeeping tasks that might need to be performed after all other processing for a request has been completed.
protected boolean	requiresLogon(BaseServlet.Context baseCtx) Answers if the servlet requires a valid non-default user to log on in order to continue processing.
protected void	resetCart(FlashServlet.Context ctx) Resets various shopping cart values and forces a refresh of the cart's cart lines.
protected void	resetCategories(FlashServlet.Context ctx, boolean newlist, boolean listonly) Resets the session values that control the display of the product categories list.
protected void	resetProducts(FlashServlet.Context ctx) Resets the session values that control the display of products.
protected boolean	setDefaultUser(FlashServlet.Context ctx) Sets the current session to point to the default user or to the user saved as a cookie from a previous session's logon.
protected void	setSessionCart(FlashServlet.Context ctx, Cart cart, boolean newCart) Sets the session's shopping cart to the given cart.
protected void	setSFIShoppingUser(FlashServlet.Context ctx, User user) Sets the SFI/CSR shopping user (the sales rep's selected account).
protected void	useExistingSessionImpl(BaseServlet.Context baseCtx) Provides additional application-specific functionality for using an existing session.
protected void	writeCookie(BaseServlet.Context baseCtx, java.lang.String name, java.lang.String value) Adds a given cookie name and value to the response header and sets the cookie to expire based on the value for "Site.Cookie.Expires" or the value for "Store.Cart.Expires" or to a quasi-permanent default of one year.
protected void	writePageImpl(BaseServlet.Context baseCtx) Provides additional application-specific functionality for writing a page.

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

createNewSession, determineBrowser, doGet, doPost, editFormFields, getCookie, getInvokerName, getInvokerName, getInvokerParams, getInvokerParams, getInvokerPath, getInvokerPath, getInvokerURL, getNextURL, getPageParams, getRequestURL, getServletName, getServletName, getServletParams, getServletParams, getServletPath, getServletURL, getServletURL, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateMessage, getTemplateName, initTemplateData, isPrintable, isServerTomcat, log, qualifyURL, readParameters, redirectURL, resetFormFields, setCookieValues, setP3PCompactPolicy, setSessionValues, setTemplateData, 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

SN_CART

protected static final java.lang.String SN_CART

The session's key for the shopping cart.

See Also:

Constant Field Values

SN_LOGON_STATUS

protected static final java.lang.String SN_LOGON_STATUS

The session's key for the logon status.

See Also:

Constant Field Values

SN_SECPROFILE

protected static final java.lang.String SN_SECPROFILE

The session's key for the current security profile.

See Also:

Constant Field Values

SN_USER

protected static final java.lang.String SN_USER

The session's key for the current user.

See Also:

Constant Field Values

SN_USERSFI

protected static final java.lang.String SN_USERSFI

The session's key for the current SFI/CSR selected user.

See Also:

Constant Field Values

Constructor Detail

FlashServlet

public FlashServlet()

Method Detail

confirmSession

protected int confirmSession(BaseServlet.Context baseCtx)
                      throws java.io.IOException

Determines if the servlet is being accessed within the context of a valid user session. Invoked by the doGet and doPost methods. Overrides confirmSession in BaseServlet.

Overrides:

confirmSession in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

int - -1 if error, 0 if redirected, 1 okay.

Throws:

java.io.IOException - - if an error occurs while confirming the user session.

createNewSessionImpl

protected void createNewSessionImpl(BaseServlet.Context baseCtx)

Provides additional application-specific functionality for creating a new session. Invoked by the createNewSession method. Overrides createNewSessionImpl in BaseServlet.

Specified by:

createNewSessionImpl in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

useExistingSessionImpl

protected void useExistingSessionImpl(BaseServlet.Context baseCtx)

Provides additional application-specific functionality for using an existing session. Invoked by the useExistingSession method. Overrides useExistingSessionImpl in BaseServlet.

Specified by:

useExistingSessionImpl in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

getPageTitle

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

Returns the title of the servlet page to be displayed to the user. Invoked by the writePage method. This implementation retrieves the title from the servlet's html template. Overrides getPageTitle in BaseServlet.

Overrides:

getPageTitle in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The page's title.

getServletPath

protected java.lang.String getServletPath(BaseServlet.Context ctx,
                                          boolean inclSlash)

Returns the current servlet's path. Does not include protocol, host, port and any parameters. Overrides getServletPath in BaseServlet.

Overrides:

getServletPath in class BaseServlet

Parameters:

ctx - (Context) The current servlet context.

inclSlash - (boolean) true to include the leading slash, otherwise false.

Returns:

String - The servlet's path.

initTemplateDataImpl

protected void initTemplateDataImpl(BaseServlet.Context baseCtx,
                                    org.apache.velocity.VelocityContext vc,
                                    boolean cookies)

Provides additional application-specific functionality for initializing a new set of Velocity template data. Invoked by the initTemplateData method. Overrides initTemplateDataImpl in BaseServlet.

Specified by:

initTemplateDataImpl in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

vc - (VelocityContext) The current set of Velocity template data.

cookies - (boolean) true if any relevant cookies are to be written, otherwise false.

requestComplete

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

Handles completion processing for a request, such as any housekeeping tasks that might need to be performed after all other processing for a request has been completed. Invoked by doGet and doPost as the very last action to be performed for each and every request, even if exceptions are thrown during the request's processing. Overrides requestComplete in BaseServlet.

Overrides:

requestComplete in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

post - (boolean) true if the activity occurred during a POST operation, otherwise false.

requiresLogon

protected boolean requiresLogon(BaseServlet.Context baseCtx)

Answers if the servlet requires a valid non-default user to log on in order to continue processing. The default is false for public shopping functions and true for admin, SAT and SFI/CSR functions. This method should be overridden by a subclass if the subclass requires something different than the default. Overrides requiresLogon in BaseServlet.

Specified by:

requiresLogon in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

boolean - true if the servlet requires a non-default user to log on, otherwise false.

writeCookie

protected void writeCookie(BaseServlet.Context baseCtx,
                           java.lang.String name,
                           java.lang.String value)
                    throws java.io.IOException

Adds a given cookie name and value to the response header and sets the cookie to expire based on the value for "Site.Cookie.Expires" or the value for "Store.Cart.Expires" or to a quasi-permanent default of one year. Normally invoked by calls from the setCookieValues method. Overrides writeCookie in BaseServlet.

Overrides:

writeCookie in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

name - (String) The name by which the cookies will be referred.

value - (String) The value associated with the cookie.

Throws:

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

writePageImpl

protected void writePageImpl(BaseServlet.Context baseCtx)

Provides additional application-specific functionality for writing a page. Invoked by the writePage method. Overrides writePageImpl in BaseServlet.

Specified by:

writePageImpl in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

confirmCart

protected boolean confirmCart(FlashServlet.Context ctx)
                       throws java.io.IOException

Determines if a shopping cart is associated with the current user session. If a cart is not in the session, an attempt is made to retrieve a cart id from the client's cookie. If this does not work, a new cart is then created. Invoked by the confirmSession method.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if a valid cart is created or found, false if error occurred.

Throws:

java.io.IOException - - if an error occurs while confirming the shopping cart.

confirmRequest

protected int confirmRequest(FlashServlet.Context ctx)
                      throws java.io.IOException

Determines if a servlet is being accessed with a valid request id.

Parameters:

ctx - (Context) The current servlet context.

Returns:

int - -1 if error, 0 if redirected, 1 okay.

Throws:

java.io.IOException - - if an error occurs while confirming the request id.

confirmRetail

protected int confirmRetail(FlashServlet.Context ctx)
                     throws java.io.IOException

Determines if the servlet is being accessed within the context of a valid retail user session.

Parameters:

ctx - (Context) The current servlet context.

Returns:

int - -1 if error, 0 if redirected, 1 okay.

Throws:

java.io.IOException - - if an error occurs while confirming the user session.

confirmWholesale

protected int confirmWholesale(FlashServlet.Context ctx)
                        throws java.io.IOException

Determines if the servlet is being accessed within the context of a valid wholesale user session.

Parameters:

ctx - (Context) The current servlet context.

Returns:

int - -1 if error, 0 if redirected, 1 okay.

Throws:

java.io.IOException - - if an error occurs while confirming the user session.

createNewCart

protected void createNewCart(FlashServlet.Context ctx)
                      throws java.io.IOException

Creates a new shopping cart and attaches it to the current session.

Parameters:

ctx - (Context) The current servlet context.

Throws:

java.io.IOException - - if an error occurs while creating the new shopping cart.

getUser

protected User getUser(FlashServlet.Context ctx,
                       java.lang.String userid)

Returns a User object for the given user id. The given user id will typically be the default user User.DEFAULT_USER or the user id obtained from the SN_USER cookie.

Parameters:

ctx - (Context) The current servlet context.

userid - (String) The id for the user to be retrieved.

Returns:

User - A User object for the specified user id, or null if the user does not exist or cannot be found.

isLogonRequest

protected boolean isLogonRequest(FlashServlet.Context ctx)

Answers if the current request is for a logon servlet.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the current request is for logon, otherwise false.

resetCart

protected void resetCart(FlashServlet.Context ctx)

Resets various shopping cart values and forces a refresh of the cart's cart lines. Typically invoked when something has occurred that affects the current catalog (i.e. logon, account changes, etc.).

Parameters:

ctx - (Context) The current servlet context.

resetCategories

protected void resetCategories(FlashServlet.Context ctx,
                               boolean newlist,
                               boolean listonly)

Resets the session values that control the display of the product categories list. Typically invoked when something has occurred that affects the current catalog (i.e. logon, account changes, etc.).

Parameters:

ctx - (Context) The current servlet context.

newlist - (boolean) true if the list of categories should be reset, otherwise false.

listonly - (boolean) true if only the list of categories is to be rebuilt. This controls whether a product catalog or category-specific description page should be shown, as would be the normal case. Sometimes we only want to reshow the list of categories, such as when the user has just logged on and they are about to be redirected to checkout, favorite items, order history, etc. We do not want to overwrite the redirection with a product catalog or category description.

resetProducts

protected void resetProducts(FlashServlet.Context ctx)

Resets the session values that control the display of products. Typically invoked when something has occurred that affects the current catalog (i.e. logon, account changes, etc.).

Parameters:

ctx - (Context) The current servlet context.

setDefaultUser

protected boolean setDefaultUser(FlashServlet.Context ctx)

Sets the current session to point to the default user or to the user saved as a cookie from a previous session's logon. This method is only invoked for a retail site. Invoked by the confirmSessionRetail method.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the default user was successfully set, otherwise false.

setSessionCart

protected void setSessionCart(FlashServlet.Context ctx,
                              Cart cart,
                              boolean newCart)
                       throws java.io.IOException

Sets the session's shopping cart to the given cart.

Parameters:

ctx - (Context) The current servlet context.

cart - (Cart) The cart to attach to the session.

newCart - (boolean) true if the cart is a new cart, otherwise false.

Throws:

java.io.IOException - - if an error occurs while setting the session's shopping cart.

setSFIShoppingUser

protected void setSFIShoppingUser(FlashServlet.Context ctx,
                                  User user)

Sets the SFI/CSR shopping user (the sales rep's selected account).

Parameters:

ctx - (Context) The current servlet context.

user - (User) The selected account or null to reset or void the shopping user.

createContext

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

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

Overrides:

createContext in class BaseServlet

Parameters:

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

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

Returns:

Context - The servlet context.