Package org.springframework.batch.test

Class JobRepositoryTestUtils

java.lang.Object

org.springframework.batch.test.JobRepositoryTestUtils

public class JobRepositoryTestUtils
extends Object

Convenience class for creating and removing JobExecution instances from a database. Typical usage in test case would be to create instances before a transaction, save the result, and then use it to remove them after the transaction.

Author:

Dave Syer, Mahmoud Ben Hassine

Constructor Summary

Constructors

Constructor	Description
JobRepositoryTestUtils()	Default constructor.
JobRepositoryTestUtils(JobRepository jobRepository)	Create a JobRepositoryTestUtils with all its mandatory properties.

Method Summary

Modifier and Type	Method	Description
List<JobExecution>	createJobExecutions(int count)	Use the JobRepository to create some JobExecution instances each with a single step execution.
List<JobExecution>	createJobExecutions(String jobName, String[] stepNames, int count)	Use the JobRepository to create some JobExecution instances each with the given job name and each having step executions with the given step names.
void	removeJobExecution(JobExecution jobExecution)	Remove the JobExecution and its associated StepExecution instances from the standard locations used by Spring Batch.
void	removeJobExecutions()	Remove all the JobExecution instances, and all associated JobInstance and StepExecution instances from the standard locations used by Spring Batch.
void	removeJobExecutions(Collection<JobExecution> jobExecutions)	Remove the JobExecution instances, and all associated JobInstance and StepExecution instances from the standard locations used by Spring Batch.
void	setJobParametersIncrementer(JobParametersIncrementer jobParametersIncrementer)
void	setJobRepository(JobRepository jobRepository)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JobRepositoryTestUtils

public JobRepositoryTestUtils()

Default constructor.

JobRepositoryTestUtils

public JobRepositoryTestUtils(JobRepository jobRepository)

Create a JobRepositoryTestUtils with all its mandatory properties.

Parameters:

jobRepository - a JobRepository.

Method Details

setJobParametersIncrementer

public void setJobParametersIncrementer(JobParametersIncrementer jobParametersIncrementer)

Parameters:

jobParametersIncrementer - the jobParametersIncrementer to set

setJobRepository

public void setJobRepository(JobRepository jobRepository)

Parameters:

jobRepository - the jobRepository to set

createJobExecutions

public List<JobExecution> createJobExecutions(String jobName,
 String[] stepNames,
 int count)
                                       throws JobExecutionAlreadyRunningException,
JobRestartException,
JobInstanceAlreadyCompleteException

Use the JobRepository to create some JobExecution instances each with the given job name and each having step executions with the given step names.

Parameters:

jobName - the name of the job

stepNames - the names of the step executions

count - the required number of instances of JobExecution to create

Returns:

a collection of JobExecution

Throws:

JobExecutionAlreadyRunningException - thrown if Job is already running.

JobRestartException - thrown if Job is not restartable.

JobInstanceAlreadyCompleteException - thrown if Job Instance is already complete.

createJobExecutions

public List<JobExecution> createJobExecutions(int count)
                                       throws JobExecutionAlreadyRunningException,
JobRestartException,
JobInstanceAlreadyCompleteException

Use the JobRepository to create some JobExecution instances each with a single step execution.

Parameters:

count - the required number of instances of JobExecution to create

Returns:

a collection of JobExecution

Throws:

JobExecutionAlreadyRunningException - thrown if Job is already running.

JobRestartException - thrown if Job is not restartable.

JobInstanceAlreadyCompleteException - thrown if Job Instance is already complete.

removeJobExecutions

public void removeJobExecutions(Collection<JobExecution> jobExecutions)

Remove the JobExecution instances, and all associated JobInstance and StepExecution instances from the standard locations used by Spring Batch.

Parameters:

jobExecutions - a collection of JobExecution

removeJobExecution

public void removeJobExecution(JobExecution jobExecution)

Remove the JobExecution and its associated StepExecution instances from the standard locations used by Spring Batch.

Parameters:

jobExecution - the JobExecution to delete

removeJobExecutions

public void removeJobExecutions()

Remove all the JobExecution instances, and all associated JobInstance and StepExecution instances from the standard locations used by Spring Batch.