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

Class DefaultTaskExecutionService

java.lang.Object

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

All Implemented Interfaces:

TaskExecutionService

@Transactional
public class DefaultTaskExecutionService
extends Object
implements TaskExecutionService

Default implementation of the TaskExecutionService interface. Provide service methods for Tasks.

Author:

Michael Minella, Marius Bogoevici, Glenn Renfro, Mark Fisher, Janne Valkealahti, Gunnar Hillert, Thomas Risberg, Ilayaperumal Gopinathan, Michael Wirth, David Turanski, Daniel Serleg, Corneil du Plessis

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.cloud.dataflow.audit.service.AuditRecordService	auditRecordService
static String	COMMAND_LINE_ARGS
static String	TASK_DEFINITION_DSL_TEXT
static String	TASK_DEPLOYMENT_PROPERTIES
static String	TASK_PLATFORM_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultTaskExecutionService(PropertyResolver propertyResolver, LauncherRepository launcherRepository, org.springframework.cloud.dataflow.audit.service.AuditRecordService auditRecordService, org.springframework.cloud.dataflow.aggregate.task.TaskRepositoryContainer taskRepositoryContainer, TaskExecutionInfoService taskExecutionInfoService, TaskDeploymentRepository taskDeploymentRepository, TaskDefinitionRepository taskDefinitionRepository, org.springframework.cloud.dataflow.aggregate.task.TaskDefinitionReader taskDefinitionReader, TaskExecutionCreationService taskExecutionRepositoryService, TaskAppDeploymentRequestCreator taskAppDeploymentRequestCreator, org.springframework.cloud.dataflow.aggregate.task.AggregateTaskExplorer taskExplorer, DataflowTaskExecutionDaoContainer dataflowTaskExecutionDaoContainer, DataflowTaskExecutionMetadataDaoContainer dataflowTaskExecutionMetadataDaoContainer, org.springframework.cloud.dataflow.aggregate.task.DataflowTaskExecutionQueryDao dataflowTaskExecutionQueryDao, org.springframework.cloud.common.security.core.support.OAuth2TokenUtilsService oauth2TokenUtilsService, TaskSaveService taskSaveService, TaskConfigurationProperties taskConfigurationProperties, org.springframework.cloud.dataflow.aggregate.task.AggregateExecutionSupport aggregateExecutionSupport) Deprecated.
DefaultTaskExecutionService(PropertyResolver propertyResolver, LauncherRepository launcherRepository, org.springframework.cloud.dataflow.audit.service.AuditRecordService auditRecordService, org.springframework.cloud.dataflow.aggregate.task.TaskRepositoryContainer taskRepositoryContainer, TaskExecutionInfoService taskExecutionInfoService, TaskDeploymentRepository taskDeploymentRepository, TaskDefinitionRepository taskDefinitionRepository, org.springframework.cloud.dataflow.aggregate.task.TaskDefinitionReader taskDefinitionReader, TaskExecutionCreationService taskExecutionRepositoryService, TaskAppDeploymentRequestCreator taskAppDeploymentRequestCreator, org.springframework.cloud.dataflow.aggregate.task.AggregateTaskExplorer taskExplorer, DataflowTaskExecutionDaoContainer dataflowTaskExecutionDaoContainer, DataflowTaskExecutionMetadataDaoContainer dataflowTaskExecutionMetadataDaoContainer, org.springframework.cloud.dataflow.aggregate.task.DataflowTaskExecutionQueryDao dataflowTaskExecutionQueryDao, org.springframework.cloud.common.security.core.support.OAuth2TokenUtilsService oauth2TokenUtilsService, TaskSaveService taskSaveService, TaskConfigurationProperties taskConfigurationProperties, org.springframework.cloud.dataflow.aggregate.task.AggregateExecutionSupport aggregateExecutionSupport, ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties) Initializes the DefaultTaskExecutionService.

Method Summary

