com.dpslink.flash.servlet

Class MainServlet

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AccountLogonViewId, AccountPasswordEdit, AccountServlet, AdmBackendControlEdit, AdmCategoryAddEdit, AdmCategorySubcatSeq, AdmCountryAddEdit, AdmHome, AdmImportData, AdmLeadtimeAddEdit, AdmManufacturerAddEdit, AdmPasswordEdit, AdmPendingProductBatchSelect, AdmPendingProductFind, AdmPendingProductProfile, AdmProductAttributeDescrAddEdit, AdmProductImportBatchAddEdit, AdmProductImportBatchInfo, AdmProductImportBatchSelect, AdmProductSearchIndexBuild, AdmPropertiesEdit, AdmPurge, AdmQueryDatabase, AdmSalesRepAddEdit, AdmSalesRepUserAddEdit, AdmSecurityProfileAddEdit, AdmSendMassEmail, AdmShipperAddEdit, AdmSpecialAddEdit, AdmStateAddEdit, AdmStoreTypeEdit, AdmSynchronizeData, AdmTestSiteEmails, AdmUnitMeasureAddEdit, AdmUserCatalogExport, AdmUserFavoritesCopy, AdmVerifyEmailAddresses, AdmVerifySiteImages, AdmViewDatabaseInfo, AdmViewFileSystemInfo, AdmViewPoolStatus, AdmViewScheduledTasks, AdmViewServerInfo, AdmWordFixAddEdit, CartLineEdit, CheckOut, ConfirmOrder, DemoIndustryEdit, FavoriteAddEdit, InvoiceHistory, Logon, LogonAssistance, LogonShippingSelect, MainPagingServlet, OrderDetails, OrderSummary, OrderToExcel, ProductCompare, ProductDetails, ProductSearch, ProductWarehouseDetail, QuickOrder, ReorderRejects, ReviewCart, SatAccess, SatActivity, SatLocations, SatTrends, SfiUserSelect, ShipmentDetails, StaticPage

public abstract class MainServlet
extends FlashServlet

