org.springframework.batch.core.explore

Interface JobExplorer

All Known Implementing Classes:

SimpleJobExplorer

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.

Since:

2.0

Author:

Dave Syer

Method Summary

Methods

Modifier and Type	Method and Description
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

getJobInstances

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

Fetch JobInstance 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

getJobExecution

JobExecution getJobExecution(Long executionId)

Retrieve a 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).

Parameters:

executionId - the job execution id

Returns:

the JobExecution with this id, or null if not found

getStepExecution

StepExecution getStepExecution(Long jobExecutionId,
                             Long stepExecutionId)

Retrieve a 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.

Parameters:

jobExecutionId - the parent job execution id

stepExecutionId - the step execution id

Returns:

the StepExecution with this id, or null if not found

See Also:

getJobExecution(Long)

getJobInstance

JobInstance getJobInstance(Long instanceId)

Parameters:

instanceId -

Returns:

the JobInstance with this id, or null

getJobExecutions

List<JobExecution> getJobExecutions(JobInstance jobInstance)

Retrieve job executions by their job instance. The corresponding step executions may not be fully hydrated (e.g. their execution context may be missing), depending on the implementation. Use getStepExecution(Long, Long) to hydrate them in that case.

Parameters:

jobInstance - the JobInstance to query

Returns:

the set of all executions for the specified JobInstance

findRunningJobExecutions

Set<JobExecution> findRunningJobExecutions(String jobName)

Retrieve running job executions. The corresponding step executions may not be fully hydrated (e.g. their execution context may be missing), depending on the implementation. Use getStepExecution(Long, Long) to hydrate them in that case.

Parameters:

jobName - the name of the job

Returns:

the set of running executions for jobs with the specified name

getJobNames

List<String> getJobNames()

Query the repository for all unique JobInstance names (sorted alphabetically).

Returns:

the set of job names that have been executed