CustomerRequestProcessor (SoftSlate Commerce API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.softslate.commerce.customer.core
Class CustomerRequestProcessor

java.lang.Object
  org.apache.struts.action.RequestProcessor
      org.apache.struts.tiles.TilesRequestProcessor
          com.softslate.commerce.customer.core.BaseRequestProcessor
              com.softslate.commerce.customer.core.CheckEERequestProcessor
                  com.softslate.commerce.customer.core.CustomerRequestProcessor

public class CustomerRequestProcessor
extends com.softslate.commerce.customer.core.CheckEERequestProcessor
extends com.softslate.commerce.customer.core.CheckEERequestProcessor

Subclass of BaseRequestProcessor that negotiates each application request for the customer interface. The "/WEB-INF/conf/core/struts-config.xml" file identifies this class as the customer application's <controller>.

Author:: David Tobey

Field Summary
`(package private) static org.apache.commons.logging.Log`	`log`

Fields inherited from class com.softslate.commerce.customer.core.BaseRequestProcessor
`errorPath, installerPath`

Fields inherited from class org.apache.struts.tiles.TilesRequestProcessor
`definitionsFactory`

Fields inherited from class org.apache.struts.action.RequestProcessor
`actions, INCLUDE_PATH_INFO, INCLUDE_SERVLET_PATH, moduleConfig, servlet`

Constructor Summary
`CustomerRequestProcessor()`

Method Summary
`protected boolean`	`processPreprocess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Runs initializations and other necessary routines before every request into the system.
`boolean`	`sscOnCustomerPreRequestEnd(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Performs custom processing at the end of each call to `processPreProcess`.

Methods inherited from class com.softslate.commerce.customer.core.CheckEERequestProcessor
`sscOnPreRequestEnd`

Methods inherited from class com.softslate.commerce.customer.core.BaseRequestProcessor
`doForward, getExceptionAsString, getRequestParamsDebugMessage, processAuditLogging, processException, sscOnPreRequestBegin, sscOnPreRequestMiddle`

Methods inherited from class org.apache.struts.tiles.TilesRequestProcessor
`getDefinitionsFactory, init, initDefinitionsMapping, internalModuleRelativeForward, internalModuleRelativeInclude, processForwardConfig, processTilesDefinition, processTilesDefinition`

Methods inherited from class org.apache.struts.action.RequestProcessor
`destroy, doInclude, getInternal, getServletContext, process, processActionCreate, processActionForm, processActionPerform, processCachedMessages, processContent, processForward, processInclude, processLocale, processMapping, processMultipart, processNoCache, processPath, processPopulate, processRoles, processValidate`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

log

static org.apache.commons.logging.Log log

Constructor Detail

CustomerRequestProcessor

public CustomerRequestProcessor()

Method Detail

processPreprocess

protected boolean processPreprocess(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)

Runs initializations and other necessary routines before every request into the system.

Here are the steps this method takes for each request:

Initializes the request's htmlHeadTitle attribute to the "storeName" setting from the database. This attribute may be modified later by an action class or by LayoutAction.
Similarly initializes the request's htmlHeadKeywords and htmlHeadDescriptionattributes. These settings must be initialized in advance of forwarding the request to a Tiles definition so they are available when the "htmlHead" Tile is called.
Sets the session scope's currentLayout attribute to the "layout" request parameter, if it is present, or to the "defaultLayout" setting from the database, if it is not present.
Sets a convenience attribute named "loggedIn" to "true" in the request scope, if the current user is a logged in customer.
Calls sscOnCustomerPreRequestEnd, which can be overridden by a subclass to provide customizations.

Overrides:: processPreprocess in class BaseRequestProcessor

Parameters:: request - The servlet request we are processing.; response - The servlet response we are creating.

sscOnCustomerPreRequestEnd

public boolean sscOnCustomerPreRequestEnd(javax.servlet.http.HttpServletRequest request,
                                          javax.servlet.http.HttpServletResponse response)

Performs custom processing at the end of each call to processPreProcess. Intended to be overridden by subclasses for customizations. This method should return false to signal processPreProcess to return false itself.

Returns:: true if the processing was successful, false if processing should stop.