org.mule.service.scheduler.internal.threads

Class SchedulerThreadPools

java.lang.Object

org.mule.service.scheduler.internal.threads.SchedulerThreadPools

public abstract class SchedulerThreadPools
extends Object

Schedulers provided by this implementation of SchedulerService use a shared single-threaded ScheduledExecutorService for scheduling work. When a scheduled tasks is fired, they are executed using the Scheduler's own executor.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchedulerThreadPools.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.mule.runtime.api.scheduler.Scheduler>	activeCustomSchedulers
protected Lock	activeSchedulersReadLock
protected Lock	activeSchedulersWriteLock
protected Function<String,RejectedExecutionHandler>	byCallerThreadGroupPolicy
protected ThreadGroup	customCallerRunsAnsWaitGroup
protected ThreadGroup	customCallerRunsGroup
protected ThreadGroup	customGroup
protected Set<ThreadPoolExecutor>	customSchedulersExecutors
protected ThreadGroup	customWaitGroup
protected String	name
protected ThreadGroup	parentGroup
protected org.quartz.Scheduler	quartzScheduler
protected ScheduledThreadPoolExecutor	scheduledExecutor
protected org.mule.runtime.api.scheduler.SchedulerPoolsConfig	threadPoolsConfig
protected ThreadGroup	timerGroup
protected org.slf4j.Logger	traceLogger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SchedulerThreadPools(String name, org.mule.runtime.api.scheduler.SchedulerPoolsConfig threadPoolsConfig, boolean preStartThreads, Consumer<AbstractExecutorService> preStartCallback, org.slf4j.Logger traceLogger)

Method Summary

Modifier and Type	Method and Description
protected boolean	addScheduler(List<org.mule.runtime.api.scheduler.Scheduler> activeSchedulers, org.mule.runtime.api.scheduler.Scheduler scheduler)
static SchedulerThreadPools.Builder	builder(String name, org.mule.runtime.api.scheduler.SchedulerPoolsConfig config)
abstract String	buildReportString()
org.mule.runtime.api.scheduler.Scheduler	createCpuIntensiveScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int workers, Supplier<Long> stopTimeout)
abstract org.mule.runtime.api.scheduler.Scheduler	createCpuIntensiveScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int workers, Supplier<Long> stopTimeout, org.mule.runtime.api.profiling.ProfilingService profilingService)
org.mule.runtime.api.scheduler.Scheduler	createCpuLightScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int parallelTasksEstimate, Supplier<Long> stopTimeout)
abstract org.mule.runtime.api.scheduler.Scheduler	createCpuLightScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int parallelTasksEstimate, Supplier<Long> stopTimeout, org.mule.runtime.api.profiling.ProfilingService profilingService)
org.mule.runtime.api.scheduler.Scheduler	createCustomScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int workers, Supplier<Long> stopTimeout)
org.mule.runtime.api.scheduler.Scheduler	createCustomScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int workers, Supplier<Long> stopTimeout, int queueSize)
org.mule.runtime.api.scheduler.Scheduler	createCustomScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int workers, Supplier<Long> stopTimeout, int queueSize, org.mule.runtime.api.profiling.ProfilingService profilingService)
org.mule.runtime.api.scheduler.Scheduler	createCustomScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int workers, Supplier<Long> stopTimeout, org.mule.runtime.api.profiling.ProfilingService profilingService)
protected abstract void	createCustomThreadGroups()
org.mule.runtime.api.scheduler.Scheduler	createIoScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int workers, Supplier<Long> stopTimeout)
abstract org.mule.runtime.api.scheduler.Scheduler	createIoScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config, int workers, Supplier<Long> stopTimeout, org.mule.runtime.api.profiling.ProfilingService profilingService)
protected BlockingQueue<Runnable>	createQueue(int size) Create queue using a SynchronousQueue if size is 0 or a LinkedBlockingQueue if size > 0.
protected abstract ByCallerThreadGroupPolicy	createThreadGroupPolicy(String schedulerName)
protected abstract void	doStart(boolean preStartThreads)
protected abstract ThreadPoolExecutor	getCustomSchedulerDestroyerExecutor()
protected abstract List<org.mule.runtime.api.scheduler.Scheduler>	getOwnSchedulers()
List<org.mule.runtime.api.scheduler.Scheduler>	getSchedulers()
abstract boolean	isCurrentThreadForCpuWork()
protected abstract void	onStopCompleted()
protected void	prestartCoreThreads(AbstractExecutorService executor, int corePoolSize) Workaround to avoid a race condition when a SynchronousQueue is combined with a call to ThreadPoolExecutor.prestartAllCoreThreads().
protected String	resolveSchedulerName(org.mule.runtime.api.scheduler.SchedulerConfig config, String prefix)
protected boolean	shouldThrottle(org.mule.runtime.api.scheduler.SchedulerConfig config, OptionalInt backingPoolMaxSize)
protected Consumer<org.mule.runtime.api.scheduler.Scheduler>	shutdownCallback(List<org.mule.runtime.api.scheduler.Scheduler> activeSchedulers)
protected abstract void	shutdownPools()
void	start()
void	stop()
protected void	validateCustomSchedulerOnlyConfigNotChanged(org.mule.runtime.api.scheduler.SchedulerConfig config)
protected abstract void	waitForExecutorTermination(long shutdownStartMillis)
protected void	waitForExecutorTermination(long startMillis, ExecutorService executor, String executorLabel)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final String name

