How to use

resume

method

in

org.springframework.webflow.engine.ViewState

/**
 * Resume a paused session for this flow in its current view state.
 * @param context the flow execution control context
 * @throws FlowExecutionException when an exception occurs during the resume operation
 */
public void resume(RequestControlContext context) throws FlowExecutionException {
  restoreVariables(context);
  getCurrentViewState(context).resume(context);
}

/**
 * Resume a paused session for this flow in its current view state.
 * @param context the flow execution control context
 * @throws FlowExecutionException when an exception occurs during the resume operation
 */
public void resume(RequestControlContext context) throws FlowExecutionException {
  restoreVariables(context);
  getCurrentViewState(context).resume(context);
}

/**
 * Resume a paused session for this flow in its current view state.
 * @param context the flow execution control context
 * @throws FlowExecutionException when an exception occurs during the resume operation
 */
public void resume(RequestControlContext context) throws FlowExecutionException {
  restoreVariables(context);
  getCurrentViewState(context).resume(context);
}

public void testRedirectInSameStateOverridesAlwaysRedirectOnPause() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  Transition t = new Transition(on("submit"), null);
  state.getTransitionSet().add(t);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.setAlwaysRedirectOnPause(false);
  context.setRedirectInSameState(true);
  context.getFlowScope().remove("renderCalled");
  context.putRequestParameter("_eventId", "submit");
  state.resume(context);
  assertTrue(context.getMockExternalContext().getFlowExecutionRedirectRequested());
}

public void testResumeViewStateRestoreVariables() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  state.addVariable(new ViewVariable("foo", new VariableValueFactory() {
    public Object createInitialValue(RequestContext context) {
      return new TestBean();
    }
    public void restoreReferences(Object value, RequestContext context) {
      ((TestBean) value).datum1 = "Restored";
    }
  }));
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  state.resume(context);
  assertTrue("Render not called", context.getFlowScope().contains("renderCalled"));
  assertFalse(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertEquals("Restored", ((TestBean) context.getViewScope().get("foo")).datum1);
}

public void testResumeViewStateForRefresh() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.getFlashScope().put("foo", "bar");
  state.resume(context);
  assertTrue("Render not called", context.getFlowScope().contains("renderCalled"));
  assertTrue(context.getExternalContext().isResponseComplete());
  assertFalse(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertFalse(context.getFlashScope().contains("foo"));
}

public void testResumeViewStateForEventWithTransitionFlowEnded() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  state.getTransitionSet().add(new Transition(on("submit"), to("finish")));
  EndState end = new EndState(flow, "finish");
  TestAction testAction = new TestAction();
  end.setFinalResponseAction(testAction);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.putRequestParameter("_eventId", "submit");
  state.resume(context);
  assertTrue(context.getExternalContext().isResponseComplete());
  assertFalse(context.getFlowExecutionContext().isActive());
  assertTrue(testAction.isExecuted());
}

public void testResumeViewStateForEventWithTransitionStateExited() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  state.getTransitionSet().add(new Transition(on("submit"), to("next")));
  ViewState next = new ViewState(flow, "next", viewFactory);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  context.setAlwaysRedirectOnPause(true);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.putRequestParameter("_eventId", "submit");
  state.resume(context);
  assertTrue(context.getExternalContext().isResponseComplete());
  assertTrue(context.getFlowExecutionContext().isActive());
  assertSame(next, context.getCurrentState());
  assertTrue(context.getFlowScope().contains("saveStateCalled"));
}

public void testResumeViewStateForEventWithTransitionStateExitedNoRedirect() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  state.getTransitionSet().add(new Transition(on("submit"), to("next")));
  ViewState next = new ViewState(flow, "next", viewFactory);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  context.setAlwaysRedirectOnPause(false);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.putRequestParameter("_eventId", "submit");
  state.resume(context);
  assertTrue(context.getExternalContext().isResponseComplete());
  assertTrue(context.getFlowExecutionContext().isActive());
  assertSame(next, context.getCurrentState());
  assertFalse(context.getFlowScope().contains("saveStateCalled"));
}

public void testResumeViewStateForRefreshResponseCompleteRecorded() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  state.getTransitionSet().add(new Transition(on("submit"), to("finish")));
  new EndState(flow, "finish");
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.getFlowScope().remove("renderCalled");
  context.getFlashScope().put("foo", "bar");
  context.getExternalContext().recordResponseComplete();
  state.resume(context);
  assertFalse("Render called", context.getFlowScope().contains("renderCalled"));
  assertFalse(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertFalse(context.getFlashScope().contains("foo"));
}

public void testResumeViewStateForEventDestroyVariables() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  state.addVariable(new ViewVariable("foo", new VariableValueFactory() {
    public Object createInitialValue(RequestContext context) {
      return "bar";
    }
    public void restoreReferences(Object value, RequestContext context) {
    }
  }));
  state.getTransitionSet().add(new Transition(on("submit"), to("next")));
  new ViewState(flow, "next", viewFactory);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  assertTrue(context.getViewScope().contains("foo"));
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.putRequestParameter("_eventId", "submit");
  state.resume(context);
  assertTrue(context.getFlowExecutionContext().isActive());
  assertEquals("next", context.getCurrentState().getId());
  assertFalse(context.getViewScope().contains("foo"));
}

