How to use

FlowStep

in

org.springframework.batch.core.job.flow

/**
 * Build a step that executes the flow provided, normally composed of other steps. The flow is not executed in a
 * transaction because the individual steps are supposed to manage their own transaction state.
 * 
 * @return a flow step
 */
public Step build() {
  FlowStep step = new FlowStep();
  step.setName(getName());
  step.setFlow(flow);
  super.enhance(step);
  try {
    step.afterPropertiesSet();
  }
  catch (Exception e) {
    throw new StepBuilderException(e);
  }
  return step;
}

/**
 * Delegate to the flow provided for the execution of the step.
 * 
 * @see AbstractStep#doExecute(StepExecution)
 */
@Override
protected void doExecute(StepExecution stepExecution) throws Exception {
  try {
    stepExecution.getExecutionContext().put(STEP_TYPE_KEY, this.getClass().getName());
    StepHandler stepHandler = new SimpleStepHandler(getJobRepository(), stepExecution.getExecutionContext());
    FlowExecutor executor = new JobFlowExecutor(getJobRepository(), stepHandler, stepExecution.getJobExecution());
    executor.updateJobExecutionStatus(flow.start(executor).getStatus());
    stepExecution.upgradeStatus(executor.getJobExecution().getStatus());
    stepExecution.setExitStatus(executor.getJobExecution().getExitStatus());
  }
  catch (FlowExecutionException e) {
    if (e.getCause() instanceof JobExecutionException) {
      throw (JobExecutionException) e.getCause();
    }
    throw new JobExecutionException("Flow execution ended unexpectedly", e);
  }
}

/**
 * Ensure that the flow is set.
 * @see AbstractStep#afterPropertiesSet()
 */
@Override
public void afterPropertiesSet() throws Exception {
  Assert.state(flow != null, "A Flow must be provided");
  if (getName()==null) {
    setName(flow.getName());
  }
  super.afterPropertiesSet();
}

/**
 * Test method for {@link org.springframework.batch.core.job.flow.FlowStep#afterPropertiesSet()}.
 */
@Test(expected=IllegalStateException.class)
public void testAfterPropertiesSet() throws Exception{
  FlowStep step = new FlowStep();
  step.setJobRepository(jobRepository);
  step.afterPropertiesSet();
}

/**
 * Test method for {@link org.springframework.batch.core.job.flow.FlowStep#doExecute(org.springframework.batch.core.StepExecution)}.
 */
@Test
public void testExecuteWithParentContext() throws Exception {
  FlowStep step = new FlowStep();
  step.setJobRepository(jobRepository);
  SimpleFlow flow = new SimpleFlow("job");
  List<StateTransition> transitions = new ArrayList<>();
  transitions.add(StateTransition.createStateTransition(new StepState(new StubStep("step1")), "end0"));
  transitions.add(StateTransition.createEndStateTransition(new EndState(FlowExecutionStatus.COMPLETED, "end0")));
  flow.setStateTransitions(transitions);
  step.setFlow(flow);
  step.afterPropertiesSet();
  StepExecution stepExecution = jobExecution.createStepExecution("step");
  stepExecution.getExecutionContext().put("foo", "bar");
  jobRepository.add(stepExecution);
  step.execute(stepExecution);
  stepExecution = getStepExecution(jobExecution, "step");
  assertEquals(ExitStatus.COMPLETED, stepExecution.getExitStatus());
  stepExecution = getStepExecution(jobExecution, "step1");
  assertEquals(ExitStatus.COMPLETED, stepExecution.getExitStatus());
  assertEquals("bar", stepExecution.getExecutionContext().get("foo"));
}

@SuppressWarnings("serial")
private void configureFlowStep(FlowStep ts) {
  configureAbstractStep(ts);
  if (flow != null) {
    ts.setFlow(flow);
  }
}

FlowStep ts = new FlowStep();
configureFlowStep(ts);
return ts;

/**
 * Test method for {@link org.springframework.batch.core.job.flow.FlowStep#doExecute(org.springframework.batch.core.StepExecution)}.
 */
