org.axonframework.spring.eventsourcing

Class SpringAggregateSnapshotter.Builder

java.lang.Object

org.axonframework.eventsourcing.AbstractSnapshotter.Builder

org.axonframework.eventsourcing.AggregateSnapshotter.Builder

org.axonframework.spring.eventsourcing.SpringAggregateSnapshotter.Builder

Enclosing class:

SpringAggregateSnapshotter

public static class SpringAggregateSnapshotter.Builder
extends AggregateSnapshotter.Builder

Builder class to instantiate a SpringAggregateSnapshotter. The AggregateFactory instances are lazily retrieved by the ApplicationContext.

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 AggregateSnapshotter.Builder.buildParameterResolverFactory() and AggregateSnapshotter.Builder.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
SpringAggregateSnapshotter	build() Initializes a SpringAggregateSnapshotter as specified through this Builder.
SpringAggregateSnapshotter.Builder	eventStore(EventStore eventStore) Sets the EventStore instance which this AbstractSnapshotter implementation will store snapshots in.
SpringAggregateSnapshotter.Builder	executor(Executor executor) Sets the Executor which handles the actual snapshot creation process.
SpringAggregateSnapshotter.Builder	handlerDefinition(HandlerDefinition handlerDefinition) Sets the HandlerDefinition used to create concrete handlers in the snapshot aggregate this snapshotter creates.
SpringAggregateSnapshotter.Builder	parameterResolverFactory(ParameterResolverFactory parameterResolverFactory) Sets the ParameterResolverFactory used to resolve parameter values for annotated handlers in the snapshot aggregate this snapshotter creates.
SpringAggregateSnapshotter.Builder	repositoryProvider(RepositoryProvider repositoryProvider) Sets the RepositoryProvider provided to the snapshot aggregates this snapshotter creates for correct instantiation.
SpringAggregateSnapshotter.Builder	spanFactory(SnapshotterSpanFactory spanFactory) Sets the SnapshotterSpanFactory implementation to use for providing tracing capabilities.
SpringAggregateSnapshotter.Builder	spanFactory(SpanFactory spanFactory) Sets the SpanFactory implementation to use for providing tracing capabilities.
SpringAggregateSnapshotter.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.AggregateSnapshotter.Builder

aggregateFactories, aggregateFactories, buildHandlerDefinition, buildParameterResolverFactory

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

eventStore

public SpringAggregateSnapshotter.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 AggregateSnapshotter.Builder

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

executor

public SpringAggregateSnapshotter.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 AggregateSnapshotter.Builder

Parameters:

executor - an Executor which handles the actual snapshot creation process

Returns:

the current Builder instance, for fluent interfacing

transactionManager

public SpringAggregateSnapshotter.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 AggregateSnapshotter.Builder

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

repositoryProvider

public SpringAggregateSnapshotter.Builder repositoryProvider(RepositoryProvider repositoryProvider)

Description copied from class: AggregateSnapshotter.Builder

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

Overrides:

repositoryProvider in class AggregateSnapshotter.Builder

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 SpringAggregateSnapshotter.Builder parameterResolverFactory(ParameterResolverFactory parameterResolverFactory)

Description copied from class: AggregateSnapshotter.Builder

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

Overrides:

parameterResolverFactory in class AggregateSnapshotter.Builder

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 SpringAggregateSnapshotter.Builder handlerDefinition(HandlerDefinition handlerDefinition)

Description copied from class: AggregateSnapshotter.Builder

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

Overrides:

handlerDefinition in class AggregateSnapshotter.Builder

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

spanFactory

public SpringAggregateSnapshotter.Builder spanFactory(@Nonnull
                                                      SpanFactory spanFactory)

Description copied from class: AbstractSnapshotter.Builder

Sets the SpanFactory implementation to use for providing tracing capabilities. Defaults to 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.

spanFactory

public SpringAggregateSnapshotter.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 AggregateSnapshotter.Builder

Parameters:

spanFactory - The SpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

build

public SpringAggregateSnapshotter build()

Initializes a SpringAggregateSnapshotter as specified through this Builder.

Overrides:

build in class AggregateSnapshotter.Builder

Returns:

a SpringAggregateSnapshotter as specified through this Builder

validate

protected void validate()
                 throws AxonConfigurationException

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

Overrides:

validate in class AggregateSnapshotter.Builder

Throws:

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