org.mule.runtime.api.scheduler

Class SchedulerConfig

java.lang.Object

org.mule.runtime.api.scheduler.SchedulerConfig

public class SchedulerConfig
extends Object

Provides a fluent way of customizing a Scheduler obtained through the SchedulerService.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static SchedulerConfig	config() Whenever possible, use a SchedulerConfig from the Registry or inject it rather than building a new one with this method.
boolean	equals(Object o)
Optional<Boolean>	getDirectRunCpuLightWhenTargetBusy()
Integer	getMaxConcurrentTasks()
String	getSchedulerName()
Supplier<Long>	getShutdownTimeoutMillis()
Optional<Boolean>	getWaitAllowed()
int	hashCode()
boolean	hasName()
SchedulerConfig	withDirectRunCpuLightWhenTargetBusy(boolean runCpuLightWhenTargetBusy) When true, if the target custom Scheduler tries to dispatch a task to the cpu-light Scheduler when it's busy, the task will be run by the target Scheduler instead of dispatching it to cpu-lite.
SchedulerConfig	withMaxConcurrentTasks(int maxConcurrentTasks) Sets the max tasks that can be run at the same time for the target Scheduler.
SchedulerConfig	withName(String schedulerName) Sets the name for the target Scheduler, which will override the default one.
SchedulerConfig	withPrefix(String schedulerPrefix) Sets the prefix to prepend to the name for the target Scheduler, which will override the default one.
SchedulerConfig	withShutdownTimeout(long shutdownTimeout, TimeUnit shutdownTimeoutUnit) Sets the graceful shutdown timeout to use when stopping the target Scheduler.
SchedulerConfig	withShutdownTimeout(Supplier<Long> shutdownTimeoutSupplier, TimeUnit shutdownTimeoutUnit) Sets the graceful shutdown timeout to use when stopping the target Scheduler.
SchedulerConfig	withWaitAllowed(boolean waitAllowed) Whether the threads of the target custom Scheduler may block to wait when dispatching to a busy Scheduler.

Methods inherited from class java.lang.Object

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

Method Detail

config

public static SchedulerConfig config()

Whenever possible, use a SchedulerConfig from the Registry or inject it rather than building a new one with this method. SchedulerConfigs obtained that way are already configured with base configuration based on the artifact it belongs to.

Returns:

a default configuration, which can be further customized.

withMaxConcurrentTasks

public SchedulerConfig withMaxConcurrentTasks(int maxConcurrentTasks)

Sets the max tasks that can be run at the same time for the target Scheduler.

This is useful to apply throttling on the target Scheduler. The way exceeding tasks will be handled is determined by the target Scheduler.

Parameters:

maxConcurrentTasks - how many tasks can be running at the same time for the target Scheduler.

Returns:

the updated configuration.

getMaxConcurrentTasks

public Integer getMaxConcurrentTasks()

Returns:

how many tasks can be running at the same time for the target Scheduler.

withPrefix

public SchedulerConfig withPrefix(String schedulerPrefix)

Sets the prefix to prepend to the name for the target Scheduler, which will override the default one.

Parameters:

schedulerPrefix - the prefix for the name for the target Scheduler.

Returns:

the updated configuration.

withName

public SchedulerConfig withName(String schedulerName)

Sets the name for the target Scheduler, which will override the default one.

Parameters:

schedulerName - the name for the target Scheduler.

Returns:

the updated configuration.

getSchedulerName

public String getSchedulerName()

Returns:

the name for the target Scheduler.

hasName

public boolean hasName()

Returns:

true if withName(String) was called with a non-null value, false otherwise.

withDirectRunCpuLightWhenTargetBusy

public SchedulerConfig withDirectRunCpuLightWhenTargetBusy(boolean runCpuLightWhenTargetBusy)

When true, if the target custom Scheduler tries to dispatch a task to the cpu-light Scheduler when it's busy, the task will be run by the target Scheduler instead of dispatching it to cpu-lite.

This is only applicable for custom Schedulers. This behaviour cannot be changed for the runtime managed Scheduler.

A custom scheduler may have flags set for both runCpuLightWhenTargetBusy and waitAllowed. In such case, the behaviour when the target Scheduler is busy depends on the type of the target Scheduler: if it's cpu-light or the same as the current, the task will run directly, otherwise it will wait.

Returns:

the updated configuration

Since:

1.1

getDirectRunCpuLightWhenTargetBusy

public Optional<Boolean> getDirectRunCpuLightWhenTargetBusy()

Returns:

When true, if the target custom Scheduler tries to dispatch a task to the cpu-light Scheduler when it's busy, the task will be run by the target Scheduler instead of dispatching it to cpu-lite.

Since:

1.1

withWaitAllowed

public SchedulerConfig withWaitAllowed(boolean waitAllowed)

Whether the threads of the target custom Scheduler may block to wait when dispatching to a busy Scheduler.

This is only applicable for custom Schedulers. This behaviour cannot be changed for the runtime managed Scheduler.

A custom scheduler may have flags set for both runCpuLightWhenTargetBusy and waitAllowed. In such case, the behaviour when the target Scheduler is busy depends on the type of the target Scheduler: if it's cpu-light or the same as the current, the task will run directly, otherwise it will wait.

Returns:

the updated configuration

getWaitAllowed

public Optional<Boolean> getWaitAllowed()

Returns:

whether the threads of the target custom Scheduler may block to wait when dispatching to a busy Scheduler.

withShutdownTimeout

public SchedulerConfig withShutdownTimeout(Supplier<Long> shutdownTimeoutSupplier,
                                           TimeUnit shutdownTimeoutUnit)

Sets the graceful shutdown timeout to use when stopping the target Scheduler.

Parameters:

shutdownTimeoutSupplier - a supplier of the value of the timeout to use when gracefully stopping the target Scheduler, expressed in the provided TimeUnit.

shutdownTimeoutUnit - the unit of the timeout to use when gracefully stopping the target Scheduler.

Returns:

the updated configuration

withShutdownTimeout

public SchedulerConfig withShutdownTimeout(long shutdownTimeout,
                                           TimeUnit shutdownTimeoutUnit)

Sets the graceful shutdown timeout to use when stopping the target Scheduler.

Parameters:

shutdownTimeout - the value of the timeout to use when gracefully stopping the target Scheduler, expressed in the provided TimeUnit.

shutdownTimeoutUnit - the unit of the timeout to use when gracefully stopping the target Scheduler.

Returns:

the updated configuration

getShutdownTimeoutMillis

public Supplier<Long> getShutdownTimeoutMillis()

Returns:

a supplier of the timeout to use when gracefully stopping the target Scheduler, in millis.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object