Package org.axonframework.messaging.core.unitofwork

Record Class UnitOfWorkConfiguration

java.lang.Object

java.lang.Record

org.axonframework.messaging.core.unitofwork.UnitOfWorkConfiguration

Record Components:

workScheduler - The Executor for processing unit of work actions.

allowAsyncProcessing - Whether the unit of work should allow fully asynchronous processing.

processingLifecycleEnhancers - The enhancers that are applied to the processing lifecycle for each created unit of work.

lifecycleInterceptor - The ProcessingLifecycleInterceptor invoked immediately around every action and handler dispatch executed by the unit of work, or null when no interceptor is installed (the direct, zero-overhead path).

public record UnitOfWorkConfiguration(Executor workScheduler, boolean allowAsyncProcessing, List<Consumer<ProcessingLifecycle>> processingLifecycleEnhancers, @Nullable ProcessingLifecycleInterceptor lifecycleInterceptor)
extends Record

Configuration used for the UnitOfWork creation in the UnitOfWorkFactory.

Defines the work scheduler used during unit of work processing, and allows registering possible enhancers for a unit of work's lifecycle.

Since:

5.0.0

Author:

Mateusz Nowak, John Hendrikx

Constructor Summary

Constructors

Constructor	Description
UnitOfWorkConfiguration(Executor workScheduler, boolean allowAsyncProcessing, List<Consumer<ProcessingLifecycle>> processingLifecycleEnhancers)	Creates a UnitOfWorkConfiguration without a ProcessingLifecycleInterceptor.
UnitOfWorkConfiguration(Executor workScheduler, boolean allowAsyncProcessing, List<Consumer<ProcessingLifecycle>> processingLifecycleEnhancers, @Nullable ProcessingLifecycleInterceptor lifecycleInterceptor)	Creates an instance of a UnitOfWorkConfiguration record class.

Method Summary

Modifier and Type	Method	Description
UnitOfWorkConfiguration	addLifecycleInterceptor(ProcessingLifecycleInterceptor lifecycleInterceptor)	Creates a new configuration that chains the given interceptor after any already registered interceptor (composing via ProcessingLifecycleInterceptor.andThen(ProcessingLifecycleInterceptor)).
boolean	allowAsyncProcessing()	Returns the value of the allowAsyncProcessing record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
UnitOfWorkConfiguration	forcedSameThreadInvocation()	Creates a new UnitOfWorkConfiguration that forces all handlers to be invoked by the same thread.
final int	hashCode()	Returns a hash code value for this object.
@Nullable ProcessingLifecycleInterceptor	lifecycleInterceptor()	Returns the value of the lifecycleInterceptor record component.
UnitOfWorkConfiguration	lifecycleInterceptor(ProcessingLifecycleInterceptor lifecycleInterceptor)	Creates a new configuration that replaces the current interceptor with the given one.
List<Consumer<ProcessingLifecycle>>	processingLifecycleEnhancers()	Returns the value of the processingLifecycleEnhancers record component.
UnitOfWorkConfiguration	registerProcessingLifecycleEnhancer(Consumer<ProcessingLifecycle> enhancer)	Creates a new configuration including the specified enhancer.
final String	toString()	Returns a string representation of this record class.
Executor	workScheduler()	Returns the value of the workScheduler record component.
UnitOfWorkConfiguration	workScheduler(Executor workScheduler)	Creates a new configuration with specified work scheduler.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UnitOfWorkConfiguration

public UnitOfWorkConfiguration(Executor workScheduler,
 boolean allowAsyncProcessing,
 List<Consumer<ProcessingLifecycle>> processingLifecycleEnhancers)

Creates a UnitOfWorkConfiguration without a ProcessingLifecycleInterceptor. Retained for backward compatibility with callers constructing the configuration before the interceptor component was introduced.

Parameters:

workScheduler - the Executor for processing unit of work actions