parentGroup

protected final ThreadGroup parentGroup

threadPoolsConfig

protected final org.mule.runtime.api.scheduler.SchedulerPoolsConfig threadPoolsConfig

timerGroup

protected final ThreadGroup timerGroup

customGroup

protected final ThreadGroup customGroup

customWaitGroup

protected final ThreadGroup customWaitGroup

customCallerRunsGroup

protected final ThreadGroup customCallerRunsGroup

customCallerRunsAnsWaitGroup

protected final ThreadGroup customCallerRunsAnsWaitGroup

customSchedulersExecutors

protected final Set<ThreadPoolExecutor> customSchedulersExecutors

byCallerThreadGroupPolicy

protected final Function<String,RejectedExecutionHandler> byCallerThreadGroupPolicy

activeSchedulersReadLock

protected final Lock activeSchedulersReadLock

activeCustomSchedulers

protected final List<org.mule.runtime.api.scheduler.Scheduler> activeCustomSchedulers

activeSchedulersWriteLock

protected final Lock activeSchedulersWriteLock

traceLogger

protected final org.slf4j.Logger traceLogger

scheduledExecutor

protected ScheduledThreadPoolExecutor scheduledExecutor

quartzScheduler

protected org.quartz.Scheduler quartzScheduler

Constructor Detail

SchedulerThreadPools

protected SchedulerThreadPools(String name,
                               org.mule.runtime.api.scheduler.SchedulerPoolsConfig threadPoolsConfig,
                               boolean preStartThreads,
                               Consumer<AbstractExecutorService> preStartCallback,
                               org.slf4j.Logger traceLogger)

Method Detail

builder

public static SchedulerThreadPools.Builder builder(String name,
                                                   org.mule.runtime.api.scheduler.SchedulerPoolsConfig config)

createThreadGroupPolicy

protected abstract ByCallerThreadGroupPolicy createThreadGroupPolicy(String schedulerName)

createCustomThreadGroups

protected abstract void createCustomThreadGroups()

start

public final void start()
                 throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

doStart

protected abstract void doStart(boolean preStartThreads)
                         throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

createQueue

protected BlockingQueue<Runnable> createQueue(int size)

Create queue using a SynchronousQueue if size is 0 or a LinkedBlockingQueue if size > 0.

Parameters:

size - queue size

Returns:

new queue instance

shutdownPools

protected abstract void shutdownPools()
                               throws org.mule.runtime.api.exception.MuleException,
                                      InterruptedException

Throws:

org.mule.runtime.api.exception.MuleException

InterruptedException

stop

public final void stop()
                throws org.mule.runtime.api.exception.MuleException,
                       InterruptedException

Throws:

org.mule.runtime.api.exception.MuleException

InterruptedException

waitForExecutorTermination

protected abstract void waitForExecutorTermination(long shutdownStartMillis)
                                            throws InterruptedException

Throws:

InterruptedException

onStopCompleted

protected abstract void onStopCompleted()

waitForExecutorTermination

protected void waitForExecutorTermination(long startMillis,
                                          ExecutorService executor,
                                          String executorLabel)
                                   throws InterruptedException

