org.springframework.cloud.task.repository.dao

Class MapTaskExecutionDao

java.lang.Object

org.springframework.cloud.task.repository.dao.MapTaskExecutionDao

All Implemented Interfaces:

TaskExecutionDao

public class MapTaskExecutionDao
extends Object
implements TaskExecutionDao

Stores Task Execution Information to a in-memory map.

Author:

Glenn Renfro

Constructor Summary

Constructors

Constructor and Description
MapTaskExecutionDao()

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.
ConcurrentMap<Long,Set<Long>>	getBatchJobAssociations()
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.
Map<Long,TaskExecution>	getTaskExecutions()
List<String>	getTaskNames() Retrieves a sorted list of distinct task names for the task executions.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapTaskExecutionDao

public MapTaskExecutionDao()

Method Detail

createTaskExecution

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

Description copied from interface: TaskExecutionDao

Save a new TaskExecution.

Specified by:

createTaskExecution in interface TaskExecutionDao

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

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

Description copied from interface: TaskExecutionDao

Update and existing TaskExecution.

Specified by:

completeTaskExecution in interface TaskExecutionDao

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

public TaskExecution getTaskExecution(long executionId)

Description copied from interface: TaskExecutionDao

Retrieves a task execution from the task repository.

Specified by:

getTaskExecution in interface TaskExecutionDao

Parameters:

executionId - the id associated with the task execution.

Returns:

a fully qualified TaskExecution instance.

getTaskExecutionCountByTaskName

public long getTaskExecutionCountByTaskName(String taskName)

Description copied from interface: TaskExecutionDao

Retrieves current number of task executions for a taskName.

Specified by:

getTaskExecutionCountByTaskName in interface TaskExecutionDao

Parameters:

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

Returns:

current number of task executions for the taskName.

getRunningTaskExecutionCountByTaskName

public long getRunningTaskExecutionCountByTaskName(String taskName)

Description copied from interface: TaskExecutionDao

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

Specified by:

getRunningTaskExecutionCountByTaskName in interface TaskExecutionDao

Parameters:

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

Returns:

current number of task executions for the taskName.

getTaskExecutionCount

public long getTaskExecutionCount()

Description copied from interface: TaskExecutionDao

Retrieves current number of task executions.

Specified by:

getTaskExecutionCount in interface TaskExecutionDao

Returns:

current number of task executions.

findRunningTaskExecutions

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

Description copied from interface: TaskExecutionDao

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

Specified by:

findRunningTaskExecutions in interface TaskExecutionDao

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

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

Description copied from interface: TaskExecutionDao

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

Specified by:

findTaskExecutionsByName in interface TaskExecutionDao

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

public List<String> getTaskNames()

Description copied from interface: TaskExecutionDao

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

Specified by:

getTaskNames in interface TaskExecutionDao

Returns:

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

findAll

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

Description copied from interface: TaskExecutionDao

Retrieves all the task executions within the pageable constraints.

Specified by:

findAll in interface TaskExecutionDao

Parameters:

pageable - the constraints for the search

Returns:

page containing the results from the search

getTaskExecutions

public Map<Long,TaskExecution> getTaskExecutions()

getNextExecutionId

public long getNextExecutionId()

Description copied from interface: TaskExecutionDao

Retrieves the next available execution id for a task execution.

Specified by:

getNextExecutionId in interface TaskExecutionDao

Returns:

long containing the executionId.

getTaskExecutionIdByJobExecutionId

public Long getTaskExecutionIdByJobExecutionId(long jobExecutionId)

Description copied from interface: TaskExecutionDao

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.

Specified by:

getTaskExecutionIdByJobExecutionId in interface TaskExecutionDao

Parameters:

jobExecutionId - the id of the JobExecution

Returns:

the id of the TaskExecution

getJobExecutionIdsByTaskExecutionId

public Set<Long> getJobExecutionIdsByTaskExecutionId(long taskExecutionId)

Description copied from interface: TaskExecutionDao

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

Specified by:

getJobExecutionIdsByTaskExecutionId in interface TaskExecutionDao

Parameters:

taskExecutionId - id of the TaskExecution

Returns:

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

getBatchJobAssociations

public ConcurrentMap<Long,Set<Long>> getBatchJobAssociations()