allowAsyncProcessing - whether the unit of work should allow fully asynchronous processing

processingLifecycleEnhancers - the enhancers applied to the processing lifecycle for each created unit of work

UnitOfWorkConfiguration

public UnitOfWorkConfiguration(Executor workScheduler,
 boolean allowAsyncProcessing,
 List<Consumer<ProcessingLifecycle>> processingLifecycleEnhancers,
 @Nullable ProcessingLifecycleInterceptor lifecycleInterceptor)

Creates an instance of a UnitOfWorkConfiguration record class.

Parameters:

workScheduler - the value for the workScheduler record component

allowAsyncProcessing - the value for the allowAsyncProcessing record component

processingLifecycleEnhancers - the value for the processingLifecycleEnhancers record component

lifecycleInterceptor - the value for the lifecycleInterceptor record component

Method Details

forcedSameThreadInvocation

public UnitOfWorkConfiguration forcedSameThreadInvocation()

Creates a new UnitOfWorkConfiguration that forces all handlers to be invoked by the same thread. The configuration uses a direct execution model where all tasks are run immediately on the calling thread, and the coordinating thread will wait for any asynchronous processing to complete.

The enhancers and the interceptor are preserved, so lifecycle customization and state-bridging around framework-executed segments survive the switch to same-thread invocation.

Returns:

A new modified UnitOfWorkConfiguration.

workScheduler

public UnitOfWorkConfiguration workScheduler(Executor workScheduler)

Creates a new configuration with specified work scheduler.

Parameters:

workScheduler - The Executor for processing actions.

Returns:

A new modified UnitOfWorkConfiguration.

registerProcessingLifecycleEnhancer

public UnitOfWorkConfiguration registerProcessingLifecycleEnhancer(Consumer<ProcessingLifecycle> enhancer)

Creates a new configuration including the specified enhancer.

Parameters:

enhancer - The processing lifecycle enhancer to include.

Returns:

A new modified UnitOfWorkConfiguration.

lifecycleInterceptor

public UnitOfWorkConfiguration lifecycleInterceptor(ProcessingLifecycleInterceptor lifecycleInterceptor)

Creates a new configuration that replaces the current interceptor with the given one. To compose with an already registered interceptor instead of replacing it, use addLifecycleInterceptor(ProcessingLifecycleInterceptor).

Parameters:

lifecycleInterceptor - The ProcessingLifecycleInterceptor to install.

Returns:

A new modified UnitOfWorkConfiguration.

addLifecycleInterceptor

public UnitOfWorkConfiguration addLifecycleInterceptor(ProcessingLifecycleInterceptor lifecycleInterceptor)

Creates a new configuration that chains the given interceptor after any already registered interceptor (composing via ProcessingLifecycleInterceptor.andThen(ProcessingLifecycleInterceptor)). Chaining (rather than replacement) ensures multiple contributors never clobber each other, which is the common case when several framework modules each install their own interceptor. To replace the current interceptor instead, use lifecycleInterceptor(ProcessingLifecycleInterceptor).

Parameters:

lifecycleInterceptor - The ProcessingLifecycleInterceptor to chain in.

Returns:

A new modified UnitOfWorkConfiguration.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

workScheduler

public Executor workScheduler()

Returns the value of the workScheduler record component.

Returns:

the value of the workScheduler record component

allowAsyncProcessing

public boolean allowAsyncProcessing()

Returns the value of the allowAsyncProcessing record component.

Returns:

the value of the allowAsyncProcessing record component

processingLifecycleEnhancers

public List<Consumer<ProcessingLifecycle>> processingLifecycleEnhancers()

Returns the value of the processingLifecycleEnhancers record component.

Returns:

the value of the processingLifecycleEnhancers record component

lifecycleInterceptor

public @Nullable ProcessingLifecycleInterceptor lifecycleInterceptor()

Returns the value of the lifecycleInterceptor record component.

Returns:

the value of the lifecycleInterceptor record component