Package org.axonframework.extension.springboot

Class TimeoutProperties

java.lang.Object

org.axonframework.extension.springboot.TimeoutProperties

@ConfigurationProperties(prefix="axon.timeout")
public class TimeoutProperties
extends Object

Configuration properties for time limits of processing transactions and handlers in Axon Framework.

Since:

4.11.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimeoutProperties.MessageHandlerTimeoutProperties
static class	TimeoutProperties.TransactionTimeoutProperties

Constructor Summary

Constructors

Constructor	Description
TimeoutProperties()

Method Summary

Modifier and Type	Method	Description
TimeoutProperties.MessageHandlerTimeoutProperties	getHandler()	Timeout settings for message handlers.
TimeoutProperties.TransactionTimeoutProperties	getTransaction()	Timeout settings for transactions (UnitOfWork).
boolean	isEnabled()	Whether timeouts are enabled.
void	setEnabled(boolean enabled)	Sets whether timeouts are enabled.
void	setHandler(TimeoutProperties.MessageHandlerTimeoutProperties properties)	Sets the timeout settings for message handlers.
void	setTransaction(TimeoutProperties.TransactionTimeoutProperties properties)	Sets the timeout settings for transactions.

Methods inherited from class java.lang.Object

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

Constructor Details

TimeoutProperties

public TimeoutProperties()

Method Details

isEnabled

public boolean isEnabled()

Whether timeouts are enabled. Defaults to true. Setting this to false disabled all timeouts, even the ones set through the MessageHandlerTimeout annotations.

Returns:

whether timeouts are enabled

setEnabled

public void setEnabled(boolean enabled)

Sets whether timeouts are enabled.

getTransaction

public TimeoutProperties.TransactionTimeoutProperties getTransaction()

Timeout settings for transactions (UnitOfWork). Default to 30-second timeout, 10-second warning threshold and a warning interval of 1 second for all types of transactions.

Returns:

the timeout settings for transactions

setTransaction

public void setTransaction(TimeoutProperties.TransactionTimeoutProperties properties)

Sets the timeout settings for transactions.

Parameters:

properties - the timeout settings for transactions

getHandler

public TimeoutProperties.MessageHandlerTimeoutProperties getHandler()

Timeout settings for message handlers. Defaults to 30-second timeout, 10-second warning threshold and a warning interval of 1 second for all types of message handlers.

Returns:

the timeout settings for message handlers

setHandler

public void setHandler(TimeoutProperties.MessageHandlerTimeoutProperties properties)

Sets the timeout settings for message handlers.

Parameters:

properties - the timeout settings for message handlers