org.apache.beehive.netui.pageflow.interceptor.action
Class ActionInterceptorContext

Object
  extended by InterceptorContext
      extended by RequestInterceptorContext
          extended by ActionInterceptorContext
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AfterNestedInterceptContext

public class ActionInterceptorContext
extends RequestInterceptorContext

Context passed to ActionInterceptor methods.

See Also:
Serialized Form

Constructor Summary
ActionInterceptorContext(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, PageFlowController controller, InterceptorForward originalForward, String actionName)
           
 
Method Summary
 List getActionInterceptors()
           
 String getActionName()
          Get the name of the action being raised.
static ActionInterceptorContext getActiveContext(ServletRequest request, boolean consume)
           
 InterceptorForward getInterceptorForward()
           
 InterceptorForward getOriginalForward()
          Get a wrapper for the original URI from the action that was intercepted.
 ActionInterceptor getOverridingActionInterceptor()
           
 PageFlowController getPageFlow()
          Get the page flow on which the action is being raised.
 boolean hasInterceptorForward()
           
static void init(ServletContext servletContext)
           
 void setOriginalForward(ActionForward origFwd)
           
 void setOverrideForward(InterceptorForward fwd, ActionInterceptor interceptor)
          Set an InterceptorForward that changes the destination URI of the intercepted action.
 
Methods inherited from class RequestInterceptorContext
addInterceptor, cancelRequest, getRequest, getRequestInterceptors, getResponse, getServletContext, requestWasCancelled
 
Methods inherited from class InterceptorContext
addInterceptor, addInterceptors, createInterceptor, getOverridingInterceptor, getResultOverride, hasResultOverride, setResultOverride
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ActionInterceptorContext

public ActionInterceptorContext(HttpServletRequest request,
                                HttpServletResponse response,
                                ServletContext servletContext,
                                PageFlowController controller,
                                InterceptorForward originalForward,
                                String actionName)
Method Detail

getPageFlow

public PageFlowController getPageFlow()
Get the page flow on which the action is being raised.


getOriginalForward

public InterceptorForward getOriginalForward()
Get a wrapper for the original URI from the action that was intercepted. This value will be null if the interceptor was run before the action, or if the action itself returned null.


getActionName

public String getActionName()
Get the name of the action being raised.


setOverrideForward

public void setOverrideForward(InterceptorForward fwd,
                               ActionInterceptor interceptor)
Set an InterceptorForward that changes the destination URI of the intercepted action. If the InterceptorForward points to a nested page flow, then ActionInterceptor.afterNestedIntercept(org.apache.beehive.netui.pageflow.interceptor.action.AfterNestedInterceptContext) will be called before the nested page flow returns to the original page flow.


getOverridingActionInterceptor

public ActionInterceptor getOverridingActionInterceptor()

getInterceptorForward

public InterceptorForward getInterceptorForward()

hasInterceptorForward

public boolean hasInterceptorForward()

getActiveContext

public static ActionInterceptorContext getActiveContext(ServletRequest request,
                                                        boolean consume)

getActionInterceptors

public List getActionInterceptors()

setOriginalForward

public void setOriginalForward(ActionForward origFwd)

init

public static void init(ServletContext servletContext)