public void testResumeViewStateForEventStateNotExitedNonAjaxResponseNotAllowed() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  Transition t = new Transition(on("submit"), null);
  state.getTransitionSet().add(t);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.getFlowScope().remove("renderCalled");
  context.putRequestParameter("_eventId", "submit");
  context.getMockExternalContext().setResponseAllowed(false);
  context.getFlashScope().put("foo", "bar");
  state.resume(context);
  assertTrue(context.getFlowExecutionContext().isActive());
  assertTrue(context.getExternalContext().isResponseComplete());
  assertFalse("Render called", context.getFlowScope().contains("renderCalled"));
  assertTrue(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertEquals(StubViewFactory.USER_EVENT_STATE, context.getFlashScope().get(View.USER_EVENT_STATE_ATTRIBUTE));
  assertTrue(context.getFlashScope().contains("foo"));
}

public void testResumeViewStateForEventStateNotExitedNonAjaxRedirectEnabled() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  Transition t = new Transition(on("submit"), null);
  TestAction action = new TestAction();
  t.setExecutionCriteria(new ActionTransitionCriteria(action));
  state.getTransitionSet().add(t);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  context.setAlwaysRedirectOnPause(true);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.setAlwaysRedirectOnPause(true);
  context.putRequestParameter("_eventId", "submit");
  context.getFlashScope().put("foo", "bar");
  state.resume(context);
  assertTrue(context.getFlowExecutionContext().isActive());
  assertEquals(1, action.getExecutionCount());
  assertFalse("Render called", context.getFlowScope().contains("renderCalled"));
  assertTrue(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertEquals(StubViewFactory.USER_EVENT_STATE, context.getFlashScope().get(View.USER_EVENT_STATE_ATTRIBUTE));
  assertTrue(context.getFlashScope().contains("foo"));
}

public void testResumeViewStateForEventStateNotExitedNonAjax() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  Transition t = new Transition(on("submit"), null);
  TestAction action = new TestAction();
  t.setExecutionCriteria(new ActionTransitionCriteria(action));
  state.getTransitionSet().add(t);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.getFlowScope().remove("renderCalled");
  context.putRequestParameter("_eventId", "submit");
  context.getFlashScope().put("foo", "bar");
  state.resume(context);
  assertTrue(context.getFlowExecutionContext().isActive());
  assertEquals(1, action.getExecutionCount());
  assertTrue(context.getExternalContext().isResponseComplete());
  assertTrue("Render not called", context.getFlowScope().contains("renderCalled"));
  assertFalse(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertFalse(context.getFlashScope().contains("foo"));
  assertFalse(context.getFlashScope().contains(View.USER_EVENT_STATE_ATTRIBUTE));
}

public void testResumeViewStateForEventStateNotExitedAjax() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  Transition t = new Transition(on("submit"), null);
  TestAction action = new TestAction();
  t.setExecutionCriteria(new ActionTransitionCriteria(action));
  state.getTransitionSet().add(t);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  context.getMockExternalContext().setAjaxRequest(true);
  state.enter(context);
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.putRequestParameter("_eventId", "submit");
  context.getMockExternalContext().setAjaxRequest(true);
  context.getFlashScope().put("foo", "bar");
  state.resume(context);
  assertTrue(context.getFlowExecutionContext().isActive());
  assertEquals(1, action.getExecutionCount());
  assertTrue(context.getExternalContext().isResponseComplete());
  assertTrue("Render not called", context.getFlowScope().contains("renderCalled"));
  assertFalse(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertFalse(context.getFlashScope().contains("foo"));
  assertFalse(context.getFlashScope().contains(View.USER_EVENT_STATE_ATTRIBUTE));
}

public void testResumeViewStateForEventStateNoExitActionRecordedExecutionRedirect() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  Transition t = new Transition(on("submit"), null);
  TestAction action = new TestAction() {
    protected Event doExecute(RequestContext context) throws Exception {
      super.doExecute(context);
      context.getExternalContext().requestFlowExecutionRedirect();
      return success();
    }
  };
  t.setExecutionCriteria(new ActionTransitionCriteria(action));
  state.getTransitionSet().add(t);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  assertTrue("Render not called", context.getFlowScope().contains("renderCalled"));
  context.getFlowScope().remove("renderCalled");
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.putRequestParameter("_eventId", "submit");
  context.getFlashScope().put("foo", "bar");
  state.resume(context);
  assertTrue(context.getFlowExecutionContext().isActive());
  assertEquals(1, action.getExecutionCount());
  assertTrue(context.getExternalContext().isResponseComplete());
  assertFalse("Render called", context.getFlowScope().contains("renderCalled"));
  assertTrue(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertTrue(context.getFlashScope().contains("foo"));
  assertEquals(StubViewFactory.USER_EVENT_STATE, context.getFlashScope().get(View.USER_EVENT_STATE_ATTRIBUTE));
}

public void testResumeViewStateForEventStateNoExitActionRecordedResponseComplete() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  Transition t = new Transition(on("submit"), null);
  TestAction action = new TestAction() {
    protected Event doExecute(RequestContext context) throws Exception {
      super.doExecute(context);
      context.getExternalContext().recordResponseComplete();
      return success();
    }
  };
  t.setExecutionCriteria(new ActionTransitionCriteria(action));
  state.getTransitionSet().add(t);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  assertTrue("Render not called", context.getFlowScope().contains("renderCalled"));
  context.getFlowScope().remove("renderCalled");
  context = new MockRequestControlContext(context.getFlowExecutionContext());
  context.putRequestParameter("_eventId", "submit");
  context.getFlashScope().put("Foo", "bar");
  state.resume(context);
  assertTrue(context.getFlowExecutionContext().isActive());
  assertEquals(1, action.getExecutionCount());
  assertTrue(context.getExternalContext().isResponseComplete());
  assertFalse("Render called", context.getFlowScope().contains("renderCalled"));
  assertFalse(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertFalse(context.getFlashScope().contains("foo"));
  assertFalse(context.getFlashScope().contains(View.USER_EVENT_STATE_ATTRIBUTE));
}