Package org.springframework.batch.test
Class StepRunner
- java.lang.Object
- org.springframework.batch.test.StepRunner
public class StepRunner extends java.lang.Object
Utility class for executing steps outside of aJob
. This is useful in end to end testing in order to allow for the testing of a step individually without running every Step in a job.- launchStep(Step step): Launch the step with new parameters each time. (The current system time will be used)
- launchStep(Step step, JobParameters jobParameters): Launch the specified step with the provided JobParameters. This may be useful if your step requires a certain parameter during runtime.
- Since:
- 2.0
- Author:
- Dan Garrette, Lucas Ward, Mahmoud Ben Hassine
- See Also:
SimpleJob
Field Summary
Fields Modifier and Type Field Description protected org.apache.commons.logging.Log
logger
Logger
Constructor Summary
Constructors Constructor Description StepRunner(JobLauncher launcher, JobRepository jobRepository)
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description JobExecution
launchStep(Step step)
Launch just the specified step as its own job.JobExecution
launchStep(Step step, JobParameters jobParameters)
Launch just the specified step as its own job.JobExecution
launchStep(Step step, JobParameters jobParameters, ExecutionContext jobExecutionContext)
Launch just the specified step as its own job.JobExecution
launchStep(Step step, ExecutionContext jobExecutionContext)
Launch just the specified step as its own job.
Constructor Detail
StepRunner
public StepRunner(JobLauncher launcher, JobRepository jobRepository)
Method Detail
launchStep
public JobExecution launchStep(Step step)
Launch just the specified step as its own job. A unique set of JobParameters will automatically be generated. An IllegalStateException is thrown if there is no Step with the given name.- Parameters:
step
- The step to launch- Returns:
- JobExecution
launchStep
public JobExecution launchStep(Step step, @Nullable ExecutionContext jobExecutionContext)
Launch just the specified step as its own job. A unique set of JobParameters will automatically be generated. An IllegalStateException is thrown if there is no Step with the given name.- Parameters:
step
- The step to launchjobExecutionContext
- An ExecutionContext whose values will be loaded into the Job ExecutionContext prior to launching the step.- Returns:
- JobExecution
launchStep
public JobExecution launchStep(Step step, JobParameters jobParameters)
Launch just the specified step as its own job. An IllegalStateException is thrown if there is no Step with the given name.- Parameters:
step
- The step to launchjobParameters
- The JobParameters to use during the launch- Returns:
- JobExecution
launchStep
public JobExecution launchStep(Step step, JobParameters jobParameters, @Nullable ExecutionContext jobExecutionContext)
Launch just the specified step as its own job. An IllegalStateException is thrown if there is no Step with the given name.- Parameters:
step
- The step to launchjobParameters
- The JobParameters to use during the launchjobExecutionContext
- An ExecutionContext whose values will be loaded into the Job ExecutionContext prior to launching the step.- Returns:
- JobExecution