@Test
public void testDoExecute() throws Exception {
  FlowStep step = new FlowStep();
  step.setJobRepository(jobRepository);
  SimpleFlow flow = new SimpleFlow("job");
  List<StateTransition> transitions = new ArrayList<>();
  transitions.add(StateTransition.createStateTransition(new StepState(new StubStep("step1")), "step2"));
  StepState step2 = new StepState(new StubStep("step2"));
  transitions.add(StateTransition.createStateTransition(step2, ExitStatus.FAILED.getExitCode(), "end0"));
  transitions.add(StateTransition.createStateTransition(step2, ExitStatus.COMPLETED.getExitCode(), "end1"));
  transitions.add(StateTransition.createEndStateTransition(new EndState(FlowExecutionStatus.FAILED, "end0")));
  transitions.add(StateTransition.createEndStateTransition(new EndState(FlowExecutionStatus.COMPLETED, "end1")));
  flow.setStateTransitions(transitions);
  step.setFlow(flow);
  step.afterPropertiesSet();
  StepExecution stepExecution = jobExecution.createStepExecution("step");
  jobRepository.add(stepExecution);
  step.execute(stepExecution);
  stepExecution = getStepExecution(jobExecution, "step");
  assertEquals(ExitStatus.COMPLETED, stepExecution.getExitStatus());
  stepExecution = getStepExecution(jobExecution, "step2");
  assertEquals(ExitStatus.COMPLETED, stepExecution.getExitStatus());
  assertEquals(3, jobExecution.getStepExecutions().size());
}

/**
 * Build a step that executes the flow provided, normally composed of other steps. The flow is not executed in a
 * transaction because the individual steps are supposed to manage their own transaction state.
 * 
 * @return a flow step
 */
public Step build() {
  FlowStep step = new FlowStep();
  step.setName(getName());
  step.setFlow(flow);
  super.enhance(step);
  try {
    step.afterPropertiesSet();
  }
  catch (Exception e) {
    throw new StepBuilderException(e);
  }
  return step;
}

@Test
public void testDoExecuteAndFail() throws Exception {
  FlowStep step = new FlowStep();
  step.setJobRepository(jobRepository);
  SimpleFlow flow = new SimpleFlow("job");
  List<StateTransition> transitions = new ArrayList<>();
  transitions.add(StateTransition.createStateTransition(new StepState(new StubStep("step1")), "step2"));
  StepState step2 = new StepState(new StubStep("step2", true));
  transitions.add(StateTransition.createStateTransition(step2, ExitStatus.FAILED.getExitCode(), "end0"));
  transitions.add(StateTransition.createStateTransition(step2, ExitStatus.COMPLETED.getExitCode(), "end1"));
  transitions.add(StateTransition.createEndStateTransition(new EndState(FlowExecutionStatus.FAILED, "end0")));
  transitions.add(StateTransition.createEndStateTransition(new EndState(FlowExecutionStatus.COMPLETED, "end1")));
  flow.setStateTransitions(transitions);
  step.setFlow(flow);
  step.afterPropertiesSet();
  StepExecution stepExecution = jobExecution.createStepExecution("step");
  jobRepository.add(stepExecution);
  step.execute(stepExecution);
  stepExecution = getStepExecution(jobExecution, "step1");
  assertEquals(ExitStatus.COMPLETED, stepExecution.getExitStatus());
  stepExecution = getStepExecution(jobExecution, "step2");
  assertEquals(ExitStatus.FAILED, stepExecution.getExitStatus());
  stepExecution = getStepExecution(jobExecution, "step");
  assertEquals(ExitStatus.FAILED, stepExecution.getExitStatus());
  assertEquals(3, jobExecution.getStepExecutions().size());
}

/**
 * Ensure that the flow is set.
 * @see AbstractStep#afterPropertiesSet()
 */
@Override
public void afterPropertiesSet() throws Exception {
  Assert.state(flow != null, "A Flow must be provided");
  if (getName()==null) {
    setName(flow.getName());
  }
  super.afterPropertiesSet();
}

/**
 * Delegate to the flow provided for the execution of the step.
 * 
 * @see AbstractStep#doExecute(StepExecution)
 */
@Override
protected void doExecute(StepExecution stepExecution) throws Exception {
  try {
    stepExecution.getExecutionContext().put(STEP_TYPE_KEY, this.getClass().getName());
    StepHandler stepHandler = new SimpleStepHandler(getJobRepository(), stepExecution.getExecutionContext());
    FlowExecutor executor = new JobFlowExecutor(getJobRepository(), stepHandler, stepExecution.getJobExecution());
    executor.updateJobExecutionStatus(flow.start(executor).getStatus());
    stepExecution.upgradeStatus(executor.getJobExecution().getStatus());
    stepExecution.setExitStatus(executor.getJobExecution().getExitStatus());
  }
  catch (FlowExecutionException e) {
    if (e.getCause() instanceof JobExecutionException) {
      throw (JobExecutionException) e.getCause();
    }
    throw new JobExecutionException("Flow execution ended unexpectedly", e);
  }
}