Modifier and Type	Method and Description
LaunchResponse	executeTask(String taskName, Map<String,String> taskDeploymentProperties, List<String> commandLineArgs) Launch a task.
TaskManifest	findTaskManifestById(Long id, String schemaTarget) Retrieve the TaskManifest for the execution id provided
Set<Long>	getAllTaskExecutionIds(boolean onlyCompleted, String taskName) Returns all the task execution IDs with the option to include only the completed task executions.
Integer	getAllTaskExecutionsCount(boolean onlyCompleted, String taskName) Returns the count of all the task execution IDs with the option to include only the completed task executions.
Integer	getAllTaskExecutionsCount(boolean onlyCompleted, String taskName, Integer days) Returns the count of all the task execution IDs with the option to include only the completed task executions.
String	getLog(String platformName, String taskId, String schemaTarget) Return the log content of the task execution identified by the given task deployment ID (external execution ID).
void	setAutoCreateTaskDefinitions(boolean autoCreateTaskDefinitions)
void	stopTaskExecution(Set<Long> ids, String schemaTarget) Request the platform to stop the task executions for the ids provided.
void	stopTaskExecution(Set<Long> ids, String schemaTarget, String platform) Request the platform to stop the task executions for the ids provided.
protected void	updateExternalExecutionId(long executionId, String taskLaunchId, String schemaTarget)

Methods inherited from class java.lang.Object

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

Field Detail

TASK_DEFINITION_DSL_TEXT

public static final String TASK_DEFINITION_DSL_TEXT

See Also:

Constant Field Values

TASK_DEPLOYMENT_PROPERTIES

public static final String TASK_DEPLOYMENT_PROPERTIES

See Also:

Constant Field Values

COMMAND_LINE_ARGS

public static final String COMMAND_LINE_ARGS

See Also:

Constant Field Values

TASK_PLATFORM_NAME

public static final String TASK_PLATFORM_NAME

See Also:

Constant Field Values

auditRecordService

protected final org.springframework.cloud.dataflow.audit.service.AuditRecordService auditRecordService

Constructor Detail

DefaultTaskExecutionService

@Deprecated
public DefaultTaskExecutionService(PropertyResolver propertyResolver,
                                               LauncherRepository launcherRepository,
                                               org.springframework.cloud.dataflow.audit.service.AuditRecordService auditRecordService,
                                               org.springframework.cloud.dataflow.aggregate.task.TaskRepositoryContainer taskRepositoryContainer,
                                               TaskExecutionInfoService taskExecutionInfoService,
                                               TaskDeploymentRepository taskDeploymentRepository,
                                               TaskDefinitionRepository taskDefinitionRepository,
                                               org.springframework.cloud.dataflow.aggregate.task.TaskDefinitionReader taskDefinitionReader,
                                               TaskExecutionCreationService taskExecutionRepositoryService,
                                               TaskAppDeploymentRequestCreator taskAppDeploymentRequestCreator,
                                               org.springframework.cloud.dataflow.aggregate.task.AggregateTaskExplorer taskExplorer,
                                               DataflowTaskExecutionDaoContainer dataflowTaskExecutionDaoContainer,
                                               DataflowTaskExecutionMetadataDaoContainer dataflowTaskExecutionMetadataDaoContainer,
                                               org.springframework.cloud.dataflow.aggregate.task.DataflowTaskExecutionQueryDao dataflowTaskExecutionQueryDao,
                                               org.springframework.cloud.common.security.core.support.OAuth2TokenUtilsService oauth2TokenUtilsService,
                                               TaskSaveService taskSaveService,
                                               TaskConfigurationProperties taskConfigurationProperties,
                                               org.springframework.cloud.dataflow.aggregate.task.AggregateExecutionSupport aggregateExecutionSupport)

Deprecated.

Initializes the DefaultTaskExecutionService.

Parameters:

propertyResolver - the spring application context

launcherRepository - the repository of task launcher used to launch task apps.

auditRecordService - the audit record service

taskRepositoryContainer - the container of repositories to use for accessing and updating task executions

taskExecutionInfoService - the service used to setup a task execution

taskDeploymentRepository - the repository to track task deployment

taskDefinitionRepository - the repository to query the task definition

taskDefinitionReader - use task definition repository to retrieve definition

taskExecutionRepositoryService - the service used to create the task execution

taskAppDeploymentRequestCreator - the task app deployment request creator

taskExplorer - the task explorer

dataflowTaskExecutionDaoContainer - the dataflow task execution dao

dataflowTaskExecutionMetadataDaoContainer - repository used to manipulate task manifests

dataflowTaskExecutionQueryDao - repository to query aggregate TaskExecution data

oauth2TokenUtilsService - the oauth2 token server

taskSaveService - the task save service

taskConfigurationProperties - task configuration properties.

aggregateExecutionSupport - support for selecting SchemaVersionTarget

DefaultTaskExecutionService

public DefaultTaskExecutionService(PropertyResolver propertyResolver,
                                   LauncherRepository launcherRepository,
                                   org.springframework.cloud.dataflow.audit.service.AuditRecordService auditRecordService,
                                   org.springframework.cloud.dataflow.aggregate.task.TaskRepositoryContainer taskRepositoryContainer,
                                   TaskExecutionInfoService taskExecutionInfoService,
                                   TaskDeploymentRepository taskDeploymentRepository,
                                   TaskDefinitionRepository taskDefinitionRepository,
                                   org.springframework.cloud.dataflow.aggregate.task.TaskDefinitionReader taskDefinitionReader,
                                   TaskExecutionCreationService taskExecutionRepositoryService,
                                   TaskAppDeploymentRequestCreator taskAppDeploymentRequestCreator,
                                   org.springframework.cloud.dataflow.aggregate.task.AggregateTaskExplorer taskExplorer,
                                   DataflowTaskExecutionDaoContainer dataflowTaskExecutionDaoContainer,
                                   DataflowTaskExecutionMetadataDaoContainer dataflowTaskExecutionMetadataDaoContainer,
                                   org.springframework.cloud.dataflow.aggregate.task.DataflowTaskExecutionQueryDao dataflowTaskExecutionQueryDao,
                                   org.springframework.cloud.common.security.core.support.OAuth2TokenUtilsService oauth2TokenUtilsService,
                                   TaskSaveService taskSaveService,
                                   TaskConfigurationProperties taskConfigurationProperties,
                                   org.springframework.cloud.dataflow.aggregate.task.AggregateExecutionSupport aggregateExecutionSupport,
                                   ComposedTaskRunnerConfigurationProperties composedTaskRunnerConfigurationProperties)

Initializes the DefaultTaskExecutionService.

Parameters:

propertyResolver - the spring application context

launcherRepository - the repository of task launcher used to launch task apps.

auditRecordService - the audit record service

taskRepositoryContainer - the container of repositories to use for accessing and updating task executions

taskExecutionInfoService - the task execution info service

taskDeploymentRepository - the repository to track task deployment

taskDefinitionRepository - the repository to query the task definition

taskDefinitionReader - uses task definition repository to retrieve definition

taskExecutionRepositoryService - the service used to create the task execution

taskAppDeploymentRequestCreator - the task app deployment request creator

taskExplorer - the task explorer

dataflowTaskExecutionDaoContainer - the dataflow task execution dao

dataflowTaskExecutionMetadataDaoContainer - repository used to manipulate task manifests

dataflowTaskExecutionQueryDao - repository to query aggregate task execution data.

oauth2TokenUtilsService - the oauth2 token server

taskSaveService - the task save service

taskConfigurationProperties - task configuration properties

aggregateExecutionSupport - support for selecting SchemaVersionTarget.

composedTaskRunnerConfigurationProperties - properties used to configure the composed task runner

Method Detail

executeTask

public LaunchResponse executeTask(String taskName,
                                  Map<String,String> taskDeploymentProperties,
                                  List<String> commandLineArgs)

