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

Class DefaultSchedulerService

java.lang.Object

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

All Implemented Interfaces:

SchedulerService

public class DefaultSchedulerService
extends Object
implements SchedulerService

Default implementation of the SchedulerService interface. Provide service methods for Scheduling tasks.

Author:

Glenn Renfro, Chris Schaefer

Constructor Summary

Constructors

Constructor and Description

DefaultSchedulerService(CommonApplicationProperties commonApplicationProperties, TaskPlatform taskPlatform, TaskDefinitionRepository taskDefinitionRepository, AppRegistryService registry, org.springframework.core.io.ResourceLoader resourceLoader, TaskConfigurationProperties taskConfigurationProperties, org.springframework.boot.autoconfigure.jdbc.DataSourceProperties dataSourceProperties, String dataflowServerUri, ApplicationConfigurationMetadataResolver metaDataResolver, SchedulerServiceProperties schedulerServiceProperties, org.springframework.cloud.dataflow.audit.service.AuditRecordService auditRecordService)

Method Summary

Modifier and Type	Method and Description
org.springframework.cloud.scheduler.spi.core.ScheduleInfo	getSchedule(String scheduleName) Retrieves the ScheduleInfo for the specified ScheduleName.
protected org.springframework.core.io.Resource	getTaskResource(String taskDefinitionName)
List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo>	list() List all of the schedules registered with the system up to the established maximum as specified SchedulerServiceProperties.maxSchedulesReturned.
org.springframework.data.domain.Page<org.springframework.cloud.scheduler.spi.core.ScheduleInfo>	list(org.springframework.data.domain.Pageable pageable) List all of the schedules registered with the system.
List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo>	list(org.springframework.data.domain.Pageable pageable, String taskDefinitionName) List all of the Schedules associated with the provided TaskDefinition.
List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo>	list(String taskDefinitionName) List all of the Schedules associated with the provided TaskDefinition up to the established maximum as specified SchedulerServiceProperties.maxSchedulesReturned.
void	schedule(String scheduleName, String taskDefinitionName, Map<String,String> taskDeploymentProperties, List<String> commandLineArgs) Schedules the task specified with the taskDefinitionName with the platform specific scheduler.
void	unschedule(String scheduleName) Unschedule a schedule that has been created.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSchedulerService

public DefaultSchedulerService(CommonApplicationProperties commonApplicationProperties,
                               TaskPlatform taskPlatform,
                               TaskDefinitionRepository taskDefinitionRepository,
                               AppRegistryService registry,
                               org.springframework.core.io.ResourceLoader resourceLoader,
                               TaskConfigurationProperties taskConfigurationProperties,
                               org.springframework.boot.autoconfigure.jdbc.DataSourceProperties dataSourceProperties,
                               String dataflowServerUri,
                               ApplicationConfigurationMetadataResolver metaDataResolver,
                               SchedulerServiceProperties schedulerServiceProperties,
                               org.springframework.cloud.dataflow.audit.service.AuditRecordService auditRecordService)

Method Detail

schedule

public void schedule(String scheduleName,
                     String taskDefinitionName,
                     Map<String,String> taskDeploymentProperties,
                     List<String> commandLineArgs)

Description copied from interface: SchedulerService

Schedules the task specified with the taskDefinitionName with the platform specific scheduler. To setup the task with the scheduler set the properties required to process the schedule within the taskProperties map. Each scheduler property should be prefixed with "spring.cloud.scheduler.". The schedule expression (cron for example) are specified within the task properties using the "spring.cloud.scheduler.cron.expression" as the key and the associated value would be the cron expression to be used.

Specified by:

schedule in interface SchedulerService

Parameters:

scheduleName - A name to be associated with the schedule.

taskDefinitionName - the name of the TaskDefinition to be scheduled.

taskDeploymentProperties - properties required for scheduling or launching a task.

commandLineArgs - the command line args to be used when launching the task.

unschedule

public void unschedule(String scheduleName)

Description copied from interface: SchedulerService

Unschedule a schedule that has been created.

Specified by:

unschedule in interface SchedulerService

Parameters:

scheduleName - the name of the schedule to be removed.

list

public List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> list(org.springframework.data.domain.Pageable pageable,
                                                                            String taskDefinitionName)

Description copied from interface: SchedulerService

List all of the Schedules associated with the provided TaskDefinition.

Specified by:

list in interface SchedulerService

Parameters:

pageable - Establish the pagination setup for the result set.

taskDefinitionName - to retrieve Schedules for a specified taskDefinitionName.

Returns:

A List of Schedules configured for the provided taskDefinitionName.

list

public org.springframework.data.domain.Page<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> list(org.springframework.data.domain.Pageable pageable)

Description copied from interface: SchedulerService

List all of the schedules registered with the system.

Specified by:

list in interface SchedulerService

Parameters:

pageable - Establish the pagination setup for the result set.

Returns:

Paged items of schedules.

list

public List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> list(String taskDefinitionName)

Description copied from interface: SchedulerService

List all of the Schedules associated with the provided TaskDefinition up to the established maximum as specified SchedulerServiceProperties.maxSchedulesReturned.

Specified by:

list in interface SchedulerService

Parameters:

taskDefinitionName - to retrieve Schedules for a specified taskDefinitionName.

Returns:

A List of Schedules configured for the provided taskDefinitionName.

list

public List<org.springframework.cloud.scheduler.spi.core.ScheduleInfo> list()

Description copied from interface: SchedulerService

List all of the schedules registered with the system up to the established maximum as specified SchedulerServiceProperties.maxSchedulesReturned.

Specified by:

list in interface SchedulerService

Returns:

A List of Schedules for the given system.

getSchedule

public org.springframework.cloud.scheduler.spi.core.ScheduleInfo getSchedule(String scheduleName)

Description copied from interface: SchedulerService

Retrieves the ScheduleInfo for the specified ScheduleName.

Specified by:

getSchedule in interface SchedulerService

Parameters:

scheduleName - the name of schedule to retrieve.

Returns:

ScheduleInfo for the scheduleName passed in.

getTaskResource

protected org.springframework.core.io.Resource getTaskResource(String taskDefinitionName)