org.seedstack.scheduler

Interface ScheduledTaskBuilder

public interface ScheduledTaskBuilder

DSL to produce and schedule a Task. To use the ScheduledTaskBuilder, inject a ScheduledTasks and create a new ScheduledTaskBuilder.

 ScheduledTaskBuilder schedulerBuilder = factory.scheduledTask(MyTask.class);
 schedulerBuilder.withCronExpression("0/2 * * * * ?").schedule();
 

See Also:

ScheduledTasks

Method Summary

Modifier and Type	Method and Description
void	reschedule(String triggerName) Reschedule the Task with a new trigger
void	schedule() Bind a Task to a trigger and schedule.
void	unschedule(String triggerName) Unschedule the Task with provided trigger identification. triggerGroup is the Class of the Task implementation
ScheduledTaskBuilder	updateExistingTrigger() Requests an existing trigger (sharing the same key as the new trigger) for this task to be replaced with the new trigger.
ScheduledTaskBuilder	withCronExpression(String cronExpression) Sets the cron expression to base the schedule on.
ScheduledTaskBuilder	withDataMap(Map<String,?> dataMap) Sets the Task's data map
ScheduledTaskBuilder	withPriority(int priority) Sets the Trigger's priority. When more than one Trigger have the same fire time, the scheduler will fire the one with the highest priority first.
ScheduledTaskBuilder	withRequestRecovery(boolean requestRecovery) Instructs the Scheduler whether or not the Task should be re-executed if a recovery or fail-over situation is encountered.
ScheduledTaskBuilder	withStoreDurably(boolean storeDurably) Whether or not the Task should remain stored after it is orphaned (no Triggers point to it).
ScheduledTaskBuilder	withTaskName(String taskName) Sets the Task's identity
ScheduledTaskBuilder	withTimeZone(TimeZone timeZone) Sets the time zone for which the cronExpression of this CronTrigger will be resolved.
ScheduledTaskBuilder	withTrigger(Object trigger) Sets the Trigger that will be used to schedule the Task.
ScheduledTaskBuilder	withTriggerName(String triggerName) Sets the Trigger name, must be unique within the group.

Method Detail

withRequestRecovery

ScheduledTaskBuilder withRequestRecovery(boolean requestRecovery)

Instructs the Scheduler whether or not the Task should be re-executed if a recovery or fail-over situation is encountered.

Parameters:

requestRecovery - The activation flag

Returns:

This builder instance

withStoreDurably

ScheduledTaskBuilder withStoreDurably(boolean storeDurably)

Whether or not the Task should remain stored after it is orphaned (no Triggers point to it).

Parameters:

storeDurably - The activation flag

Returns:

This builder instance

withTriggerName

ScheduledTaskBuilder withTriggerName(String triggerName)

Sets the Trigger name, must be unique within the group.

Parameters:

triggerName - The Trigger name, must be unique within the group

Returns:

This builder instance

withCronExpression

ScheduledTaskBuilder withCronExpression(String cronExpression)

Sets the cron expression to base the schedule on.

Parameters:

cronExpression - The cron expression to base the schedule on

Returns:

This builder instance

withTimeZone

ScheduledTaskBuilder withTimeZone(TimeZone timeZone)

Sets the time zone for which the cronExpression of this CronTrigger will be resolved.

Parameters:

timeZone - The time zone for which the cronExpression of this CronTrigger will be resolved.

Returns:

This builder instance

withTaskName

ScheduledTaskBuilder withTaskName(String taskName)

Sets the Task's identity

Parameters:

taskName - The Task's name

Returns:

This builder instance

withDataMap

ScheduledTaskBuilder withDataMap(Map<String,?> dataMap)

Sets the Task's data map

Parameters:

dataMap - The Task's data map

Returns:

This builder instance

withPriority

ScheduledTaskBuilder withPriority(int priority)

Sets the Trigger's priority.
When more than one Trigger have the same fire time,
the scheduler will fire the one with the highest priority first.

Parameters:

priority - - The Trigger's priority

Returns:

This builder instance

withTrigger

ScheduledTaskBuilder withTrigger(Object trigger)

Sets the Trigger that will be used to schedule the Task.

Be aware that using using this method will override any other Trigger-related operation, like withTriggerName(String) or withTimeZone(java.util.TimeZone)

Parameters:

trigger - The Trigger to associate with the Task

Returns:

This builder instance

updateExistingTrigger

ScheduledTaskBuilder updateExistingTrigger()

Requests an existing trigger (sharing the same key as the new trigger) for this task to be replaced with the new trigger.

Returns:

This builder instance

schedule

void schedule()

Bind a Task to a trigger and schedule.

reschedule

void reschedule(String triggerName)

Reschedule the Task with a new trigger

The new trigger should be provided either using DSL
withTrigger() or throw @Scheduled CRON definition.
The DSL can precise attributes of the new trigger such as withTriggerName

Arguments provide the previous trigger identification to be replaced

Parameters:

triggerName - the name of the trigger to reschedule.

unschedule

void unschedule(String triggerName)

Unschedule the Task with provided trigger identification.
triggerGroup is the Class of the Task implementation

Parameters:

triggerName - the name of the trigger to unschedule.