org.axonframework.eventsourcing

Class AggregateSnapshotter.Builder

java.lang.Object

org.axonframework.eventsourcing.AbstractSnapshotter.Builder

org.axonframework.eventsourcing.AggregateSnapshotter.Builder

Direct Known Subclasses:

SpringAggregateSnapshotter.Builder

Enclosing class:

AggregateSnapshotter

public static class AggregateSnapshotter.Builder
extends AbstractSnapshotter.Builder

Builder class to instantiate a AggregateSnapshotter.

The Executor is defaulted to an DirectExecutor.INSTANCE, the TransactionManager defaults to a NoTransactionManager and the SpanFactory defaults to a NoOpSpanFactory. Additionally, this Builder has convenience functions to default the ParameterResolverFactory and HandlerDefinition based on instances of these available on the classpath in case these are not provided (respectively buildParameterResolverFactory() and buildHandlerDefinition()). Upon instantiation of a AggregateSnapshotter, it is recommended to use these function to set those fields.

The EventStore is a hard requirement and as such should be provided.

See Also:

ClasspathParameterResolverFactory, ClasspathHandlerDefinition

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AggregateSnapshotter.Builder	aggregateFactories(AggregateFactory<?>... aggregateFactories) Sets the aggregateFactories supported by this snapshotter.
AggregateSnapshotter.Builder	aggregateFactories(List<AggregateFactory<?>> aggregateFactories) Sets the aggregateFactories supported by this snapshotter.
AggregateSnapshotter	build() Initializes a AggregateSnapshotter as specified through this Builder.
protected HandlerDefinition	buildHandlerDefinition() Return the set HandlerDefinition, or create and return it if it is null.
protected ParameterResolverFactory	buildParameterResolverFactory() Return the set ParameterResolverFactory, or create and return it if it is null.
AggregateSnapshotter.Builder	eventStore(EventStore eventStore) Sets the EventStore instance which this AbstractSnapshotter implementation will store snapshots in.
AggregateSnapshotter.Builder	executor(Executor executor) Sets the Executor which handles the actual snapshot creation process.
AggregateSnapshotter.Builder	handlerDefinition(HandlerDefinition handlerDefinition) Sets the HandlerDefinition used to create concrete handlers in the snapshot aggregate this snapshotter creates.
AggregateSnapshotter.Builder	parameterResolverFactory(ParameterResolverFactory parameterResolverFactory) Sets the ParameterResolverFactory used to resolve parameter values for annotated handlers in the snapshot aggregate this snapshotter creates.
AggregateSnapshotter.Builder	repositoryProvider(RepositoryProvider repositoryProvider) Sets the RepositoryProvider provided to the snapshot aggregates this snapshotter creates for correct instantiation.
AggregateSnapshotter.Builder	spanFactory(SnapshotterSpanFactory spanFactory) Sets the SnapshotterSpanFactory implementation to use for providing tracing capabilities.
AggregateSnapshotter.Builder	transactionManager(TransactionManager transactionManager) Sets the TransactionManager used to manage the transaction around storing the snapshot.
protected void	validate() Validates whether the fields contained in this Builder are set accordingly.

Methods inherited from class org.axonframework.eventsourcing.AbstractSnapshotter.Builder

spanFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

spanFactory

public AggregateSnapshotter.Builder spanFactory(@Nonnull
                                                SnapshotterSpanFactory spanFactory)

Description copied from class: AbstractSnapshotter.Builder

Sets the SnapshotterSpanFactory implementation to use for providing tracing capabilities. Defaults to a DefaultSnapshotterSpanFactory with a NoOpSpanFactory by default, which provides no tracing capabilities.

Overrides:

spanFactory in class AbstractSnapshotter.Builder

Parameters:

spanFactory - The SpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

eventStore

public AggregateSnapshotter.Builder eventStore(EventStore eventStore)

Description copied from class: AbstractSnapshotter.Builder

Sets the EventStore instance which this AbstractSnapshotter implementation will store snapshots in.

Overrides:

eventStore in class AbstractSnapshotter.Builder

Parameters:

eventStore - the EventStore instance which this AbstractSnapshotter implementation will store snapshots in

Returns:

the current Builder instance, for fluent interfacing

executor

public AggregateSnapshotter.Builder executor(Executor executor)

