org.apache.beehive.netui.pageflow
Class PageFlowRequestProcessor

Object
  extended by RequestProcessor
      extended by PageFlowRequestProcessor
All Implemented Interfaces:
Serializable

public class PageFlowRequestProcessor
extends RequestProcessor
implements Serializable

The Page Flow extension of the Struts RequestProcessor, which contains callbacks that are invoked during processing of a request to the Struts action servlet. This class is registered as the controller for all Struts modules derived from page flows.

See Also:
Serialized Form

Nested Class Summary
static class PageFlowRequestProcessor.ExceptionHandledAction
          Used by processMapping(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String).
protected static class PageFlowRequestProcessor.ExceptionHandledActionMapping
          Used by processMapping(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String).
 
Field Summary
 
Fields inherited from class RequestProcessor
actions, appConfig, INCLUDE_PATH_INFO, INCLUDE_SERVLET_PATH, log, moduleConfig, servlet
 
Constructor Summary
PageFlowRequestProcessor()
           
 
Method Summary
protected  void changeScheme(String webappRelativeURI, String scheme, int port, HttpServletRequest request, HttpServletResponse response)
           
protected  void doForward(String uri, HttpServletRequest request, HttpServletResponse response)
           
protected  ActionMapping getBeginMapping()
           
 void process(HttpServletRequest request, HttpServletResponse response)
           
protected  Action processActionCreate(HttpServletRequest request, HttpServletResponse response, ActionMapping actionMapping)
           
protected  ActionForm processActionForm(HttpServletRequest request, HttpServletResponse response, ActionMapping mapping)
           
protected  ActionForward processActionPerform(HttpServletRequest request, HttpServletResponse response, Action action, ActionForm form, ActionMapping mapping)
           
 ActionForward processException(HttpServletRequest request, HttpServletResponse response, Exception ex, ActionForm form, ActionMapping mapping)
           
protected  boolean processForward(HttpServletRequest request, HttpServletResponse response, ActionMapping mapping)
           
protected  void processForwardConfig(HttpServletRequest request, HttpServletResponse response, ForwardConfig fwd)
          This override of the base method ensures that absolute URIs don't get the context path prepended, and handles forwards to special things like return-to="currentPage".
protected  boolean processInclude(HttpServletRequest request, HttpServletResponse response, ActionMapping mapping)
           
 ActionMapping processMapping(HttpServletRequest request, HttpServletResponse response, String path)
           
protected  HttpServletRequest processMultipart(HttpServletRequest request)
          If this is a multipart request, wrap it with a special wrapper.
protected  void processNoCache(HttpServletRequest request, HttpServletResponse response)
          Set the no-cache headers for all responses.
protected  void processPopulate(HttpServletRequest request, HttpServletResponse response, ActionForm form, ActionMapping mapping)
           
protected  boolean processRoles(HttpServletRequest request, HttpServletResponse response, ActionMapping mapping)
           
protected  ActionMapping processUnresolvedAction(String actionPath, String originalServletPath, HttpServletRequest request, HttpServletResponse response, Object returningForm)
           
protected  boolean processValidate(HttpServletRequest request, HttpServletResponse response, ActionForm form, ActionMapping mapping)
           
protected  boolean shouldDoSecureForwards()
          Deprecated. Use ContextCache.shouldDoSecureForwards() instead.
protected  boolean trySharedFlowAction(String actionPath, HttpServletRequest request, HttpServletResponse response)
           
 
Methods inherited from class RequestProcessor
destroy, doInclude, getDebug, getInternal, getServletContext, init, internalModuleRelativeForward, internalModuleRelativeInclude, log, log, processActionForward, processContent, processLocale, processPath, processPreprocess
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageFlowRequestProcessor

public PageFlowRequestProcessor()
Method Detail

processActionCreate

protected Action processActionCreate(HttpServletRequest request,
                                     HttpServletResponse response,
                                     ActionMapping actionMapping)
                              throws IOException
Overrides:
processActionCreate in class RequestProcessor
Throws:
IOException

processActionForm

protected ActionForm processActionForm(HttpServletRequest request,
                                       HttpServletResponse response,
                                       ActionMapping mapping)
Overrides:
processActionForm in class RequestProcessor

processPopulate

protected void processPopulate(HttpServletRequest request,
                               HttpServletResponse response,
                               ActionForm form,
                               ActionMapping mapping)
                        throws ServletException
