Package io.axoniq.framework.springboot.autoconfig

Class PersistentStreamAutoConfiguration

java.lang.Object

io.axoniq.framework.springboot.autoconfig.PersistentStreamAutoConfiguration

@AutoConfiguration(after={AxonServerAutoConfiguration.class,DeadLetterQueueConfiguration.class},
                   before=EventProcessingAutoConfiguration.class)
public class PersistentStreamAutoConfiguration
extends Object

Spring Boot autoconfiguration that defines the required infrastructure for persistent streams by creating a PersistentStreamScheduledExecutorBuilder, a PersistentStreamEventSourceFactory and a named PersistentStreamEventSource bean for each entry under axon.axonserver.persistent-streams using the PersistentStreamConfigurationEnhancer configuration enhancer.

Since:

5.2.0

Author:

Jakob Hatzl

See Also:

• PersistentStreamEventSource
• AxonServerConfiguration.PersistentStreamSettings
• PersistentStreamEventSourceFactory

Constructor Summary

Constructors

Constructor	Description
PersistentStreamAutoConfiguration()

Method Summary

Modifier and Type	Method	Description
PersistentStreamConfigurationEnhancer	persistentStreamConfigurationEnhancer(org.springframework.beans.factory.ObjectProvider<AxonServerConfiguration> axonServerConfigProvider, PersistentStreamScheduledExecutorBuilder schedulerBuilder, PersistentStreamEventSourceFactory factory)	Creates a PersistentStreamConfigurationEnhancer that registers a PersistentStreamEventSource component for each entry under axon.axonserver.persistent-streams.
PersistentStreamEventSourceFactory	persistentStreamEventSourceFactory()	Creates the default PersistentStreamEventSourceFactory if no custom one is present.
PersistentStreamScheduledExecutorBuilder	persistentStreamScheduledExecutorBuilder()	Creates the default PersistentStreamScheduledExecutorBuilder if no custom one is present.

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentStreamAutoConfiguration

public PersistentStreamAutoConfiguration()

Method Details

persistentStreamScheduledExecutorBuilder

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(name="axon.axonserver.event-store.enabled",
                       matchIfMissing=true)
public PersistentStreamScheduledExecutorBuilder persistentStreamScheduledExecutorBuilder()

Creates the default PersistentStreamScheduledExecutorBuilder if no custom one is present.

Returns:

the default PersistentStreamScheduledExecutorBuilder

persistentStreamEventSourceFactory

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(name="axon.axonserver.event-store.enabled",
                       matchIfMissing=true)
public PersistentStreamEventSourceFactory persistentStreamEventSourceFactory()

Creates the default PersistentStreamEventSourceFactory if no custom one is present.

The default implementation is DefaultPersistentStreamEventSourceFactory. Declare a bean of type PersistentStreamEventSourceFactory to replace this with custom construction logic.

Returns:

the default PersistentStreamEventSourceFactory

persistentStreamConfigurationEnhancer

@Bean
@ConditionalOnMissingBean
@ConditionalOnProperty(name="axon.axonserver.event-store.enabled",
                       matchIfMissing=true)
public PersistentStreamConfigurationEnhancer persistentStreamConfigurationEnhancer(org.springframework.beans.factory.ObjectProvider<AxonServerConfiguration> axonServerConfigProvider,
 PersistentStreamScheduledExecutorBuilder schedulerBuilder,
 PersistentStreamEventSourceFactory factory)

Creates a PersistentStreamConfigurationEnhancer that registers a PersistentStreamEventSource component for each entry under axon.axonserver.persistent-streams.

By being a ConfigurationEnhancer each component is registered under the map key as its name, making it retrievable via configuration.getOptionalComponent(SubscribableEventSource.class, "<stream-name>"). The SpringComponentRegistry promotes these components to named Spring beans, which enables wiring through axon.eventhandling.processors.<name>.source=<stream-name>.

The returned bean also implements DisposableBean to shut down all created ScheduledExecutorService instances when the Spring application context closes.

Parameters:

axonServerConfigProvider - provider for the Axon Server configuration containing persistent stream settings; resolved lazily during PersistentStreamConfigurationEnhancer.enhance(org.axonframework.common.configuration.ComponentRegistry) to avoid Spring lifecycle ordering issues

schedulerBuilder - the builder used to create a per-stream ScheduledExecutorService

factory - the factory used to construct each PersistentStreamEventSource

Returns:

a PersistentStreamConfigurationEnhancer that registers PersistentStreamEventSource components