org.apache.beehive.netui.pageflow.internal
Class PageFlowRequestWrapper

Object
  extended by ServletRequestWrapper
      extended by HttpServletRequestWrapper
          extended by PageFlowRequestWrapper
All Implemented Interfaces:
HttpServletRequest, ServletRequest

public final class PageFlowRequestWrapper
extends HttpServletRequestWrapper


Field Summary
 
Fields inherited from interface HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
 
Constructor Summary
PageFlowRequestWrapper(HttpServletRequest delegate)
           
 
Method Summary
static PageFlowRequestWrapper get(ServletRequest servletRequest)
           
 String getCharacterEncoding()
          This override returns "utf-8" if the character encoding in the request is null.
 FlowController getCurrentFlowController()
           
 Throwable getExceptionBeingHandled()
           
 int getForwardedRequestCount()
           
 HttpServletRequest getHttpRequest()
           
 MultipartRequestWrapper getMultipartRequestWrapper()
           
 String getOriginalServletPath()
           
 String getPageFlowScopedFormName()
           
 PreviousPageInfo getPreviousPageInfo(boolean remove)
           
 ViewRenderer getViewRenderer()
           
 void initFrom(PageFlowRequestWrapper wrapper)
           
 boolean isForwardedByButton()
           
 boolean isForwardedRequest()
           
 boolean isProcessPopulateAlreadyCalled()
           
 boolean isReturningFromActionIntercept()
           
 boolean isStayInCurrentModule()
           
 void setCurrentFlowController(FlowController currentFlowController)
           
 void setExceptionBeingHandled(Throwable th)
           
 void setForwardedByButton(boolean forwardedByButton)
           
 void setForwardedRequestCount(int count)
           
 void setMultipartRequestWrapper(MultipartRequestWrapper multipartRequestWrapper)
           
 void setOriginalServletPath(String originalServletPath)
           
 void setPageFlowScopedFormName(String pageFlowScopedFormName)
           
 void setPreviousPageInfo(PreviousPageInfo previousPageInfo)
           
 void setProcessPopulateAlreadyCalled(boolean processPopulateAlreadyCalled)
           
 void setReturningFromActionIntercept(boolean returningFromActionIntercept)
           
 void setStayInCurrentModule(boolean stayInCurrentModule)
           
 void setViewRenderer(ViewRenderer viewRenderer)
           
static PageFlowRequestWrapper unwrap(ServletRequest servletRequest)
          Unwrap to find the PageFlowRequestWrapper.
static PageFlowRequestWrapper wrapRequest(HttpServletRequest req)
           
 
Methods inherited from class HttpServletRequestWrapper
getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole
 
Methods inherited from class ServletRequestWrapper
getAttribute, getAttributeNames, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface ServletRequest
getAttribute, getAttributeNames, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding
 

Constructor Detail

PageFlowRequestWrapper

public PageFlowRequestWrapper(HttpServletRequest delegate)
Method Detail

get

public static PageFlowRequestWrapper get(ServletRequest servletRequest)

unwrap

public static PageFlowRequestWrapper unwrap(ServletRequest servletRequest)
Unwrap to find the PageFlowRequestWrapper. This method may return null.


initFrom

public void initFrom(PageFlowRequestWrapper wrapper)

isForwardedRequest

public boolean isForwardedRequest()

getForwardedRequestCount

public int getForwardedRequestCount()

setForwardedRequestCount

public void setForwardedRequestCount(int count)

getOriginalServletPath

public String getOriginalServletPath()

setOriginalServletPath

public void setOriginalServletPath(String originalServletPath)

getCurrentFlowController

public FlowController getCurrentFlowController()

setCurrentFlowController

public void setCurrentFlowController(FlowController currentFlowController)

getViewRenderer

public ViewRenderer getViewRenderer()

setViewRenderer

public void setViewRenderer(ViewRenderer viewRenderer)

getPreviousPageInfo

public PreviousPageInfo getPreviousPageInfo(boolean remove)

setPreviousPageInfo

public void setPreviousPageInfo(PreviousPageInfo previousPageInfo)

isReturningFromActionIntercept

public boolean isReturningFromActionIntercept()

setReturningFromActionIntercept

public void setReturningFromActionIntercept(boolean returningFromActionIntercept)

getHttpRequest

public HttpServletRequest getHttpRequest()

getPageFlowScopedFormName

public String getPageFlowScopedFormName()

setPageFlowScopedFormName

public void setPageFlowScopedFormName(String pageFlowScopedFormName)

isProcessPopulateAlreadyCalled

public boolean isProcessPopulateAlreadyCalled()

setProcessPopulateAlreadyCalled

public void setProcessPopulateAlreadyCalled(boolean processPopulateAlreadyCalled)

isForwardedByButton

public boolean isForwardedByButton()

setForwardedByButton

public void setForwardedByButton(boolean forwardedByButton)

getMultipartRequestWrapper

public MultipartRequestWrapper getMultipartRequestWrapper()

setMultipartRequestWrapper

public void setMultipartRequestWrapper(MultipartRequestWrapper multipartRequestWrapper)

isStayInCurrentModule

public boolean isStayInCurrentModule()

setStayInCurrentModule

public void setStayInCurrentModule(boolean stayInCurrentModule)

getExceptionBeingHandled

public Throwable getExceptionBeingHandled()

setExceptionBeingHandled

public void setExceptionBeingHandled(Throwable th)

wrapRequest

public static PageFlowRequestWrapper wrapRequest(HttpServletRequest req)

getCharacterEncoding

public String getCharacterEncoding()
This override returns "utf-8" if the character encoding in the request is null. It works around a Struts issue (http://issues.apache.org/bugzilla/show_bug.cgi?id=29668), where CommonsMultipartRequestHandler uses the character encoding from the request, which causes problems if the encoding wasn't specified in the request (as it usually never is). This is tracked in Beehive's JIRA as http://issues.apache.org/jira/browse/BEEHIVE-803 .

Specified by:
getCharacterEncoding in interface ServletRequest
Overrides:
getCharacterEncoding in class ServletRequestWrapper