Package org.axonframework.messaging.core.configuration

Class MessagingConfigurer

java.lang.Object

org.axonframework.messaging.core.configuration.MessagingConfigurer

All Implemented Interfaces:

ApplicationConfigurer

public class MessagingConfigurer
extends Object
implements ApplicationConfigurer

The messaging ApplicationConfigurer of Axon Framework's configuration API.

Provides register operations for command, event, and query infrastructure components.

This configurer registers several defaults, provided by class MessagingConfigurationDefaults.
To replace or decorate any of these defaults, use their respective interfaces as the identifier. For example, to adjust the CommandBus, invoke componentRegistry(Consumer) and ComponentRegistry.registerComponent(Class, ComponentBuilder) with CommandBus.class to replace it.

     MessagingConfigurer.create()
                        .componentRegistry(cr -> cr.registerEnhancer(CommandBus.class, (config, component) -> ...));
 

Since:

5.0.0

Author:

Allard Buijze, Steven van Beelen

Method Summary

Modifier and Type	Method	Description
AxonConfiguration	build()	Returns the completely initialized Configuration instance of type C built using this Configurer implementation.
MessagingConfigurer	componentRegistry(Consumer<ComponentRegistry> componentRegistrar)	Executes the given componentRegistrar on the component registry associated with this ApplicationConfigurer.
static MessagingConfigurer	create()	Build a default MessagingConfigurer instance with several messaging defaults, as well as methods to register (e.g.) a command bus.
static MessagingConfigurer	enhance(ApplicationConfigurer applicationConfigurer)	Creates a MessagingConfigurer that enhances an existing ApplicationConfigurer.
MessagingConfigurer	eventProcessing(Consumer<EventProcessingConfigurer> configurerTask)	Delegates given configurerTask to the EventProcessingConfigurer.
MessagingConfigurer	lifecycleRegistry(Consumer<LifecycleRegistry> lifecycleRegistrar)	Executes the given lifecycleRegistrar on the lifecycle registry associated with this ApplicationConfigurer.
MessagingConfigurer	registerCommandBus(ComponentBuilder<CommandBus> commandBusBuilder)	Registers the given CommandBus factory in this Configurer.
MessagingConfigurer	registerCommandDispatchInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given CommandMessage-specific MessageDispatchInterceptor factory in this Configurer.
MessagingConfigurer	registerCommandHandlerInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given CommandMessage MessageHandlerInterceptor factory in this Configurer.
MessagingConfigurer	registerCommandHandlingModule(ModuleBuilder<CommandHandlingModule> moduleBuilder)	Registers the given builder for a CommandHandlingModule to use in this configuration.
MessagingConfigurer	registerCommandMonitor(ComponentBuilder<MessageMonitor<? super CommandMessage>> messageMonitorBuilder)	Registers a command monitor using the given message monitor builder.
MessagingConfigurer	registerCorrelationDataProvider(ComponentBuilder<CorrelationDataProvider> providerBuilder)	Registers the given CorrelationDataProvider factory in this providerBuilder.
MessagingConfigurer	registerDispatchInterceptor(ComponentBuilder<MessageDispatchInterceptor<Message>> interceptorBuilder)	Registers the given generic Message MessageDispatchInterceptor factory in this Configurer.
MessagingConfigurer	registerEventDispatchInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given EventMessage-specific MessageDispatchInterceptor factory in this Configurer.
MessagingConfigurer	registerEventHandlerInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given EventMessage MessageHandlerInterceptor factory in this Configurer.
MessagingConfigurer	registerEventMonitor(ComponentBuilder<MessageMonitor<? super EventMessage>> messageMonitorBuilder)	Registers a component builder to configure the MessageMonitor used for monitoring EventMessage.
MessagingConfigurer	registerEventSink(ComponentBuilder<EventSink> eventSinkBuilder)	Registers the given EventSink factory in this Configurer.
MessagingConfigurer	registerMessageHandlerInterceptor(ComponentBuilder<MessageHandlerInterceptor<Message>> interceptorBuilder)	Registers the given generic Message MessageHandlerInterceptor factory in this Configurer.
MessagingConfigurer	registerMessageMonitor(ComponentBuilder<MessageMonitor<Message>> messageMonitorBuilder)	Registers a message monitor for the messaging components in the configuration.
MessagingConfigurer	registerMessageTypeResolver(ComponentBuilder<MessageTypeResolver> messageTypeResolverFactory)	Registers the given MessageTypeResolver factory in this Configurer.
MessagingConfigurer	registerParameterResolverFactory(ComponentBuilder<ParameterResolverFactory> parameterResolverFactoryBuilder)	Registers the given ParameterResolverFactory factory in this Configurer.
MessagingConfigurer	registerQueryBus(ComponentBuilder<QueryBus> queryBusBuilder)	Registers the given QueryBus factory in this Configurer.
MessagingConfigurer	registerQueryDispatchInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)	Registers the given QueryMessage-specific MessageDispatchInterceptor factory in this Configurer.
MessagingConfigurer	registerQueryHandlerInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super QueryMessage>> interceptorBuilder)	Registers the given QueryMessage MessageHandlerInterceptor factory in this Configurer.
MessagingConfigurer	registerQueryHandlingModule(ModuleBuilder<QueryHandlingModule> moduleBuilder)	Registers the given builder for a QueryHandlingModule to use in this configuration.
MessagingConfigurer	registerQueryMonitor(ComponentBuilder<MessageMonitor<? super QueryMessage>> messageMonitorBuilder)	Registers a query monitor using the specified messageMonitorBuilder.
MessagingConfigurer	registerSubscriptionQueryUpdateMonitor(ComponentBuilder<MessageMonitor<? super SubscriptionQueryUpdateMessage>> messageMonitorBuilder)	Registers a subscription query update monitor using the specified messageMonitorBuilder.
MessagingConfigurer	registerUnitOfWorkFactory(ComponentBuilder<UnitOfWorkFactory> unitOfWorkFactoryBuilder)	Registers the given UnitOfWorkFactory factory in this Configurer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.common.configuration.ApplicationConfigurer

