org.springframework.cloud.dataflow.server.service

Interface TaskJobService

All Known Implementing Classes:

DefaultTaskJobService

public interface TaskJobService

Repository that retrieves Tasks and JobExecutions/Instances and the associations between them.

Author:

Glenn Renfro., Gunnar Hillert

Method Summary

Modifier and Type	Method and Description
TaskJobExecution	getJobExecution(long id, String schemaTarget) Retrieves a JobExecution from the JobRepository and matches it with a task id.
JobInstanceExecutions	getJobInstance(long id, String schemaTarget) Retrieves a JobInstance from the JobRepository and matches it with the associated JobExecutions.
org.springframework.data.domain.Page<TaskJobExecution>	listJobExecutions(org.springframework.data.domain.Pageable pageable) Retrieves Pageable list of JobExecutions from the JobRepository and matches the data with a task id.
org.springframework.data.domain.Page<TaskJobExecution>	listJobExecutionsForJob(org.springframework.data.domain.Pageable pageable, String jobName, org.springframework.batch.core.BatchStatus status) Retrieves Pageable list of JobExecution from the JobRepository with a specific jobName, status and matches the data with a task id.
org.springframework.data.domain.Page<TaskJobExecution>	listJobExecutionsForJobWithStepCount(org.springframework.data.domain.Pageable pageable, Date fromDate, Date toDate) Retrieves Pageable list of JobExecutionWithStepCount from the JobRepository filtered by the date range.
org.springframework.data.domain.Page<TaskJobExecution>	listJobExecutionsForJobWithStepCount(org.springframework.data.domain.Pageable pageable, String jobName) Retrieves Pageable list of JobExecutionWithStepCount from the JobRepository with a specific jobName and matches the data with a task id.
org.springframework.data.domain.Page<TaskJobExecution>	listJobExecutionsForJobWithStepCountFilteredByJobInstanceId(org.springframework.data.domain.Pageable pageable, int jobInstanceId, String schemaTarget) Retrieves Pageable list of JobExecutionWithStepCount from the JobRepository filtered by the job instance id.
org.springframework.data.domain.Page<TaskJobExecution>	listJobExecutionsForJobWithStepCountFilteredByTaskExecutionId(org.springframework.data.domain.Pageable pageable, int taskExecutionId, String schemaTarget) Retrieves Pageable list of JobExecutionWithStepCount from the JobRepository filtered by the task execution id.
org.springframework.data.domain.Page<TaskJobExecution>	listJobExecutionsWithStepCount(org.springframework.data.domain.Pageable pageable) Retrieves Pageable list of JobExecutionWithStepCounts from the JobRepository and matches the data with a task id but excludes the step executions.
org.springframework.data.domain.Page<JobInstanceExecutions>	listTaskJobInstancesForJobName(org.springframework.data.domain.Pageable pageable, String jobName) Retrieves Pageable list of JobInstanceExecutions from the JobRepository with a specific jobName and matches the data with the associated JobExecutions.
void	restartJobExecution(long jobExecutionId, String schemaTarget) Restarts a JobExecution IF the respective JobExecution is actually deemed restartable.
void	stopJobExecution(long jobExecutionId, String schemaTarget) Requests a JobExecution to stop.

Method Detail

listJobExecutions

org.springframework.data.domain.Page<TaskJobExecution> listJobExecutions(org.springframework.data.domain.Pageable pageable)
                                                                  throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Retrieves Pageable list of JobExecutions from the JobRepository and matches the data with a task id.

Parameters:

pageable - enumerates the data to be returned.

Returns:

List containing TaskJobExecutions.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - in the event that a job execution id specified is not present when looking up stepExecutions for the result.

listJobExecutionsForJobWithStepCount

org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsForJobWithStepCount(org.springframework.data.domain.Pageable pageable,
                                                                                            String jobName)
                                                                                     throws org.springframework.batch.core.launch.NoSuchJobException

Retrieves Pageable list of JobExecutionWithStepCount from the JobRepository with a specific jobName and matches the data with a task id.

Parameters:

pageable - enumerates the data to be returned.

jobName - the name of the job for which to findByTaskNameContains.

Returns:

List containing JobExecutionWithStepCounts.

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job with the given name does not exist.

getJobExecution

TaskJobExecution getJobExecution(long id,
                                 String schemaTarget)
                          throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Retrieves a JobExecution from the JobRepository and matches it with a task id.

Parameters:

id - the id of the JobExecution

schemaTarget - the schema target of the task job execution.

Returns:

the TaskJobExecutions associated with the id.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - if the specified job execution for the id does not exist.

listTaskJobInstancesForJobName

org.springframework.data.domain.Page<JobInstanceExecutions> listTaskJobInstancesForJobName(org.springframework.data.domain.Pageable pageable,
                                                                                           String jobName)
                                                                                    throws org.springframework.batch.core.launch.NoSuchJobException

Retrieves Pageable list of JobInstanceExecutions from the JobRepository with a specific jobName and matches the data with the associated JobExecutions.

Parameters:

pageable - enumerates the data to be returned.

jobName - the name of the job for which to findByTaskNameContains.

Returns:

List containing JobInstanceExecutions.

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job for the jobName specified does not exist.

