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

Class PooledStreamingEventProcessorModule

java.lang.Object

org.axonframework.common.configuration.BaseModule<PooledStreamingEventProcessorModule>

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

All Implemented Interfaces:

Module, ModuleBuilder<PooledStreamingEventProcessorModule>, EventProcessorModule, EventProcessorModule.CustomizationPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>, EventProcessorModule.EventHandlingPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>

public class PooledStreamingEventProcessorModule
extends BaseModule<PooledStreamingEventProcessorModule>
implements EventProcessorModule, ModuleBuilder<PooledStreamingEventProcessorModule>, EventProcessorModule.EventHandlingPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>, EventProcessorModule.CustomizationPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>

A configuration module for configuring and registering a single PooledStreamingEventProcessor component.

The main capabilities provided by this module include:

• Automatic thread pool configuration for coordinator and worker executors
• Event handling component decoration with tracing, monitoring, and interception
• Integration with shared configuration customizations from parent modules
• Lifecycle management for the created processor and its executors

This module is typically not instantiated directly but created through EventProcessorModule.pooledStreaming(String) or registered via PooledStreamingEventProcessorsConfigurer.defaultProcessor(java.lang.String, java.util.function.Function<org.axonframework.messaging.eventhandling.configuration.EventHandlingComponentsConfigurer.RequiredComponentPhase, org.axonframework.messaging.eventhandling.configuration.EventHandlingComponentsConfigurer.CompletePhase>) methods.

The module applies shared defaults from PooledStreamingEventProcessorsConfigurer and EventProcessingConfigurer before applying processor-specific customizations.

Since:

5.0.0

Author:

Mateusz Nowak

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PooledStreamingEventProcessorModule.Customization	Allows customizing the PooledStreamingEventProcessorConfiguration.

Nested classes/interfaces inherited from interface org.axonframework.messaging.eventhandling.configuration.EventProcessorModule

EventProcessorModule.CustomizationPhase<P extends EventProcessorModule,C extends EventProcessorConfiguration>, EventProcessorModule.EventHandlingPhase<P extends EventProcessorModule,C extends EventProcessorConfiguration>

Field Summary

Fields inherited from class org.axonframework.common.configuration.BaseModule

name

Constructor Summary

Constructors

Constructor	Description
PooledStreamingEventProcessorModule(String processorName)	Constructs a module with the given processor name.

Method Summary

Modifier and Type	Method	Description
PooledStreamingEventProcessorModule	build()	Builds a Module of type M.
PooledStreamingEventProcessorModule	customized(BiFunction<Configuration,PooledStreamingEventProcessorConfiguration,PooledStreamingEventProcessorConfiguration> instanceCustomization)	Customizes the processor configuration by applying modifications to the default configuration.
EventProcessorModule.CustomizationPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>	eventHandlingComponents(Function<EventHandlingComponentsConfigurer.RequiredComponentPhase,EventHandlingComponentsConfigurer.CompletePhase> configurerTask)	Configures event handling components using a configurer function.
PooledStreamingEventProcessorModule	notCustomized()	Builds the processor module with the current configuration.

Methods inherited from class org.axonframework.common.configuration.BaseModule

build, componentRegistry, name, postProcessConfiguration

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.Module

build, name

Constructor Details

PooledStreamingEventProcessorModule

public PooledStreamingEventProcessorModule(@Nonnull
 String processorName)

Constructs a module with the given processor name.

The processor name will be used as the module name and as the unique identifier for the PooledStreamingEventProcessor component created by this module.

Parameters:

processorName - The unique name for the pooled streaming event processor.

Method Details

build

public PooledStreamingEventProcessorModule build()

Description copied from interface: ModuleBuilder

Builds a Module of type M.

Specified by:

build in interface ModuleBuilder<PooledStreamingEventProcessorModule>

Returns:

A Module of type M.

customized

public PooledStreamingEventProcessorModule customized(@Nonnull
 BiFunction<Configuration,PooledStreamingEventProcessorConfiguration,PooledStreamingEventProcessorConfiguration> instanceCustomization)

Description copied from interface: EventProcessorModule.CustomizationPhase

Customizes the processor configuration by applying modifications to the default configuration.

This method applies processor-specific customizations on top of shared defaults from parent modules, providing the recommended approach for most configuration scenarios.

Specified by:

customized in interface EventProcessorModule.CustomizationPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>

Parameters:

instanceCustomization - A function that receives the configuration and default processor config, returning the customized processor configuration.

Returns:

The configured processor module.

notCustomized

public PooledStreamingEventProcessorModule notCustomized()

Description copied from interface: EventProcessorModule.CustomizationPhase

Builds the processor module with the current configuration.

Specified by:

notCustomized in interface EventProcessorModule.CustomizationPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>

Returns:

The configured processor module.

eventHandlingComponents

public EventProcessorModule.CustomizationPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration> eventHandlingComponents(@Nonnull
 Function<EventHandlingComponentsConfigurer.RequiredComponentPhase,EventHandlingComponentsConfigurer.CompletePhase> configurerTask)

Description copied from interface: EventProcessorModule.EventHandlingPhase

Configures event handling components using a configurer function.

Specified by:

eventHandlingComponents in interface EventProcessorModule.EventHandlingPhase<PooledStreamingEventProcessorModule,PooledStreamingEventProcessorConfiguration>

Parameters:

configurerTask - The configurer function.

Returns:

The customization phase for further configuration.