An abstract extension of FlashServlet that provides default functionality for main page 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	MainServlet.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 java.lang.String	CATEGORY_PATH_LINK The value of the "Categories.Path.Link" key in properties.
private static java.lang.String	CATEGORY_PATH_SEPARATOR The value of the "Categories.Path.Separator" key in properties.
private static boolean	CATEGORY_PATH_SHOWTOP The value of the "Categories.Path.Show.Topmost" key in properties.
protected static int	DISPLAY_MODE The value of the "Categories.Display.Mode" key in properties.
private static int	EXTERNALREQ_CATEGORY The external request type for a category request.
private static int	EXTERNALREQ_NONE The external request type for no request.
private static int	EXTERNALREQ_PRODUCT The external request type for a product request.
private static long	serialVersionUID The class' serialization version id.
protected static java.lang.String	SN_ADMINMODE The session's key for the current admin mode (cfg or tbl).
protected static java.lang.String	SN_CATEGORIES The session's key for the user's current category list.
protected static java.lang.String	SN_CATEGORIES_LISTONLY The session's key for the user's current category list only flag.
protected static java.lang.String	SN_CATEGORIES_PATH The session's key for the user's current category path.
protected static java.lang.String	SN_CATEGORY The session's key for the catalog's current category.
protected static java.lang.String	SN_CONTINUE_PAGEURL The session's key for the catalog's current continue shopping url.
protected static java.lang.String	SN_PRODUCTS The session's key for the catalog's current list of products.
protected static java.lang.String	SN_PRODUCTS_INSTOCK The session's key for the catalog's current list of products with stock.
protected static java.lang.String	SN_PRODUCTS_NOSTOCK The session's key for the catalog's current omit no stock flag.
protected static java.lang.String	SN_PRODUCTS_PAFILTERS The session's key for the catalog's current list of product attribute filters.
protected static java.lang.String	SN_PRODUCTS_PAGEHIST The session's key for the catalog's current page history.
protected static java.lang.String	SN_PRODUCTS_PAGENUM The session's key for the catalog's current page number.
protected static java.lang.String	SN_PRODUCTS_PAGEURL The session's key for the catalog's current page url.
protected static java.lang.String	SOURCE_CATALOG The source code for a catalog product ("Catalog").
protected static java.lang.String	SOURCE_FAVORITES The source code for a favorite items product ("Favorites").
protected static java.lang.String	SOURCE_SEARCH The source code for a search results product ("Search").
protected static java.lang.String	SOURCE_SHOPCART The source code for a shopping cart product ("ShopCart").
protected static java.lang.String	SOURCE_SPECIAL The source code for a special product ("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
MainServlet()

Method Summary

Modifier and Type	Method and Description
private void	buildCategories(MainServlet.Context ctx) Builds the product categories list for the current servlet context.
private void	buildCategoriesDefault(MainServlet.Context ctx, Category topcategory, Category dftcategory) Builds a revised category list based on given topmost (catalog) category and given starting category.
private void	buildCategoriesParent(MainServlet.Context ctx, Category category) Builds a revised category list, or a portion of the revised category list based on a given parent category starting point.
private boolean	buildCategoriesPrevious(MainServlet.Context ctx, Category category, boolean clone) Builds a revised category list based on all or part of the previously displayed category list.
private void	buildCategoriesTopmost(MainServlet.Context ctx) Builds a revised category list based on the user's topmost (catalog) category and default starting category.
private void	buildCategoriesTopmost(MainServlet.Context ctx, java.lang.String category) Builds a revised category list based on the user's topmost (catalog) category and the given starting category.
protected int	confirmSession(BaseServlet.Context baseCtx) Determines if the servlet is being accessed within the context of a valid user session.
protected FlashServlet.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
private void	findCategoryInPreviousList(MainServlet.Context ctx, Category category) Finds the given category in the previously displayed list of categories and sets the context variable for the category's index (ctx.mpSelectedIdx).
private void	findCategoryInPreviousList(MainServlet.Context ctx, java.lang.String category) Finds the given category in the previously displayed list of categories and sets the context variable for the category's index (ctx.mpSelectedIdx).
protected java.util.ArrayList<CategoryListItem>	getPreviousCategoryList(MainServlet.Context ctx) Returns the previous category list stored in the session.
protected java.util.ArrayList<Category>	getPreviousCategoryPath(MainServlet.Context ctx) Returns the previous category path stored in the session.
protected boolean	hasSubcategories(MainServlet.Context ctx, Category category) Answers if the given category has subcategories.
protected boolean	hasSubcategories(MainServlet.Context ctx, java.lang.String category) Answers if the given category has subcategories.
private boolean	isExpiredRequest(MainServlet.Context ctx) Determines if the current request is expired and, if so, displays the expired request page.
private int	isExternalRequest(MainServlet.Context ctx) Determines if an external request has been made for category or product information and, if so, sets the ctx.mpRedirectURL url for the request.
protected boolean	isOmitNoStock(MainServlet.Context ctx) Anwers if products with stock should be processed based on the current session flag SN_PRODUCTS_NOSTOCK.
protected boolean	isPreshopRequest(MainServlet.Context ctx) Answers if a request has been made that uses the preshop layout (no banner links, no navigation bar options and no displayed categories).
private boolean	isRedirectURL(MainServlet.Context ctx) Answers if the current value for ctx.mpRedirectURL is for a valid redirection.
protected boolean	isUserHelpRequest(MainServlet.Context ctx) Answers if a request has been made for user help.
private CategoryListItem	newCategoryListItem(MainServlet.Context ctx, Category category, int type, java.util.ArrayList<Category> children) Creates and returns a new category list item using the supplied values.
private void	setCategoryPathData(MainServlet.Context ctx) Retrieves and sets the category path data for the current selected category.
private void	setCategoryProductData(MainServlet.Context ctx) Retrieves and sets the product data required for the current selected category.
protected void	setTemplateCategoryPath(MainServlet.Context ctx) Invoked by a subclass' implementation of setTemplateData to retrieve and set the category path data required by the html template.
protected boolean	sortCategoryProductData(MainServlet.Context ctx, java.util.ArrayList<Product> products, java.util.ArrayList<Product> productsInStock) Sorts the given collections of products, only if additional sorting is necessary.
private void	updateServletRequest(MainServlet.Context ctx, FlashServletRequest fsr) Updates the given servlet request with category and category path data so subsequent invocations of the same request will display the same information.
protected void	writePageImpl(BaseServlet.Context baseCtx) Provides additional application-specific functionality for writing a page.

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, 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

SOURCE_CATALOG

protected static final java.lang.String SOURCE_CATALOG

The source code for a catalog product ("Catalog").

See Also:

Constant Field Values

SOURCE_SEARCH

protected static final java.lang.String SOURCE_SEARCH

The source code for a search results product ("Search").

See Also:

Constant Field Values

SOURCE_SHOPCART

protected static final java.lang.String SOURCE_SHOPCART

The source code for a shopping cart product ("ShopCart").

See Also:

Constant Field Values

SOURCE_FAVORITES

protected static final java.lang.String SOURCE_FAVORITES

The source code for a favorite items product ("Favorites").

See Also:

Constant Field Values

SOURCE_SPECIAL

protected static final java.lang.String SOURCE_SPECIAL

The source code for a special product ("Special").

See Also:

Constant Field Values

SN_ADMINMODE

protected static final java.lang.String SN_ADMINMODE

The session's key for the current admin mode (cfg or tbl).

See Also:

Constant Field Values

SN_CATEGORY

protected static final java.lang.String SN_CATEGORY

The session's key for the catalog's current category.

See Also:

Constant Field Values

SN_CATEGORIES

protected static final java.lang.String SN_CATEGORIES

The session's key for the user's current category list.

See Also:

Constant Field Values

SN_CATEGORIES_PATH

protected static final java.lang.String SN_CATEGORIES_PATH

The session's key for the user's current category path.

See Also:

Constant Field Values

SN_CATEGORIES_LISTONLY

protected static final java.lang.String SN_CATEGORIES_LISTONLY

The session's key for the user's current category list only flag. See the javadocs for the resetCategories method's dolistonly parameter for a description of how this session value is used.

See Also:

Constant Field Values

SN_PRODUCTS

protected static final java.lang.String SN_PRODUCTS

The session's key for the catalog's current list of products.

See Also:

Constant Field Values

SN_PRODUCTS_INSTOCK

protected static final java.lang.String SN_PRODUCTS_INSTOCK

The session's key for the catalog's current list of products with stock.

See Also:

Constant Field Values

SN_PRODUCTS_NOSTOCK

protected static final java.lang.String SN_PRODUCTS_NOSTOCK

The session's key for the catalog's current omit no stock flag.

See Also:

Constant Field Values

SN_PRODUCTS_PAFILTERS

protected static final java.lang.String SN_PRODUCTS_PAFILTERS

The session's key for the catalog's current list of product attribute filters.

See Also:

Constant Field Values

SN_PRODUCTS_PAGENUM

protected static final java.lang.String SN_PRODUCTS_PAGENUM

The session's key for the catalog's current page number.

See Also:

Constant Field Values

SN_PRODUCTS_PAGEHIST

protected static final java.lang.String SN_PRODUCTS_PAGEHIST

The session's key for the catalog's current page history.

See Also:

Constant Field Values

SN_PRODUCTS_PAGEURL

protected static final java.lang.String SN_PRODUCTS_PAGEURL

The session's key for the catalog's current page url.

See Also:

Constant Field Values

SN_CONTINUE_PAGEURL

protected static final java.lang.String SN_CONTINUE_PAGEURL

The session's key for the catalog's current continue shopping url.

See Also:

Constant Field Values

EXTERNALREQ_NONE

private static final int EXTERNALREQ_NONE

The external request type for no request.

See Also:

Constant Field Values

EXTERNALREQ_CATEGORY

private static final int EXTERNALREQ_CATEGORY

The external request type for a category request.

See Also:

Constant Field Values

EXTERNALREQ_PRODUCT

private static final int EXTERNALREQ_PRODUCT

The external request type for a product request.

See Also:

Constant Field Values

DISPLAY_MODE

protected static final int DISPLAY_MODE

The value of the "Categories.Display.Mode" key in properties. This value is used to determine if the list of categories should expand to display subcategories or if subcategories are displayed in the main area of the page by the Home servlet.

• When 0 (zero) the menu of categories expands and collapses to show or hide subcategories depending on the user's selection.
• When 1 (one) only the first level of subcategories within the user's topmost category are displayed in the menu. All other subcategories are displayed in the main area by the Home servlet. The first level of subcategories are NOT repeated in the main area and the standard home page is displayed.
• When 2 (two) only the first level of subcategories within the user's topmost category are displayed in the menu. All other subcategories are displayed in the main area by the Home servlet. The first level of subcategories is repeated in the main area and displayed as the home page.

CATEGORY_PATH_LINK

private static final java.lang.String CATEGORY_PATH_LINK

The value of the "Categories.Path.Link" key in properties. This value is used to format the link for each category in the current category's path.

CATEGORY_PATH_SEPARATOR

private static final java.lang.String CATEGORY_PATH_SEPARATOR

The value of the "Categories.Path.Separator" key in properties. This value is used to separate the categories in the displayed category path.

CATEGORY_PATH_SHOWTOP

private static final boolean CATEGORY_PATH_SHOWTOP

The value of the "Categories.Path.Show.Topmost" key in properties. This value is used to determine if the user's topmost category should appear in the displayed category path.

Constructor Detail

MainServlet

public MainServlet()

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

Overrides:

confirmSession in class FlashServlet

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.

writePageImpl

protected void writePageImpl(BaseServlet.Context baseCtx)

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

Overrides:

writePageImpl in class FlashServlet

Parameters:

baseCtx - (Context) The current servlet context.

buildCategories

private void buildCategories(MainServlet.Context ctx)

Builds the product categories list for the current servlet context.

Parameters:

ctx - (Context) The current servlet context.

buildCategoriesDefault

private void buildCategoriesDefault(MainServlet.Context ctx,
                                    Category topcategory,
                                    Category dftcategory)

Builds a revised category list based on given topmost (catalog) category and given starting category. If the given starting category appears more than once within the catalog, the first occurrence is used.

Parameters:

ctx - (Context) The current servlet context.

topcategory - (Category) The topmost (catalog) category.

dftcategory - (Category) The default starting category.

buildCategoriesParent

private void buildCategoriesParent(MainServlet.Context ctx,
                                   Category category)

Builds a revised category list, or a portion of the revised category list based on a given parent category starting point.

Parameters:

ctx - (Context) The current servlet context.

category - (Category) The category that is to be used as the starting point for building the list.

buildCategoriesPrevious

private boolean buildCategoriesPrevious(MainServlet.Context ctx,
                                        Category category,
                                        boolean clone)

Builds a revised category list based on all or part of the previously displayed category list.

Parameters:

ctx - (Context) The current servlet context.

category - (Category) The selected or target category.

clone - (boolean) true if it has already been determined that the revised list will be an exact copy of the previously displayed list; otherwise false.

Returns:

boolean - true if the list is successfully built, otherwise false.

buildCategoriesTopmost

private void buildCategoriesTopmost(MainServlet.Context ctx)

Builds a revised category list based on the user's topmost (catalog) category and default starting category. If the user's default starting category appears more than once within the catalog, the first occurrence is used.

Parameters:

ctx - (Context) The current servlet context.

buildCategoriesTopmost

private void buildCategoriesTopmost(MainServlet.Context ctx,
                                    java.lang.String category)

Builds a revised category list based on the user's topmost (catalog) category and the given starting category. If the given starting category appears more than once within the catalog, the first occurrence is used.

Parameters:

ctx - (Context) The current servlet context.

category - (String) The starting category or null if the starting category is not known, in which case the user's default starting category will be used.

findCategoryInPreviousList

private void findCategoryInPreviousList(MainServlet.Context ctx,
                                        Category category)

Finds the given category in the previously displayed list of categories and sets the context variable for the category's index (ctx.mpSelectedIdx).

Parameters:

ctx - (Context) The current servlet context.

category - (Category) The selected category.

findCategoryInPreviousList

private void findCategoryInPreviousList(MainServlet.Context ctx,
                                        java.lang.String category)

Finds the given category in the previously displayed list of categories and sets the context variable for the category's index (ctx.mpSelectedIdx).

Parameters:

ctx - (Context) The current servlet context.

category - (String) The selected category.

getPreviousCategoryList

protected java.util.ArrayList<CategoryListItem> getPreviousCategoryList(MainServlet.Context ctx)

Returns the previous category list stored in the session.

Parameters:

ctx - (Context) The current servlet context.

Returns:

ArrayList - The previous category list.

getPreviousCategoryPath

protected java.util.ArrayList<Category> getPreviousCategoryPath(MainServlet.Context ctx)

Returns the previous category path stored in the session.

Parameters:

ctx - (Context) The current servlet context.

Returns:

ArrayList - The previous category path.

hasSubcategories

protected boolean hasSubcategories(MainServlet.Context ctx,
                                   Category category)

Answers if the given category has subcategories.

Parameters:

ctx - (Context) The current servlet context.

category - (Category) The category to check.

Returns:

boolean - true if the category has subcategories, otherwise false.

hasSubcategories

protected boolean hasSubcategories(MainServlet.Context ctx,
                                   java.lang.String category)

Answers if the given category has subcategories.

Parameters:

ctx - (Context) The current servlet context.

category - (String) The category to check.

Returns:

boolean - true if the category has subcategories, otherwise false.

isExpiredRequest

private boolean isExpiredRequest(MainServlet.Context ctx)
                          throws java.io.IOException

Determines if the current request is expired and, if so, displays the expired request page.

Parameters:

ctx - (Context) The current servlet context.

Returns:

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

Throws:

java.io.IOException - - if an error occurs while displaying the expired request page.

isExternalRequest

private int isExternalRequest(MainServlet.Context ctx)

Determines if an external request has been made for category or product information and, if so, sets the ctx.mpRedirectURL url for the request.

Parameters:

ctx - (Context) The current servlet context.

Returns:

int - EXTERNALREQ_NONE if no valid external request has been made, otherwise one of the other EXTERNALREQ codes is returned.

isPreshopRequest

protected boolean isPreshopRequest(MainServlet.Context ctx)

Answers if a request has been made that uses the preshop layout (no banner links, no navigation bar options and no displayed categories). The default is false. This method should be overridden by a subclass if the subclass requires something different than the default.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if this is a request for preshop, otherwise false.

isUserHelpRequest

protected boolean isUserHelpRequest(MainServlet.Context ctx)

Answers if a request has been made for user help.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if this is a request for user help, otherwise false.

isRedirectURL

private boolean isRedirectURL(MainServlet.Context ctx)

Answers if the current value for ctx.mpRedirectURL is for a valid redirection. A redirection is considered valid if it is not null and if it is not for the exact same request that is already being requested.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true for a valid redirection, otherwise false.

isOmitNoStock

protected boolean isOmitNoStock(MainServlet.Context ctx)

Anwers if products with stock should be processed based on the current session flag SN_PRODUCTS_NOSTOCK. If the session flag has not yet been established, then the answer is based on the configured properties value for "Product.Catalog.OmitNoStock.Default". A submitted form field flag for omitting no stock products should take precedence over the value returned here. Servlets that accept a submitted form field should set the SN_PRODUCTS_NOSTOCK session value to reflect what was submitted.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if in stock products should be processed, otherwise false.

newCategoryListItem

private CategoryListItem newCategoryListItem(MainServlet.Context ctx,
                                             Category category,
                                             int type,
                                             java.util.ArrayList<Category> children)

Creates and returns a new category list item using the supplied values.

Parameters:

ctx - (Context) The current servlet context.

category - (Category) The category object associated with this list item.

type - (int) The type of list item (topcategory or subcategory). Must be one of the list type constants (TOPCATEGORY, SUBCATEGORY).

children - (ArrayList) A collection of children for this list item's category.

Returns:

CategoryListItem - A new category list item.

setCategoryPathData

private void setCategoryPathData(MainServlet.Context ctx)

Retrieves and sets the category path data for the current selected category.

Parameters:

ctx - (Context) The current servlet context.

setCategoryProductData

private void setCategoryProductData(MainServlet.Context ctx)

Retrieves and sets the product data required for the current selected category. The product data that is retrieved and set includes the list of products for the category and the url required to display the product catalog. If the category has no products, this method may set the url for displaying either the category's category-specific description page (if such a page exists) or the store's home page.

Parameters:

ctx - (Context) The current servlet context.

sortCategoryProductData

protected boolean sortCategoryProductData(MainServlet.Context ctx,
                                          java.util.ArrayList<Product> products,
                                          java.util.ArrayList<Product> productsInStock)

Sorts the given collections of products, only if additional sorting is necessary. The collections have already been sorted based on SQL, but additional sorting might be required based on the results of realtime pricing and availablity, which isn't possible to do with SQL because the realtime pricing and availablity results aren't persisted to the database.

Parameters:

ctx - (Context) The current servlet context.

products - (ArrayList) The collection of all products for the current category.

productsInStock - (ArrayList) The collection of in-stock products for the current category.

Returns:

boolean - true if additional sorting was performed, otherwise false.

setTemplateCategoryPath

protected void setTemplateCategoryPath(MainServlet.Context ctx)

Invoked by a subclass' implementation of setTemplateData to retrieve and set the category path data required by the html template. The template variable created by this method is named $CategoryPath and must be coded in the template as $str.pre($CategoryPath).

Parameters:

ctx - (Context) The current servlet context.

updateServletRequest

private void updateServletRequest(MainServlet.Context ctx,
                                  FlashServletRequest fsr)

Updates the given servlet request with category and category path data so subsequent invocations of the same request will display the same information.

Parameters:

ctx - (Context) The current servlet context.

fsr - (FlashServletRequest) The servlet request to update.

createContext

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

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

Overrides:

createContext in class FlashServlet

Parameters:

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

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

Returns:

Context - The servlet context.