Package org.axonframework.spring.eventsourcing

Class SpringAggregateSnapshotter

java.lang.Object

org.axonframework.eventsourcing.AbstractSnapshotter

org.axonframework.eventsourcing.AggregateSnapshotter

org.axonframework.spring.eventsourcing.SpringAggregateSnapshotter

All Implemented Interfaces:

Snapshotter, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class SpringAggregateSnapshotter
extends AggregateSnapshotter
implements org.springframework.context.ApplicationContextAware

Snapshotter implementation that uses the AggregateRoot as state for the snapshot. Unlike the AggregateSnapshotter, this implementation lazily retrieves AggregateFactories from the Application Context when snapshot requests are made.

Instead of configuring directly, consider using the SpringAggregateSnapshotterFactoryBean, which configures this class using values available in the application context.

Since:

3.0

Author:

Allard Buijze

See Also:

• SpringAggregateSnapshotterFactoryBean

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpringAggregateSnapshotter.Builder	Builder class to instantiate a SpringAggregateSnapshotter.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SpringAggregateSnapshotter(SpringAggregateSnapshotter.Builder builder)	Instantiate a SpringAggregateSnapshotter based on the fields contained in the SpringAggregateSnapshotter.Builder.

Method Summary

Modifier and Type	Method	Description
static SpringAggregateSnapshotter.Builder	builder()	Instantiate a Builder to be able to create a SpringAggregateSnapshotter.
protected AggregateFactory<?>	getAggregateFactory(Class<?> aggregateType)	Returns the AggregateFactory registered for the given aggregateType, or null if no such AggregateFactory is known.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class org.axonframework.eventsourcing.AggregateSnapshotter

createSnapshot, registerAggregateFactory

Methods inherited from class org.axonframework.eventsourcing.AbstractSnapshotter

createSnapshotterTask, getEventStore, getExecutor, scheduleSnapshot

Methods inherited from class java.lang.Object

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

Constructor Details

SpringAggregateSnapshotter

protected SpringAggregateSnapshotter(SpringAggregateSnapshotter.Builder builder)

Instantiate a SpringAggregateSnapshotter based on the fields contained in the SpringAggregateSnapshotter.Builder. The AggregateFactory instances are lazily retrieved by the ApplicationContext.

Will assert that the EventStore, ParameterResolverFactory and HandlerDefinition are not null, and will throw an AxonConfigurationException if any of them is null.

Parameters:

builder - the SpringAggregateSnapshotter.Builder used to instantiate a SpringAggregateSnapshotter instance

Method Details

builder

public static SpringAggregateSnapshotter.Builder builder()

Instantiate a Builder to be able to create 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.

Returns:

a Builder to be able to create a SpringAggregateSnapshotter

See Also:

• ClasspathParameterResolverFactory
• ClasspathHandlerDefinition

getAggregateFactory

protected AggregateFactory<?> getAggregateFactory(Class<?> aggregateType)

Description copied from class: AggregateSnapshotter

Returns the AggregateFactory registered for the given aggregateType, or null if no such AggregateFactory is known.

Subclasses may override this method to enhance how AggregateFactories are retrieved. They may choose to AggregateSnapshotter.registerAggregateFactory(AggregateFactory) if it hasn't been found using this implementation.

Overrides:

getAggregateFactory in class AggregateSnapshotter

Parameters:

aggregateType - The type to get the AggregateFactory for

Returns:

the appropriate AggregateFactory, or null if not found

setApplicationContext

public void setApplicationContext(@Nonnull
 org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException