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

    assertTrue(avf.getAction() instanceof ExternalRedirectAction);
  }


  public void testResourceBackedFlowBuilder() {
    ClassPathResource resource = new ClassPathResource("flow-endstate.xml", XmlFlowModelBuilderTests.class);
    Flow flow = getFlow(resource);
    assertEquals("flow", flow.getId());
    assertEquals("end", flow.getStartState().getId());
  }

View Full Code Here

    assertEquals("end", flow.getStartState().getId());
  }


  public void testResourceBackedFlowBuilderWithMessages() {
    ClassPathResource resource = new ClassPathResource("resources/flow.xml", FlowModelFlowBuilderTests.class);
    Flow flow = getFlow(resource);
    assertNotNull(flow.getApplicationContext());
    assertEquals("bar", flow.getApplicationContext().getMessage("foo", null, null));
  }

View Full Code Here

    };
    FlowModelFlowBuilder builder = new FlowModelFlowBuilder(new StaticFlowModelHolder(model));
    MockFlowBuilderContext context = new MockFlowBuilderContext("foo");
    context.registerBean("exceptionHandler", handler);
    FlowAssembler assembler = new FlowAssembler(builder, context);
    Flow flow = assembler.assembleFlow();
    assertEquals(1, flow.getExceptionHandlerSet().size());
  }

View Full Code Here

    RequestContext ctx = getRequestContext();
    assertFalse("Criterion should evaluate to false", criterion.test(ctx));
  }


  private MockRequestContext getRequestContext() {
    Flow flow = new Flow("id");
    MockRequestContext ctx = new MockRequestContext(flow);
    RequestContextHolder.setRequestContext(ctx);
    ctx.getFlowScope().put("foo", "bar");
    ctx.setCurrentEvent(new Event(this, "sample"));
    return ctx;

View Full Code Here


  public void testGetFlowExecutorBasicConfig() throws Exception {
    factoryBean.setFlowDefinitionLocator(new FlowDefinitionLocator() {
      public FlowDefinition getFlowDefinition(String id) throws NoSuchFlowDefinitionException,
          FlowDefinitionConstructionException {
        Flow flow = new Flow(id);
        ViewState view = new ViewState(flow, "view", new StubViewFactory());
        view.getTransitionSet().add(new Transition(new DefaultTargetStateResolver("end")));
        new EndState(flow, "end");
        return flow;
      }

View Full Code Here


  public void testGetFlowExecutorOptionsSpecified() throws Exception {
    factoryBean.setFlowDefinitionLocator(new FlowDefinitionLocator() {
      public FlowDefinition getFlowDefinition(String id) throws NoSuchFlowDefinitionException,
          FlowDefinitionConstructionException {
        Flow flow = new Flow(id);
        ViewState view = new ViewState(flow, "view", new StubViewFactory());
        view.getTransitionSet().add(new Transition(new DefaultTargetStateResolver("end")));
        new EndState(flow, "end");
        return flow;
      }

View Full Code Here

    resumeFlow(context);
    assertCurrentStateEquals("displayResults");
  }


  protected void configureFlowBuilderContext(MockFlowBuilderContext builderContext) {
    Flow mockDetailFlow = new Flow("detail-flow");
    mockDetailFlow.setInputMapper(new Mapper() {
      public MappingResults map(Object source, Object target) {
        assertEquals("id of value 1 not provided as input by calling search flow", new Long(1),
            ((AttributeMap) source).get("id"));
        return null;
      }

View Full Code Here


  protected Flow createFlow() {
    String flowId = getContext().getFlowId();
    AttributeMap flowAttributes = parseFlowMetaAttributes(flowModel);
    flowAttributes = getContext().getFlowAttributes().union(flowAttributes);
    Flow flow = getLocalContext().getFlowArtifactFactory().createFlow(flowId, flowAttributes);
    flow.setApplicationContext(getLocalContext().getApplicationContext());
    return flow;
  }

View Full Code Here

  private Flow flow;
  private ConversationManager conversationManager;
  private DefaultFlowExecutionRepository repository;


  protected void setUp() throws Exception {
    flow = new Flow("myFlow");
    new State(flow, "state") {
      protected void doEnter(RequestControlContext context) throws FlowExecutionException {
        context.assignFlowExecutionKey();
      }
    };

View Full Code Here

    ClassPathResource resource = new ClassPathResource("flow-formaction-validatormethod.xml", getClass());
    XmlFlowModelBuilder builder = new XmlFlowModelBuilder(resource, registry);
    DefaultFlowModelHolder holder = new DefaultFlowModelHolder(builder);
    FlowModelFlowBuilder flowBuilder = new FlowModelFlowBuilder(holder);
    FlowAssembler assembler = new FlowAssembler(flowBuilder, new MockFlowBuilderContext("flow"));
    Flow flow = assembler.assembleFlow();
    FlowExecutionImplFactory factory = new FlowExecutionImplFactory();
    factory.setExecutionListenerLoader(new StaticFlowExecutionListenerLoader(new FlowExecutionListenerAdapter() {
      public void viewRendering(RequestContext context, View view, StateDefinition viewState) {
        if (context.getCurrentEvent() != null && context.getCurrentEvent().getId().equals("submit")) {
          BindingResult result = (BindingResult) context.getFlashScope().get(
              "org.springframework.validation.BindingResult.formBean");
          assertEquals(1, result.getErrorCount());
        }
      }


      public void viewRendered(RequestContext context, View view, StateDefinition viewState) {
        if (context.getCurrentEvent() != null && context.getCurrentEvent().getId().equals("submit")) {
          BindingResult result = (BindingResult) context.getFlashScope().get(
              "org.springframework.validation.BindingResult.formBean");
          assertNull(result);
        }
      }
    }));
    FlowExecution execution = factory.createFlowExecution(flow);
    FormAction action = (FormAction) flow.getApplicationContext().getBean("formAction");
    assertFalse(((TestBeanValidator) action.getValidator()).getInvoked());
    execution.start(null, new MockExternalContext());
    MockExternalContext context = new MockExternalContext();
    context.setEventId("submit");
    execution.resume(context);

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.