Java Doc for FlowExecution.java in  » Workflow-Engines » spring-webflow-1.0.4 » org » springframework » webflow » execution » 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 » Workflow Engines » spring webflow 1.0.4 » org.springframework.webflow.execution 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.springframework.webflow.execution.FlowExecution

All known Subclasses:   org.springframework.webflow.engine.impl.FlowExecutionImpl,
FlowExecution
public interface FlowExecution extends FlowExecutionContext(Code)
A top-level instance of a flow definition that carries out definition execution on behalf of a single client. Typically used to support the orchestration of a web conversation.

This is the central facade interface for manipulating one runtime execution of a flow definition. Implementations of this interface are the finite state machine that is the heart of Spring Web Flow.

Typically, when a client wants to launch a flow execution at production time, she passes the id of the governing FlowDefinition flow definition to a coordinating org.springframework.webflow.executor.FlowExecutor.launch(StringExternalContext) flow executor . This coordinator then typically uses a FlowExecutionFactory flow execution factory to create an object implementing this interface, initializing it with the requested flow definition which becomes the execution's "root" or top-level flow.

After execution creation, the FlowExecution.start(MutableAttributeMap,ExternalContext) start operation is called, which causes this execution to activate a new FlowSession session for its root flow definition. That session is then said to become the active flow. An execution RequestContext request context is created, the Flow's FlowDefinition.getStartState start state is entered, and the request is processed.

In a distributed environment such as HTTP, after a call into this object has completed and control returns to the caller, this execution object (if still active) is typically saved out to a repository before the server request ends. For example it might be saved out to the HttpSession, a Database, or a client-side hidden form field for later restoration and manipulation. This execution persistence is the responsibility of the org.springframework.webflow.execution.repository.FlowExecutionRepository flow execution repository subsystem.

Subsequent requests from the client to manipuate this flow execution trigger restoration of this object, followed by an invocation of the FlowExecution.signalEvent(String,ExternalContext) signal event operation. The signalEvent operation resumes this execution by indicating what action the user took from within the current state; for example, the user may have pressed the "submit" button, or pressed "cancel". After the user event is processed, control again goes back to the caller and if this execution is still active, it is again saved out to the repository.

This process continues until a client event causes this flow execution to end (by the root flow reaching an end state). At that time this object is no longer active, and is removed from the repository and discarded.

Flow executions can have their lifecycle observed by FlowExecutionListener listeners .
See Also:   FlowDefinition
See Also:   FlowSession
See Also:   RequestContext
See Also:   FlowExecutionListener
See Also:   org.springframework.webflow.execution.repository.FlowExecutionRepository
See Also:   org.springframework.webflow.executor.FlowExecutor
author:
   Keith Donald
author:
   Erwin Vervaet





Method Summary
public  ViewSelectionrefresh(ExternalContext context)
     Refresh this flow execution, asking the current view selection to be reconstituted to support reissuing the last response.
public  ViewSelectionsignalEvent(String eventId, ExternalContext context)
     Signal an occurrence of the specified user event in the current state of this executing flow.
public  ViewSelectionstart(MutableAttributeMap input, ExternalContext context)
     Start this flow execution, transitioning it to the root flow's start state and returning the starting view selection needed to issue an initial user response.



Method Detail
refresh
public ViewSelection refresh(ExternalContext context) throws FlowExecutionException(Code)
Refresh this flow execution, asking the current view selection to be reconstituted to support reissuing the last response. This is an idempotent operation that may be safely called on a paused execution.
Parameters:
  context - the externa context in which the refresh event occured the current view selection for this flow execution
throws:
  FlowExecutionException - if an exception was thrown within a stateof the resumed flow execution during event processing



signalEvent
public ViewSelection signalEvent(String eventId, ExternalContext context) throws FlowExecutionException(Code)
Signal an occurrence of the specified user event in the current state of this executing flow. The event will be processed in full and control will be returned once event processing is complete.
Parameters:
  eventId - the identifier of the user event that occured
Parameters:
  context - the external context in which the event occured the next view selection to render, used by the calling executorto issue a suitable response to the client
throws:
  FlowExecutionException - if an exception was thrown within a stateof the resumed flow execution during event processing



start
public ViewSelection start(MutableAttributeMap input, ExternalContext context) throws FlowExecutionException(Code)
Start this flow execution, transitioning it to the root flow's start state and returning the starting view selection needed to issue an initial user response. Typically called by a flow executor on behalf of a browser client, but also from test code.

This will start the entire flow execution from scratch.
Parameters:
  input - input attributes to pass to the flow, which the flow maychoose to map into its scope
Parameters:
  context - the external context in which the starting event occured the starting view selection, a value object to be used to issue asuitable response to the caller
throws:
  FlowExecutionException - if an exception was thrown within a stateof the flow execution during request processing




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