org.springframework.cloud.task.repository.dao

Interface TaskExecutionDao

All Known Implementing Classes:

JdbcTaskExecutionDao, MapTaskExecutionDao

public interface TaskExecutionDao

Data Access Object for task executions.

Author:

Glenn Renfro

Method Summary

Modifier and Type	Method and Description
void	completeTaskExecution(long executionId, Integer exitCode, Date endTime, String exitMessage) Update and existing TaskExecution.
TaskExecution	createTaskExecution(String taskName, Date startTime, List<String> arguments) Save a new TaskExecution.
org.springframework.data.domain.Page<TaskExecution>	findAll(org.springframework.data.domain.Pageable pageable) Retrieves all the task executions within the pageable constraints.
org.springframework.data.domain.Page<TaskExecution>	findRunningTaskExecutions(String taskName, org.springframework.data.domain.Pageable pageable) Retrieves a set of task executions that are running for a taskName.
org.springframework.data.domain.Page<TaskExecution>	findTaskExecutionsByName(String taskName, org.springframework.data.domain.Pageable pageable) Retrieves a subset of task executions by task name, start location and size.
Set<Long>	getJobExecutionIdsByTaskExecutionId(long taskExecutionId) Returns the job execution ids associated with a task execution id.
long	getNextExecutionId() Retrieves the next available execution id for a task execution.
long	getRunningTaskExecutionCountByTaskName(String taskName) Retrieves current number of task executions for a taskName and with an endTime of null.
TaskExecution	getTaskExecution(long executionId) Retrieves a task execution from the task repository.
long	getTaskExecutionCount() Retrieves current number of task executions.
long	getTaskExecutionCountByTaskName(String taskName) Retrieves current number of task executions for a taskName.
Long	getTaskExecutionIdByJobExecutionId(long jobExecutionId) Returns the id of the TaskExecution that the requested Spring Batch job execution was executed within the context of.
List<String>	getTaskNames() Retrieves a sorted list of distinct task names for the task executions.

Method Detail

createTaskExecution

TaskExecution createTaskExecution(String taskName,
                                  Date startTime,
                                  List<String> arguments)

Save a new TaskExecution.

Parameters:

taskName - the name that associated with the task execution.

startTime - the time task began.

arguments - list of key/value pairs that configure the task.

Returns:

A fully qualified TaskExecution instance.

completeTaskExecution

void completeTaskExecution(long executionId,
                           Integer exitCode,
                           Date endTime,
                           String exitMessage)

Update and existing TaskExecution.

Parameters:

executionId - the id of the taskExecution to be updated.

exitCode - the status of the task upon completion.

endTime - the time the task completed.

exitMessage - the message assigned to the task upon completion.

getTaskExecution

TaskExecution getTaskExecution(long executionId)

Retrieves a task execution from the task repository.

Parameters:

executionId - the id associated with the task execution.

Returns:

a fully qualified TaskExecution instance.

getTaskExecutionCountByTaskName

long getTaskExecutionCountByTaskName(String taskName)

Retrieves current number of task executions for a taskName.

Parameters:

taskName - the name of the task to search for in the repository.

Returns:

current number of task executions for the taskName.

getRunningTaskExecutionCountByTaskName

long getRunningTaskExecutionCountByTaskName(String taskName)

Retrieves current number of task executions for a taskName and with an endTime of null.

Parameters:

taskName - the name of the task to search for in the repository.

Returns:

current number of task executions for the taskName.

getTaskExecutionCount

long getTaskExecutionCount()

Retrieves current number of task executions.

Returns:

current number of task executions.

findRunningTaskExecutions

org.springframework.data.domain.Page<TaskExecution> findRunningTaskExecutions(String taskName,
                                                                              org.springframework.data.domain.Pageable pageable)

Retrieves a set of task executions that are running for a taskName.

Parameters:

taskName - the name of the task to search for in the repository.

pageable - the constraints for the search.

Returns:

set of running task executions.

findTaskExecutionsByName

org.springframework.data.domain.Page<TaskExecution> findTaskExecutionsByName(String taskName,
                                                                             org.springframework.data.domain.Pageable pageable)

Retrieves a subset of task executions by task name, start location and size.

Parameters:

taskName - the name of the task to search for in the repository.

pageable - the constraints for the search.

Returns:

a list that contains task executions from the query bound by the start position and count specified by the user.

getTaskNames

List<String> getTaskNames()

Retrieves a sorted list of distinct task names for the task executions.

Returns:

a list of distinct task names from the task repository..

findAll

org.springframework.data.domain.Page<TaskExecution> findAll(org.springframework.data.domain.Pageable pageable)

Retrieves all the task executions within the pageable constraints.

Parameters:

pageable - the constraints for the search

Returns:

page containing the results from the search

getNextExecutionId

long getNextExecutionId()

Retrieves the next available execution id for a task execution.

Returns:

long containing the executionId.

getTaskExecutionIdByJobExecutionId

Long getTaskExecutionIdByJobExecutionId(long jobExecutionId)

Returns the id of the TaskExecution that the requested Spring Batch job execution was executed within the context of. Returns null if non were found.

Parameters:

jobExecutionId - the id of the JobExecution

Returns:

the id of the TaskExecution

getJobExecutionIdsByTaskExecutionId

Set<Long> getJobExecutionIdsByTaskExecutionId(long taskExecutionId)

Returns the job execution ids associated with a task execution id.

Parameters:

taskExecutionId - id of the TaskExecution

Returns:

a Set of the ids of the job executions executed within the task.