start

Method Details

enhance

public static MessagingConfigurer enhance(@Nonnull
 ApplicationConfigurer applicationConfigurer)

Creates a MessagingConfigurer that enhances an existing ApplicationConfigurer. This method is useful when applying multiple specialized Configurers to configure a single application.

Parameters:

applicationConfigurer - The ApplicationConfigurer to enhance with configuration of messaging components.

Returns:

The current instance of the Configurer for a fluent API.

See Also:

• create()

create

public static MessagingConfigurer create()

Build a default MessagingConfigurer instance with several messaging defaults, as well as methods to register (e.g.) a command bus.

Besides the specific operations, the MessagingConfigurer allows for configuring generic components, component decorators, enhancers, and modules for a message-driven application.

Returns:

A MessagingConfigurer instance for further configuring.

See Also:

• enhance(ApplicationConfigurer)

registerMessageTypeResolver

public MessagingConfigurer registerMessageTypeResolver(@Nonnull
 ComponentBuilder<MessageTypeResolver> messageTypeResolverFactory)

Registers the given MessageTypeResolver factory in this Configurer. This is the global MessageTypeResolver, whose mappings can be accessed by all Modules and Components within the application.

The commandBusFactory receives the Configuration as input and is expected to return a MessageTypeResolver instance.

Parameters:

messageTypeResolverFactory - The factory building the MessageTypeResolver.

Returns:

The current instance of the Configurer for a fluent API.

registerCommandBus

public MessagingConfigurer registerCommandBus(@Nonnull
 ComponentBuilder<CommandBus> commandBusBuilder)

Registers the given CommandBus factory in this Configurer.

The commandBusBuilder receives the Configuration as input and is expected to return a CommandBus instance.

Parameters:

commandBusBuilder - The builder constructing the CommandBus.

Returns:

The current instance of the Configurer for a fluent API.

registerEventSink

public MessagingConfigurer registerEventSink(@Nonnull
 ComponentBuilder<EventSink> eventSinkBuilder)

Registers the given EventSink factory in this Configurer.

The eventSinkBuilder receives the Configuration as input and is expected to return a EventSink instance.

Parameters:

eventSinkBuilder - The builder constructing the EventSink.

Returns:

The current instance of the Configurer for a fluent API.

registerQueryBus

public MessagingConfigurer registerQueryBus(@Nonnull
 ComponentBuilder<QueryBus> queryBusBuilder)

