Eclipse
Eclipse
IDEA
IntelliJ
NetBeans
NetBeans
XpoLog
XpoLog
Package org.apache.beehive.netui.pageflow
SinceNot specified.
VersionNot specified.
AuthorNot specified.
Wiki javadoc Use textile entry format.
Add your comments here.
Interfaces
ActionResolver Interface for controller classes that resolve actions to URIs.
ActionResult Encapsulation of the results returned by strutsLookup(ServletContext, ServletRequest, HttpServletResponse, String, String[]) .
AutoRegisterActionServlet.ModuleConfigLocator Interface for specifying alternate locations for auto-registered Struts modules.
PageFlowConstants Constants related to Page Flow.
PageFlowContextActivator This interface will create an object that will be put into the PageFlow context, it it doesn't already exist there.
PageFlowControlContainer No description provided.
RequestParameterHandler No description provided.
ResponseErrorCodeSender No description provided.
ServletContainerAdapter Adapter interface for plugging into various Servlet containers.
Validatable Interface for beans that can validate themselves.
Classes
AutoRegisterActionServlet ActionServlet that automatically registers requested Struts modules based on a set of module configuration file locators.
DefaultPageFlowEventReporter Default event reporter.
DefaultPageFlowEventReporter.LogMsg No description provided.
DefaultServletContainerAdapter Default implementation of a Servlet container adapter.
DynaFormData Extension of org.apache.struts.validator.DynaValidatorForm that implements Map.
DynamicSubappActionServlet ActionServlet that dynamically registers modules based on naming/location conventions for Struts configuration files that are generated by the Page Flow compiler.
ExpressionMessage Extension of the base Struts ActionMessage; instead of retrieving messages and their arguments from message resources, it calculates them by evaluating JSP 2.0-style expressions (or, in the degenerate case, from hardcoded strings).
FacesBackingBean

A JavaServer Faces backing bean.
FacesBackingBeanFactory Factory for creating "backing beans" for JavaServer Faces pages.
FlowController Base class for user-written flow controllers - PageFlowController s and SharedFlowController s.
FlowControllerFactory

Factory for creating FlowController s - user PageFlowController s and SharedFlowController s.
FormData Base class for form beans associated with action methods in PageFlowController s.
Forward An object of this type is returned from an action methods in a PageFlowController to determine the next URI to be displayed.
GlobalApp Base class for user-defined global state and fallback controller logic.
PageFlowActionServlet ActionServlet that dynamically registers modules based on naming/location conventions for Struts configuration files that are generated by the Page Flow compiler.
PageFlowActionServlet.DefaultModuleConfigLocator Default ModuleConfigLocator that looks for Struts module configuration files according to the pattern "/WEB-INF/classes/_pageflow/struts-config-<module>".
PageFlowActionServlet.LegacyModuleConfigLocator ModuleConfigLocator that looks for legacy Struts module configuration files according to the pattern "/WEB-INF/struts-config-<module>".
PageFlowContext This class is a ThreadLocal class that contains the servlet information.
PageFlowContextListener Performs various initialization at ServletContext-init time.
PageFlowControlContainerFactory No description provided.
PageFlowControlContainerImpl This class provide a set of method that deal with the ControlContainerContext that is scoped to the FlowController.
PageFlowController

Base class for controller logic, exception handlers, and state associated with a particular web directory path.
PageFlowEventReporter An event reporter, which will be notified of events like "page flow created", "action raised", etc.
PageFlowFacesFilter Servlet Filter for JavaServer Faces requests.
PageFlowFileFilter File filter that accepts any PageFlowController source file (*.jpf).
PageFlowForbiddenFilter Servlet Filter that sends a specified error code on the response.
PageFlowJspFilter Servlet Filter for JSP requests.
PageFlowManagedObject Base class for Page Flow managed objects (like page flows and JavaServer Faces backing beans).
PageFlowPageFilter Base class for Servlet Filters that run before Page Flow page requests.
PageFlowRequestProcessor The Page Flow extension of the Struts RequestProcessor, which contains callbacks that are invoked during processing of a request to the Struts action servlet.
PageFlowRequestProcessor.ExceptionHandledAction Used by processMapping(HttpServletRequest, HttpServletResponse, String) .
PageFlowRequestProcessor.ExceptionHandledActionMapping Used by processMapping(HttpServletRequest, HttpServletResponse, String) .
PageFlowStack Stack for keeping track of a series of nested page flows.
PageFlowStack.PushedPageFlow Wrapper that contains a pushed page flow and information related to it.
PageFlowUtils Utility methods related to Page Flow.
PreviousActionInfo Stores information about a recent action execution within a pageflow -- used with Used with navigateTo= Jpf.NavigateTo.previousAction on Jpf.Forward , Jpf.SimpleAction , or Jpf.ConditionalForward .
PreviousInfo Base class for previous-page and previous-action information.
PreviousPageInfo Stores information about a previously-displayed page, as well as its initialization data.
ProcessPopulate Implement the processPopulate stage of the Struts / PageFlow request processing lifecycle.
ProcessPopulate.ExpressionUpdateNode An inner class that represnts the data that will be used to perform an update.
RequestContext Base request/response context.
SecurityProtocol Enumeration to represent secure/unsecure/unspecified values associated with paths in the webapp.
SharedFlowController

