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 builder in this Configurer.
MessagingConfigurer	registerCommandHandlerInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super CommandMessage>> interceptorBuilder)	Registers the given CommandMessage MessageHandlerInterceptor builder 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>> monitorBuilder)	Registers a command MessageMonitor builder for all command-specific infrastructure components component in this configuration.
MessagingConfigurer	registerCommandMonitor(MessageMonitorFactory<? super CommandMessage> monitorFactory)	Registers a message monitor factory for command-specific infrastructure components in this configuration.
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 builder in this Configurer.
MessagingConfigurer	registerEventDispatchInterceptor(ComponentBuilder<MessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given EventMessage-specific MessageDispatchInterceptor builder in this Configurer.
MessagingConfigurer	registerEventHandlerInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super EventMessage>> interceptorBuilder)	Registers the given EventMessage MessageHandlerInterceptor builder in this Configurer.
MessagingConfigurer	registerEventMonitor(ComponentBuilder<MessageMonitor<? super EventMessage>> monitorBuilder)	Registers a event MessageMonitor builder for all event-specific infrastructure components component in this configuration.
MessagingConfigurer	registerEventMonitor(MessageMonitorFactory<? super EventMessage> monitorFactory)	Registers a message monitor factory for event-specific infrastructure components in this configuration.
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 builder in this Configurer.
MessagingConfigurer	registerMessageMonitor(ComponentBuilder<MessageMonitor<Message>> monitorBuilder)	Registers a MessageMonitor builder for any type of messaging component in this configuration.
MessagingConfigurer	registerMessageMonitor(MessageMonitorFactory<Message> monitorFactory)	Registers a message monitor factory for any type of messaging component in this 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 builder in this Configurer.
MessagingConfigurer	registerQueryHandlerInterceptor(ComponentBuilder<MessageHandlerInterceptor<? super QueryMessage>> interceptorBuilder)	Registers the given QueryMessage MessageHandlerInterceptor builder 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>> monitorBuilder)	Registers a query monitor using the specified monitorBuilder.
MessagingConfigurer	registerQueryMonitor(MessageMonitorFactory<? super QueryMessage> monitorFactory)	Registers a message monitor factory for query-specific infrastructure components in this configuration.
MessagingConfigurer	registerSubscriptionQueryUpdateMonitor(ComponentBuilder<MessageMonitor<? super SubscriptionQueryUpdateMessage>> monitorBuilder)	Registers a subscription query update monitor using the specified monitorBuilder.
MessagingConfigurer	registerSubscriptionQueryUpdateMonitor(MessageMonitorFactory<? super SubscriptionQueryUpdateMessage> monitorFactory)	Registers a message monitor factory for subscription-update-specific infrastructure components in this configuration.
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(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(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(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(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(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(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(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(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(ComponentBuilder<MessageDispatchInterceptor<Message>> interceptorBuilder)

Registers the given generic Message MessageDispatchInterceptor builder 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(ComponentBuilder<MessageDispatchInterceptor<? super CommandMessage>> interceptorBuilder)

Registers the given CommandMessage-specific MessageDispatchInterceptor builder 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(ComponentBuilder<MessageDispatchInterceptor<? super EventMessage>> interceptorBuilder)

Registers the given EventMessage-specific MessageDispatchInterceptor builder 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(ComponentBuilder<MessageDispatchInterceptor<? super QueryMessage>> interceptorBuilder)

Registers the given QueryMessage-specific MessageDispatchInterceptor builder 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(ComponentBuilder<MessageHandlerInterceptor<Message>> interceptorBuilder)

Registers the given generic Message MessageHandlerInterceptor builder 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(ComponentBuilder<MessageHandlerInterceptor<? super CommandMessage>> interceptorBuilder)

Registers the given CommandMessage MessageHandlerInterceptor builder 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(ComponentBuilder<MessageHandlerInterceptor<? super EventMessage>> interceptorBuilder)

Registers the given EventMessage MessageHandlerInterceptor builder 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(ComponentBuilder<MessageHandlerInterceptor<? super QueryMessage>> interceptorBuilder)

Registers the given QueryMessage MessageHandlerInterceptor builder 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

public MessagingConfigurer registerCommandHandlingModule(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

public MessagingConfigurer registerQueryHandlingModule(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(ComponentBuilder<MessageMonitor<Message>> monitorBuilder)

Registers a MessageMonitor builder for any type of messaging component in this configuration.

If more fine-grained control is needed how and when a monitor should be created, use the registerMessageMonitor(MessageMonitorFactory) operation instead.

Parameters:

monitorBuilder - a builder for creating a MessageMonitor instance to monitor messages.

Returns:

the current instance of the Configurer for a fluent API

registerMessageMonitor

public MessagingConfigurer registerMessageMonitor(MessageMonitorFactory<Message> monitorFactory)

Registers a message monitor factory for any type of messaging component in this configuration.

The factory receives the component's type and name for which it is invoked, ensuring unique MessageMonitors can be constructed for the component at hand.

Parameters:

monitorFactory - a factory for creating a MessageMonitor instance to monitor messages

Returns:

the current instance of the Configurer for a fluent API

registerCommandMonitor

public MessagingConfigurer registerCommandMonitor(ComponentBuilder<MessageMonitor<? super CommandMessage>> monitorBuilder)

Registers a command MessageMonitor builder for all command-specific infrastructure components component in this configuration.

If more fine-grained control is needed how and when a monitor should be created, use the registerCommandMonitor(MessageMonitorFactory) operation instead.

Parameters:

monitorBuilder - a builder for creating a command-specific MessageMonitor instance

Returns:

the current instance of the Configurer for a fluent API

registerCommandMonitor

public MessagingConfigurer registerCommandMonitor(MessageMonitorFactory<? super CommandMessage> monitorFactory)

Registers a message monitor factory for command-specific infrastructure components in this configuration.

The factory receives the component's type and name for which it is invoked, ensuring unique MessageMonitors can be constructed for the component at hand.

Parameters:

monitorFactory - a factory for creating a command-specific MessageMonitor instance

Returns:

the current instance of the Configurer for a fluent API

registerEventMonitor

public MessagingConfigurer registerEventMonitor(ComponentBuilder<MessageMonitor<? super EventMessage>> monitorBuilder)

Registers a event MessageMonitor builder for all event-specific infrastructure components component in this configuration.

If more fine-grained control is needed how and when a monitor should be created, use the registerEventMonitor(MessageMonitorFactory) operation instead.

Parameters:

monitorBuilder - a builder for creating a event-specific MessageMonitor instance

Returns:

the current instance of the Configurer for a fluent API

registerEventMonitor

public MessagingConfigurer registerEventMonitor(MessageMonitorFactory<? super EventMessage> monitorFactory)

Registers a message monitor factory for event-specific infrastructure components in this configuration.

The factory receives the component's type and name for which it is invoked, ensuring unique MessageMonitors can be constructed for the component at hand.

Parameters:

monitorFactory - a factory for creating a event-specific MessageMonitor instance

Returns:

the current instance of the Configurer for a fluent API

registerQueryMonitor

public MessagingConfigurer registerQueryMonitor(ComponentBuilder<MessageMonitor<? super QueryMessage>> monitorBuilder)

Registers a query monitor using the specified monitorBuilder.

If more fine-grained control is needed how and when a monitor should be created, use the registerQueryMonitor(MessageMonitorFactory) operation instead.

Parameters:

monitorBuilder - a builder for creating a query-specific MessageMonitor instance

Returns:

the current instance of the Configurer for a fluent API

registerQueryMonitor

public MessagingConfigurer registerQueryMonitor(MessageMonitorFactory<? super QueryMessage> monitorFactory)

Registers a message monitor factory for query-specific infrastructure components in this configuration.

The factory receives the component's type and name for which it is invoked, ensuring unique MessageMonitors can be constructed for the component at hand.

Parameters:

monitorFactory - a factory for creating a query-specific MessageMonitor instance

Returns:

the current instance of the Configurer for a fluent API

registerSubscriptionQueryUpdateMonitor

public MessagingConfigurer registerSubscriptionQueryUpdateMonitor(ComponentBuilder<MessageMonitor<? super SubscriptionQueryUpdateMessage>> monitorBuilder)

Registers a subscription query update monitor using the specified monitorBuilder.

If more fine-grained control is needed how and when a monitor should be created, use the registerSubscriptionQueryUpdateMonitor(MessageMonitorFactory) operation instead.

Parameters:

monitorBuilder - a builder for creating a subscription-update-specific MessageMonitor instance

Returns:

the current instance of the Configurer for a fluent API

registerSubscriptionQueryUpdateMonitor

public MessagingConfigurer registerSubscriptionQueryUpdateMonitor(MessageMonitorFactory<? super SubscriptionQueryUpdateMessage> monitorFactory)

Registers a message monitor factory for subscription-update-specific infrastructure components in this configuration.

The factory receives the component's type and name for which it is invoked, ensuring unique MessageMonitors can be constructed for the component at hand.

Parameters:

monitorFactory - a factory for creating a subscription-update-specific MessageMonitor instance

Returns:

the current instance of the Configurer for a fluent API

componentRegistry

public MessagingConfigurer componentRegistry(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(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(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.