Registers the given QueryBus factory in this Configurer.

The queryBusBuilder receives the Configuration as input and is expected to return a QueryBus instance.

Parameters:

queryBusBuilder - The builder constructing the QueryBus.

Returns:

The current instance of the Configurer for a fluent API.

registerParameterResolverFactory

public MessagingConfigurer registerParameterResolverFactory(@Nonnull
 ComponentBuilder<ParameterResolverFactory> parameterResolverFactoryBuilder)

Registers the given ParameterResolverFactory factory in this Configurer.

The parameterResolverFactoryBuilder receives the Configuration as input and is expected to return a ParameterResolverFactory instance.

Parameters:

parameterResolverFactoryBuilder - The builder constructing the ParameterResolverFactory.

Returns:

The current instance of the Configurer for a fluent API.

registerUnitOfWorkFactory

public MessagingConfigurer registerUnitOfWorkFactory(@Nonnull
 ComponentBuilder<UnitOfWorkFactory> unitOfWorkFactoryBuilder)

Registers the given UnitOfWorkFactory factory in this Configurer.

The unitOfWorkFactoryBuilder receives the Configuration as input and is expected to return a UnitOfWorkFactory instance.

Parameters:

unitOfWorkFactoryBuilder - The builder constructing the UnitOfWorkFactory.

Returns:

The current instance of the Configurer for a fluent API.

registerCorrelationDataProvider

public MessagingConfigurer registerCorrelationDataProvider(@Nonnull
 ComponentBuilder<CorrelationDataProvider> providerBuilder)

Registers the given CorrelationDataProvider factory in this providerBuilder.

The interceptorBuilder receives the Configuration as input and is expected to return a CorrelationDataProvider instance.

CorrelationDataProviders are typically automatically registered with all applicable infrastructure components through the CorrelationDataProviderRegistry.

Parameters:

providerBuilder - The builder constructing the CorrelationDataProvider.

Returns:

The current instance of the Configurer for a fluent API

registerDispatchInterceptor

public MessagingConfigurer registerDispatchInterceptor(@Nonnull
 ComponentBuilder<MessageDispatchInterceptor<Message>> interceptorBuilder)

Registers the given generic Message MessageDispatchInterceptor factory in this Configurer.

The interceptorBuilder receives the Configuration as input and is expected to return a generic Message MessageDispatchInterceptor instance.

Generic MessageDispatchInterceptors are typically automatically registered with all applicable infrastructure components through the DispatchInterceptorRegistry.

Parameters:

interceptorBuilder - The builder constructing the generic Message MessageDispatchInterceptor.

Returns:

The current instance of the Configurer for a fluent API

registerCommandDispatchInterceptor

public MessagingConfigurer registerCommandDispatchInterceptor(@Nonnull
 ComponentBuilder<MessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)

Registers the given CommandMessage-specific MessageDispatchInterceptor factory in this Configurer.

The interceptorBuilder receives the Configuration as input and is expected to return a CommandMessage-specific MessageDispatchInterceptor instance.

CommandMessage MessageDispatchInterceptors are typically automatically registered with all applicable infrastructure components through the DispatchInterceptorRegistry.

Parameters:

interceptorBuilder - The builder constructing the CommandMessage-specific MessageDispatchInterceptor.

Returns:

The current instance of the Configurer for a fluent API

registerEventDispatchInterceptor

public MessagingConfigurer registerEventDispatchInterceptor(@Nonnull
 ComponentBuilder<MessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)

Registers the given EventMessage-specific MessageDispatchInterceptor factory in this Configurer.

The interceptorBuilder receives the Configuration as input and is expected to return a EventMessage-specific MessageDispatchInterceptor instance.

EventMessage-specific MessageDispatchInterceptors are typically automatically registered with all applicable infrastructure components through the DispatchInterceptorRegistry.

Parameters:

interceptorBuilder - The builder constructing the EventMessage-specific MessageDispatchInterceptor.

Returns:

The current instance of the Configurer for a fluent API

registerQueryDispatchInterceptor

public MessagingConfigurer registerQueryDispatchInterceptor(@Nonnull
 ComponentBuilder<MessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)

Registers the given QueryMessage-specific MessageDispatchInterceptor factory in this Configurer.

The interceptorBuilder receives the Configuration as input and is expected to return a QueryMessage-specific MessageDispatchInterceptor instance.

