Java Doc for PageFlowController.java in  » Library » Apache-beehive-1.0.2-src » org » apache » beehive » netui » pageflow » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Library » Apache beehive 1.0.2 src » org.apache.beehive.netui.pageflow 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.beehive.netui.pageflow.PageFlowManagedObject
      org.apache.beehive.netui.pageflow.FlowController
         org.apache.beehive.netui.pageflow.PageFlowController

PageFlowController
abstract public class PageFlowController extends FlowController implements InternalConstants(Code)

Base class for controller logic, exception handlers, and state associated with a particular web directory path. The class is configured through the org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller annotation.

When a page flow request (the page flow URI itself, or any ".do" or page URI in the directory path), arrives, an instance of the associated PageFlowController class is set as the current page flow, and remains stored in the session until a different one becomes active ("long lived" page flows stay in the session indefinitely; see org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.longLived longLived on org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller ).

The page flow class handles actions that are most commonly raised by user interaction with pages. The actions are handled by action methods or action annotations that determine the next URI to be displayed, after optionally performing arbitrary logic.

If the PageFlowController is a "nested page flow" ( org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.nested nested is set to true on org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller ), then this is a reusable, modular flow that can be "nested" during other flows. It has entry points (actions with optional form bean arguments), and exit points ( org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward annotations that have returnAction attributes).

The page flow class also handles exceptions thrown by actions or during page execution (see org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.catches catches on org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller ). Unhandled exceptions are handled in order by declared SharedFlowController s (see org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.sharedFlowRefs sharedFlowRefs on org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller ).

Properties in the current page flow instance can be accessed from JSP 2.0-style expressions like this one: ${pageFlow.someProperty}.

There may only be one page flow in any package.


See Also:   SharedFlowController


Field Summary
 ControlContainerContext_beanContext
    

Constructor Summary
protected  PageFlowController()
     Default constructor.

Method Summary
final  voidbeforePage()
    
