Package org.axonframework.messaging.core.timeout

Class HandlerTimeoutHandlerEnhancerDefinition

java.lang.Object

org.axonframework.messaging.core.timeout.HandlerTimeoutHandlerEnhancerDefinition

All Implemented Interfaces:

HandlerEnhancerDefinition

public class HandlerTimeoutHandlerEnhancerDefinition
extends Object
implements HandlerEnhancerDefinition

Inspects message handler and wraps it in a TimeoutWrappedMessageHandlingMember if the handler should have a timeout.

The timeout is determined by the HandlerTimeoutConfiguration and the MessageHandlerTimeout annotation on the message handler method. The annotation takes precedence over the configuration.

Since:

4.11.0

Author:

Mitchell Herrijgers

See Also:

• TimeoutWrappedMessageHandlingMember
• HandlerTimeoutConfiguration

Constructor Summary

Constructors

Constructor	Description
HandlerTimeoutHandlerEnhancerDefinition(HandlerTimeoutConfiguration configuration, ScheduledExecutorService executorService)	Creates a new HandlerTimeoutHandlerEnhancerDefinition with the given configuration.

Method Summary

Modifier and Type	Method	Description
<T> MessageHandlingMember<T>	wrapHandler(MessageHandlingMember<T> original)	Enhance the given original handler.

Methods inherited from class java.lang.Object

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

Constructor Details

HandlerTimeoutHandlerEnhancerDefinition

public HandlerTimeoutHandlerEnhancerDefinition(HandlerTimeoutConfiguration configuration,
 ScheduledExecutorService executorService)

Creates a new HandlerTimeoutHandlerEnhancerDefinition with the given configuration.

Warnings and the timeout will be scheduled on the given executorService, which is strongly recommended to be the ScheduledExecutorService provided by the AxonTaskJanitor to ensure a single executor is used throughout.

The configuration will be used as default, but can be overridden by the MessageHandlerTimeout annotation for individual message handlers.

Parameters:

configuration - the configuration for the timeout settings

executorService - the executor service to schedule the timeout and warnings

Method Details

wrapHandler

public <T> MessageHandlingMember<T> wrapHandler(MessageHandlingMember<T> original)

Description copied from interface: HandlerEnhancerDefinition

Enhance the given original handler. Implementations may return the original message handler.

Specified by:

wrapHandler in interface HandlerEnhancerDefinition

Type Parameters:

T - The type of object that will perform the actual handling of the message

Parameters:

original - The original message handler

Returns:

The enhanced message handler