QueryMessage-specific MessageDispatchInterceptors are typically automatically registered with all applicable infrastructure components through the DispatchInterceptorRegistry.

Parameters:

interceptorBuilder - The builder constructing the QueryMessage-specific MessageDispatchInterceptor.

Returns:

The current instance of the Configurer for a fluent API

registerMessageHandlerInterceptor

public MessagingConfigurer registerMessageHandlerInterceptor(@Nonnull
 ComponentBuilder<MessageHandlerInterceptor<Message>> interceptorBuilder)

Registers the given generic Message MessageHandlerInterceptor factory in this Configurer.

The interceptorBuilder receives the Configuration as input and is expected to return a generic Message MessageHandlerInterceptor instance.

Generic MessageHandlerInterceptors are typically automatically registered with all applicable infrastructure components through the HandlerInterceptorRegistry.

Parameters:

interceptorBuilder - The builder constructing the generic Message MessageHandlerInterceptor.

Returns:

The current instance of the Configurer for a fluent API

registerCommandHandlerInterceptor

public MessagingConfigurer registerCommandHandlerInterceptor(@Nonnull
 ComponentBuilder<MessageHandlerInterceptor<? super CommandMessage>> interceptorBuilder)

Registers the given CommandMessage MessageHandlerInterceptor factory in this Configurer.

The interceptorBuilder receives the Configuration as input and is expected to return a CommandMessage MessageHandlerInterceptor instance.

CommandMessage MessageHandlerInterceptors are typically automatically registered with all applicable infrastructure components through the HandlerInterceptorRegistry.

Parameters:

interceptorBuilder - The builder constructing the CommandMessage MessageHandlerInterceptor.

Returns:

The current instance of the Configurer for a fluent API

registerEventHandlerInterceptor

public MessagingConfigurer registerEventHandlerInterceptor(@Nonnull
 ComponentBuilder<MessageHandlerInterceptor<? super EventMessage>> interceptorBuilder)

Registers the given EventMessage MessageHandlerInterceptor factory in this Configurer.

The interceptorBuilder receives the Configuration as input and is expected to return a EventMessage MessageHandlerInterceptor instance.

EventMessage MessageHandlerInterceptors are typically automatically registered with all applicable infrastructure components through the HandlerInterceptorRegistry.

Parameters:

interceptorBuilder - The builder constructing the EventMessage MessageHandlerInterceptor.

Returns:

The current instance of the Configurer for a fluent API

registerQueryHandlerInterceptor

public MessagingConfigurer registerQueryHandlerInterceptor(@Nonnull
 ComponentBuilder<MessageHandlerInterceptor<? super QueryMessage>> interceptorBuilder)

Registers the given QueryMessage MessageHandlerInterceptor factory in this Configurer.

The interceptorBuilder receives the Configuration as input and is expected to return a QueryMessage MessageHandlerInterceptor instance.

QueryMessage MessageHandlerInterceptors are typically automatically registered with all applicable infrastructure components through the HandlerInterceptorRegistry.

Parameters:

interceptorBuilder - The builder constructing the QueryMessage MessageHandlerInterceptor.

Returns:

The current instance of the Configurer for a fluent API

registerCommandHandlingModule

@Nonnull
public MessagingConfigurer registerCommandHandlingModule(@Nonnull
 ModuleBuilder<CommandHandlingModule> moduleBuilder)

Registers the given builder for a CommandHandlingModule to use in this configuration.

As a Module implementation, any components registered with the result of the given moduleBuilder will not be accessible from other Modules to enforce encapsulation. The sole exception to this, are Modules registered with the resulting CommandHandlingModule itself.

Parameters:

moduleBuilder - The builder returning a command handling module to register with this MessagingConfigurer.

Returns:

The current instance of the Configurer for a fluent API

registerQueryHandlingModule

@Nonnull
public MessagingConfigurer registerQueryHandlingModule(@Nonnull
 ModuleBuilder<QueryHandlingModule> moduleBuilder)

Registers the given builder for a QueryHandlingModule to use in this configuration.

As a Module implementation, any components registered with the result of the given moduleBuilder will not be accessible from other Modules to enforce encapsulation. The sole exception to this, are Modules registered with the resulting QueryHandlingModule itself.

