Package io.axoniq.framework.axonserver.connector.event

Interface PersistentStreamEventSourceFactory

All Known Implementing Classes:

DefaultPersistentStreamEventSourceFactory, MultiTenantPersistentStreamEventSourceFactory

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface PersistentStreamEventSourceFactory

Factory for creating the SubscribableEventSource that consumes a persistent stream on Axon Server.

Provides the customization point for persistent stream event source construction. The default implementation is DefaultPersistentStreamEventSourceFactory, which builds a PersistentStreamEventSource and additionally tracks stream names, emitting a warning when the same Axon Server stream name is used more than once.

In a Spring Boot application the default factory is registered as a @ConditionalOnMissingBean, so advanced use cases can replace it by declaring their own bean of this type.

Since:

5.2.0

Author:

Jakob Hatzl

See Also:

• DefaultPersistentStreamEventSourceFactory

Method Summary

Modifier and Type	Method	Description
default SubscribableEventSource	build(String name, io.axoniq.axonserver.connector.event.PersistentStreamProperties properties, ScheduledExecutorService scheduler, int batchSize, Configuration configuration)	Builds the SubscribableEventSource consuming the persistent stream described by the given parameters, on the given, already created scheduler.
SubscribableEventSource	build(String name, io.axoniq.axonserver.connector.event.PersistentStreamProperties properties, Function<String,ScheduledExecutorService> schedulerFactory, int batchSize, Configuration configuration)	Builds the SubscribableEventSource consuming the persistent stream described by the given parameters, taking the ScheduledExecutorService instances it needs from the given schedulerFactory.
static PersistentStreamEventSourceFactory	defaultFactory()	The default PersistentStreamEventSourceFactory (a DefaultPersistentStreamEventSourceFactory) to be used to create the SubscribableEventSource consuming a persistent stream.

Method Details

build

SubscribableEventSource build(String name,
 io.axoniq.axonserver.connector.event.PersistentStreamProperties properties,
 Function<String,ScheduledExecutorService> schedulerFactory,
 int batchSize,
 Configuration configuration)

Builds the SubscribableEventSource consuming the persistent stream described by the given parameters, taking the ScheduledExecutorService instances it needs from the given schedulerFactory.

The supplied Configuration provides access to all registered framework components, such as the AxonServerConnectionManager and EventConverter, so implementations do not need to receive those as constructor arguments.

A factory is handed a scheduler factory rather than a scheduler, so implementations can create pools under their control. The requested pool name is used to name the pool's threads, so the source a thread belongs to is visible in a thread dump; pass the stream name for a single stream and a name distinguishing them for several.

Parameters:

name - the unique stream name on Axon Server

properties - the persistent stream properties (segment count, sequencing policy, filter, etc.)

schedulerFactory - the factory creating a ScheduledExecutorService for the pool name given to it

batchSize - the maximum number of events to deliver per batch

configuration - the framework configuration from which additional components can be retrieved

Returns:

a new SubscribableEventSource consuming the described persistent stream

build

default SubscribableEventSource build(String name,
 io.axoniq.axonserver.connector.event.PersistentStreamProperties properties,
 ScheduledExecutorService scheduler,
 int batchSize,
 Configuration configuration)

Builds the SubscribableEventSource consuming the persistent stream described by the given parameters, on the given, already created scheduler.

Delegates to build(String, PersistentStreamProperties, Function, int, Configuration) with a factory handing out that one scheduler.

Parameters:

name - the unique stream name on Axon Server

properties - the persistent stream properties (segment count, sequencing policy, filter, etc.)

scheduler - the scheduled executor to use for this stream's background tasks

batchSize - the maximum number of events to deliver per batch

configuration - the framework configuration from which additional components can be retrieved

Returns:

a new SubscribableEventSource consuming the described persistent stream

defaultFactory

static PersistentStreamEventSourceFactory defaultFactory()

The default PersistentStreamEventSourceFactory (a DefaultPersistentStreamEventSourceFactory) to be used to create the SubscribableEventSource consuming a persistent stream.

Returns:

the default PersistentStreamEventSourceFactory