org.springframework.cloud.deployer.spi.scheduler

Interface Scheduler

public interface Scheduler

A Scheduler is a component that provides a way to register the execution of a ScheduleRequest with an underlying scheduler system (Quartz, etc).

Author:

Glenn Renfro, Ilayaperumal Gopinathan

Method Summary

Modifier and Type	Method and Description
List<ScheduleInfo>	list() List all of the ScheduleInfos registered with the system.
List<ScheduleInfo>	list(String taskDefinitionName) List all of the Schedules associated with the provided AppDefinition.
void	schedule(ScheduleRequest scheduleRequest) Registers the ScheduleRequest to be executed based on the cron expression provided.
void	unschedule(String scheduleName) Deletes a schedule that has been created.

Method Detail

schedule

void schedule(ScheduleRequest scheduleRequest)

Registers the ScheduleRequest to be executed based on the cron expression provided. If an error occurs during schedule creation then a CreateScheduleException should be thrown.

Parameters:

scheduleRequest - A request representing a sched-uable artifact(AppDefinition, the Resource), schedule properties, and deployment properties.

unschedule

void unschedule(String scheduleName)

Deletes a schedule that has been created. If an error occurs during un-scheduling then a UnScheduleException should be thrown.

Parameters:

scheduleName - the name of the schedule to be removed.

list

List<ScheduleInfo> list(String taskDefinitionName)

List all of the Schedules associated with the provided AppDefinition. If an error occurs during list generation then a SchedulerException should be thrown.

Parameters:

taskDefinitionName - to retrieve ScheduleInfos for a specified taskDefinitionName.

Returns:

A List of ScheduleInfos configured for the provided taskDefinitionName.

list

List<ScheduleInfo> list()

List all of the ScheduleInfos registered with the system. If an error occurs during list generation then a SchedulerException should be thrown.

Returns:

A List of ScheduleInfos for the given system.