Launch a task.

Specified by:

executeTask in interface TaskExecutionService

Parameters:

taskName - Name of the task definition or registered task application. If a task definition does not exist, one will be created if `autoCreateTask-Definitions` is true. Must not be null or empty.

taskDeploymentProperties - Optional deployment properties. Must not be null.

commandLineArgs - Optional runtime commandline argument

Returns:

the task execution ID.

getLog

public String getLog(String platformName,
                     String taskId,
                     String schemaTarget)

Return the log content of the task execution identified by the given task deployment ID (external execution ID). In case of concurrent task executions on Cloud Foundry, the logs of all the concurrent executions are displayed. Also, on Cloud Foundry, the task execution log is retrieved only for the latest execution that matches the given deployment ID (external execution ID).

Specified by:

getLog in interface TaskExecutionService

Parameters:

platformName - the platform

taskId - the deploymentID (externalExecutionId) associated with the task execution.

Returns:

the log of the specified task.

stopTaskExecution

public void stopTaskExecution(Set<Long> ids,
                              String schemaTarget)

Description copied from interface: TaskExecutionService

Request the platform to stop the task executions for the ids provided.

Specified by:

stopTaskExecution in interface TaskExecutionService

Parameters:

ids - a set of ids for the task executions to be stopped.

stopTaskExecution

public void stopTaskExecution(Set<Long> ids,
                              String schemaTarget,
                              String platform)

Description copied from interface: TaskExecutionService

Request the platform to stop the task executions for the ids provided.

Specified by:

stopTaskExecution in interface TaskExecutionService

Parameters:

ids - a set of ids for the task executions to be stopped.

schemaTarget - the schema target of the task execution.

platform - The name of the platform where the tasks are executing.

findTaskManifestById

public TaskManifest findTaskManifestById(Long id,
                                         String schemaTarget)

Description copied from interface: TaskExecutionService

Retrieve the TaskManifest for the execution id provided

Specified by:

findTaskManifestById in interface TaskExecutionService

Parameters:

id - task exectution id

schemaTarget - the schema target of the task execution.

Returns:

TaskManifest or null if not found.

setAutoCreateTaskDefinitions

public void setAutoCreateTaskDefinitions(boolean autoCreateTaskDefinitions)

updateExternalExecutionId

protected void updateExternalExecutionId(long executionId,
                                         String taskLaunchId,
                                         String schemaTarget)

getAllTaskExecutionIds

public Set<Long> getAllTaskExecutionIds(boolean onlyCompleted,
                                        String taskName)

Description copied from interface: TaskExecutionService

Returns all the task execution IDs with the option to include only the completed task executions.

Specified by:

getAllTaskExecutionIds in interface TaskExecutionService

Parameters:

onlyCompleted - filter by completed task executions

taskName - the task name, if null then retrieve all the tasks

Returns:

the set of execution ids.

getAllTaskExecutionsCount

public Integer getAllTaskExecutionsCount(boolean onlyCompleted,
                                         String taskName)

Description copied from interface: TaskExecutionService

Returns the count of all the task execution IDs with the option to include only the completed task executions.

Specified by:

getAllTaskExecutionsCount in interface TaskExecutionService

Parameters:

onlyCompleted - whether to include only completed task executions

taskName - the task name, if null then retrieve all the tasks

Returns:

the number of executions

getAllTaskExecutionsCount

public Integer getAllTaskExecutionsCount(boolean onlyCompleted,
                                         String taskName,
                                         Integer days)

Description copied from interface: TaskExecutionService

Returns the count of all the task execution IDs with the option to include only the completed task executions.

Specified by:

getAllTaskExecutionsCount in interface TaskExecutionService

Parameters:

onlyCompleted - whether to include only completed task executions (ignored when includeTasksEndedMinDaysAgo is specified)

taskName - the task name, if null then retrieve all the tasks

days - only include tasks that have ended at least this many days ago

Returns:

the number of executions, 0 if no data, never null