Package org.axonframework.messaging.core.timeout

Class AxonTaskJanitor

java.lang.Object

org.axonframework.messaging.core.timeout.AxonTaskJanitor

public class AxonTaskJanitor
extends Object

Utility constructing a ScheduledExecutorService and providing Logger instances for the AxonTimeLimitedTask.

To ensure a unique executor is used throughout, the executorComponent() should be registered with an applications Configuration just once under the EXECUTOR_COMPONENT_NAME. Doing so on top level ensures (1) that there is a single instance throughout and (2) that it's lifecycle is tied to the application's lifecycle.

Since:

4.11.0

Author:

Mitchell Herrijgers, Steven van Beelen

See Also:

• AxonTimeLimitedTask

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXECUTOR_COMPONENT_NAME	The name under which the Configuration-scoped ScheduledExecutorService, defined by executorComponent(), is known in the Configuration.
static final org.slf4j.Logger	LOGGER	Unique instance of the Logger for the AxonTimeLimitedTask to log warnings and errors.

Method Summary

Modifier and Type	Method	Description
protected static ScheduledThreadPoolExecutor	createExecutor()	Creates the ScheduledExecutorService used for scheduling the interrupting task.
static ComponentDefinition<ScheduledExecutorService>	executorComponent()	Creates a ComponentDefinition for a ScheduledExecutorService, named EXECUTOR_COMPONENT_NAME, scoped to whichever Configuration it is registered with (for example through ComponentRegistry.registerIfNotPresent(ComponentDefinition)).

Methods inherited from class java.lang.Object

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

Field Details

EXECUTOR_COMPONENT_NAME

public static final String EXECUTOR_COMPONENT_NAME

The name under which the Configuration-scoped ScheduledExecutorService, defined by executorComponent(), is known in the Configuration.

See Also:

• Constant Field Values

LOGGER

public static final org.slf4j.Logger LOGGER

Unique instance of the Logger for the AxonTimeLimitedTask to log warnings and errors.

Method Details

executorComponent

public static ComponentDefinition<ScheduledExecutorService> executorComponent()

Creates a ComponentDefinition for a ScheduledExecutorService, named EXECUTOR_COMPONENT_NAME, scoped to whichever Configuration it is registered with (for example through ComponentRegistry.registerIfNotPresent(ComponentDefinition)).

The defined executor is created lazily, on first use, and is shut down automatically when the owning Configuration shuts down. Since the executor is scoped to a single Configuration, shutting that Configuration down can never affect timeout enforcement in another Configuration sharing the same JVM.

Returns:

a ComponentDefinition for a Configuration-scoped ScheduledExecutorService

createExecutor

protected static ScheduledThreadPoolExecutor createExecutor()

Creates the ScheduledExecutorService used for scheduling the interrupting task.

It only has one thread as the load is very low. Cancelling the tasks will clean it up to reduce memory pressure.

Returns:

the ScheduledExecutorService used for scheduling the interrupting task