Package org.springframework.batch.core.repository.support

Class SimpleJobRepository

java.lang.Object

org.springframework.batch.core.repository.support.SimpleJobRepository

All Implemented Interfaces:

JobRepository

public class SimpleJobRepository
extends Object
implements JobRepository

Implementation of JobRepository that stores job instances, job executions, and step executions using the injected DAOs.

Author:

Lucas Ward, Dave Syer, Robert Kasanicky, David Turanski, Mahmoud Ben Hassine, Baris Cubukcuoglu, Parikshit Dutta

See Also:

• JobRepository
• JobInstanceDao
• JobExecutionDao
• StepExecutionDao

Constructor Summary

Constructors

Constructor	Description
SimpleJobRepository(JobInstanceDao jobInstanceDao, JobExecutionDao jobExecutionDao, StepExecutionDao stepExecutionDao, ExecutionContextDao ecDao)

Method Summary

Modifier and Type	Method	Description
void	add(StepExecution stepExecution)	Save the StepExecution and its ExecutionContext.
void	addAll(Collection<StepExecution> stepExecutions)	Save a collection of StepExecutions and each ExecutionContext.
JobExecution	createJobExecution(String jobName, JobParameters jobParameters)	Create a JobExecution for a given Job and JobParameters.
JobInstance	createJobInstance(String jobName, JobParameters jobParameters)	Create a new JobInstance with the name and job parameters provided.
void	deleteJobExecution(JobExecution jobExecution)	Delete the job execution object graph (ie the job execution with its execution context, all related step executions and their executions contexts, as well as associated job parameters)
void	deleteJobInstance(JobInstance jobInstance)	Delete the job instance object graph (ie the job instance with all associated job executions along with their respective object graphs as specified in JobRepository.deleteJobExecution(JobExecution)).
void	deleteStepExecution(StepExecution stepExecution)	Delete the step execution along with its execution context.
List<JobExecution>	findJobExecutions(JobInstance jobInstance)	Return all JobExecutions for given JobInstance, sorted backwards by creation order (so the first element is the most recent).
List<JobInstance>	findJobInstancesByName(String jobName, int start, int count)	Fetch the last job instances with the provided name, sorted backwards by primary key, using a 'like' criteria
JobInstance	getJobInstance(String jobName, JobParameters jobParameters)
List<String>	getJobNames()	Retrieve the names of all job instances sorted alphabetically - i.e.
JobExecution	getLastJobExecution(String jobName, JobParameters jobParameters)
StepExecution	getLastStepExecution(JobInstance jobInstance, String stepName)
long	getStepExecutionCount(JobInstance jobInstance, String stepName)
boolean	isJobInstanceExists(String jobName, JobParameters jobParameters)	Check if an instance of this job already exists with the parameters provided.
void	update(JobExecution jobExecution)	Update the JobExecution (but not its ExecutionContext).
void	update(StepExecution stepExecution)	Update the StepExecution (but not its ExecutionContext).
void	updateExecutionContext(JobExecution jobExecution)	Persist the updated ExecutionContext of the given JobExecution.
void	updateExecutionContext(StepExecution stepExecution)	Persist the updated ExecutionContexts of the given StepExecution.

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleJobRepository

public SimpleJobRepository(JobInstanceDao jobInstanceDao,
 JobExecutionDao jobExecutionDao,
 StepExecutionDao stepExecutionDao,
 ExecutionContextDao ecDao)

Method Details

getJobNames

public List<String> getJobNames()

Description copied from interface: JobRepository

Retrieve the names of all job instances sorted alphabetically - i.e. jobs that have ever been executed.

Specified by:

getJobNames in interface JobRepository

Returns:

the names of all job instances

findJobInstancesByName

public List<JobInstance> findJobInstancesByName(String jobName,
 int start,
 int count)

Description copied from interface: JobRepository

Fetch the last job instances with the provided name, sorted backwards by primary key, using a 'like' criteria

Specified by:

findJobInstancesByName in interface JobRepository

Parameters:

jobName - String containing the name of the job.

start - int containing the offset of where list of job instances results should begin.

count - int containing the number of job instances to return.

Returns:

a list of JobInstance for the job name requested.

findJobExecutions

public List<JobExecution> findJobExecutions(JobInstance jobInstance)

Description copied from interface: JobRepository

Return all JobExecutions for given JobInstance, sorted backwards by creation order (so the first element is the most recent).

Specified by:

findJobExecutions in interface JobRepository

Parameters:

jobInstance - parent JobInstance of the JobExecutions to find.

Returns:

List containing JobExecutions for the jobInstance.

isJobInstanceExists

public boolean isJobInstanceExists(String jobName,
 JobParameters jobParameters)

Description copied from interface: JobRepository

Check if an instance of this job already exists with the parameters provided.

Specified by:

isJobInstanceExists in interface JobRepository

Parameters:

jobName - the name of the job

jobParameters - the parameters to match

Returns:

true if a JobInstance already exists for this job name and job parameters

createJobExecution

public JobExecution createJobExecution(String jobName,
 JobParameters jobParameters)
                                throws JobExecutionAlreadyRunningException,
JobRestartException,
JobInstanceAlreadyCompleteException

Description copied from interface: JobRepository

Create a JobExecution for a given Job and JobParameters. If matching JobInstance already exists, the job must be restartable and it's last JobExecution must *not* be completed. If matching JobInstance does not exist yet it will be created.

