org.apache.beehive.netui.pageflow
Class SharedFlowController

Object
  extended by PageFlowManagedObject
      extended by FlowController
          extended by SharedFlowController
All Implemented Interfaces:
Serializable, EventListener, HttpSessionBindingListener, ActionResolver, PageFlowConstants
Direct Known Subclasses:
GlobalApp

public abstract class SharedFlowController
extends FlowController
implements PageFlowConstants

See Also:
Serialized Form

Field Summary
 
Fields inherited from class FlowController
defaultLocale, servlet
 
Fields inherited from interface PageFlowConstants
ACTION_EXTENSION, ACTION_OVERRIDE, AUTO_VIEW_RENDER_FORWARD_NAME, BEGIN_ACTION_NAME, DEFAULT_FORWARD_OVERFLOW_COUNT, DEFAULT_NESTING_OVERFLOW_COUNT, FORWARD_OVERFLOW_COUNT_PARAM, GLOBALAPP_CLASSNAME, GLOBALAPP_SOURCEFILE_NAME, JPF_EXTENSION, JPF_MODULE_CONFIG_EXTENSION, JPF_MODULE_CONFIG_GEN_DIR, JPF_MODULE_CONFIG_PREFIX, NESTING_OVERFLOW_COUNT_PARAM, PAGEFLOW_EXTENSION, PAGEFLOW_MODULE_CONFIG_EXTENSION, PAGEFLOW_MODULE_CONFIG_GEN_DIR, PAGEFLOW_MODULE_CONFIG_PREFIX, SECURE_FORWARDS_PARAM
 
Constructor Summary
SharedFlowController()
           
 
Method Summary
 void ensureFailover(HttpServletRequest request)
          Ensures that any changes to this FlowController will be replicated in a cluster (for failover), even if the replication scheme uses a change-detection algorithm that relies on HttpSession.setAttribute to be aware of changes.
 String getDisplayName()
           
 String getModulePath()
          Get the Struts module path.
 PreviousPageInfo getPreviousPageInfoLegacy(PageFlowController curJpf, HttpServletRequest request)
          Deprecated. This method will be removed without replacement in a future release.
 String getURI()
          Get the URI.
 void persistInSession(HttpServletRequest request, HttpServletResponse response)
          Store this object in the user session, in the appropriate place.
protected  void removeFromSession(HttpServletRequest request)
          Remove this instance from the session.
 void savePreviousPageInfo(ActionForward forward, ActionForm form, ActionMapping mapping, HttpServletRequest request, ServletContext servletContext, boolean isSpecialForward)
          Store information about recent pages displayed.
 
Methods inherited from class FlowController
addActionError, addActionErrorExpression, addValidationError, addValidationError, afterAction, alwaysTrackPreviousAction, alwaysTrackPreviousPage, beforeAction, create, execute, generateToken, generateToken, getActionMapping, getActionMethod, getActions, getActionURI, getCurrentActionName, getDataSource, getDataSource, getDefaultLocale, getFormBean, getLocale, getLocale, getMapping, getMessageResources, getMessageResources, getModuleConfig, getModuleConfig, getRequest, getResources, getResources, getResources, getResponse, getRewrittenActionURI, getServlet, getSession, handleException, internalExecute, invokeActionMethod, invokeExceptionHandler, isAction, isCancelled, isPageFlow, isTokenValid, isTokenValid, isTokenValid, isTokenValid, login, logout, lookup, lookup, onCreate, onDestroy, onDestroy, onRefresh, refresh, reinitialize, remove, resetToken, resetToken, resolveAction, resolveAction, retrieveUserLocale, saveActionErrors, saveErrors, saveMessages, saveToken, sendError, sendError, setLocale, setLocale
 
Methods inherited from class PageFlowManagedObject
fieldIsUninitialized, getServletContext, initializeField, valueBound, valueUnbound
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SharedFlowController

public SharedFlowController()
Method Detail

getModulePath

public String getModulePath()
Get the Struts module path.

Specified by:
getModulePath in interface ActionResolver
Specified by:
getModulePath in class FlowController
Returns:
"/-global".

persistInSession

public void persistInSession(HttpServletRequest request,
                             HttpServletResponse response)
Description copied from class: PageFlowManagedObject
Store this object in the user session, in the appropriate place.

Specified by:
persistInSession in class PageFlowManagedObject

ensureFailover

public void ensureFailover(HttpServletRequest request)
Ensures that any changes to this FlowController will be replicated in a cluster (for failover), even if the replication scheme uses a change-detection algorithm that relies on HttpSession.setAttribute to be aware of changes.

Specified by:
ensureFailover in class PageFlowManagedObject
Parameters:
request - the current HttpServletRequest

getURI

public String getURI()
Get the URI.

Specified by:
getURI in interface ActionResolver
Returns:
null, as this object is not URL-addressible.

getDisplayName

public String getDisplayName()
Specified by:
getDisplayName in class PageFlowManagedObject

getPreviousPageInfoLegacy

public PreviousPageInfo getPreviousPageInfoLegacy(PageFlowController curJpf,
                                                  HttpServletRequest request)
Deprecated. This method will be removed without replacement in a future release.

Get a legacy PreviousPageInfo.

Specified by:
getPreviousPageInfoLegacy in class FlowController

savePreviousPageInfo

public void savePreviousPageInfo(ActionForward forward,
                                 ActionForm form,
                                 ActionMapping mapping,
                                 HttpServletRequest request,
                                 ServletContext servletContext,
                                 boolean isSpecialForward)
Store information about recent pages displayed. Usually should not be called directly.

Overrides:
savePreviousPageInfo in class FlowController

removeFromSession

protected void removeFromSession(HttpServletRequest request)
Remove this instance from the session.

Specified by:
removeFromSession in class PageFlowManagedObject