spring-framework / org.springframework.scheduling.concurrent / ForkJoinPoolFactoryBean

ForkJoinPoolFactoryBean

open class ForkJoinPoolFactoryBean : FactoryBean<ForkJoinPool>, InitializingBean, DisposableBean

A Spring FactoryBean that builds and exposes a preconfigured ForkJoinPool.

For details on the ForkJoinPool API and its use with RecursiveActions, see the JDK 7 javadoc.

jsr166.jar, containing java.util.concurrent updates for Java 6, can be obtained from the concurrency interest website.

Author
Juergen Hoeller

Since
3.1

Constructors

<init>

ForkJoinPoolFactoryBean()

A Spring FactoryBean that builds and exposes a preconfigured ForkJoinPool.

For details on the ForkJoinPool API and its use with RecursiveActions, see the JDK 7 javadoc.

jsr166.jar, containing java.util.concurrent updates for Java 6, can be obtained from the concurrency interest website.

Functions

afterPropertiesSet

open fun afterPropertiesSet(): Unit

destroy

open fun destroy(): Unit

getObject

open fun getObject(): ForkJoinPool

getObjectType

open fun getObjectType(): Class<*>

isSingleton

open fun isSingleton(): Boolean

setAsyncMode

open fun setAsyncMode(asyncMode: Boolean): Unit

Specify whether to establish a local first-in-first-out scheduling mode for forked tasks that are never joined. This mode (asyncMode = true) may be more appropriate than the default locally stack-based mode in applications in which worker threads only process event-style asynchronous tasks. Default is false.

setAwaitTerminationSeconds

open fun setAwaitTerminationSeconds(awaitTerminationSeconds: Int): Unit

Set the maximum number of seconds that this ForkJoinPool is supposed to block on shutdown in order to wait for remaining tasks to complete their execution before the rest of the container continues to shut down. This is particularly useful if your remaining tasks are likely to need access to other resources that are also managed by the container.

By default, this ForkJoinPool won't wait for the termination of tasks at all. It will continue to fully execute all ongoing tasks as well as all remaining tasks in the queue, in parallel to the rest of the container shutting down. In contrast, if you specify an await-termination period using this property, this executor will wait for the given time (max) for the termination of tasks.

Note that this feature works for the "commonPool" mode as well. The underlying ForkJoinPool won't actually terminate in that case but will wait for all tasks to terminate.

setCommonPool

open fun setCommonPool(commonPool: Boolean): Unit

Set whether to expose JDK 8's 'common' ForkJoinPool.

Default is "false", creating a local ForkJoinPool instance based on the "parallelism", "threadFactory", "uncaughtExceptionHandler" and "asyncMode" properties on this FactoryBean.

NOTE: Setting this flag to "true" effectively ignores all other properties on this FactoryBean, reusing the shared common JDK ForkJoinPool instead. This is a fine choice on JDK 8 but does remove the application's ability to customize ForkJoinPool behavior, in particular the use of custom threads.

setParallelism

open fun setParallelism(parallelism: Int): Unit

Specify the parallelism level. Default is Runtime#availableProcessors().

setThreadFactory

open fun setThreadFactory(threadFactory: ForkJoinWorkerThreadFactory): Unit

Set the factory for creating new ForkJoinWorkerThreads. Default is ForkJoinPool#defaultForkJoinWorkerThreadFactory.

setUncaughtExceptionHandler

open fun setUncaughtExceptionHandler(uncaughtExceptionHandler: UncaughtExceptionHandler): Unit

Set the handler for internal worker threads that terminate due to unrecoverable errors encountered while executing tasks. Default is none.