org.springframework.cloud.dataflow.aggregate.task.impl

Class DefaultAggregateTaskExplorer

java.lang.Object

org.springframework.cloud.dataflow.aggregate.task.impl.DefaultAggregateTaskExplorer

All Implemented Interfaces:

AggregateTaskExplorer

public class DefaultAggregateTaskExplorer
extends Object
implements AggregateTaskExplorer

Implements CompositeTaskExplorer. This class will be responsible for retrieving task execution data for all schema targets.

Author:

Corneil du Plessis

Constructor Summary

Constructors

Constructor and Description
DefaultAggregateTaskExplorer(DataSource dataSource, DataflowTaskExecutionQueryDao taskExecutionQueryDao, SchemaService schemaService, AggregateExecutionSupport aggregateExecutionSupport, TaskDefinitionReader taskDefinitionReader, TaskDeploymentReader taskDeploymentReader)

Method Summary

Modifier and Type	Method and Description
org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findAll(org.springframework.data.domain.Pageable pageable) Retrieves all the task executions within the pageable constraints sorted by start date descending, taskExecution id descending.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findChildTaskExecutions(Collection<Long> parentIds, String schemaTarget)
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findChildTaskExecutions(long executionId, String schemaTarget)
org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findRunningTaskExecutions(String taskName, org.springframework.data.domain.Pageable pageable) Retrieve a collection of taskExecutions that have the task name provided.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findTaskExecutions(String taskName, boolean completed) Get a list of executions for a task by name and completion status.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findTaskExecutionsBeforeEndTime(String taskName, Date endTime) Get a list of executions for a task by name, completion status and end time.
org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	findTaskExecutionsByName(String taskName, org.springframework.data.domain.Pageable pageable) Get a collection/page of executions.
Set<Long>	getJobExecutionIdsByTaskExecutionId(long taskExecutionId, String schemaTarget) Returns a Set of JobExecution ids for the jobs that were executed within the scope of the requested task.
org.springframework.cloud.dataflow.schema.AggregateTaskExecution	getLatestTaskExecutionForTaskName(String taskName) Returns the latest task execution for a given task name.
List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution>	getLatestTaskExecutionsByTaskNames(String... taskNames) Returns a List of the latest TaskExecution for 1 or more task names.
long	getRunningTaskExecutionCount() Retrieves current number of running task executions.
org.springframework.cloud.dataflow.schema.AggregateTaskExecution	getTaskExecution(long executionId, String schemaTarget) find a task execution given an execution id and schema target.
org.springframework.cloud.dataflow.schema.AggregateTaskExecution	getTaskExecutionByExternalExecutionId(String externalExecutionId, String platform) find a task execution given an external execution id and platform name.
long	getTaskExecutionCount() Retrieves current number of task executions.
long	getTaskExecutionCountByTaskName(String taskName) Get number of executions for a taskName.
Long	getTaskExecutionIdByJobExecutionId(long jobExecutionId, String schemaTarget) Returns the id of the TaskExecution that the requested Spring Batch job execution was executed within the context of.
List<String>	getTaskNames() Retrieve a list of available task names.
void	setup()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAggregateTaskExplorer

public DefaultAggregateTaskExplorer(DataSource dataSource,
                                    DataflowTaskExecutionQueryDao taskExecutionQueryDao,
                                    SchemaService schemaService,
                                    AggregateExecutionSupport aggregateExecutionSupport,
                                    TaskDefinitionReader taskDefinitionReader,
                                    TaskDeploymentReader taskDeploymentReader)

Method Detail

getTaskExecution

public org.springframework.cloud.dataflow.schema.AggregateTaskExecution getTaskExecution(long executionId,
                                                                                         String schemaTarget)

Description copied from interface: AggregateTaskExplorer

find a task execution given an execution id and schema target.

Specified by:

getTaskExecution in interface AggregateTaskExplorer

Parameters:

executionId - the task execution id

schemaTarget - the schema target

Returns:

the task execution

getTaskExecutionByExternalExecutionId

public org.springframework.cloud.dataflow.schema.AggregateTaskExecution getTaskExecutionByExternalExecutionId(String externalExecutionId,
                                                                                                              String platform)

Description copied from interface: AggregateTaskExplorer

find a task execution given an external execution id and platform name.

Specified by:

getTaskExecutionByExternalExecutionId in interface AggregateTaskExplorer

Parameters:

externalExecutionId - the external execution id

platform - the platform name

Returns:

the task execution

findChildTaskExecutions

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findChildTaskExecutions(long executionId,
                                                                                                      String schemaTarget)

Specified by:

findChildTaskExecutions in interface AggregateTaskExplorer

findChildTaskExecutions

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findChildTaskExecutions(Collection<Long> parentIds,
                                                                                                      String schemaTarget)

Specified by:

findChildTaskExecutions in interface AggregateTaskExplorer

findRunningTaskExecutions

public org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findRunningTaskExecutions(String taskName,
                                                                                                                                        org.springframework.data.domain.Pageable pageable)

Description copied from interface: AggregateTaskExplorer

Retrieve a collection of taskExecutions that have the task name provided.

Specified by:

findRunningTaskExecutions in interface AggregateTaskExplorer

Parameters:

taskName - the name of the task

pageable - the constraints for the search

Returns:

the set of running executions for tasks with the specified name

getTaskNames

public List<String> getTaskNames()

