|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JobExplorer
Entry point for browsing executions of running or historical jobs and steps. Since the data may be re-hydrated from persistent storage, it may not contain volatile fields that would have been present when the execution was active.
Method Summary | |
---|---|
Set<JobExecution> |
findRunningJobExecutions(String jobName)
Retrieve running job executions. |
JobExecution |
getJobExecution(Long executionId)
Retrieve a JobExecution by its id. |
List<JobExecution> |
getJobExecutions(JobInstance jobInstance)
Retrieve job executions by their job instance. |
JobInstance |
getJobInstance(Long instanceId)
|
List<JobInstance> |
getJobInstances(String jobName,
int start,
int count)
Fetch JobInstance values in descending order of creation (and
therefore usually of first execution). |
List<String> |
getJobNames()
Query the repository for all unique JobInstance names (sorted
alphabetically). |
StepExecution |
getStepExecution(Long jobExecutionId,
Long stepExecutionId)
Retrieve a StepExecution by its id and parent
JobExecution id. |
Method Detail |
---|
List<JobInstance> getJobInstances(String jobName, int start, int count)
JobInstance
values in descending order of creation (and
therefore usually of first execution).
jobName
- the name of the job to querystart
- the start index of the instances to returncount
- the maximum number of instances to return
JobInstance
values up to a maximum of count valuesJobExecution getJobExecution(Long executionId)
JobExecution
by its id. The complete object graph for
this execution should be returned (unless otherwise indicated) including
the parent JobInstance
and associated ExecutionContext
and StepExecution
instances (also including their execution
contexts).
executionId
- the job execution id
JobExecution
with this id, or null if not foundStepExecution getStepExecution(Long jobExecutionId, Long stepExecutionId)
StepExecution
by its id and parent
JobExecution
id. The execution context for the step should be
available in the result, and the parent job execution should have its
primitive properties, but may not contain the job instance information.
jobExecutionId
- the parent job execution idstepExecutionId
- the step execution id
StepExecution
with this id, or null if not foundgetJobExecution(Long)
JobInstance getJobInstance(Long instanceId)
instanceId
-
JobInstance
with this id, or nullList<JobExecution> getJobExecutions(JobInstance jobInstance)
getStepExecution(Long, Long)
to hydrate them in that case.
jobInstance
- the JobInstance
to query
JobInstance
Set<JobExecution> findRunningJobExecutions(String jobName)
getStepExecution(Long, Long)
to hydrate them in that case.
jobName
- the name of the job
List<String> getJobNames()
JobInstance
names (sorted
alphabetically).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |