How to use

setRedirect

method

in

org.springframework.webflow.engine.ViewState

/**
 * Factory method that creates a new view state, a state where a user is allowed to participate in the flow. This
 * method is an atomic operation that returns a fully initialized state. It encapsulates the selection of the view
 * state implementation as well as the state assembly.
 * @param id the identifier to assign to the state, must be unique to its owning flow (required)
 * @param flow the flow that will own (contain) this state (required)
 * @param entryActions any state entry actions; may be null
 * @param viewFactory the state view factory strategy
 * @param redirect whether to send a flow execution redirect before rendering
 * @param popup whether to display the view in a popup window
 * @param renderActions any 'render actions' to execute on entry and refresh; may be null
 * @param transitions any transitions (paths) out of this state; may be null
 * @param exceptionHandlers any exception handlers; may be null
 * @param exitActions any state exit actions; may be null
 * @param attributes attributes to assign to the State, which may also be used to affect state construction; may be
 * null
 * @return the fully initialized view state instance
 */
public State createViewState(String id, Flow flow, ViewVariable[] variables, Action[] entryActions,
    ViewFactory viewFactory, Boolean redirect, boolean popup, Action[] renderActions, Transition[] transitions,
    FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap<?> attributes) {
  ViewState viewState = new ViewState(flow, id, viewFactory);
  viewState.addVariables(variables);
  viewState.setRedirect(redirect);
  viewState.setPopup(popup);
  viewState.getRenderActionList().addAll(renderActions);
  configureCommonProperties(viewState, entryActions, transitions, exceptionHandlers, exitActions, attributes);
  return viewState;
}

/**
 * Factory method that creates a new view state, a state where a user is allowed to participate in the flow. This
 * method is an atomic operation that returns a fully initialized state. It encapsulates the selection of the view
 * state implementation as well as the state assembly.
 * @param id the identifier to assign to the state, must be unique to its owning flow (required)
 * @param flow the flow that will own (contain) this state (required)
 * @param entryActions any state entry actions; may be null
 * @param viewFactory the state view factory strategy
 * @param redirect whether to send a flow execution redirect before rendering
 * @param popup whether to display the view in a popup window
 * @param renderActions any 'render actions' to execute on entry and refresh; may be null
 * @param transitions any transitions (paths) out of this state; may be null
 * @param exceptionHandlers any exception handlers; may be null
 * @param exitActions any state exit actions; may be null
 * @param attributes attributes to assign to the State, which may also be used to affect state construction; may be
 * null
 * @return the fully initialized view state instance
 */
public State createViewState(String id, Flow flow, ViewVariable[] variables, Action[] entryActions,
    ViewFactory viewFactory, Boolean redirect, boolean popup, Action[] renderActions, Transition[] transitions,
    FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap<?> attributes) {
  ViewState viewState = new ViewState(flow, id, viewFactory);
  viewState.addVariables(variables);
  viewState.setRedirect(redirect);
  viewState.setPopup(popup);
  viewState.getRenderActionList().addAll(renderActions);
  configureCommonProperties(viewState, entryActions, transitions, exceptionHandlers, exitActions, attributes);
  return viewState;
}

/**
 * Factory method that creates a new view state, a state where a user is allowed to participate in the flow. This
 * method is an atomic operation that returns a fully initialized state. It encapsulates the selection of the view
 * state implementation as well as the state assembly.
 * @param id the identifier to assign to the state, must be unique to its owning flow (required)
 * @param flow the flow that will own (contain) this state (required)
 * @param entryActions any state entry actions; may be null
 * @param viewFactory the state view factory strategy
 * @param redirect whether to send a flow execution redirect before rendering
 * @param popup whether to display the view in a popup window
 * @param renderActions any 'render actions' to execute on entry and refresh; may be null
 * @param transitions any transitions (paths) out of this state; may be null
 * @param exceptionHandlers any exception handlers; may be null
 * @param exitActions any state exit actions; may be null
 * @param attributes attributes to assign to the State, which may also be used to affect state construction; may be
 * null
 * @return the fully initialized view state instance
 */
public State createViewState(String id, Flow flow, ViewVariable[] variables, Action[] entryActions,
    ViewFactory viewFactory, Boolean redirect, boolean popup, Action[] renderActions, Transition[] transitions,
    FlowExecutionExceptionHandler[] exceptionHandlers, Action[] exitActions, AttributeMap attributes) {
  ViewState viewState = new ViewState(flow, id, viewFactory);
  viewState.addVariables(variables);
  viewState.setRedirect(redirect);
  viewState.setPopup(popup);
  viewState.getRenderActionList().addAll(renderActions);
  configureCommonProperties(viewState, entryActions, transitions, exceptionHandlers, exitActions, attributes);
  return viewState;
}

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

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

public void testViewStateRedirectOverridesEmbeddedMode() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  state.setRedirect(false);
  Transition t = new Transition(on("submit"), null);
  state.getTransitionSet().add(t);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  state.enter(context);
  context.getMockExternalContext().setAjaxRequest(true);
  context.setEmbeddedMode();
  context.setAlwaysRedirectOnPause(true);
  context.setRedirectInSameState(true);
  assertFalse(context.getMockExternalContext().getFlowExecutionRedirectRequested());
}

public void testEnterViewStateRedirectInPopup() {
  Flow flow = new Flow("myFlow");
  StubViewFactory viewFactory = new StubViewFactory();
  ViewState state = new ViewState(flow, "viewState", viewFactory);
  state.setRedirect(true);
  state.setPopup(true);
  MockRequestControlContext context = new MockRequestControlContext(flow);
  context.getFlashScope().put("foo", "bar");
  state.enter(context);
  assertFalse("Render called", context.getFlowScope().contains("renderCalled"));
  assertTrue(context.getMockExternalContext().getFlowExecutionRedirectRequested());
  assertTrue(context.getMockExternalContext().getRedirectInPopup());
  assertTrue(context.getFlashScope().contains("foo"));
}