final public synchronized  voidcreate(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
     This is a framework method for initializing a newly-created page flow, and should not normally be called directly.
public  voidensureFailover(HttpServletRequest request)
    

Ensure that any changes to this object will be replicated in a cluster (for failover), even if the replication scheme uses a change-detection algorithm that relies on javax.servlet.http.HttpSession.setAttribute(StringObject) to be aware of changes.

public  ActionForwardexitNesting(HttpServletRequest request, HttpServletResponse response, ActionMapping mapping, ActionForm form)
    
 ActionForwardforwardTo(ActionForward fwd, ActionMapping mapping, PageFlowExceptionConfig exceptionConfig, String actionName, ModuleConfig altModuleConfig, ActionForm form, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
    
public  StringgetCurrentForwardPath()
     Get the webapp-relative URI for the most recent page (in this page flow) shown to the user.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage currentPage or navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousPage previousPage , then this method will always return null by default.

final protected  PreviousPageInfogetCurrentPageInfo()
     Get information about the most recent page (in this page flow) shown to the user.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage currentPage or navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousPage previousPage , then this method will always return null by default.

public  StringgetDisplayName()
     Get the display name of this page flow.
public  StringgetModulePath()
     Get the Struts module path for this page flow.
final protected  PreviousActionInfogetPreviousActionInfo()
     Get information about the most recent action run in this page flow.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousAction previousAction , then this method will always return null by default.

protected  StringgetPreviousActionURI()
     Get the URI for the most recent action in this PageFlowController.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousAction previousAction , then this method will always return null by default.

protected  ActionFormgetPreviousForm()
     Get the submitted form bean from the most recent action execution in this PageFlowController.

Note: if the current page flow does not contain a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward or a org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousAction Jpf.NavigateTo.previousAction , then this method will always return null by default.

protected  ObjectgetPreviousFormBean()
     Get the submitted form bean from the most recent action execution in this PageFlowController.

Note: if the current page flow does not contain a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward or a org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousAction Jpf.NavigateTo.previousAction , then this method will always return null by default.

protected  StringgetPreviousForwardPath()
     Get the webapp-relative URI for the previous page (in this page flow) shown to the user. The previous page is the one shown before the most recent page.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage currentPage or navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousPage previousPage , then this method will always return null by default.

final protected  PreviousPageInfogetPreviousPageInfo()
     Get information about the previous page (in this page flow) shown to the user.
final public  PreviousPageInfogetPreviousPageInfoLegacy(PageFlowController curJpf, HttpServletRequest request)
     Get a legacy PreviousPageInfo.
public  SharedFlowControllergetSharedFlow(String sharedFlowName)
     Get a shared flow, based on its name as defined in this page flow's org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.sharedFlowRefs sharedFlowRefs attribute on org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller . To retrieve any shared flow based on its class name, use PageFlowUtils.getSharedFlow .
Parameters:
  sharedFlowName - the name of the shared flow, as in this page flows'sorg.apache.beehive.netui.pageflow.annotations.Jpf.Controller.sharedFlowRefs sharedFlowRefsattribute on the org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controllerannotation.
protected  MapgetSharedFlows()
     Get the a map of shared flow name to shared flow instance.
protected  StringgetTaxonomy()
     Get the "resource taxonomy": a period-separated list that starts with the current web application name, continues through all of this PageFlowController's parent directories, and ends with this PageFlowController's class name.
public  StringgetURI()
     Get the URI for addressing this PageFlowController.
protected  ActionForwardinternalExecute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
    
protected  booleanisLongLived()
     Tell whether this is a "long lived" page flow.
protected  booleanisNestable()
     Tell whether this PageFlowController can be "nested", i.e., if it can be invoked from another page flow with the intention of returning to the original one.
public  booleanisPageFlow()
     Tell whether this is a PageFlowController.
public  booleanisPreviousActionInfoDisabled()
    
public  booleanisPreviousPageInfoDisabled()
    
protected  voidonExitNesting()
     Callback that is invoked when this controller instance is exiting nesting through a return action.
public  voidpersistInSession(HttpServletRequest request, HttpServletResponse response)
     Store this object in the user session, in the appropriate place.
public synchronized  voidremoveFromSession(HttpServletRequest request)
     Remove this instance from the session.
public  voidremoveSharedFlow(String sharedFlowName)
     Remove a shared flow from the session, based on its name as defined in this page flow's org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.sharedFlowRefs sharedFlowRefs attribute on org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller .
 voidsavePreviousActionInfo(ActionForm form, HttpServletRequest request, ActionMapping mapping, ServletContext servletContext)
     Called from FlowController.execute .
public  voidsavePreviousPageInfo(ActionForward forward, ActionForm form, ActionMapping mapping, HttpServletRequest request, ServletContext servletContext, boolean isSpecialForward)
     Store information about recent pages displayed.
 voidsetIsOnNestingStack(boolean isOnNestingStack)
    
final public  PreviousPageInfotheCurrentPageInfo()
     This is a non-property public accessor that will return the property value currrentPageInfo.
final public  PreviousActionInfothePreviousActionInfo()
     This is a non-property public accessor that will return the property value previousActionInfo.
final public  PreviousPageInfothePreviousPageInfo()
     This is a non-property public accessor that will return the property value previousPageInfo.
final public  MaptheSharedFlows()
     This is a non-property public accessor that will return the property value sharedFlows.
public  voidvalueUnbound(HttpSessionBindingEvent event)
     Callback when this object is removed from the user session.

Field Detail
_beanContext
ControlContainerContext _beanContext(Code)
The bean context associated with this request




Constructor Detail
PageFlowController
protected PageFlowController()(Code)
Default constructor.




Method Detail
beforePage
final void beforePage()(Code)



create
final public synchronized void create(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)(Code)
This is a framework method for initializing a newly-created page flow, and should not normally be called directly.



ensureFailover
public void ensureFailover(HttpServletRequest request)(Code)

Ensure that any changes to this object will be replicated in a cluster (for failover), even if the replication scheme uses a change-detection algorithm that relies on javax.servlet.http.HttpSession.setAttribute(StringObject) to be aware of changes. This method is used by the framework and should not be called directly in most cases.

Note, this method ultimately causes the Page Flow to be persisted in the StorageHandler for this web application.


Parameters:
  request - the current HttpServletRequest



exitNesting
public ActionForward exitNesting(HttpServletRequest request, HttpServletResponse response, ActionMapping mapping, ActionForm form)(Code)



forwardTo
ActionForward forwardTo(ActionForward fwd, ActionMapping mapping, PageFlowExceptionConfig exceptionConfig, String actionName, ModuleConfig altModuleConfig, ActionForm form, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)(Code)



getCurrentForwardPath
public String getCurrentForwardPath()(Code)
Get the webapp-relative URI for the most recent page (in this page flow) shown to the user.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage currentPage or navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousPage previousPage , then this method will always return null by default. To enable it in this situation, add the following method to the page flow:

protected boolean alwaysTrackPreviousPage()
{
    return true;
}
a String that is the URI path for the most recent page shown to the user.
See Also:   PageFlowController.getPreviousPageInfo
See Also:   PageFlowController.getCurrentPageInfo
See Also:   PageFlowController.getPreviousActionInfo
See Also:   PageFlowController.getPreviousActionURI
See Also:   PageFlowController.getPreviousFormBean
See Also:   PageFlowController.getPreviousForwardPath



getCurrentPageInfo
final protected PreviousPageInfo getCurrentPageInfo()(Code)
Get information about the most recent page (in this page flow) shown to the user.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage currentPage or navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousPage previousPage , then this method will always return null by default. To enable it in this situation, add the following method to the page flow:

protected boolean alwaysTrackPreviousPage()
{
    return true;
}
a PreviousPageInfo with information about the most recent page shown to the user.
See Also:   PageFlowController.getPreviousPageInfo
See Also:   PageFlowController.getPreviousActionInfo
See Also:   PageFlowController.getPreviousActionURI
See Also:   PageFlowController.getPreviousFormBean
See Also:   PageFlowController.getPreviousForwardPath
See Also:   PageFlowController.getCurrentForwardPath



getDisplayName
public String getDisplayName()(Code)
Get the display name of this page flow. the display name (the URI) of this page flow.



getModulePath
public String getModulePath()(Code)
Get the Struts module path for this page flow. a String that is the Struts module path for this controller, and which is alsothe directory path from the web application root to this PageFlowController(not including the action filename).



getPreviousActionInfo
final protected PreviousActionInfo getPreviousActionInfo()(Code)
Get information about the most recent action run in this page flow.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousAction previousAction , then this method will always return null by default. To enable it in this situation, add the following method to the page flow:

protected boolean alwaysTrackPreviousAction()
{
    return true;
}
a PreviousActionInfo with information about the most recent action run in this page flow.
See Also:   PageFlowController.getPreviousPageInfo
See Also:   PageFlowController.getCurrentPageInfo
See Also:   PageFlowController.getPreviousActionURI
See Also:   PageFlowController.getPreviousFormBean
See Also:   PageFlowController.getPreviousForwardPath
See Also:   PageFlowController.getCurrentForwardPath



getPreviousActionURI
protected String getPreviousActionURI()(Code)
Get the URI for the most recent action in this PageFlowController.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousAction previousAction , then this method will always return null by default. To enable it in this situation, add the following method to the page flow:

protected boolean alwaysTrackPreviousAction()
{
    return true;
}
a String that is the most recent URI.
See Also:   PageFlowController.getPreviousPageInfo
See Also:   PageFlowController.getCurrentPageInfo
See Also:   PageFlowController.getPreviousActionInfo
See Also:   PageFlowController.getPreviousFormBean
See Also:   PageFlowController.getPreviousForwardPath
See Also:   PageFlowController.getCurrentForwardPath



getPreviousForm
protected ActionForm getPreviousForm()(Code)
Get the submitted form bean from the most recent action execution in this PageFlowController.

Note: if the current page flow does not contain a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward or a org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousAction Jpf.NavigateTo.previousAction , then this method will always return null by default. To enable it in this situation, add the following method to the page flow:

protected boolean alwaysTrackPreviousAction()
{
    return true;
}
PageFlowController.getPreviousFormBean the ActionForm instance from the most recent action execution, or nullif there was no form bean submitted.
See Also:   PageFlowController.getPreviousPageInfo
See Also:   PageFlowController.getCurrentPageInfo
See Also:   PageFlowController.getPreviousActionInfo
See Also:   PageFlowController.getPreviousActionURI
See Also:   PageFlowController.getPreviousForwardPath
See Also:   PageFlowController.getCurrentForwardPath



getPreviousFormBean
protected Object getPreviousFormBean()(Code)
Get the submitted form bean from the most recent action execution in this PageFlowController.

Note: if the current page flow does not contain a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward or a org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousAction Jpf.NavigateTo.previousAction , then this method will always return null by default. To enable it in this situation, add the following method to the page flow:

protected boolean alwaysTrackPreviousAction()
{
    return true;
}
the form bean instance from the most recent action execution, or nullif there was no form bean submitted.
See Also:   PageFlowController.getPreviousPageInfo
See Also:   PageFlowController.getCurrentPageInfo
See Also:   PageFlowController.getPreviousActionInfo
See Also:   PageFlowController.getPreviousActionURI
See Also:   PageFlowController.getPreviousForwardPath
See Also:   PageFlowController.getCurrentForwardPath



getPreviousForwardPath
protected String getPreviousForwardPath()(Code)
Get the webapp-relative URI for the previous page (in this page flow) shown to the user. The previous page is the one shown before the most recent page.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage currentPage or navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousPage previousPage , then this method will always return null by default. To enable it in this situation, add the following method to the page flow:

protected boolean alwaysTrackPreviousPage()
{
    return true;
}
a String that is the URI path for the previous page shown to the user.
See Also:   PageFlowController.getPreviousPageInfo
See Also:   PageFlowController.getCurrentPageInfo
See Also:   PageFlowController.getPreviousActionInfo
See Also:   PageFlowController.getPreviousActionURI
See Also:   PageFlowController.getPreviousFormBean
See Also:   PageFlowController.getCurrentForwardPath



getPreviousPageInfo
final protected PreviousPageInfo getPreviousPageInfo()(Code)
Get information about the previous page (in this page flow) shown to the user. The previous page is the one shown before the most recent page.

Note: if the current page flow does not use a org.apache.beehive.netui.pageflow.annotations.Jpf.Forward @Jpf.Forward , org.apache.beehive.netui.pageflow.annotations.Jpf.SimpleAction @Jpf.SimpleAction , or org.apache.beehive.netui.pageflow.annotations.Jpf.ConditionalForward @Jpf.ConditionalForward with navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.currentPage currentPage or navigateTo= org.apache.beehive.netui.pageflow.annotations.Jpf.NavigateTo.previousPage previousPage , then this method will always return null by default. To enable it in this situation, add the following method to the page flow:
a PreviousPageInfo with information about the previous page shown to the user.
See Also:   PageFlowController.getCurrentPageInfo
See Also:   PageFlowController.getPreviousActionInfo
See Also:   PageFlowController.getPreviousActionURI
See Also:   PageFlowController.getPreviousFormBean
See Also:   PageFlowController.getPreviousForwardPath
See Also:   PageFlowController.getCurrentForwardPath




getPreviousPageInfoLegacy
final public PreviousPageInfo getPreviousPageInfoLegacy(PageFlowController curJpf, HttpServletRequest request)(Code)
Get a legacy PreviousPageInfo.



getSharedFlow
public SharedFlowController getSharedFlow(String sharedFlowName)(Code)
Get a shared flow, based on its name as defined in this page flow's org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.sharedFlowRefs sharedFlowRefs attribute on org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller . To retrieve any shared flow based on its class name, use PageFlowUtils.getSharedFlow .
Parameters:
  sharedFlowName - the name of the shared flow, as in this page flows'sorg.apache.beehive.netui.pageflow.annotations.Jpf.Controller.sharedFlowRefs sharedFlowRefsattribute on the org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controllerannotation. the SharedFlowController with the given name.



getSharedFlows
protected Map getSharedFlows()(Code)
Get the a map of shared flow name to shared flow instance. a Map of shared flow name (string) to shared flow instance (SharedFlowController).



getTaxonomy
protected String getTaxonomy()(Code)
Get the "resource taxonomy": a period-separated list that starts with the current web application name, continues through all of this PageFlowController's parent directories, and ends with this PageFlowController's class name.



getURI
public String getURI()(Code)
Get the URI for addressing this PageFlowController. a String that is the URI which will execute the begin action on thisPageFlowController.



internalExecute
protected ActionForward internalExecute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)



isLongLived
protected boolean isLongLived()(Code)
Tell whether this is a "long lived" page flow. Once it is invoked, a long lived page flow is never removed from the session unless PageFlowController.remove is called. Navigating to another page flow hides the current long lived controller, but does not remove it.



isNestable
protected boolean isNestable()(Code)
Tell whether this PageFlowController can be "nested", i.e., if it can be invoked from another page flow with the intention of returning to the original one. Page flows are declared to be nested by specifying org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.nested nested =true on the org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller annotation. true if this PageFlowController can be nested.



isPageFlow
public boolean isPageFlow()(Code)
Tell whether this is a PageFlowController. true.



isPreviousActionInfoDisabled
public boolean isPreviousActionInfoDisabled()(Code)



isPreviousPageInfoDisabled
public boolean isPreviousPageInfoDisabled()(Code)



onExitNesting
protected void onExitNesting() throws Exception(Code)
Callback that is invoked when this controller instance is exiting nesting through a return action. FlowController.getRequest , FlowController.getResponse , FlowController.getSession may all be used during this method.



persistInSession
public void persistInSession(HttpServletRequest request, HttpServletResponse response)(Code)
Store this object in the user session, in the appropriate place. Used by the framework; normally should not be called directly.



removeFromSession
public synchronized void removeFromSession(HttpServletRequest request)(Code)
Remove this instance from the session. When inside a page flow action, PageFlowController.remove may be called instead. This method is synchronized in order to maintain single threaded semantics for the Page Flow's PageFlowController.onDestroy(javax.servlet.http.HttpSession) lifecycle method.



removeSharedFlow
public void removeSharedFlow(String sharedFlowName)(Code)
Remove a shared flow from the session, based on its name as defined in this page flow's org.apache.beehive.netui.pageflow.annotations.Jpf.Controller.sharedFlowRefs sharedFlowRefs attribute on org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controller . To remove any shared flow based on its class name, use PageFlowUtils.removeSharedFlow .
Parameters:
  sharedFlowName - the name of the shared flow, as in this page flows'sorg.apache.beehive.netui.pageflow.annotations.Jpf.Controller.sharedFlowRefs sharedFlowRefsattribute on the org.apache.beehive.netui.pageflow.annotations.Jpf.Controller @Jpf.Controllerannotation.



savePreviousActionInfo
void savePreviousActionInfo(ActionForm form, HttpServletRequest request, ActionMapping mapping, ServletContext servletContext)(Code)
Called from FlowController.execute .



savePreviousPageInfo
public void savePreviousPageInfo(ActionForward forward, ActionForm form, ActionMapping mapping, HttpServletRequest request, ServletContext servletContext, boolean isSpecialForward)(Code)
Store information about recent pages displayed. This is a framework-invoked method that should not normally be called directly.



setIsOnNestingStack
void setIsOnNestingStack(boolean isOnNestingStack)(Code)



theCurrentPageInfo
final public PreviousPageInfo theCurrentPageInfo()(Code)
This is a non-property public accessor that will return the property value currrentPageInfo. This is a non-property method because properties are exposed to databinding and that would expose internal data structures to attack. a PreviousPageInfo with information about the most recent page shown to the user.



thePreviousActionInfo
final public PreviousActionInfo thePreviousActionInfo()(Code)
This is a non-property public accessor that will return the property value previousActionInfo. This is a non-property method because properties are exposed to databinding and that would expose internal data structures to attack. a PreviousActionInfo with information about the most recent action run in this page flow.



thePreviousPageInfo
final public PreviousPageInfo thePreviousPageInfo()(Code)
This is a non-property public accessor that will return the property value previousPageInfo. This is a non-property method because properties are exposed to databinding and that would expose internal data structures to attack. a PreviousPageInfo with information about the previous page shown to the user.



theSharedFlows
final public Map theSharedFlows()(Code)
This is a non-property public accessor that will return the property value sharedFlows. This is a non-property method because properties are exposed to databinding and that would expose internal data structures to attack. a Map of shared flow name (string) to shared flow instance (SharedFlowController).



valueUnbound
public void valueUnbound(HttpSessionBindingEvent event)(Code)
Callback when this object is removed from the user session. Causes PageFlowController.onDestroy to be called. This is a framework-invoked method that should not be called directly.



Fields inherited from org.apache.beehive.netui.pageflow.FlowController
protected static Locale defaultLocale(Code)(Java Doc)

Methods inherited from org.apache.beehive.netui.pageflow.FlowController
protected void addActionError(String propertyName, String messageKey, Object[] messageArgs)(Code)(Java Doc)
protected void addActionErrorExpression(String propertyName, String expression, Object[] messageArgs)(Code)(Java Doc)
protected void addValidationError(String propertyName, String messageKey, Object[] messageArgs)(Code)(Java Doc)
protected void addValidationError(String propertyName, String messageKey)(Code)(Java Doc)
protected synchronized void afterAction() throws Exception(Code)(Java Doc)
protected boolean alwaysTrackPreviousAction()(Code)(Java Doc)
protected boolean alwaysTrackPreviousPage()(Code)(Java Doc)
protected synchronized void beforeAction() throws Exception(Code)(Java Doc)
public synchronized void create(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)(Code)(Java Doc)
NotLoggedInException createNotLoggedInException(String actionName, HttpServletRequest request)(Code)(Java Doc)
void decrementRequestCount(HttpServletRequest request)(Code)(Java Doc)
void destroy(HttpSession session)(Code)(Java Doc)
public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
ActionForward forwardTo(ActionForward fwd, ActionMapping mapping, PageFlowExceptionConfig exceptionConfig, String actionName, ModuleConfig altModuleConfig, ActionForm form, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)(Code)(Java Doc)
protected String generateToken(HttpServletRequest request)(Code)(Java Doc)
protected String generateToken()(Code)(Java Doc)
final protected ActionMapping getActionMapping()(Code)(Java Doc)
protected Method getActionMethod(String methodName, Class argType)(Code)(Java Doc)
ActionForward getActionMethodForward(String actionName, Object inputForm, HttpServletRequest request, HttpServletResponse response, ActionMapping mapping) throws Exception(Code)(Java Doc)
public MutableURI getActionURI(String actionName) throws URISyntaxException(Code)(Java Doc)
protected String[] getActions()(Code)(Java Doc)
protected String getCurrentActionName()(Code)(Java Doc)
protected DataSource getDataSource(HttpServletRequest request)(Code)(Java Doc)
protected DataSource getDataSource(HttpServletRequest request, String key)(Code)(Java Doc)
protected static Locale getDefaultLocale()(Code)(Java Doc)
public ActionForm getFormBean(ActionMapping mapping)(Code)(Java Doc)
FlowControllerHandlerContext getHandlerContext()(Code)(Java Doc)
protected Locale getLocale(HttpServletRequest request)(Code)(Java Doc)
protected Locale getLocale()(Code)(Java Doc)
final protected ActionMapping getMapping()(Code)(Java Doc)
protected MessageResources getMessageResources()(Code)(Java Doc)
protected MessageResources getMessageResources(String key)(Code)(Java Doc)
final protected ModuleConfig getModuleConfig()(Code)(Java Doc)
public ModuleConfig getModuleConfig(ServletContext servletContext, HttpServletRequest request)(Code)(Java Doc)
abstract public String getModulePath()(Code)(Java Doc)
abstract public PreviousPageInfo getPreviousPageInfoLegacy(PageFlowController curJpf, HttpServletRequest request)(Code)(Java Doc)
final protected HttpServletRequest getRequest()(Code)(Java Doc)
PageFlowRequestProcessor getRequestProcessor()(Code)(Java Doc)
protected MessageResources getResources()(Code)(Java Doc)
protected MessageResources getResources(HttpServletRequest request)(Code)(Java Doc)
protected MessageResources getResources(HttpServletRequest request, String key)(Code)(Java Doc)
final protected HttpServletResponse getResponse()(Code)(Java Doc)
public String getRewrittenActionURI(String actionName, Map parameters, boolean asValidXml) throws URISyntaxException(Code)(Java Doc)
protected ActionServlet getServlet()(Code)(Java Doc)
final protected HttpSession getSession()(Code)(Java Doc)
public Principal getUserPrincipal()(Code)(Java Doc)
public synchronized ActionForward handleException(Throwable ex, ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException(Code)(Java Doc)
boolean incrementRequestCount(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext) throws IOException(Code)(Java Doc)
protected ActionForward internalExecute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
protected ActionForward invokeActionMethod(Method method, Object arg) throws Exception(Code)(Java Doc)
ActionForward invokeActionMethod(Method method, Object arg, HttpServletRequest request, ActionMapping mapping) throws Exception(Code)(Java Doc)
public synchronized ActionForward invokeExceptionHandler(Method method, Throwable ex, String message, ActionForm wrappedFormBean, PageFlowExceptionConfig exceptionConfig, ActionMapping actionMapping, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException(Code)(Java Doc)
public boolean isAction(String name)(Code)(Java Doc)
protected boolean isCancelled(HttpServletRequest request)(Code)(Java Doc)
public boolean isPageFlow()(Code)(Java Doc)
protected boolean isTokenValid(HttpServletRequest request)(Code)(Java Doc)
protected boolean isTokenValid()(Code)(Java Doc)
protected boolean isTokenValid(HttpServletRequest request, boolean reset)(Code)(Java Doc)
protected boolean isTokenValid(boolean reset)(Code)(Java Doc)
public boolean isUserInRole(String roleName)(Code)(Java Doc)
public void login(String username, String password) throws LoginException(Code)(Java Doc)
public void logout(boolean invalidateSessions)(Code)(Java Doc)
public static ActionResult lookup(String actionName, ServletContext context, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public static ActionResult lookup(String actionName, ServletContext context, HttpServletRequest request, HttpServletResponse response, String actionServletClassName) throws Exception(Code)(Java Doc)
protected void onCreate() throws Exception(Code)(Java Doc)
protected void onDestroy()(Code)(Java Doc)
protected void onDestroy(HttpSession session)(Code)(Java Doc)
protected void onRefresh()(Code)(Java Doc)
final public synchronized void refresh(HttpServletRequest request, HttpServletResponse response)(Code)(Java Doc)
public void reinitialize(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)(Code)(Java Doc)
protected void remove()(Code)(Java Doc)
protected void resetToken(HttpServletRequest request)(Code)(Java Doc)
protected void resetToken()(Code)(Java Doc)
public String resolveAction(String actionName, Object form, HttpServletRequest request, HttpServletResponse response) throws Exception(Code)(Java Doc)
public String resolveAction(String actionName, Object form) throws Exception(Code)(Java Doc)
public static Locale retrieveUserLocale(HttpServletRequest request, String locale)(Code)(Java Doc)
protected void saveActionErrors(ActionMessages errors)(Code)(Java Doc)
protected void saveErrors(HttpServletRequest request, ActionMessages errors)(Code)(Java Doc)
protected void saveMessages(HttpServletRequest request, ActionMessages messages)(Code)(Java Doc)
void savePreviousActionInfo(ActionForm form, HttpServletRequest request, ActionMapping mapping, ServletContext servletContext)(Code)(Java Doc)
public void savePreviousPageInfo(ActionForward forward, ActionForm form, ActionMapping mapping, HttpServletRequest request, ServletContext servletContext, boolean isSpecialForward)(Code)(Java Doc)
protected void saveToken(HttpServletRequest request)(Code)(Java Doc)
protected void sendError(String errText, HttpServletResponse response) throws IOException(Code)(Java Doc)
protected void sendError(String errText, HttpServletRequest request, HttpServletResponse response) throws IOException(Code)(Java Doc)
protected void setLocale(HttpServletRequest request, Locale locale)(Code)(Java Doc)
protected void setLocale(Locale locale)(Code)(Java Doc)
PerRequestState setPerRequestState(PerRequestState state)(Code)(Java Doc)
final public ModuleConfig theModuleConfig()(Code)(Java Doc)

Methods inherited from org.apache.beehive.netui.pageflow.PageFlowManagedObject
public synchronized void create(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext) throws Exception(Code)(Java Doc)
void destroy(HttpSession session)(Code)(Java Doc)
abstract public void ensureFailover(HttpServletRequest request)(Code)(Java Doc)
protected boolean fieldIsUninitialized(Field field)(Code)(Java Doc)
public long getCreateTime()(Code)(Java Doc)
abstract public String getDisplayName()(Code)(Java Doc)
protected ServletContext getServletContext()(Code)(Java Doc)
protected void initializeField(Field field, Object instance)(Code)(Java Doc)
boolean isDestroyed()(Code)(Java Doc)
protected void onCreate() throws Exception(Code)(Java Doc)
protected void onDestroy(HttpSession session)(Code)(Java Doc)
abstract public void persistInSession(HttpServletRequest request, HttpServletResponse response)(Code)(Java Doc)
public void reinitialize(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)(Code)(Java Doc)
void reinitializeIfNecessary(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)(Code)(Java Doc)
abstract public void removeFromSession(HttpServletRequest request)(Code)(Java Doc)
public void valueBound(HttpSessionBindingEvent event)(Code)(Java Doc)
public void valueUnbound(HttpSessionBindingEvent event)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.