com.dpslink.flash.servlet

Class PunchOut

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

com.dpslink.flash.servlet.PunchOut

All Implemented Interfaces:

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

public class PunchOut
extends Logon

Writes and processes the store's punch-out request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PunchOut.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_OBJECT The session's key for the punch-out session object.
static java.lang.String	SN_PROCESS The session's key for the punch-out process flag.

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

SN_CHANGEPWD, SN_SELSHIPTO, SN_SHIPTOCUST

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

Method Summary

Modifier and Type	Method and Description
protected Logon.Context	createContext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Creates the servlet context inner class.
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Returns the name of the html template file used by the servlet.
protected boolean	isPasswordValid(Logon.Context ctx) Answers if the logon user password is valid.
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).
protected boolean	isSessionValid(PunchOut.Context ctx, java.lang.String sessionId) Answers if the given punch-out session id is valid.
protected boolean	isUserValid(PunchOut.Context ctx, java.lang.String userId) Answers if the given punch-out user id is valid.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Reads the parameters passed to the servlet via the http request object.
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	showErrorPage(PunchOut.Context ctx, int error) Redirects to the punch-out error page for the given error code.
protected void	showNextPage(PunchOut.Context ctx, java.lang.String name) Redirects to the given servlet name (Home or ReviewCart).

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

editFormFields, getNextURL, isPasswordNeeded, isShiptoNeeded, resetCategories, resetFormFields, retrieveShiptos, setCookieValues, setTemplateError

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

confirmSession, getPreviousCategoryList, getPreviousCategoryPath, hasSubcategories, hasSubcategories, isOmitNoStock, 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

SN_PROCESS

public static final java.lang.String SN_PROCESS

The session's key for the punch-out process flag.

See Also:

Constant Field Values

SN_OBJECT

public static final java.lang.String SN_OBJECT

The session's key for the punch-out session object.

See Also:

Constant Field Values

Constructor Detail

PunchOut

public PunchOut()

Method Detail

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. Overrides isPreshopRequest in Logon.

Overrides:

isPreshopRequest in class Logon

Parameters:

ctx - (Context) The current servlet context.

Returns:

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

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

Overrides:

getTemplateName in class Logon

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

Overrides:

readParameters in class Logon

Parameters:

baseCtx - (Context) The current servlet context.

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

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

Overrides:

setSessionValues in class Logon

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

Overrides:

setTemplateData in class Logon

Parameters:

baseCtx - (Context) The current servlet context.

isPasswordValid

protected boolean isPasswordValid(Logon.Context ctx)

Answers if the logon user password is valid. Overrides isPasswordValid in Logon.

Overrides:

isPasswordValid in class Logon

Parameters:

ctx - (Context) The current servlet context.

Returns:

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

isSessionValid

protected boolean isSessionValid(PunchOut.Context ctx,
                                 java.lang.String sessionId)

Answers if the given punch-out session id is valid.

Parameters:

ctx - (Context) The current servlet context.

sessionId - (String) The id for the session to validate.

Returns:

boolean - true if the session id is valid, otherwise false.

isUserValid

protected boolean isUserValid(PunchOut.Context ctx,
                              java.lang.String userId)

Answers if the given punch-out user id is valid.

Parameters:

ctx - (Context) The current servlet context.

userId - (String) The id for the user to validate.

Returns:

boolean - true if the user id is valid, otherwise false.

showErrorPage

protected void showErrorPage(PunchOut.Context ctx,
                             int error)

Redirects to the punch-out error page for the given error code.

Parameters:

ctx - (Context) The current servlet context.

error - (int) The error code for the page to display where 0 = processing error, 1 = invalid session and 2 = invalid buyer id.

showNextPage

protected void showNextPage(PunchOut.Context ctx,
                            java.lang.String name)

Redirects to the given servlet name (Home or ReviewCart).

Parameters:

ctx - (Context) The current servlet context.

name - (String) The name of the servlet to display.

createContext

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

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

Overrides:

createContext in class Logon

Parameters:

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

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

Returns:

Context - The servlet context.