Overrides:
processPopulate in class RequestProcessor
Throws:
ServletException

processValidate

protected boolean processValidate(HttpServletRequest request,
                                  HttpServletResponse response,
                                  ActionForm form,
                                  ActionMapping mapping)
                           throws IOException,
                                  ServletException
Overrides:
processValidate in class RequestProcessor
Throws:
IOException
ServletException

processForward

protected boolean processForward(HttpServletRequest request,
                                 HttpServletResponse response,
                                 ActionMapping mapping)
                          throws IOException,
                                 ServletException
Overrides:
processForward in class RequestProcessor
Throws:
IOException
ServletException

processInclude

protected boolean processInclude(HttpServletRequest request,
                                 HttpServletResponse response,
                                 ActionMapping mapping)
                          throws IOException,
                                 ServletException
Overrides:
processInclude in class RequestProcessor
Throws:
IOException
ServletException

process

public void process(HttpServletRequest request,
                    HttpServletResponse response)
             throws IOException,
                    ServletException
Overrides:
process in class RequestProcessor
Throws:
IOException
ServletException

processMultipart

protected HttpServletRequest processMultipart(HttpServletRequest request)
If this is a multipart request, wrap it with a special wrapper. Otherwise, return the request unchanged.

Overrides:
processMultipart in class RequestProcessor
Parameters:
request - The HttpServletRequest we are processing

getBeginMapping

protected ActionMapping getBeginMapping()

processException

public ActionForward processException(HttpServletRequest request,
                                      HttpServletResponse response,
                                      Exception ex,
                                      ActionForm form,
                                      ActionMapping mapping)
                               throws IOException,
                                      ServletException
Overrides:
processException in class RequestProcessor
Throws:
IOException
ServletException

processMapping

public ActionMapping processMapping(HttpServletRequest request,
                                    HttpServletResponse response,
                                    String path)
                             throws IOException
Overrides:
processMapping in class RequestProcessor
Throws:
IOException

trySharedFlowAction

protected boolean trySharedFlowAction(String actionPath,
                                      HttpServletRequest request,
                                      HttpServletResponse response)
                               throws IOException
Throws:
IOException

processUnresolvedAction

protected ActionMapping processUnresolvedAction(String actionPath,
                                                String originalServletPath,
                                                HttpServletRequest request,
                                                HttpServletResponse response,
                                                Object returningForm)
                                         throws IOException
Throws:
IOException

processRoles

protected boolean processRoles(HttpServletRequest request,
                               HttpServletResponse response,
                               ActionMapping mapping)
                        throws IOException,
                               ServletException
Overrides:
processRoles in class RequestProcessor
Throws:
IOException
ServletException

processForwardConfig

protected void processForwardConfig(HttpServletRequest request,
                                    HttpServletResponse response,
                                    ForwardConfig fwd)
                             throws IOException,
                                    ServletException
This override of the base method ensures that absolute URIs don't get the context path prepended, and handles forwards to special things like return-to="currentPage".

Overrides:
processForwardConfig in class RequestProcessor
Throws:
IOException
ServletException

changeScheme

protected void changeScheme(String webappRelativeURI,
                            String scheme,
                            int port,
                            HttpServletRequest request,
                            HttpServletResponse response)
                     throws URISyntaxException,
                            IOException,
                            ServletException
Throws:
URISyntaxException
IOException
ServletException

shouldDoSecureForwards

protected boolean shouldDoSecureForwards()
Deprecated. Use ContextCache.shouldDoSecureForwards() instead.


doForward

protected void doForward(String uri,
                         HttpServletRequest request,
                         HttpServletResponse response)
                  throws IOException,
                         ServletException
Overrides:
doForward in class RequestProcessor
Throws:
IOException
ServletException

processNoCache

protected void processNoCache(HttpServletRequest request,
                              HttpServletResponse response)
Set the no-cache headers for all responses. This overrides the base Struts behavior to prevent caching entirely in iterative dev mode.

Overrides:
processNoCache in class RequestProcessor

processActionPerform

protected ActionForward processActionPerform(HttpServletRequest request,
                                             HttpServletResponse response,
                                             Action action,
                                             ActionForm form,
                                             ActionMapping mapping)
                                      throws IOException,
                                             ServletException
Overrides:
processActionPerform in class RequestProcessor
Throws:
IOException
ServletException