getJobInstance

JobInstanceExecutions getJobInstance(long id,
                                     String schemaTarget)
                              throws org.springframework.batch.core.launch.NoSuchJobInstanceException,
                                     org.springframework.batch.core.launch.NoSuchJobException

Retrieves a JobInstance from the JobRepository and matches it with the associated JobExecutions.

Parameters:

id - the id of the JobInstance

schemaTarget - the schema target of the job instance.

Returns:

the JobInstanceExecutions associated with the id.

Throws:

org.springframework.batch.core.launch.NoSuchJobInstanceException - if job instance id does not exist.

org.springframework.batch.core.launch.NoSuchJobException - if the job for the job instance does not exist.

restartJobExecution

void restartJobExecution(long jobExecutionId,
                         String schemaTarget)
                  throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Restarts a JobExecution IF the respective JobExecution is actually deemed restartable. Otherwise a JobNotRestartableException is being thrown.

Parameters:

jobExecutionId - The id of the JobExecution to restart.

schemaTarget - the schema target of the job execution.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - if the JobExecution for the provided id does not exist.

stopJobExecution

void stopJobExecution(long jobExecutionId,
                      String schemaTarget)
               throws org.springframework.batch.core.launch.NoSuchJobExecutionException,
                      org.springframework.batch.core.launch.JobExecutionNotRunningException

Requests a JobExecution to stop.

Please remember, that calling this method only requests a job execution to stop processing. This method does not guarantee a JobExecution to stop. It is the responsibility of the implementor of the Job to react to that request. Furthermore, this method does not interfere with the associated TaskExecution.

Parameters:

jobExecutionId - The id of the JobExecution to stop.

schemaTarget - the schema target of the job execution.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - thrown if no job execution exists for the jobExecutionId.

org.springframework.batch.core.launch.JobExecutionNotRunningException - thrown if a stop is requested on a job that is not running.

See Also:

JobService.stop(Long)

listJobExecutionsWithStepCount

org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsWithStepCount(org.springframework.data.domain.Pageable pageable)
                                                                               throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Retrieves Pageable list of JobExecutionWithStepCounts from the JobRepository and matches the data with a task id but excludes the step executions.

Parameters:

pageable - enumerates the data to be returned.

Returns:

List containing TaskJobExecutions.

Throws:

org.springframework.batch.core.launch.NoSuchJobExecutionException - thrown if the job execution specified does not exist.

listJobExecutionsForJob

org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsForJob(org.springframework.data.domain.Pageable pageable,
                                                                               String jobName,
                                                                               org.springframework.batch.core.BatchStatus status)
                                                                        throws org.springframework.batch.core.launch.NoSuchJobException,
                                                                               org.springframework.batch.core.launch.NoSuchJobExecutionException

Retrieves Pageable list of JobExecution from the JobRepository with a specific jobName, status and matches the data with a task id.

Parameters:

pageable - enumerates the data to be returned.

jobName - the name of the job for which to findByTaskNameContains.

status - the BatchStatus of the job execution.

Returns:

List containing TaskJobExecutions.

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job with the given name does not exist.

org.springframework.batch.core.launch.NoSuchJobExecutionException - the job execution with the given name doesn't exist.

listJobExecutionsForJobWithStepCount

org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsForJobWithStepCount(org.springframework.data.domain.Pageable pageable,
                                                                                            Date fromDate,
                                                                                            Date toDate)
                                                                                     throws org.springframework.batch.core.launch.NoSuchJobException

Retrieves Pageable list of JobExecutionWithStepCount from the JobRepository filtered by the date range.

Parameters:

pageable - enumerates the data to be returned.

fromDate - the date which start date must be greater than.

toDate - the date which start date must be less than.

Returns:

List containing JobExecutionWithStepCounts.

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job with the given name does not exist.

listJobExecutionsForJobWithStepCountFilteredByJobInstanceId

org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsForJobWithStepCountFilteredByJobInstanceId(org.springframework.data.domain.Pageable pageable,
                                                                                                                   int jobInstanceId,
                                                                                                                   String schemaTarget)
                                                                                                            throws org.springframework.batch.core.launch.NoSuchJobException

Retrieves Pageable list of JobExecutionWithStepCount from the JobRepository filtered by the job instance id.

Parameters:

pageable - enumerates the data to be returned.

jobInstanceId - the job instance id associated with the execution.

schemaTarget - the schema target of the job instance.

Returns:

List containing JobExecutionWithStepCounts.

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job with the given name does not exist.

listJobExecutionsForJobWithStepCountFilteredByTaskExecutionId

org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsForJobWithStepCountFilteredByTaskExecutionId(org.springframework.data.domain.Pageable pageable,
                                                                                                                     int taskExecutionId,
                                                                                                                     String schemaTarget)
                                                                                                              throws org.springframework.batch.core.launch.NoSuchJobException

Retrieves Pageable list of JobExecutionWithStepCount from the JobRepository filtered by the task execution id.

Parameters:

pageable - enumerates the data to be returned.

taskExecutionId - the task execution id associated with the execution.

schemaTarget - the schema target of the task execution.

Returns:

List containing JobExecutionWithStepCounts.

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job with the given name does not exist.