AdministratorRequestProcessor (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.administrator.core
Class AdministratorRequestProcessor

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

public class AdministratorRequestProcessor
extends BaseRequestProcessor
extends BaseRequestProcessor

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

Author:: David Tobey

Field Summary
`static java.lang.String`	`customLayoutDirectory`
`static java.lang.String`	`errorPath`
`(package private) static org.apache.commons.logging.Log`	`log`
`static java.lang.String`	`loginFormPath`
`static java.lang.String`	`loginPath`
`static java.lang.String`	`npoDispatchPath`
`static java.lang.String`	`npoProcessFileUploadPath`

Fields inherited from class com.softslate.commerce.customer.core.BaseRequestProcessor
`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
`AdministratorRequestProcessor()`

Method Summary
`protected boolean`	`processPreprocess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` General-purpose preprocessing hook.
`protected boolean`	`processRoles(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, org.apache.struts.action.ActionMapping mapping)`
`boolean`	`sscOnAdministratorPreRequestEnd(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.BaseRequestProcessor
`doForward, getExceptionAsString, getRequestParamsDebugMessage, processAuditLogging, processException, sscOnPreRequestBegin, sscOnPreRequestEnd, 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, 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

loginPath

public static final java.lang.String loginPath

See Also:: Constant Field Values

loginFormPath

public static final java.lang.String loginFormPath

See Also:: Constant Field Values

errorPath

public static final java.lang.String errorPath

See Also:: Constant Field Values

npoDispatchPath

public static final java.lang.String npoDispatchPath

See Also:: Constant Field Values

npoProcessFileUploadPath

public static final java.lang.String npoProcessFileUploadPath

See Also:: Constant Field Values

customLayoutDirectory

public static final java.lang.String customLayoutDirectory

See Also:: Constant Field Values

Constructor Detail

AdministratorRequestProcessor

public AdministratorRequestProcessor()

Method Detail

processPreprocess

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

General-purpose preprocessing hook. Loads settings into the request and session scopes.

Overrides:: processPreprocess in class BaseRequestProcessor

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

sscOnAdministratorPreRequestEnd

public boolean sscOnAdministratorPreRequestEnd(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.

processRoles

protected boolean processRoles(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response,
                               org.apache.struts.action.ActionMapping mapping)
                        throws java.io.IOException,
                               javax.servlet.ServletException

Overrides:: processRoles in class org.apache.struts.action.RequestProcessor

Throws:: java.io.IOException; javax.servlet.ServletException