Base "shared flow" class for controller logic, exception handlers, and state that can be shared by any number of page flows.
StrutsModule An ActionResolver that submits actions to a Struts module.
StrutsModuleFactory No description provided.
Exceptions
ActionNotFoundException Exception that occurs when the user tries to execute an action that does not exist on the page flow.
ControlFieldInitializationException Exception thrown when there are errors initializing an annotated Control field.
DoubleSubmitException Exception thrown when an action marked with the @Jpf.Action(preventDoubleSubmit=... annotation attribute has been submitted to more than once.
EmptyNestingStackException Exception that occurs when the user invokes an action in a nested page flow that uses a @Jpf.Forward (... returnAction="action-name-in-calling-pageflow") annotation, but there is no calling page flow.
IllegalActionOutputException Exception that occurs when an action output has been added to a Forward that resolves to a @Jpf.Forward annotation marked with redirect =true.
IllegalOutputFormException Base type for errors related to output forms on Forwards.
IllegalOutputFormTypeException Exception that occurs when the first output form for a Forward resolves to a @Jpf.Forward annotation whose outputFormBean or outputFormBeanType attribute demands a different form type.
IllegalPageInputException Exception that occurs when a action output has been added to a Forward that resolves to a @Jpf.Forward annotation marked with redirect =true.
IllegalRedirectOutputFormException Exception that occurs when an output form has been added to a Forward that resolves to a @Jpf.Forward annotation marked with redirect =true.
InfiniteReturnToActionException Exception that occurs when the navigateTo= previousAction attribute is used on a @Jpf.Forward , a @Jpf.SimpleAction , or a @Jpf.ConditionalForward , but the previous action was the same as the current action (an infinite loop).
LoginExpiredException Exception thrown when NotLoggedInException would be thrown, and when the current HttpServletRequest refers to a session that no longer exists.
MismatchedActionOutputException Exception that occurs in iterative development mode when an action output attached to a Forward is of a different type than was declared.
MismatchedPageInputException Exception that occurs in iterative development mode when an action output attached to a Forward is of a different type than was declared.
MissingActionOutputException Exception that occurs when a required action output is missing from a Forward .
MissingPageInputException Exception that occurs when a required page input is missing from a Forward .
NoCurrentPageFlowException Exception that occurs when the navigateTo= previousAction , navigateTo= currentPage , or navigateTo= previousPage attribute is used on a @Jpf.Forward , a @Jpf.SimpleAction , or a @Jpf.ConditionalForward , but there is no current page flow.
NoMatchingActionMethodException Exception that occurs when the current action method does not accept the type of form bean passed in the Forward to the action.
NoPreviousActionException Exception that occurs when the navigateTo= previousAction attribute is used on a @Jpf.Forward , a @Jpf.SimpleAction , or a @Jpf.ConditionalForward , but thethere is no previously-run action in the page flow.
NoPreviousPageException Exception that occurs when the navigateTo= previousPage or navigateTo= currentPage attribute is used on a @Jpf.Forward , a @Jpf.SimpleAction , or a @Jpf.ConditionalForward , but there is no previously-shown page in the current page flow.
NotLoggedInException Exception thrown when:
  • An action ( @Jpf.Action or @Jpf.SimpleAction ) marked with loginRequired=true is hit when there is no logged-in user, or,
  • An action marked with rolesAllowed="list of roles" is hit when there is no logged-in user.
NullActionOutputException No description provided.
PageFlowException Base class for PageFlow-related Exceptions.
PageFlowManagedObjectException Base class for exceptions related to Page Flow managed objects.
SessionExpiredException Exception thrown in place of another PageFlowException when:
  • The requested session ID is different than the current session ID (or there is no current session), and
  • the original exception to be thrown returns true for causeMayBeSessionExpiration() , and
  • The <throw-session-expired-exception> element in WEB-INF/beehive-netui-config.xml is set to true (the default)
    • .
UnfulfilledRolesException Exception that is thrown when rolesAllowed is set on the current action's annotation ( @Jpf.Action or @Jpf.SimpleAction ), and there is a logged-in user who does not fulfil any of the given roles.
UnresolvableForwardException Exception thrown by Forward when its name does not resolve to one defined by a @Jpf.Forward annotation in the current action's @Jpf.Action annotation.