Interface JobExplorer
- All Known Implementing Classes:
SimpleJobExplorer
public interface JobExplorer
Entry point for browsing the executions of running or historical jobs and steps. Since
the data may be re-hydrated from persistent storage, it cannot contain volatile fields
that would have been present when the execution was active.
- Since:
- 2.0
- Author:
- Dave Syer, Michael Minella, Will Schipp, Mahmoud Ben Hassine, Parikshit Dutta
-
Method Summary
Modifier and TypeMethodDescriptionfindJobInstancesByJobName
(String jobName, int start, int count) FetchJobInstance
values in descending order of creation (and, therefore, usually of first execution) with a 'like' or wildcard criteria.findRunningJobExecutions
(String jobName) Retrieve running job executions.getJobExecution
(Long executionId) Retrieve aJobExecution
by its ID.getJobExecutions
(JobInstance jobInstance) Retrieve job executions by their job instance.getJobInstance
(Long instanceId) default JobInstance
getJobInstance
(String jobName, JobParameters jobParameters) long
getJobInstanceCount
(String jobName) Query the repository for the number of uniqueJobInstance
objects associated with the supplied job name.getJobInstances
(String jobName, int start, int count) FetchJobInstance
values in descending order of creation (and, therefore, usually, of first execution).Query the repository for all uniqueJobInstance
names (sorted alphabetically).default JobExecution
getLastJobExecution
(JobInstance jobInstance) Find the lastJobExecution
that has been created for a givenJobInstance
.default JobInstance
getLastJobInstance
(String jobName) Find the last job instance, by ID, for the given job.getStepExecution
(Long jobExecutionId, Long stepExecutionId) Retrieve aStepExecution
by its ID and parentJobExecution
ID.
-
Method Details
-
getJobInstances
FetchJobInstance
values in descending order of creation (and, therefore, usually, of first execution).- Parameters:
jobName
- The name of the job to query.start
- The start index of the instances to return.count
- The maximum number of instances to return.- Returns:
- the
JobInstance
values up to a maximum of count values.
-
getLastJobInstance
Find the last job instance, by ID, for the given job.- Parameters:
jobName
- The name of the job.- Returns:
- the last job instance by Id if any or
null
otherwise. - Since:
- 4.2
-
getJobExecution
Retrieve aJobExecution
by its ID. The complete object graph for this execution should be returned (unless otherwise indicated), including the parentJobInstance
and associatedExecutionContext
andStepExecution
instances (also including their execution contexts).- Parameters:
executionId
- The job execution ID.- Returns:
- the
JobExecution
that has this ID ornull
if not found.
-
getStepExecution
@Nullable StepExecution getStepExecution(@Nullable Long jobExecutionId, @Nullable Long stepExecutionId) Retrieve aStepExecution
by its ID and parentJobExecution
ID. The execution context for the step should be available in the result, and the parent job execution should have its primitive properties, but it may not contain the job instance information.- Parameters:
jobExecutionId
- The parent job execution ID.stepExecutionId
- The step execution ID.- Returns:
- the
StepExecution
that has this ID ornull
if not found. - See Also:
-
getJobInstance
- Parameters:
instanceId
-Long
The ID for theJobInstance
to obtain.- Returns:
- the
JobInstance
that has this ID, ornull
if not found.
-
getJobInstance
- Parameters:
jobName
-String
name of the job.jobParameters
-JobParameters
parameters for the job instance.- Returns:
- the
JobInstance
with the given name and parameters, ornull
. - Since:
- 5.0
-
getJobExecutions
Retrieve job executions by their job instance. The corresponding step executions may not be fully hydrated (for example, their execution context may be missing), depending on the implementation. In that case, usegetStepExecution(Long, Long)
to hydrate them.- Parameters:
jobInstance
- TheJobInstance
to query.- Returns:
- the list of all executions for the specified
JobInstance
.
-
getLastJobExecution
Find the lastJobExecution
that has been created for a givenJobInstance
.- Parameters:
jobInstance
- TheJobInstance
for which to find the lastJobExecution
.- Returns:
- the last
JobExecution
that has been created for this instance ornull
if no job execution is found for the given job instance. - Since:
- 4.2
-
findRunningJobExecutions
Retrieve running job executions. The corresponding step executions may not be fully hydrated (for example, their execution context may be missing), depending on the implementation. In that case, usegetStepExecution(Long, Long)
to hydrate them.- Parameters:
jobName
- The name of the job.- Returns:
- the set of running executions for jobs with the specified name.
-
getJobNames
Query the repository for all uniqueJobInstance
names (sorted alphabetically).- Returns:
- the list of job names that have been executed.
-
findJobInstancesByJobName
FetchJobInstance
values in descending order of creation (and, therefore, usually of first execution) with a 'like' or wildcard criteria.- Parameters:
jobName
- The name of the job for which to query.start
- The start index of the instances to return.count
- The maximum number of instances to return.- Returns:
- a list of
JobInstance
for the requested job name.
-
getJobInstanceCount
Query the repository for the number of uniqueJobInstance
objects associated with the supplied job name.- Parameters:
jobName
- The name of the job for which to query.- Returns:
- the number of
JobInstance
s that exist within the associated job repository. - Throws:
NoSuchJobException
- thrown when there is noJobInstance
for the jobName specified.
-