org.springframework.cloud.dataflow.server.service.impl

Class DefaultTaskJobService

java.lang.Object

org.springframework.cloud.dataflow.server.service.impl.DefaultTaskJobService

All Implemented Interfaces:

TaskJobService

public class DefaultTaskJobService
extends Object
implements TaskJobService

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

Author:

Glenn Renfro., Gunnar Hillert, Mark Fisher, Ilayaperumal Gopinathan

Constructor Summary

Constructors

Constructor and Description
DefaultTaskJobService(org.springframework.batch.admin.service.JobService jobService, org.springframework.cloud.task.repository.TaskExplorer taskExplorer, TaskDefinitionRepository taskDefinitionRepository, TaskService taskService)

Method Summary

Modifier and Type	Method and Description
int	countJobExecutions() Retrieves the total number of the job executions.
int	countJobExecutionsForJob(String jobName) Retrieves the total number JobExecution that match a specific job name.
int	countJobInstances(String jobName) Retrieves the total number of job instances for a job name.
TaskJobExecution	getJobExecution(long id) Retrieves a JobExecution from the JobRepository and matches it with a task id.
JobInstanceExecutions	getJobInstance(long id) Retrieves a JobInstance from the JobRepository and matches it with the associated JobExecutions.
List<TaskJobExecution>	listJobExecutions(org.springframework.data.domain.Pageable pageable) Retrieves Pageable list of JobExecutions from the JobRepository and matches the data with a task id.
List<TaskJobExecution>	listJobExecutionsForJob(org.springframework.data.domain.Pageable pageable, String jobName) Retrieves Pageable list of JobExecution from the JobRepository with a specific jobName and matches the data with a task id.
List<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) Restarts a JobExecution IF the respective JobExecution is actually deemed restartable.
void	stopJobExecution(long jobExecutionId) Requests a JobExecution to stop.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultTaskJobService

public DefaultTaskJobService(org.springframework.batch.admin.service.JobService jobService,
                             org.springframework.cloud.task.repository.TaskExplorer taskExplorer,
                             TaskDefinitionRepository taskDefinitionRepository,
                             TaskService taskService)

Method Detail

listJobExecutions

public List<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.

Specified by:

listJobExecutions in interface TaskJobService

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.

listJobExecutionsForJob

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

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

Specified by:

listJobExecutionsForJob in interface TaskJobService

Parameters:

pageable - enumerates the data to be returned.

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

Returns:

List containing TaskJobExecutions.

Throws:

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

getJobExecution

public TaskJobExecution getJobExecution(long id)
                                 throws org.springframework.batch.core.launch.NoSuchJobExecutionException

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

Specified by:

getJobExecution in interface TaskJobService

Parameters:

id - the id of the JobExecution

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

public List<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.

Specified by:

listTaskJobInstancesForJobName in interface TaskJobService

Parameters:

pageable - enumerates the data to be returned.

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

Returns:

List containing JobInstanceExecutions.

Throws:

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

getJobInstance

public JobInstanceExecutions getJobInstance(long id)
                                     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.

Specified by:

getJobInstance in interface TaskJobService

Parameters:

id - the id of the JobInstance

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.

countJobInstances

public int countJobInstances(String jobName)
                      throws org.springframework.batch.core.launch.NoSuchJobException

Retrieves the total number of job instances for a job name.

Specified by:

countJobInstances in interface TaskJobService

Parameters:

jobName - the name of the job instance.

Returns:

the number of job instances associated with the jobName.

Throws:

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

countJobExecutions

public int countJobExecutions()

Retrieves the total number of the job executions.

Specified by:

countJobExecutions in interface TaskJobService

Returns:

the total number of job executions.

countJobExecutionsForJob

public int countJobExecutionsForJob(String jobName)
                             throws org.springframework.batch.core.launch.NoSuchJobException

Retrieves the total number JobExecution that match a specific job name.

Specified by:

countJobExecutionsForJob in interface TaskJobService

Parameters:

jobName - the job name to search.

Returns:

the number of JobExecutions that match the job name.

Throws:

org.springframework.batch.core.launch.NoSuchJobException - if the job with the given name is not available

restartJobExecution

public void restartJobExecution(long jobExecutionId)
                         throws org.springframework.batch.core.launch.NoSuchJobExecutionException

Description copied from interface: TaskJobService

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

Specified by:

restartJobExecution in interface TaskJobService

Parameters:

jobExecutionId - The id of the JobExecution to restart.

Throws:

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

stopJobExecution

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

Description copied from interface: TaskJobService

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.

Specified by:

stopJobExecution in interface TaskJobService

Parameters:

jobExecutionId - The id of the JobExecution to stop

Throws:

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

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

See Also:

JobService.stop(Long)