com.dpslink.flash.servlet

Class AccountServlet

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.AccountServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

AccountBillingAddEdit, AccountContactAddEdit, AccountCreditCardAddEdit, AccountCreditCardSelect, AccountLogonAddEdit, AccountProfile, AccountShippingAddEdit, AccountShippingSelect

public abstract class AccountServlet
extends MainServlet

An abstract extension of MainServlet that provides default functionality for account maintenance 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
protected class	AccountServlet.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.
static java.lang.String	SN_BILLINFO The session's key for the current billing information customer.
static java.lang.String	SN_SHIPINFO The session's key for the current shipping information customer.
static java.lang.String	SN_USERINFO The session's key for the current contact and logon information user.

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

Method Summary

Modifier and Type	Method and Description
protected boolean	allowAdmin(AccountServlet.Context ctx) Answers if various admin-only fields are to be displayed and if they are changeable by the user.
protected boolean	allowCatalog(AccountServlet.Context ctx) Answers if the topmost category and default category are to be displayed and if they are changeable by the user.
protected boolean	allowLogonId(AccountServlet.Context ctx) Answers if logon id is to be displayed and if it is enterable by the user.
protected void	assignDefaultUserCatalog(AccountServlet.Context ctx) Assigns the topmost category and default category from the default user to the current user being maintained.
protected MainServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected User	getAccountObject(AccountServlet.Context ctx) Returns the account (user) to process.
protected java.lang.String	getURLForAdminCreate(AccountServlet.Context ctx) Returns the URL for the admin account create servlet (billing info).
protected java.lang.String	getURLForAdminSelect(AccountServlet.Context ctx) Returns the URL for the admin account selection servlet.
protected java.lang.String	getURLForProfile(AccountServlet.Context ctx) Returns the URL for the account profile servlet.
protected java.lang.String	getURLForSfiSelect(AccountServlet.Context ctx) Returns the URL for the SFI/CSR account selection servlet.
protected Category	getValidDefaultCategory(AccountServlet.Context ctx) Returns a Category object suitable for use as the user's default start category.
protected boolean	isCheckOut(AccountServlet.Context ctx) Answers if check out processing is being performed.
protected boolean	isOneTimeShipto(AccountServlet.Context ctx) Answers if the account being maintained is a one-time ship-to account (user is a shopping user and the user's ship-to customer id = *onetime).
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
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	runMiniSync(AccountServlet.Context ctx) Performs user and customer mini-sync with the backend ERP system (if configured in properties).
protected void	setAccountObject(AccountServlet.Context ctx) Sets the account (user) in the session to reflect the results of an edit.
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	updatePageExpired(AccountServlet.Context ctx) Sets all servlet requests in the stack for account maintenance related functions to expired.

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, resetCart, resetCategories, resetProducts, setDefaultUser, setSessionCart, setSFIShoppingUser, useExistingSessionImpl, writeCookie

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, redirectURL, resetFormFields, setP3PCompactPolicy, 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_BILLINFO

public static final java.lang.String SN_BILLINFO

The session's key for the current billing information customer. (add mode only)

See Also:

Constant Field Values

SN_SHIPINFO

public static final java.lang.String SN_SHIPINFO

The session's key for the current shipping information customer. (add mode only)

See Also:

Constant Field Values

SN_USERINFO

public static final java.lang.String SN_USERINFO

The session's key for the current contact and logon information user. (add mode only)

See Also:

Constant Field Values

Constructor Detail

AccountServlet

public AccountServlet()

Method Detail

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 FlashServlet.

Overrides:

requiresLogon in class FlashServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

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

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.

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.

allowAdmin

protected boolean allowAdmin(AccountServlet.Context ctx)

Answers if various admin-only fields are to be displayed and if they are changeable by the user.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the admin-only fields are vieweable and changeable, otherwise false.

allowCatalog

protected boolean allowCatalog(AccountServlet.Context ctx)

Answers if the topmost category and default category are to be displayed and if they are changeable by the user.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the category fields are viewable and changeable, otherwise false.

allowLogonId

protected boolean allowLogonId(AccountServlet.Context ctx)

Answers if logon id is to be displayed and if it is enterable by the user.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if the logon id field is viewable and enterable, otherwise false.

assignDefaultUserCatalog

protected void assignDefaultUserCatalog(AccountServlet.Context ctx)

Assigns the topmost category and default category from the default user to the current user being maintained.

Parameters:

ctx - (Context) The current servlet context..

getAccountObject

protected User getAccountObject(AccountServlet.Context ctx)

Returns the account (user) to process.

Parameters:

ctx - (Context) The current servlet context.

Returns:

User - The account to process.

setAccountObject

protected void setAccountObject(AccountServlet.Context ctx)

Sets the account (user) in the session to reflect the results of an edit.

Parameters:

ctx - (Context) The current servlet context.

getURLForAdminCreate

protected java.lang.String getURLForAdminCreate(AccountServlet.Context ctx)

Returns the URL for the admin account create servlet (billing info).

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The URL.

getURLForAdminSelect

protected java.lang.String getURLForAdminSelect(AccountServlet.Context ctx)

Returns the URL for the admin account selection servlet.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The URL.

getURLForSfiSelect

protected java.lang.String getURLForSfiSelect(AccountServlet.Context ctx)

Returns the URL for the SFI/CSR account selection servlet.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The URL.

getURLForProfile

protected java.lang.String getURLForProfile(AccountServlet.Context ctx)

Returns the URL for the account profile servlet.

Parameters:

ctx - (Context) The current servlet context.

Returns:

String - The URL.

getValidDefaultCategory

protected Category getValidDefaultCategory(AccountServlet.Context ctx)

Returns a Category object suitable for use as the user's default start category. The value returned will either be the current default start category or the topmost category, depending on whether the default category is a valid descendant (child) of the topmost category.

The default category could become invalid, for example, if the catalog undergoes some kind of reorganization via the admin functions. This method ensures that the default category presented to the user is valid for their assigned topmost category.

Parameters:

ctx - (Context) The current servlet context.

Returns:

Category - A category object that is a valid default start category for the current topmost category.

isCheckOut

protected boolean isCheckOut(AccountServlet.Context ctx)

Answers if check out processing is being performed.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if check out is being processed, otherwise false.

isOneTimeShipto

protected boolean isOneTimeShipto(AccountServlet.Context ctx)

Answers if the account being maintained is a one-time ship-to account (user is a shopping user and the user's ship-to customer id = *onetime).

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if one-time ship-to account, otherwise false.

runMiniSync

protected void runMiniSync(AccountServlet.Context ctx)

Performs user and customer mini-sync with the backend ERP system (if configured in properties).

Parameters:

ctx - (Context) The current servlet context.

updatePageExpired

protected void updatePageExpired(AccountServlet.Context ctx)

Sets all servlet requests in the stack for account maintenance related functions to expired. This includes all account add/edit servlets and their associated select servlets.

Parameters:

ctx - (Context) The current servlet context.

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.