Package org.axonframework.messaging.eventhandling.processing.subscribing

Class SubscribingEventProcessorsConfigurer

java.lang.Object

org.axonframework.messaging.eventhandling.processing.subscribing.SubscribingEventProcessorsConfigurer

public class SubscribingEventProcessorsConfigurer
extends Object

A configurer for managing multiple SubscribingEventProcessor instances within an application.

The SubscribingEventProcessorsConfigurer provides a centralized way to configure and register multiple subscribing event processing. It acts as a container that manages individual SubscribingEventProcessorModule instances, allowing you to set shared defaults that apply to all processing while enabling processor-specific customizations.

The main purpose is to simplify the configuration of multiple event processing by providing shared configuration capabilities such as default SubscribableEventSource, and processor settings that apply to all processing unless explicitly overridden.

The configurer automatically configures default components:

• Automatically wires available SubscribableEventSource components to all processing
• Applies shared customizations through the defaults(BiFunction) and defaults(UnaryOperator) methods

This configurer is typically accessed through EventProcessingConfigurer.pooledStreaming(UnaryOperator) rather than being instantiated directly.

Since:

5.0.0

Author:

Mateusz Nowak

Constructor Summary

Constructors

Constructor	Description
SubscribingEventProcessorsConfigurer(EventProcessingConfigurer parent)	Constructs a new subscribing event processing configurer.

Method Summary

Modifier and Type	Method	Description
void	build()	Builds and registers all configured subscribing event processing.
SubscribingEventProcessorsConfigurer	componentRegistry(Consumer<ComponentRegistry> registryAction)	Provides access to the component registry for additional component registrations.
SubscribingEventProcessorsConfigurer	defaultProcessor(String name, Function<EventHandlingComponentsConfigurer.RequiredComponentPhase,EventHandlingComponentsConfigurer.CompletePhase> eventHandlingComponentsBuilder)	Registers a subscribing event processor with the specified name and event handling components.
SubscribingEventProcessorsConfigurer	defaults(BiFunction<Configuration,SubscribingEventProcessorConfiguration,SubscribingEventProcessorConfiguration> configureDefaults)	Configures default settings that will be applied to all SubscribingEventProcessor instances managed by this configurer.
SubscribingEventProcessorsConfigurer	defaults(UnaryOperator<SubscribingEventProcessorConfiguration> configureDefaults)	Configures default settings that will be applied to all SubscribingEventProcessor instances managed by this configurer.
SubscribingEventProcessorsConfigurer	processor(String name, Function<EventProcessorModule.EventHandlingPhase<SubscribingEventProcessorModule,SubscribingEventProcessorConfiguration>,SubscribingEventProcessorModule> moduleCustomizer)	Registers a subscribing event processor with a custom module configuration.
SubscribingEventProcessorsConfigurer	processor(ModuleBuilder<SubscribingEventProcessorModule> moduleBuilder)	Registers a SubscribingEventProcessorModule using a ModuleBuilder.

Methods inherited from class java.lang.Object

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

Constructor Details

SubscribingEventProcessorsConfigurer

@Internal
public SubscribingEventProcessorsConfigurer(@Nonnull
 EventProcessingConfigurer parent)

Constructs a new subscribing event processing configurer.

This constructor is marked as Internal because the configurer is typically created and managed by the EventProcessingConfigurer. Users should not instantiate this class directly but instead access it through EventProcessingConfigurer.subscribing(UnaryOperator).

Parameters:

parent - The parent EventProcessingConfigurer that manages this configurer.

Method Details

build

@Internal
public void build()

Builds and registers all configured subscribing event processing.

This method is typically called automatically by the framework during configuration building. It registers default components and all configured processor modules.

defaults

@Nonnull
public SubscribingEventProcessorsConfigurer defaults(@Nonnull
 BiFunction<Configuration,SubscribingEventProcessorConfiguration,SubscribingEventProcessorConfiguration> configureDefaults)

Configures default settings that will be applied to all SubscribingEventProcessor instances managed by this configurer.

This method allows you to specify configurations that should be shared across all subscribing event processing. The provided function receives both the Axon Configuration and the processor configuration, allowing access to application-wide components when setting defaults.

Common use cases include setting default error handling policies, message interception, or processing configurations that should apply to all processing unless explicitly overridden.

Parameters:

configureDefaults - A function that receives the Axon configuration and processor configuration, returning a modified SubscribingEventProcessorConfiguration with the desired defaults applied.

Returns:

This configurer instance for method chaining.

defaults

@Nonnull
public SubscribingEventProcessorsConfigurer defaults(@Nonnull
 UnaryOperator<SubscribingEventProcessorConfiguration> configureDefaults)

Configures default settings that will be applied to all SubscribingEventProcessor instances managed by this configurer.

This is a simplified version of defaults(BiFunction) that provides only the processor configuration for modification, without access to the Axon Configuration. Use this when your default configurations don't require components from the application configuration.

Parameters:

configureDefaults - A function that modifies the SubscribingEventProcessorConfiguration with desired defaults.

Returns:

This configurer instance for method chaining.

defaultProcessor

@Nonnull
public SubscribingEventProcessorsConfigurer defaultProcessor(@Nonnull
 String name,
 @Nonnull
 Function<EventHandlingComponentsConfigurer.RequiredComponentPhase,EventHandlingComponentsConfigurer.CompletePhase> eventHandlingComponentsBuilder)

Registers a subscribing event processor with the specified name and event handling components. The processor will use the default subscribing event processor configuration.

Parameters:

name - The unique name for the processor.

eventHandlingComponentsBuilder - Function to configure the event handling components.

Returns:

This configurer instance for method chaining.

processor

@Nonnull
public SubscribingEventProcessorsConfigurer processor(@Nonnull
 String name,
 @Nonnull
 Function<EventProcessorModule.EventHandlingPhase<SubscribingEventProcessorModule,SubscribingEventProcessorConfiguration>,SubscribingEventProcessorModule> moduleCustomizer)

Registers a subscribing event processor with a custom module configuration.

Parameters:

name - The unique name for the processor.

moduleCustomizer - Function to customize the processor module configuration.

Returns:

This configurer instance for method chaining.

processor

@Nonnull
public SubscribingEventProcessorsConfigurer processor(@Nonnull
 ModuleBuilder<SubscribingEventProcessorModule> moduleBuilder)

Registers a SubscribingEventProcessorModule using a ModuleBuilder.

Parameters:

moduleBuilder - A builder that creates a SubscribingEventProcessorModule instance.

Returns:

This configurer instance for method chaining.

componentRegistry

@Nonnull
public SubscribingEventProcessorsConfigurer componentRegistry(@Nonnull
 Consumer<ComponentRegistry> registryAction)

Provides access to the component registry for additional component registrations.

Parameters:

registryAction - Action to perform on the component registry.

Returns:

This configurer instance for method chaining.