Parameters:

moduleBuilder - The builder returning a query handling module to register with this MessagingConfigurer.

Returns:

The current instance of the Configurer for a fluent API

registerMessageMonitor

public MessagingConfigurer registerMessageMonitor(@Nonnull
 ComponentBuilder<MessageMonitor<Message>> messageMonitorBuilder)

Registers a message monitor for the messaging components in the configuration. Multiple MessageMonitors are possible via MessageMonitorRegistry.

Parameters:

messageMonitorBuilder - A builder for creating a MessageMonitor instance to monitor messages.

Returns:

The current instance of the Configurer for a fluent API

registerCommandMonitor

public MessagingConfigurer registerCommandMonitor(@Nonnull
 ComponentBuilder<MessageMonitor<? super CommandMessage>> messageMonitorBuilder)

Registers a command monitor using the given message monitor builder. This method allows customization of the monitoring logic for command messages by providing a component builder that creates a message monitor for commands.

Parameters:

messageMonitorBuilder - the builder for creating a message monitor to monitor command messages; it must not be null

Returns:

The current instance of the Configurer for a fluent API

registerEventMonitor

public MessagingConfigurer registerEventMonitor(@Nonnull
 ComponentBuilder<MessageMonitor<? super EventMessage>> messageMonitorBuilder)

Registers a component builder to configure the MessageMonitor used for monitoring EventMessage.

Parameters:

messageMonitorBuilder - the ComponentBuilder for constructing the MessageMonitor to be registered for monitoring EventMessages.

Returns:

The current instance of the Configurer for a fluent API

registerQueryMonitor

public MessagingConfigurer registerQueryMonitor(@Nonnull
 ComponentBuilder<MessageMonitor<? super QueryMessage>> messageMonitorBuilder)

Registers a query monitor using the specified messageMonitorBuilder.

Parameters:

messageMonitorBuilder - The builder for a MessageMonitor specifically designed to monitor QueryMessage messages.

Returns:

The current instance of the Configurer for a fluent API

registerSubscriptionQueryUpdateMonitor

public MessagingConfigurer registerSubscriptionQueryUpdateMonitor(@Nonnull
 ComponentBuilder<MessageMonitor<? super SubscriptionQueryUpdateMessage>> messageMonitorBuilder)

Registers a subscription query update monitor using the specified messageMonitorBuilder.

Parameters:

messageMonitorBuilder - The builder for a MessageMonitor specifically designed to monitor SubscriptionQueryUpdateMessage messages.

Returns:

The current instance of the Configurer for a fluent API

componentRegistry

public MessagingConfigurer componentRegistry(@Nonnull
 Consumer<ComponentRegistry> componentRegistrar)

Description copied from interface: ApplicationConfigurer

Executes the given componentRegistrar on the component registry associated with this ApplicationConfigurer.

Specified by:

componentRegistry in interface ApplicationConfigurer

Parameters:

componentRegistrar - The actions to take on the component registry.

Returns:

This ApplicationConfigurer for a fluent API.

lifecycleRegistry

public MessagingConfigurer lifecycleRegistry(@Nonnull
 Consumer<LifecycleRegistry> lifecycleRegistrar)

Description copied from interface: ApplicationConfigurer

Executes the given lifecycleRegistrar on the lifecycle registry associated with this ApplicationConfigurer.

Specified by:

lifecycleRegistry in interface ApplicationConfigurer

Parameters:

lifecycleRegistrar - The actions to take on the lifecycle registry.

Returns:

This ApplicationConfigurer for a fluent API.

eventProcessing

public MessagingConfigurer eventProcessing(@Nonnull
 Consumer<EventProcessingConfigurer> configurerTask)

Delegates given configurerTask to the EventProcessingConfigurer.

Use this operation to configure defaults and register EventProcessors.

Parameters:

configurerTask - Lambda consuming the EventProcessingConfigurer.

Returns:

The current instance of the Configurer for a fluent API.

build

public AxonConfiguration build()

Description copied from interface: ApplicationConfigurer

Returns the completely initialized Configuration instance of type C built using this Configurer implementation.

It is not recommended to change any configuration on this ApplicationConfigurer once this method is called.

Specified by:

build in interface ApplicationConfigurer

Returns:

The fully initialized Configuration instance of type C.