Package org.axonframework.messaging.eventhandling.processing.streaming.pooled

Class PooledStreamingEventProcessorsConfigurer

java.lang.Object

org.axonframework.messaging.eventhandling.processing.streaming.pooled.PooledStreamingEventProcessorsConfigurer

public class PooledStreamingEventProcessorsConfigurer
extends Object

A configurer for managing multiple PooledStreamingEventProcessor instances within an application.

The PooledStreamingEventProcessorsModule provides a centralized way to configure and register multiple pooled streaming event processors. It acts as a container that manages individual PooledStreamingEventProcessorModule instances, allowing you to set shared defaults that apply to all processors while enabling processor-specific customizations.

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

The configurer automatically configures default components:

• Registers an InMemoryTokenStore if no TokenStore is present
• Automatically wires available TokenStore and StreamableEventSource components to all processors
• 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
PooledStreamingEventProcessorsConfigurer(EventProcessingConfigurer parent)	Constructs a new pooled streaming event processors configurer.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

PooledStreamingEventProcessorsConfigurer

@Internal
public PooledStreamingEventProcessorsConfigurer(@Nonnull
 EventProcessingConfigurer parent)

Constructs a new pooled streaming event processors 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.pooledStreaming(UnaryOperator).

Parameters:

parent - The parent EventProcessingConfigurer that manages this configurer.

Method Details

build

@Internal
public void build()

Builds and registers all configured pooled streaming event processors.

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

defaults

@Nonnull
public PooledStreamingEventProcessorsConfigurer defaults(@Nonnull
 BiFunction<Configuration,PooledStreamingEventProcessorConfiguration,PooledStreamingEventProcessorConfiguration> configureDefaults)

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

This method allows you to specify configurations that should be shared across all pooled streaming event processors. 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 buffer sizes, segment counts, thread pool configurations, or error handling policies that should apply to all processors unless explicitly overridden.

Parameters:

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

Returns:

This configurer instance for method chaining.

defaults

@Nonnull
public PooledStreamingEventProcessorsConfigurer defaults(@Nonnull
 UnaryOperator<PooledStreamingEventProcessorConfiguration> configureDefaults)

Configures default settings that will be applied to all PooledStreamingEventProcessor 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 PooledStreamingEventProcessorConfiguration with desired defaults.

Returns:

This configurer instance for method chaining.

defaultProcessor

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

Registers a pooled streaming event processor with the specified name and event handling components. The processor will use the default pooled streaming 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 PooledStreamingEventProcessorsConfigurer processor(@Nonnull
 String name,
 @Nonnull
 Function<EventProcessorModule.EventHandlingPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>,PooledStreamingEventProcessorModule> moduleCustomizer)

Registers a pooled streaming event processor with 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 PooledStreamingEventProcessorsConfigurer processor(@Nonnull
 ModuleBuilder<PooledStreamingEventProcessorModule> moduleBuilder)

Registers a PooledStreamingEventProcessorModule using a ModuleBuilder.

Parameters:

moduleBuilder - A builder that creates a PooledStreamingEventProcessorModule instance.

Returns:

This module instance for method chaining.

componentRegistry

@Nonnull
public PooledStreamingEventProcessorsConfigurer 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.