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

Class DefaultTaskJobService

java.lang.Object

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

All Implemented Interfaces:

TaskJobService

@Transactional
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, Corneil du Plessis

Constructor Summary

Constructors

Constructor	Description
DefaultTaskJobService(JobService jobService, DataflowTaskExplorer taskExplorer, TaskDefinitionRepository taskDefinitionRepository, TaskExecutionService taskExecutionService, LauncherRepository launcherRepository, TaskConfigurationProperties taskConfigurationProperties)

Method Summary

Modifier and Type	Method	Description
TaskJobExecution	getJobExecution(long id)	Retrieves a JobExecution from the JobRepository and matches it with a task id.
Map<Long,Set<Long>>	getJobExecutionIdsByTaskExecutionIds(Collection<Long> taskExecutionIds)
JobInstanceExecutions	getJobInstance(long id)	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, 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>	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>	listJobExecutionsForJobWithStepCountFilteredByJobInstanceId(org.springframework.data.domain.Pageable pageable, int jobInstanceId)	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)	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)	Restarts a JobExecution if the respective JobExecution is actually deemed restartable.
void	restartJobExecution(long jobExecutionId, Boolean useJsonJobParameters)	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 Details

DefaultTaskJobService

public DefaultTaskJobService(JobService jobService,
 DataflowTaskExplorer taskExplorer,
 TaskDefinitionRepository taskDefinitionRepository,
 TaskExecutionService taskExecutionService,
 LauncherRepository launcherRepository,
 TaskConfigurationProperties taskConfigurationProperties)

Method Details

listJobExecutions

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

Description copied from interface: TaskJobService

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.

listJobExecutionsWithStepCount

public org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsWithStepCount(org.springframework.data.domain.Pageable pageable)

Description copied from interface: TaskJobService

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

Specified by:

listJobExecutionsWithStepCount in interface TaskJobService

Parameters:

pageable - enumerates the data to be returned.

Returns:

List containing TaskJobExecutions.

listJobExecutionsForJob

public 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

Description copied from interface: TaskJobService

Retrieves Pageable list of JobExecution from the JobRepository with a specific jobName, status 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 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

public org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsForJobWithStepCount(org.springframework.data.domain.Pageable pageable,
 Date fromDate,
 Date toDate)

Description copied from interface: TaskJobService

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

Specified by:

listJobExecutionsForJobWithStepCount in interface TaskJobService

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.

listJobExecutionsForJobWithStepCountFilteredByJobInstanceId

public org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsForJobWithStepCountFilteredByJobInstanceId(org.springframework.data.domain.Pageable pageable,
 int jobInstanceId)

Description copied from interface: TaskJobService

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

Specified by:

listJobExecutionsForJobWithStepCountFilteredByJobInstanceId in interface TaskJobService

Parameters:

pageable - enumerates the data to be returned.

jobInstanceId - the job instance id associated with the execution.

Returns:

List containing JobExecutionWithStepCounts.

listJobExecutionsForJobWithStepCountFilteredByTaskExecutionId

public org.springframework.data.domain.Page<TaskJobExecution> listJobExecutionsForJobWithStepCountFilteredByTaskExecutionId(org.springframework.data.domain.Pageable pageable,
 int taskExecutionId)

Description copied from interface: TaskJobService

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

Specified by:

listJobExecutionsForJobWithStepCountFilteredByTaskExecutionId in interface TaskJobService

Parameters:

pageable - enumerates the data to be returned.

taskExecutionId - the task execution id associated with the execution.

Returns:

List containing JobExecutionWithStepCounts.

listJobExecutionsForJobWithStepCount

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

Description copied from interface: TaskJobService

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

Specified by:

listJobExecutionsForJobWithStepCount in interface TaskJobService

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

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

Description copied from interface: TaskJobService

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 org.springframework.data.domain.Page<JobInstanceExecutions> listTaskJobInstancesForJobName(org.springframework.data.domain.Pageable pageable,
 String jobName)
                                                                                           throws org.springframework.batch.core.launch.NoSuchJobException

Description copied from interface: TaskJobService

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 findByTaskNameContains.

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

Description copied from interface: TaskJobService

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.

getJobExecutionIdsByTaskExecutionIds

public Map<Long,Set<Long>> getJobExecutionIdsByTaskExecutionIds(Collection<Long> taskExecutionIds)

Specified by:

getJobExecutionIdsByTaskExecutionIds in interface TaskJobService

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. The system will use TaskConfigurationProperties.isUseJsonJobParameters() to determine the JobParameter serializer.

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.

restartJobExecution

public void restartJobExecution(long jobExecutionId,
 Boolean useJsonJobParameters)
                         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.

useJsonJobParameters - if set to true, dataflow will serialize job parameters to the command line using the format provided by JsonJobParametersConverter. If set to false dataflow will use DefaultParametersConverter. If null dataflow will use TaskConfigurationProperties.isUseJsonJobParameters() to determine the JobParameter serializer.

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 - 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)