Package org.axonframework.extension.springboot.autoconfig

Class AxonTimeoutAutoConfiguration

java.lang.Object

org.axonframework.extension.springboot.autoconfig.AxonTimeoutAutoConfiguration

@AutoConfiguration
@EnableConfigurationProperties(TimeoutProperties.class)
public class AxonTimeoutAutoConfiguration
extends Object

Translates TimeoutProperties into the HandlerTimeoutConfiguration and TimeoutUnitOfWorkFactoryConfiguration components that drive the timeout behavior.

The actual wiring of the timeout behavior, wrapping message handlers with a timeout, and decorating the UnitOfWorkFactory used by the command bus, query bus, and every event processor so every UnitOfWork they create is time-limited, is done by the HandlerTimeoutConfigurationEnhancer and TimeoutUnitOfWorkFactoryConfigurationEnhancer.

Since:

4.11.0

Author:

Mitchell Herrijgers, Steven van Beelen

Constructor Summary

Constructors

Constructor	Description
AxonTimeoutAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
HandlerTimeoutConfiguration	disabledHandlerTimeoutConfiguration()	Bean creation method specifically to disable handler-timeout behavior, by setting a HandlerTimeoutConfiguration.DISABLED
TimeoutUnitOfWorkFactoryConfiguration	disabledTimeoutUnitOfWorkFactoryConfiguration()	Bean creation method specifically to disable UnitOfWorkFactory-timeout behavior, by setting a TimeoutUnitOfWorkFactoryConfiguration.DISABLED
HandlerTimeoutConfiguration	handlerTimeoutConfiguration(TimeoutProperties properties)	Bean creation method for the HandlerTimeoutConfiguration, translated from the given properties.
TimeoutUnitOfWorkFactoryConfiguration	timeoutUnitOfWorkFactoryConfiguration(TimeoutProperties properties)	Bean creation method for the TimeoutUnitOfWorkFactoryConfiguration, translated from the given properties.

Methods inherited from class java.lang.Object

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

Constructor Details

AxonTimeoutAutoConfiguration

public AxonTimeoutAutoConfiguration()

Method Details

handlerTimeoutConfiguration

@Bean
@ConditionalOnProperty(prefix="axon.timeout",
                       name="enabled",
                       havingValue="true",
                       matchIfMissing=true)
public HandlerTimeoutConfiguration handlerTimeoutConfiguration(TimeoutProperties properties)

Bean creation method for the HandlerTimeoutConfiguration, translated from the given properties. Picked up by the HandlerTimeoutConfigurationEnhancer to wrap message handlers with a timeout.

Parameters:

properties - the timeout properties to translate into a HandlerTimeoutConfiguration

Returns:

the HandlerTimeoutConfiguration driving handler-level timeout behavior

disabledHandlerTimeoutConfiguration

@Bean
@ConditionalOnProperty(prefix="axon.timeout",
                       name="enabled",
                       havingValue="false",
                       matchIfMissing=false)
public HandlerTimeoutConfiguration disabledHandlerTimeoutConfiguration()

Bean creation method specifically to disable handler-timeout behavior, by setting a HandlerTimeoutConfiguration.DISABLED

Returns:

a HandlerTimeoutConfiguration.DISABLED instance

timeoutUnitOfWorkFactoryConfiguration

@Bean
@ConditionalOnProperty(prefix="axon.timeout",
                       name="enabled",
                       havingValue="true",
                       matchIfMissing=true)
public TimeoutUnitOfWorkFactoryConfiguration timeoutUnitOfWorkFactoryConfiguration(TimeoutProperties properties)

Bean creation method for the TimeoutUnitOfWorkFactoryConfiguration, translated from the given properties. Picked up by the TimeoutUnitOfWorkFactoryConfigurationEnhancer to decorate the UnitOfWorkFactory used by the command bus, query bus, and every event processor, constructing timeout-specific UnitOfWork instances for each.

Parameters:

properties - the timeout properties to translate into a TimeoutUnitOfWorkFactoryConfiguration

Returns:

the TimeoutUnitOfWorkFactoryConfiguration driving transaction-level timeout behavior

disabledTimeoutUnitOfWorkFactoryConfiguration

@Bean
@ConditionalOnProperty(prefix="axon.timeout",
                       name="enabled",
                       havingValue="false",
                       matchIfMissing=false)
public TimeoutUnitOfWorkFactoryConfiguration disabledTimeoutUnitOfWorkFactoryConfiguration()

Bean creation method specifically to disable UnitOfWorkFactory-timeout behavior, by setting a TimeoutUnitOfWorkFactoryConfiguration.DISABLED

Returns:

a TimeoutUnitOfWorkFactoryConfiguration.DISABLED instance