/**
 * Build a step that executes the flow provided, normally composed of other steps. The flow is not executed in a
 * transaction because the individual steps are supposed to manage their own transaction state.
 * 
 * @return a flow step
 */
public Step build() {
  FlowStep step = new FlowStep();
  step.setName(getName());
  step.setFlow(flow);
  super.enhance(step);
  try {
    step.afterPropertiesSet();
  }
  catch (Exception e) {
    throw new StepBuilderException(e);
  }
  return step;
}

/**
 * Ensure that the flow is set.
 * @see AbstractStep#afterPropertiesSet()
 */
@Override
public void afterPropertiesSet() throws Exception {
  Assert.state(flow != null, "A Flow must be provided");
  if (getName()==null) {
    setName(flow.getName());
  }
  super.afterPropertiesSet();
}

/**
 * Delegate to the flow provided for the execution of the step.
 * 
 * @see AbstractStep#doExecute(StepExecution)
 */
@Override
protected void doExecute(StepExecution stepExecution) throws Exception {
  try {
    stepExecution.getExecutionContext().put(STEP_TYPE_KEY, this.getClass().getName());
    StepHandler stepHandler = new SimpleStepHandler(getJobRepository(), stepExecution.getExecutionContext());
    FlowExecutor executor = new JobFlowExecutor(getJobRepository(), stepHandler, stepExecution.getJobExecution());
    executor.updateJobExecutionStatus(flow.start(executor).getStatus());
    stepExecution.upgradeStatus(executor.getJobExecution().getStatus());
    stepExecution.setExitStatus(executor.getJobExecution().getExitStatus());
  }
  catch (FlowExecutionException e) {
    if (e.getCause() instanceof JobExecutionException) {
      throw (JobExecutionException) e.getCause();
    }
    throw new JobExecutionException("Flow execution ended unexpectedly", e);
  }
}

/**
 * Build a step that executes the flow provided, normally composed of other steps. The flow is not executed in a
 * transaction because the individual steps are supposed to manage their own transaction state.
 * 
 * @return a flow step
 */
public Step build() {
  FlowStep step = new FlowStep();
  step.setName(getName());
  step.setFlow(flow);
  super.enhance(step);
  try {
    step.afterPropertiesSet();
  }
  catch (Exception e) {
    throw new StepBuilderException(e);
  }
  return step;
}

/**
 * Ensure that the flow is set.
 * @see AbstractStep#afterPropertiesSet()
 */
@Override
public void afterPropertiesSet() throws Exception {
  Assert.state(flow != null, "A Flow must be provided");
  if (getName()==null) {
    setName(flow.getName());
  }
  super.afterPropertiesSet();
}

/**
 * Delegate to the flow provided for the execution of the step.
 * 
 * @see AbstractStep#doExecute(StepExecution)
 */
@Override
protected void doExecute(StepExecution stepExecution) throws Exception {
  try {
    StepHandler stepHandler = new SimpleStepHandler(getJobRepository(), stepExecution.getExecutionContext());
    FlowExecutor executor = new JobFlowExecutor(getJobRepository(), stepHandler, stepExecution.getJobExecution());
    executor.updateJobExecutionStatus(flow.start(executor).getStatus());
    stepExecution.upgradeStatus(executor.getJobExecution().getStatus());
    stepExecution.setExitStatus(executor.getJobExecution().getExitStatus());
  }
  catch (FlowExecutionException e) {
    if (e.getCause() instanceof JobExecutionException) {
      throw (JobExecutionException) e.getCause();
    }
    throw new JobExecutionException("Flow execution ended unexpectedly", e);
  }
}

/**
 * Delegate to the flow provided for the execution of the step.
 * 
 * @see AbstractStep#doExecute(StepExecution)
 */
@Override
protected void doExecute(StepExecution stepExecution) throws Exception {
  try {
    StepHandler stepHandler = new SimpleStepHandler(getJobRepository(), stepExecution.getExecutionContext());
    FlowExecutor executor = new JobFlowExecutor(getJobRepository(), stepHandler, stepExecution.getJobExecution());
    executor.updateJobExecutionStatus(flow.start(executor).getStatus());
    stepExecution.upgradeStatus(executor.getJobExecution().getStatus());
    stepExecution.setExitStatus(executor.getJobExecution().getExitStatus());
  }
  catch (FlowExecutionException e) {
    if (e.getCause() instanceof JobExecutionException) {
      throw (JobExecutionException) e.getCause();
    }
    throw new JobExecutionException("Flow execution ended unexpectedly", e);
  }
}