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 through the UnitOfWork and message 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	Timeout properties for message handlers.
static class	TimeoutProperties.UnitOfWorkTimeoutProperties	Timeout properties for the UnitOfWork.

Constructor Summary

Constructors

Constructor	Description
TimeoutProperties()

Method Summary

Modifier and Type	Method	Description
TimeoutProperties.MessageHandlerTimeoutProperties	getHandler()	Timeout settings for message handlers.
TimeoutProperties.UnitOfWorkTimeoutProperties	getUnitOfWork()	Timeout settings for the 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	setUnitOfWork(TimeoutProperties.UnitOfWorkTimeoutProperties properties)	Sets the timeout settings for the UnitOfWork.

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.

Parameters:

enabled - provide true to enable timeout behavior, false otherwise.

getUnitOfWork

public TimeoutProperties.UnitOfWorkTimeoutProperties getUnitOfWork()

Timeout settings for the UnitOfWork.

Default to 30-second timeout, 10-second warning threshold and a warning interval of 1 second for any Message types backed by a UnitOfWork.

Returns:

the timeout settings for the UnitOfWork

setUnitOfWork

public void setUnitOfWork(TimeoutProperties.UnitOfWorkTimeoutProperties properties)

Sets the timeout settings for the UnitOfWork.

Parameters:

properties - the timeout settings for the UnitOfWork

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