public interface JobRepository
Repository responsible for persistence of batch meta-data entities.
JobInstance
,
JobExecution
,
StepExecution
Modifier and Type | Method and Description |
---|---|
void |
add(StepExecution stepExecution)
Save the
StepExecution and its ExecutionContext . |
void |
addAll(Collection<StepExecution> stepExecutions)
Save a collection of
StepExecution s and each ExecutionContext . |
JobExecution |
createJobExecution(String jobName,
JobParameters jobParameters)
|
JobExecution |
getLastJobExecution(String jobName,
JobParameters jobParameters) |
StepExecution |
getLastStepExecution(JobInstance jobInstance,
String stepName) |
int |
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
ExecutionContext s of the given
StepExecution . |
boolean isJobInstanceExists(String jobName, JobParameters jobParameters)
jobName
- the name of the jobjobParameters
- the parameters to matchJobInstance
already exists for this job name
and job parametersJobExecution createJobExecution(String jobName, JobParameters jobParameters) throws JobExecutionAlreadyRunningException, JobRestartException, JobInstanceAlreadyCompleteException
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).
jobName
- the name of the job that is to be executed jobParameters
- the runtime parameters for the jobJobExecution
for the arguments providedJobExecutionAlreadyRunningException
- if there is a
JobExecution
already running for the job instance with the
provided job and parameters.JobRestartException
- if one or more existing JobInstance
s
is found with the same parameters and Job.isRestartable()
is
false.JobInstanceAlreadyCompleteException
- if a JobInstance
is
found and was already completed successfully.void update(JobExecution jobExecution)
JobExecution
(but not its ExecutionContext
).
Preconditions: JobExecution
must contain a valid
JobInstance
and be saved (have an id assigned).jobExecution
- void add(StepExecution stepExecution)
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
.stepExecution
- void addAll(Collection<StepExecution> stepExecutions)
StepExecution
s 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
.stepExecution
- void update(StepExecution stepExecution)
StepExecution
(but not its ExecutionContext
).
Preconditions: StepExecution
must be saved (have an id assigned).stepExecution
- void updateExecutionContext(StepExecution stepExecution)
ExecutionContext
s of the given
StepExecution
.stepExecution
- void updateExecutionContext(JobExecution jobExecution)
ExecutionContext
of the given
JobExecution
.jobExecution
- StepExecution getLastStepExecution(JobInstance jobInstance, String stepName)
stepName
- the name of the step execution that might have run.int getStepExecutionCount(JobInstance jobInstance, String stepName)
stepName
- the name of the step execution that might have run.JobExecution getLastJobExecution(String jobName, JobParameters jobParameters)
jobName
- the name of the job that might have runjobParameters
- parameters identifying the JobInstance
Copyright © 2014 Pivotal. All rights reserved.