Throws:

InterruptedException

createCpuLightScheduler

public org.mule.runtime.api.scheduler.Scheduler createCpuLightScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                        int parallelTasksEstimate,
                                                                        Supplier<Long> stopTimeout)

createCpuLightScheduler

public abstract org.mule.runtime.api.scheduler.Scheduler createCpuLightScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                                 int parallelTasksEstimate,
                                                                                 Supplier<Long> stopTimeout,
                                                                                 org.mule.runtime.api.profiling.ProfilingService profilingService)

createIoScheduler

public org.mule.runtime.api.scheduler.Scheduler createIoScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                  int workers,
                                                                  Supplier<Long> stopTimeout)

createIoScheduler

public abstract org.mule.runtime.api.scheduler.Scheduler createIoScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                           int workers,
                                                                           Supplier<Long> stopTimeout,
                                                                           org.mule.runtime.api.profiling.ProfilingService profilingService)

addScheduler

protected boolean addScheduler(List<org.mule.runtime.api.scheduler.Scheduler> activeSchedulers,
                               org.mule.runtime.api.scheduler.Scheduler scheduler)

createCpuIntensiveScheduler

public org.mule.runtime.api.scheduler.Scheduler createCpuIntensiveScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                            int workers,
                                                                            Supplier<Long> stopTimeout)

createCpuIntensiveScheduler

public abstract org.mule.runtime.api.scheduler.Scheduler createCpuIntensiveScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                                     int workers,
                                                                                     Supplier<Long> stopTimeout,
                                                                                     org.mule.runtime.api.profiling.ProfilingService profilingService)

shutdownCallback

protected Consumer<org.mule.runtime.api.scheduler.Scheduler> shutdownCallback(List<org.mule.runtime.api.scheduler.Scheduler> activeSchedulers)

validateCustomSchedulerOnlyConfigNotChanged

protected void validateCustomSchedulerOnlyConfigNotChanged(org.mule.runtime.api.scheduler.SchedulerConfig config)

shouldThrottle

protected boolean shouldThrottle(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                 OptionalInt backingPoolMaxSize)

createCustomScheduler

public org.mule.runtime.api.scheduler.Scheduler createCustomScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                      int workers,
                                                                      Supplier<Long> stopTimeout)

createCustomScheduler

public org.mule.runtime.api.scheduler.Scheduler createCustomScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                      int workers,
                                                                      Supplier<Long> stopTimeout,
                                                                      org.mule.runtime.api.profiling.ProfilingService profilingService)

createCustomScheduler

public org.mule.runtime.api.scheduler.Scheduler createCustomScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                      int workers,
                                                                      Supplier<Long> stopTimeout,
                                                                      int queueSize)

createCustomScheduler

public org.mule.runtime.api.scheduler.Scheduler createCustomScheduler(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                                                      int workers,
                                                                      Supplier<Long> stopTimeout,
                                                                      int queueSize,
                                                                      org.mule.runtime.api.profiling.ProfilingService profilingService)

getCustomSchedulerDestroyerExecutor

protected abstract ThreadPoolExecutor getCustomSchedulerDestroyerExecutor()

prestartCoreThreads

protected void prestartCoreThreads(AbstractExecutorService executor,
                                   int corePoolSize)

Workaround to avoid a race condition when a SynchronousQueue is combined with a call to ThreadPoolExecutor.prestartAllCoreThreads().

When using a SynchronousQueue on an Executor, even if calling prestartAllCoreThreads(), a race condition may occur where the worker threads are started but before it starts to take elements from the queue, the user of the Executor dispatches some task to it.

In that case, the threads are prestarted by dispatching work to the executor as a workaround, which avoids the issue.

Parameters:

executor - the executor to prestart the threads for

corePoolSize - the number of threads to start in e=the executor

resolveSchedulerName

protected String resolveSchedulerName(org.mule.runtime.api.scheduler.SchedulerConfig config,
                                      String prefix)

isCurrentThreadForCpuWork

public abstract boolean isCurrentThreadForCpuWork()

getSchedulers

public List<org.mule.runtime.api.scheduler.Scheduler> getSchedulers()

getOwnSchedulers

protected abstract List<org.mule.runtime.api.scheduler.Scheduler> getOwnSchedulers()

buildReportString

public abstract String buildReportString()