org.mule.runtime.api.scheduler

Interface Scheduler

All Superinterfaces:

Executor, ExecutorService, ScheduledExecutorService

public interface Scheduler
extends ScheduledExecutorService

Allows tasks to be submitted/scheduled to a specific executor in the Mule runtime. Different Scheduler instances may be backed by the same ExecutorService, allowing for a fine control of the source of the tasks that the underlying ExecutorService will run.

See ScheduledExecutorService and ExecutorService for documentation on the provided methods.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
String	getName() Returns a name that indicates where was this scheduler created.
ScheduledFuture<?>	scheduleWithCronExpression(Runnable command, String cronExpression) Creates and executes a periodic action that becomes enabled according to given cronExpression and timeZone.
ScheduledFuture<?>	scheduleWithCronExpression(Runnable command, String cronExpression, TimeZone timeZone) Creates and executes a periodic action that becomes enabled according to given cronExpression in the given timeZone.
void	stop() Tries to do a graceful shutdown.

Methods inherited from interface java.util.concurrent.ScheduledExecutorService

schedule, schedule, scheduleAtFixedRate, scheduleWithFixedDelay

Methods inherited from interface java.util.concurrent.ExecutorService

awaitTermination, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow, submit, submit, submit

Methods inherited from interface java.util.concurrent.Executor

execute

Method Detail

scheduleWithCronExpression

ScheduledFuture<?> scheduleWithCronExpression(Runnable command,
                                              String cronExpression)

Creates and executes a periodic action that becomes enabled according to given cronExpression and timeZone. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor. If any execution of this task takes longer than the time before the next execution should start, then subsequent executions may start late, but will not concurrently execute.

Parameters:

command - the task to execute

cronExpression - the cron expression string to base the schedule on.

Returns:

a ScheduledFuture representing pending completion of the task, and whose get() method will throw an exception upon cancellation

Throws:

RejectedExecutionException - if the task cannot be scheduled for execution

NullPointerException - if command is null

scheduleWithCronExpression

ScheduledFuture<?> scheduleWithCronExpression(Runnable command,
                                              String cronExpression,
                                              TimeZone timeZone)

Creates and executes a periodic action that becomes enabled according to given cronExpression in the given timeZone. If any execution of the task encounters an exception, subsequent executions are suppressed. Otherwise, the task will only terminate via cancellation or termination of the executor. If any execution of this task takes longer than the time before the next execution should start, then subsequent executions may start late, but will not concurrently execute.

Parameters:

command - the task to execute

cronExpression - the cron expression string to base the schedule on.

timeZone - the time-zone for the schedule.

Returns:

a ScheduledFuture representing pending completion of the task, and whose get() method will throw an exception upon cancellation

Throws:

RejectedExecutionException - if the task cannot be scheduled for execution

NullPointerException - if command is null

stop

void stop()

Tries to do a graceful shutdown.

If this hasn't terminated after a time configured on instantiation, a forceful shutdown takes place.

getName

String getName()

Returns a name that indicates where was this scheduler created.

Returns:

the name of this scheduler.