com.dpslink.flash.servlet

Class Logoff

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.dpslink.base.servlet.BaseServlet

com.dpslink.flash.servlet.FlashServlet

com.dpslink.flash.servlet.Logoff

All Implemented Interfaces:

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

public class Logoff
extends FlashServlet

Invalidates the current session and redirects to the Home servlet for a retail site or redirects to the Logon servlet for a wholesale site.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Logoff.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.

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

Method Summary

Modifier and Type	Method and Description
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.
protected boolean	editFormFields(BaseServlet.Context baseCtx) Deprecated.
protected java.lang.String	getNextURL(BaseServlet.Context baseCtx) Deprecated.
protected java.lang.String	getTemplateName(BaseServlet.Context baseCtx) Deprecated.
protected void	readParameters(BaseServlet.Context baseCtx, boolean post) Deprecated.
protected void	resetFormFields(BaseServlet.Context baseCtx) Deprecated.
protected void	setCookieValues(BaseServlet.Context baseCtx) Deprecated.
protected void	setSessionValues(BaseServlet.Context baseCtx) Deprecated.
protected void	setTemplateData(BaseServlet.Context baseCtx) Deprecated.

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

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

Logoff

public Logoff()

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.

editFormFields

@Deprecated
protected boolean editFormFields(BaseServlet.Context baseCtx)

Deprecated.

Description copied from class: BaseServlet

Edits the values from the html template's form fields. Invoked by the doPost method. Subclasses must override this method to provide support for the editing of specific form fields.

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

@Deprecated
protected java.lang.String getNextURL(BaseServlet.Context baseCtx)

Deprecated.

Description copied from class: BaseServlet

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. Subclasses must override this method to provide a specific URL for processing.

Specified by:

getNextURL in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The URL.

getTemplateName

@Deprecated
protected java.lang.String getTemplateName(BaseServlet.Context baseCtx)

Deprecated.

Description copied from class: BaseServlet

Returns the name of the html template file used by the servlet. Invoked by the writePage method. Subclasses must override this method to provide the name of a specific html template to process.

Specified by:

getTemplateName in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

Returns:

String - The html template's name.

readParameters

@Deprecated
protected void readParameters(BaseServlet.Context baseCtx,
                                           boolean post)

Deprecated.

Description copied from class: BaseServlet

Reads the parameters passed to the servlet via the http request object. Invoked by the doGet and doPost method. Subclasses must override this method to provide support for the retrieval of specific request parameters.

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

@Deprecated
protected void resetFormFields(BaseServlet.Context baseCtx)

Deprecated.

Description copied from class: BaseServlet

Resets the values for the html template's form fields. Invoked by the doGet and doPost methods. Subclasses must override this method to provide support for specific form fields.

Specified by:

resetFormFields in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setCookieValues

@Deprecated
protected void setCookieValues(BaseServlet.Context baseCtx)
                                     throws java.io.IOException

Deprecated.

Description copied from class: BaseServlet

Adds one or more values to the http session cookies. Invoked by the writeURL method. Subclasses must override this method to provide support for writing specific cookie values. Calls should be made to writeCookie for each cookie that needs to be set.

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

@Deprecated
protected void setSessionValues(BaseServlet.Context baseCtx)

Deprecated.

Description copied from class: BaseServlet

Adds one or more values to the http session object. Invoked by the writeURL method. Subclasses must override this method to provide support for specific session values.

Specified by:

setSessionValues in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

setTemplateData

@Deprecated
protected void setTemplateData(BaseServlet.Context baseCtx)

Deprecated.

Description copied from class: BaseServlet

Sets the various data required by the html template. Invoked by the writePage method. Subclasses must override this method to provide support for specific html template data.

Specified by:

setTemplateData in class BaseServlet

Parameters:

baseCtx - (Context) The current servlet context.

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.