If this method is run in a transaction (as it normally would be) with isolation level at Isolation.REPEATABLE_READ or better, then this method should block if another transaction is already executing it (for the same JobParameters and job name). The first transaction to complete in this scenario obtains a valid JobExecution, and others throw JobExecutionAlreadyRunningException (or timeout). There are no such guarantees if the JobInstanceDao and JobExecutionDao do not respect the transaction isolation levels (e.g. if using a non-relational data-store, or if the platform does not support the higher isolation levels).

Specified by:

createJobExecution in interface JobRepository

Parameters:

jobName - the name of the job that is to be executed

jobParameters - the runtime parameters for the job

Returns:

a valid JobExecution for the arguments provided

Throws:

JobExecutionAlreadyRunningException - if there is a JobExecution already running for the job instance with the provided job and parameters.

JobRestartException - if one or more existing JobInstances is found with the same parameters and Job.isRestartable() is false.

JobInstanceAlreadyCompleteException - if a JobInstance is found and was already completed successfully.

update

public void update(JobExecution jobExecution)

Description copied from interface: JobRepository

Update the JobExecution (but not its ExecutionContext). Preconditions: JobExecution must contain a valid JobInstance and be saved (have an id assigned).

Specified by:

update in interface JobRepository

Parameters:

jobExecution - JobExecution instance to be updated in the repo.

add

public void add(StepExecution stepExecution)

Description copied from interface: JobRepository

Save the StepExecution and its ExecutionContext. ID will be assigned - it is not permitted that an ID be assigned before calling this method. Instead, it should be left blank, to be assigned by a JobRepository. Preconditions: StepExecution must have a valid Step.

Specified by:

add in interface JobRepository

Parameters:

stepExecution - StepExecution instance to be added to the repo.

addAll

public void addAll(Collection<StepExecution> stepExecutions)

Description copied from interface: JobRepository

Save a collection of StepExecutions and each ExecutionContext. The StepExecution ID will be assigned - it is not permitted that an ID be assigned before calling this method. Instead, it should be left blank, to be assigned by JobRepository. Preconditions: StepExecution must have a valid Step.

Specified by:

addAll in interface JobRepository

Parameters:

stepExecutions - collection of StepExecution instances to be added to the repo.

update

public void update(StepExecution stepExecution)

Description copied from interface: JobRepository

Update the StepExecution (but not its ExecutionContext). Preconditions: StepExecution must be saved (have an id assigned).

Specified by:

update in interface JobRepository

Parameters:

stepExecution - StepExecution instance to be updated in the repo.

updateExecutionContext

public void updateExecutionContext(StepExecution stepExecution)

Description copied from interface: JobRepository

Persist the updated ExecutionContexts of the given StepExecution.

Specified by:

updateExecutionContext in interface JobRepository

Parameters:

stepExecution - StepExecution instance to be used to update the context.

updateExecutionContext

public void updateExecutionContext(JobExecution jobExecution)

Description copied from interface: JobRepository

Persist the updated ExecutionContext of the given JobExecution.

Specified by:

updateExecutionContext in interface JobRepository

Parameters:

jobExecution - JobExecution instance to be used to update the context.

getJobInstance

public JobInstance getJobInstance(String jobName,
 JobParameters jobParameters)

Specified by:

getJobInstance in interface JobRepository

Parameters:

jobName - String name of the job.

jobParameters - JobParameters parameters for the job instance.

Returns:

the JobInstance with the given name and parameters, or null.

getLastStepExecution

@Nullable
public StepExecution getLastStepExecution(JobInstance jobInstance,
 String stepName)

Specified by:

getLastStepExecution in interface JobRepository

Parameters:

jobInstance - JobInstance instance containing the step executions.

stepName - the name of the step execution that might have run.

Returns:

the last execution of step for the given job instance.

getStepExecutionCount

public long getStepExecutionCount(JobInstance jobInstance,
 String stepName)

Specified by:

getStepExecutionCount in interface JobRepository

Parameters:

jobInstance - JobInstance instance containing the step executions.

stepName - the name of the step execution that might have run.

Returns:

number of executions of the step within given job instance

getLastJobExecution

@Nullable
public JobExecution getLastJobExecution(String jobName,
 JobParameters jobParameters)

Specified by:

getLastJobExecution in interface JobRepository

Parameters:

jobName - the name of the job that might have run

jobParameters - parameters identifying the JobInstance

Returns:

the last execution of job if exists, null otherwise

deleteStepExecution

public void deleteStepExecution(StepExecution stepExecution)

Description copied from interface: JobRepository

Delete the step execution along with its execution context.

Specified by:

deleteStepExecution in interface JobRepository

Parameters:

stepExecution - the step execution to delete

deleteJobExecution

public void deleteJobExecution(JobExecution jobExecution)

Description copied from interface: JobRepository

Delete the job execution object graph (ie the job execution with its execution context, all related step executions and their executions contexts, as well as associated job parameters)

Specified by:

deleteJobExecution in interface JobRepository

Parameters:

jobExecution - the job execution to delete

deleteJobInstance

public void deleteJobInstance(JobInstance jobInstance)

Description copied from interface: JobRepository

Delete the job instance object graph (ie the job instance with all associated job executions along with their respective object graphs as specified in JobRepository.deleteJobExecution(JobExecution)).

Specified by:

deleteJobInstance in interface JobRepository

Parameters:

jobInstance - the job instance to delete

createJobInstance

public JobInstance createJobInstance(String jobName,
 JobParameters jobParameters)

Description copied from interface: JobRepository

Create a new JobInstance with the name and job parameters provided.

Specified by:

createJobInstance in interface JobRepository

Parameters:

jobName - logical name of the job

jobParameters - parameters used to execute the job

Returns:

the new JobInstance