com.mulesoft.anypoint.backoff.scheduler

Class BackoffScheduler

java.lang.Object

com.mulesoft.anypoint.backoff.scheduler.BackoffScheduler

All Implemented Interfaces:

FastRecoveryObserver, ReschedulingObserver, org.mule.runtime.api.lifecycle.Disposable

public class BackoffScheduler
extends Object
implements FastRecoveryObserver, ReschedulingObserver, org.mule.runtime.api.lifecycle.Disposable

Defines a reduced scheduling interface to run BackoffRunnables.

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
BackoffScheduler(ScheduledExecutorService executorService)

Method Summary

Modifier and Type	Method and Description
void	dispose()
FastRecoveryObserver	fastRecoveryAbort(BackoffRunnable runnable) Notifies the fast recovery BackoffRunnable is now with Error.
FastRecoveryObserver	fastRecoveryStable(BackoffRunnable runnable, FastRecoveryConfiguration configuration) Notifies the fast recovery BackoffRunnable is now Stable.
FastRecoveryObserver	fastRecoveryUnstable(BackoffRunnable runnable, FastRecoveryConfiguration configuration) Notifies the fast recovery BackoffRunnable is still Unstable.
ReschedulingObserver	reschedule(BackoffRunnable runnable, SchedulingConfiguration configuration) Notifies the BackoffRunnable must be rescheduled with defined SchedulingConfiguration.
void	schedule(BackoffRunnable runnable, SchedulingConfiguration configuration, FastRecoveryObserver... recoveryObservers) Schedules a task in fast recovery mode: BackoffRunnable will be executed until its first success.
void	scheduleWithFixedDelay(BackoffRunnable runnable, SchedulingConfiguration configuration) Schedules a task in rescheduling mode: BackoffRunnable will be indefinitely scheduled, but with different paces depending on each execution status.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackoffScheduler

public BackoffScheduler(ScheduledExecutorService executorService)

Method Detail

schedule

public void schedule(BackoffRunnable runnable,
                     SchedulingConfiguration configuration,
                     FastRecoveryObserver... recoveryObservers)

Schedules a task in fast recovery mode: BackoffRunnable will be executed until its first success.

Parameters:

runnable - BackoffRunnable to be executed.

configuration - configuration parameters.

recoveryObservers - (optional) FastRecoveryObservers that will be notified on each execution.

scheduleWithFixedDelay

public void scheduleWithFixedDelay(BackoffRunnable runnable,
                                   SchedulingConfiguration configuration)

Schedules a task in rescheduling mode: BackoffRunnable will be indefinitely scheduled, but with different paces depending on each execution status.

Parameters:

runnable - BackoffRunnable to be executed.

configuration - configuration parameters.

fastRecoveryUnstable

public FastRecoveryObserver fastRecoveryUnstable(BackoffRunnable runnable,
                                                 FastRecoveryConfiguration configuration)

Notifies the fast recovery BackoffRunnable is still Unstable. BackoffRunnable will be rescheduled given the new configuration. While this runnable remain Unstable this process will be repeated.

Specified by:

fastRecoveryUnstable in interface FastRecoveryObserver

Parameters:

runnable - the Unstable BackoffRunnable.

configuration - the suggested delay and frequency if rescheduled along with its observers.

Returns:

this.

fastRecoveryStable

public FastRecoveryObserver fastRecoveryStable(BackoffRunnable runnable,
                                               FastRecoveryConfiguration configuration)

Notifies the fast recovery BackoffRunnable is now Stable. By not doing anything when BackoffRunnable is Stable, the BackoffScheduler will finish the retrying process of a FastRecovery runnable.

Specified by:

fastRecoveryStable in interface FastRecoveryObserver

Parameters:

runnable - the Stable BackoffRunnable.

configuration - the suggested delay and frequency if rescheduled along with its observers.

Returns:

this.

fastRecoveryAbort

public FastRecoveryObserver fastRecoveryAbort(BackoffRunnable runnable)

Notifies the fast recovery BackoffRunnable is now with Error. By not doing anything when BackoffRunnable is on Error, the BackoffScheduler will finish the retrying process of a FastRecovery runnable.

Specified by:

fastRecoveryAbort in interface FastRecoveryObserver

Parameters:

runnable - the BackoffRunnable with Error.

Returns:

this.

reschedule

public ReschedulingObserver reschedule(BackoffRunnable runnable,
                                       SchedulingConfiguration configuration)

Notifies the BackoffRunnable must be rescheduled with defined SchedulingConfiguration. BackoffRunnable is rescheduled with new configuration.

Specified by:

reschedule in interface ReschedulingObserver

Parameters:

runnable - the BackoffRunnable to rescheduled.

configuration - the defined period and frequency.

Returns:

this.

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable