Examples of org.springframework.webflow.engine.Flow

Package org.springframework.webflow.engine

Examples of org.springframework.webflow.engine.Flow

org.springframework.webflow.engine.Flow
A single flow definition. A Flow definition is a reusable, self-contained controller module that provides the blue print for a user dialog or conversation. Flows typically drive controlled navigations within web applications to guide users through fulfillment of a business process/goal that takes place over a series of steps, modeled as states.
A simple Flow definition could do nothing more than execute an action and display a view all in one request. A more elaborate Flow definition may be long-lived and execute across a series of requests, invoking many possible paths, actions, and subflows.
Especially in Intranet applications there are often "controlled navigations" where the user is not free to do what he or she wants but must follow the guidelines provided by the system to complete a process that is transactional in nature (the quintessential example would be a 'checkout' flow of a shopping cart application). This is a typical use case appropriate to model as a flow.
Structurally a Flow is composed of a set of states. A {@link State} is a point in a flow where a behavior isexecuted; for example, showing a view, executing an action, spawning a subflow, or terminating the flow. Different types of states execute different behaviors in a polymorphic fashion.
Each {@link TransitionableState} type has one or more transitions that when executed move a flow to another state.These transitions define the supported paths through the flow.
A state transition is triggered by the occurrence of an event. An event is something that happens the flow should respond to, for example a user input event like ("submit") or an action execution result event like ("success"). When an event occurs in a state of a Flow that event drives a state transition that decides what to do next.
Each Flow has exactly one start state. A start state is simply a marker noting the state executions of this Flow definition should start in. The first state added to the flow will become the start state by default.
Flow definitions may have one or more flow exception handlers. A {@link FlowExecutionExceptionHandler} can executecustom behavior in response to a specific exception (or set of exceptions) that occur in a state of one of this flow's executions.
Instances of this class are typically built by {@link org.springframework.webflow.engine.builder.FlowBuilder}implementations but may also be directly instantiated.
This class and the rest of the Spring Web Flow (SWF) engine have been designed with minimal dependencies on other libraries. Spring Web Flow is usable in a standalone fashion. The engine system is fully usable outside an HTTP servlet environment, for example in portlets, tests, or standalone applications. One of the major architectural benefits of Spring Web Flow is the ability to design reusable, high-level controller modules that may be executed in any environment.
Note: flows are singleton definition objects so they should be thread-safe. You can think a flow definition as analogous to a Java class, defining all the behavior of an application module. The core behaviors {@link #start(RequestControlContext,MutableAttributeMap) start}, {@link #resume(RequestControlContext)}, {@link #handleEvent(RequestControlContext) on event}, {@link #end(RequestControlContext,String,MutableAttributeMap) end}, and {@link #handleException(FlowExecutionException,RequestControlContext)}. Each method accepts a {@link RequestContext request context} that allows for this flow to access execution state in a thread safe manner. A flow execution iswhat models a running instance of this flow definition, somewhat analogous to a java object that is an instance of a class. @see org.springframework.webflow.engine.State @see org.springframework.webflow.engine.ActionState @see org.springframework.webflow.engine.ViewState @see org.springframework.webflow.engine.SubflowState @see org.springframework.webflow.engine.EndState @see org.springframework.webflow.engine.DecisionState @see org.springframework.webflow.engine.Transition @see org.springframework.webflow.engine.FlowExecutionExceptionHandler @author Keith Donald @author Erwin Vervaet @author Colin Sampaleanu @author Jeremy Grelle

    }


    @Test
    public void testSubflow() throws Exception {
        final FlowExecutionImplFactory executionFactory = new FlowExecutionImplFactory();
        final Flow flow = createFlowWithSubflow("parent", "child");
        final CasFlowExecutionKeyFactory keyFactory = new CasFlowExecutionKeyFactory(
            this.mockConversationManager,
            new SimpleFlowExecutionSnapshotFactory(executionFactory, newMockFlowLocator(flow)));
        keyFactory.setAlwaysGenerateNewNextKey(true);
        executionFactory.setExecutionKeyFactory(keyFactory);

View Full Code Here

        assertTrue(execution.hasEnded());
    }
    
    private Flow createSimpleFlow(final String id) {
        // Create a flat flow with an action and single view state
        final Flow flow = new Flow(id);
        final ActionState state1 = new ActionState(flow, "state1-action");
        final ViewState state2 = new ViewState(flow, "state2-view", new MockViewFactory("view"));
        new EndState(flow, "state3-end");
        state1.getActionList().add(new MockAction("state1-result"));
        state1.getTransitionSet().add(new Transition(new DefaultTargetStateResolver("state2-view")));

View Full Code Here

        return flow;
    }
    
    private Flow createFlowWithSubflow(final String parentId, final String childId) {
        // Create a flow containing a subflow followed by a view state
        final Flow parent = new Flow(parentId);
        final Flow child = createSimpleFlow(childId);
        final ActionState state1 = new ActionState(parent, "state1-action");
        final SubflowState state2 = new SubflowState(parent, "state2-subflow", new StaticExpression(child));
        final ViewState state3 = new ViewState(parent, "state3-view", new MockViewFactory("parentview"));
        new EndState(parent, "state4-end");
        state1.getActionList().add(new MockAction("state1-result"));

View Full Code Here

      FlowExecutionKey flowExecutionKey, MutableAttributeMap conversationScope,
      FlowDefinitionLocator subflowDefinitionLocator) {
    Assert.isInstanceOf(FlowExecutionImpl.class, flowExecution, "FlowExecution is of the wrong type: ");
    Assert.isInstanceOf(Flow.class, flowDefinition, "FlowDefinition is of the wrong type: ");
    FlowExecutionImpl execution = (FlowExecutionImpl) flowExecution;
    Flow flow = (Flow) flowDefinition;
    execution.setFlow(flow);
    if (execution.hasSessions()) {
      FlowSessionImpl rootSession = execution.getRootSession();
      rootSession.setFlow(flow);
      rootSession.setState(flow.getStateInstance(rootSession.getStateId()));
      if (execution.hasSubflowSessions()) {
        for (Iterator it = execution.getSubflowSessionIterator(); it.hasNext();) {
          FlowSessionImpl subflowSession = (FlowSessionImpl) it.next();
          Flow subflowDef = (Flow) subflowDefinitionLocator.getFlowDefinition(subflowSession.getFlowId());
          subflowSession.setFlow(subflowDef);
          subflowSession.setState(subflowDef.getStateInstance(subflowSession.getStateId()));
        }
      }
    }
    execution.setKey(flowExecutionKey);
    if (conversationScope == null) {

View Full Code Here


  protected final FlowDefinition getFlowDefinition() {
    if (isCacheFlowDefinition() && cachedFlowDefinition != null) {
      return cachedFlowDefinition;
    }
    Flow flow = buildFlow();
    if (isCacheFlowDefinition()) {
      cachedFlowDefinition = flow;
    }
    return flow;
  }

View Full Code Here

      }
    }
    if (logger.isDebugEnabled()) {
      logger.debug("Resuming in " + externalContext);
    }
    Flow activeFlow = getActiveSessionInternal().getFlow();
    MessageContext messageContext = createMessageContext(activeFlow.getApplicationContext());
    RequestControlContext requestContext = createRequestContext(externalContext, messageContext);
    RequestContextHolder.setRequestContext(requestContext);
    listeners.fireRequestSubmitted(requestContext);
    try {
      listeners.fireResuming(requestContext);
      activeFlow.resume(requestContext);
    } catch (FlowExecutionException e) {
      handleException(e, requestContext);
    } catch (Exception e) {
      handleException(wrap(e), requestContext);
    } finally {

View Full Code Here


  /**
   * Creates a new mock flow session that sets a flow with id "mockFlow" as the 'active flow' in state "mockState".
   */
  public MockFlowSession() {
    setDefinition(new Flow("mockFlow"));
    State state = new TransitionableState(definition, "mockState") {
      protected void doEnter(RequestControlContext context) throws FlowExecutionException {
        // nothing to do
      }
    };

View Full Code Here

  }


  private class MockViewState extends ViewState {


    public MockViewState() {
      super(new Flow("mockFlow"), "mockView", new ViewFactory() {


        public View getView(RequestContext context) {
          // TODO Auto-generated method stub
          throw new UnsupportedOperationException("Auto-generated method stub");
        }

View Full Code Here

  Flow flow;


  TransitionableState state;


  protected void setUp() {
    flow = new Flow("myFlow");
    state = new TransitionableState(flow, "state1") {
      protected void doEnter(RequestControlContext context) {
        throw new FlowExecutionException(getFlow().getId(), getId(), "Oops!", new TestException());
      }
    };

View Full Code Here


      public Flow createFlow() throws FlowBuilderException {
        return Flow.create(getContext().getFlowId(), getContext().getFlowAttributes());
      }
    };
    Flow flow = new FlowAssembler(builder, new MockFlowBuilderContext("flow")).assembleFlow();
    FlowExecution execution = new FlowExecutionImplFactory().createFlowExecution(flow);
    execution.start(null, new MockExternalContext());
    assertTrue(execution.isActive());
  }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.springframework.webflow.engine.Flow

com.example.bookstore.web.controller.CreateOrderTest

org.jasig.cas.web.flow.CasFlowExecutionKeyFactoryTests

org.springframework.binding.mapping.MappingResults

org.springframework.core.style.ToStringCreator

org.springframework.faces.webflow.FlowActionListenerTests$MockViewState

org.springframework.webflow.config.FlowExecutorFactoryBeanTests

org.springframework.webflow.engine.builder.FlowAssemblerTests

org.springframework.webflow.engine.builder.model.FlowModelFlowBuilder

org.springframework.webflow.engine.builder.model.FlowModelFlowBuilderTests

org.springframework.webflow.engine.builder.support.TextToTransitionCriteriaTests

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.