com.dpslink.flash.servlet.sat

Class SatAccess

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.sat.SatAccess

All Implemented Interfaces:

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

public class SatAccess
extends MainServlet

Writes and processes the site access history page.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SatAccess.Context Inner class used to store servlet context information.
class	SatAccess.Result Inner class that defines an access result record.

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

Method Summary

Modifier and Type	Method and Description
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.
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.).
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
private boolean	includePage(SatAccess.Context ctx, java.lang.String page) Answers if the given page should be included in the requested results.
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.
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.
private void	setTemplateAccessInfo(SatAccess.Context ctx) Invoked by this class' implementation of setTemplateData to retrieve and set the trend data required by the html template.
protected void	setTemplateData(BaseServlet.Context baseCtx) Sets the various data required by the html template.
private void	setTemplateHeadings(SatAccess.Context ctx) Retrieves and sets the column headings required by the html template.
private boolean	setTemplatePageDetail(SatAccess.Context ctx) Retrieves and sets the column data required by the html template when the selected type is for one of the page detail reports.
private boolean	setTemplatePageSummary(SatAccess.Context ctx) Retrieves and sets the column data required by the html template when the selected type is for one of the page summary reports.
private boolean	setTemplateSessionInfo(SatAccess.Context ctx) Retrieves and sets the column data required by the html template when the selected type is for one of the session reports.

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

SatAccess

public SatAccess()

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.

setTemplateAccessInfo

private void setTemplateAccessInfo(SatAccess.Context ctx)
                            throws java.lang.Exception

Invoked by this class' implementation of setTemplateData to retrieve and set the trend data required by the html template.

Parameters:

ctx - (Context) The current servlet context.

Throws:

java.lang.Exception - - if an error occurs while setting the template's results info.

setTemplateHeadings

private void setTemplateHeadings(SatAccess.Context ctx)
                          throws java.lang.Exception

Retrieves and sets the column headings required by the html template.

Parameters:

ctx - (Context) The current servlet context.

Throws:

java.lang.Exception - - if an error occurs while setting the template's results info.

setTemplatePageDetail

private boolean setTemplatePageDetail(SatAccess.Context ctx)
                               throws java.lang.Exception

Retrieves and sets the column data required by the html template when the selected type is for one of the page detail reports.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if result data was generated, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while setting the template's results info.

setTemplatePageSummary

private boolean setTemplatePageSummary(SatAccess.Context ctx)
                                throws java.lang.Exception

Retrieves and sets the column data required by the html template when the selected type is for one of the page summary reports.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if result data was generated, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while setting the template's results info.

setTemplateSessionInfo

private boolean setTemplateSessionInfo(SatAccess.Context ctx)
                                throws java.lang.Exception

Retrieves and sets the column data required by the html template when the selected type is for one of the session reports.

Parameters:

ctx - (Context) The current servlet context.

Returns:

boolean - true if result data was generated, otherwise false.

Throws:

java.lang.Exception - - if an error occurs while setting the template's results info.

includePage

private boolean includePage(SatAccess.Context ctx,
                            java.lang.String page)

Answers if the given page should be included in the requested results.

Parameters:

ctx - (Context) The current servlet context.

page - (String) The name of the page to check.

Returns:

boolean - true if the page should be included, otherwise false.

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.