Description copied from interface: AggregateTaskExplorer

Retrieve a list of available task names.

Specified by:

getTaskNames in interface AggregateTaskExplorer

Returns:

the task names that have been executed

getTaskExecutionCountByTaskName

public long getTaskExecutionCountByTaskName(String taskName)

Description copied from interface: AggregateTaskExplorer

Get number of executions for a taskName.

Specified by:

getTaskExecutionCountByTaskName in interface AggregateTaskExplorer

Parameters:

taskName - the name of the task to be searched

Returns:

the number of running tasks that have the taskname specified

getTaskExecutionCount

public long getTaskExecutionCount()

Description copied from interface: AggregateTaskExplorer

Retrieves current number of task executions.

Specified by:

getTaskExecutionCount in interface AggregateTaskExplorer

Returns:

current number of task executions.

getRunningTaskExecutionCount

public long getRunningTaskExecutionCount()

Description copied from interface: AggregateTaskExplorer

Retrieves current number of running task executions.

Specified by:

getRunningTaskExecutionCount in interface AggregateTaskExplorer

Returns:

current number of running task executions.

findTaskExecutions

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findTaskExecutions(String taskName,
                                                                                                 boolean completed)

Description copied from interface: AggregateTaskExplorer

Get a list of executions for a task by name and completion status.

Specified by:

findTaskExecutions in interface AggregateTaskExplorer

Parameters:

taskName - the name of the task to be searched

completed - whether to include only completed tasks

Returns:

list of task executions

findTaskExecutionsBeforeEndTime

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findTaskExecutionsBeforeEndTime(String taskName,
                                                                                                              Date endTime)

Description copied from interface: AggregateTaskExplorer

Get a list of executions for a task by name, completion status and end time.

Specified by:

findTaskExecutionsBeforeEndTime in interface AggregateTaskExplorer

Parameters:

taskName - the name of the task to be searched

endTime - the tasks that ended before the endTime

Returns:

list of task executions

findTaskExecutionsByName

public org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findTaskExecutionsByName(String taskName,
                                                                                                                                       org.springframework.data.domain.Pageable pageable)

Description copied from interface: AggregateTaskExplorer

Get a collection/page of executions.

Specified by:

findTaskExecutionsByName in interface AggregateTaskExplorer

Parameters:

taskName - the name of the task to be searched

pageable - the constraints for the search

Returns:

list of task executions

findAll

public org.springframework.data.domain.Page<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> findAll(org.springframework.data.domain.Pageable pageable)

Description copied from interface: AggregateTaskExplorer

Retrieves all the task executions within the pageable constraints sorted by start date descending, taskExecution id descending.

Specified by:

findAll in interface AggregateTaskExplorer

Parameters:

pageable - the constraints for the search

Returns:

page containing the results from the search

getTaskExecutionIdByJobExecutionId

public Long getTaskExecutionIdByJobExecutionId(long jobExecutionId,
                                               String schemaTarget)

Description copied from interface: AggregateTaskExplorer

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

Specified by:

getTaskExecutionIdByJobExecutionId in interface AggregateTaskExplorer

Parameters:

jobExecutionId - the id of the JobExecution

schemaTarget - the schema target

Returns:

the id of the TaskExecution

getJobExecutionIdsByTaskExecutionId

public Set<Long> getJobExecutionIdsByTaskExecutionId(long taskExecutionId,
                                                     String schemaTarget)

Description copied from interface: AggregateTaskExplorer

Returns a Set of JobExecution ids for the jobs that were executed within the scope of the requested task.

Specified by:

getJobExecutionIdsByTaskExecutionId in interface AggregateTaskExplorer

Parameters:

taskExecutionId - id of the TaskExecution

schemaTarget - the schema target

Returns:

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

getLatestTaskExecutionsByTaskNames

public List<org.springframework.cloud.dataflow.schema.AggregateTaskExecution> getLatestTaskExecutionsByTaskNames(String... taskNames)

Description copied from interface: AggregateTaskExplorer

Returns a List of the latest TaskExecution for 1 or more task names.

Latest is defined by the most recent start time. A TaskExecution does not have to be finished (The results may including pending TaskExecutions).

It is theoretically possible that a TaskExecution with the same name to have more than 1 TaskExecution for the exact same start time. In that case the TaskExecution with the highest Task Execution ID is returned.

This method will not consider end times in its calculations. Thus, when a task execution A starts after task execution B but finishes BEFORE task execution A, then task execution B is being returned.

Specified by:

getLatestTaskExecutionsByTaskNames in interface AggregateTaskExplorer

Parameters:

taskNames - At least 1 task name must be provided

Returns:

List of TaskExecutions. May be empty but never null.

getLatestTaskExecutionForTaskName

public org.springframework.cloud.dataflow.schema.AggregateTaskExecution getLatestTaskExecutionForTaskName(String taskName)

Description copied from interface: AggregateTaskExplorer

Returns the latest task execution for a given task name. Will ultimately apply the same algorithm underneath as AggregateTaskExplorer.getLatestTaskExecutionsByTaskNames(String...) but will only return a single result.

Specified by:

getLatestTaskExecutionForTaskName in interface AggregateTaskExplorer

Parameters:

taskName - Must not be null or empty

Returns:

The latest Task Execution or null

See Also:

AggregateTaskExplorer.getLatestTaskExecutionsByTaskNames(String...)

setup

@PostConstruct
public void setup()