Description copied from class: AbstractSnapshotter.Builder

Sets the Executor which handles the actual snapshot creation process. Defaults to a DirectExecutor.

Overrides:

executor in class AbstractSnapshotter.Builder

Parameters:

executor - an Executor which handles the actual snapshot creation process

Returns:

the current Builder instance, for fluent interfacing

transactionManager

public AggregateSnapshotter.Builder transactionManager(TransactionManager transactionManager)

Description copied from class: AbstractSnapshotter.Builder

Sets the TransactionManager used to manage the transaction around storing the snapshot. Defaults to a NoTransactionManager.

Overrides:

transactionManager in class AbstractSnapshotter.Builder

Parameters:

transactionManager - the TransactionManager used to manage the transaction around storing the snapshot

Returns:

the current Builder instance, for fluent interfacing

aggregateFactories

public AggregateSnapshotter.Builder aggregateFactories(AggregateFactory<?>... aggregateFactories)

Sets the aggregateFactories supported by this snapshotter. The AggregateFactory instances are used to create the relevant Aggregate Root instance, which represent the snapshots.

Parameters:

aggregateFactories - an array of AggregateFactory instances which this snapshotter will support

Returns:

the current Builder instance, for fluent interfacing

aggregateFactories

public AggregateSnapshotter.Builder aggregateFactories(List<AggregateFactory<?>> aggregateFactories)

Sets the aggregateFactories supported by this snapshotter. The AggregateFactory instances are used to create the relevant Aggregate Root instance, which represent the snapshots.

Parameters:

aggregateFactories - a List of AggregateFactory instances which this snapshotter will support

Returns:

the current Builder instance, for fluent interfacing

repositoryProvider

public AggregateSnapshotter.Builder repositoryProvider(RepositoryProvider repositoryProvider)

Sets the RepositoryProvider provided to the snapshot aggregates this snapshotter creates for correct instantiation.

Parameters:

repositoryProvider - the RepositoryProvider provided to the snapshot aggregates this snapshotter creates for correct instantiation

Returns:

the current Builder instance, for fluent interfacing

parameterResolverFactory

public AggregateSnapshotter.Builder parameterResolverFactory(ParameterResolverFactory parameterResolverFactory)

Sets the ParameterResolverFactory used to resolve parameter values for annotated handlers in the snapshot aggregate this snapshotter creates.

Parameters:

parameterResolverFactory - the ParameterResolverFactory used to resolve parameter values for annotated handlers in the snapshot aggregate this snapshotter creates

Returns:

the current Builder instance, for fluent interfacing

handlerDefinition

public AggregateSnapshotter.Builder handlerDefinition(HandlerDefinition handlerDefinition)

Sets the HandlerDefinition used to create concrete handlers in the snapshot aggregate this snapshotter creates.

Parameters:

handlerDefinition - the HandlerDefinition used to create concrete handlers in the snapshot aggregate this snapshotter creates

Returns:

the current Builder instance, for fluent interfacing

build

public AggregateSnapshotter build()

Initializes a AggregateSnapshotter as specified through this Builder.

Returns:

a AggregateSnapshotter as specified through this Builder

buildParameterResolverFactory

protected ParameterResolverFactory buildParameterResolverFactory()

Return the set ParameterResolverFactory, or create and return it if it is null. In case it has not been set yet, a ParameterResolverFactory is created by calling the ClasspathParameterResolverFactory.forClass(Class) function, either providing the AggregateSnapshotter type or the first AggregateFactory it's class as input.

Note: it is recommended to use this function when retrieving the ParameterResolverFactory as it ensure it is non-null.

Returns:

the set or instantiated ParameterResolverFactory

buildHandlerDefinition

protected HandlerDefinition buildHandlerDefinition()

Return the set HandlerDefinition, or create and return it if it is null. In case it has not been set yet, a HandlerDefinition is created by calling the ClasspathHandlerDefinition.forClass(Class) function, either providing the AggregateSnapshotter type or the first AggregateFactory it's class as input.

Note: it is recommended to use this function when retrieving the HandlerDefinition as it ensure it is non-null.

Returns:

the set or instantiated ParameterResolverFactory

validate

protected void validate()
                 throws AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Overrides:

validate in class AbstractSnapshotter.Builder

Throws:

AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications