org.axonframework.mongo.eventsourcing.eventstore

Class MongoEventStorageEngine

java.lang.Object

org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine

org.axonframework.eventsourcing.eventstore.BatchingEventStorageEngine

org.axonframework.mongo.eventsourcing.eventstore.MongoEventStorageEngine

All Implemented Interfaces:

org.axonframework.eventsourcing.eventstore.EventStorageEngine

public class MongoEventStorageEngine
extends org.axonframework.eventsourcing.eventstore.BatchingEventStorageEngine

EventStorageEngine implementation that uses Mongo to store and fetch events.

Constructor Summary

Constructors

Constructor and Description
MongoEventStorageEngine(MongoTemplate template) Initializes an EventStorageEngine that uses Mongo to store and load events.
MongoEventStorageEngine(org.axonframework.serialization.Serializer serializer, org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain, Integer batchSize, MongoTemplate template, StorageStrategy storageStrategy) Initializes an EventStorageEngine that uses Mongo to store and load events.
MongoEventStorageEngine(org.axonframework.serialization.Serializer serializer, org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain, MongoTemplate template, StorageStrategy storageStrategy) Initializes an EventStorageEngine that uses Mongo to store and load events.
MongoEventStorageEngine(org.axonframework.serialization.Serializer snapshotSerializer, org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain, org.axonframework.common.jdbc.PersistenceExceptionResolver persistenceExceptionResolver, org.axonframework.serialization.Serializer eventSerializer, Integer batchSize, MongoTemplate template, StorageStrategy storageStrategy) Initializes an EventStorageEngine that uses Mongo to store and load events.
MongoEventStorageEngine(org.axonframework.serialization.Serializer snapshotSerializer, org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain, org.axonframework.serialization.Serializer eventSerializer, Integer batchSize, MongoTemplate template, StorageStrategy storageStrategy) Initializes an EventStorageEngine that uses Mongo to store and load events.
MongoEventStorageEngine(org.axonframework.serialization.Serializer snapshotSerializer, org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain, org.axonframework.serialization.Serializer eventSerializer, MongoTemplate template, StorageStrategy storageStrategy) Initializes an EventStorageEngine that uses Mongo to store and load events.

Method Summary

Modifier and Type	Method and Description
protected void	appendEvents(List<? extends org.axonframework.eventhandling.EventMessage<?>> events, org.axonframework.serialization.Serializer serializer)
org.axonframework.eventsourcing.eventstore.TrackingToken	createHeadToken()
org.axonframework.eventsourcing.eventstore.TrackingToken	createTailToken()
org.axonframework.eventsourcing.eventstore.TrackingToken	createTokenAt(Instant dateTime)
void	ensureIndexes() Deprecated. This method is now called by the constructor instead of the dependency injection framework running the @PostConstruct. i.e. You no longer have to call it manually if you don't use a dependency injection framework.
protected List<? extends org.axonframework.eventsourcing.eventstore.DomainEventData<?>>	fetchDomainEvents(String aggregateIdentifier, long firstSequenceNumber, int batchSize)
protected List<? extends org.axonframework.eventsourcing.eventstore.TrackedEventData<?>>	fetchTrackedEvents(org.axonframework.eventsourcing.eventstore.TrackingToken lastToken, int batchSize)
Optional<Long>	lastSequenceNumberFor(String aggregateIdentifier)
protected Optional<? extends org.axonframework.eventsourcing.eventstore.DomainEventData<?>>	readSnapshotData(String aggregateIdentifier)
protected void	storeSnapshot(org.axonframework.eventsourcing.DomainEventMessage<?> snapshot, org.axonframework.serialization.Serializer serializer)

Methods inherited from class org.axonframework.eventsourcing.eventstore.BatchingEventStorageEngine

batchSize, fetchForAggregateUntilEmpty, readEventData, readEventData

Methods inherited from class org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine

appendEvents, getEventSerializer, getSerializer, handlePersistenceException, readEvents, readEvents, readSnapshot, storeSnapshot

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.eventsourcing.eventstore.EventStorageEngine

appendEvents, readEvents

Constructor Detail

MongoEventStorageEngine

public MongoEventStorageEngine(MongoTemplate template)

Initializes an EventStorageEngine that uses Mongo to store and load events. A Document-Per-Event storage strategy is used, causing each event to be stored in a separate Mongo Document.

The payload and metadata of events is stored as a serialized blob of bytes using a new XStreamSerializer. Events are read in batches of 100. No upcasting is performed after the events have been fetched.

Parameters:

template - MongoTemplate instance to obtain the database and the collections.

MongoEventStorageEngine

public MongoEventStorageEngine(org.axonframework.serialization.Serializer serializer,
                               org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain,
                               MongoTemplate template,
                               StorageStrategy storageStrategy)

Initializes an EventStorageEngine that uses Mongo to store and load events. Events are fetched in batches of 100 and both event and snapshots use the same serializer. The same Serializer is used for both snapshots and events.

Parameters:

serializer - Used to serialize and deserialize event payload and metadata, and snapshots.

upcasterChain - Allows older revisions of serialized objects to be deserialized.

template - MongoTemplate instance to obtain the database and the collections.

storageStrategy - The strategy for storing and retrieving events from the collections.

MongoEventStorageEngine

public MongoEventStorageEngine(org.axonframework.serialization.Serializer snapshotSerializer,
                               org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain,
                               org.axonframework.serialization.Serializer eventSerializer,
                               MongoTemplate template,
                               StorageStrategy storageStrategy)

Initializes an EventStorageEngine that uses Mongo to store and load events. Events are fetched in batches of 100.

Parameters:

snapshotSerializer - Used to serialize and deserialize snapshots.

upcasterChain - Allows older revisions of serialized objects to be deserialized.

eventSerializer - Used to serialize and deserialize event payload and metadata.

template - MongoTemplate instance to obtain the database and the collections.

storageStrategy - The strategy for storing and retrieving events from the collections.

MongoEventStorageEngine

public MongoEventStorageEngine(org.axonframework.serialization.Serializer serializer,
                               org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain,
                               Integer batchSize,
                               MongoTemplate template,
                               StorageStrategy storageStrategy)

Initializes an EventStorageEngine that uses Mongo to store and load events. Both events and snapshots use the same serializer. The same Serializer is used for both snapshots and events.

Parameters:

serializer - Used to serialize and deserialize event payload and metadata, and snapshots.

upcasterChain - Allows older revisions of serialized objects to be deserialized.

batchSize - The number of events that should be read at each database access. When more than this number of events must be read to rebuild an aggregate's state, the events are read in batches of this size. Tip: if you use a snapshotter, make sure to choose snapshot trigger and batch size such that a single batch will generally retrieve all events required to rebuild an aggregate's state.

template - MongoTemplate instance to obtain the database and the collections.

storageStrategy - The strategy for storing and retrieving events from the collections.

MongoEventStorageEngine

public MongoEventStorageEngine(org.axonframework.serialization.Serializer snapshotSerializer,
                               org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain,
                               org.axonframework.serialization.Serializer eventSerializer,
                               Integer batchSize,
                               MongoTemplate template,
                               StorageStrategy storageStrategy)

Initializes an EventStorageEngine that uses Mongo to store and load events.

Parameters:

snapshotSerializer - Used to serialize and deserialize snapshots.

upcasterChain - Allows older revisions of serialized objects to be deserialized.

eventSerializer - Used to serialize and deserialize event payload and metadata.

batchSize - The number of events that should be read at each database access. When more than this number of events must be read to rebuild an aggregate's state, the events are read in batches of this size. Tip: if you use a snapshotter, make sure to choose snapshot trigger and batch size such that a single batch will generally retrieve all events required to rebuild an aggregate's state.

template - MongoTemplate instance to obtain the database and the collections.

storageStrategy - The strategy for storing and retrieving events from the collections.

MongoEventStorageEngine

public MongoEventStorageEngine(org.axonframework.serialization.Serializer snapshotSerializer,
                               org.axonframework.serialization.upcasting.event.EventUpcaster upcasterChain,
                               org.axonframework.common.jdbc.PersistenceExceptionResolver persistenceExceptionResolver,
                               org.axonframework.serialization.Serializer eventSerializer,
                               Integer batchSize,
                               MongoTemplate template,
                               StorageStrategy storageStrategy)

Initializes an EventStorageEngine that uses Mongo to store and load events.

Parameters:

snapshotSerializer - Used to serialize and deserialize snapshots.

upcasterChain - Allows older revisions of serialized objects to be deserialized.

persistenceExceptionResolver - Custom resolver of persistence errors.

eventSerializer - Used to serialize and deserialize event payload and metadata.

batchSize - The number of events that should be read at each database access. When more than this number of events must be read to rebuild an aggregate's state, the events are read in batches of this size. Tip: if you use a snapshotter, make sure to choose snapshot trigger and batch size such that a single batch will generally retrieve all events required to rebuild an aggregate's state.

template - MongoTemplate instance to obtain the database and the collections.

storageStrategy - The strategy for storing and retrieving events from the collections.

Method Detail

ensureIndexes

@Deprecated
public void ensureIndexes()

Deprecated. This method is now called by the constructor instead of the dependency injection framework running the @PostConstruct. i.e. You no longer have to call it manually if you don't use a dependency injection framework.

Make sure an index is created on the collection that stores domain events.

appendEvents

protected void appendEvents(List<? extends org.axonframework.eventhandling.EventMessage<?>> events,
                            org.axonframework.serialization.Serializer serializer)

Specified by:

appendEvents in class org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine

storeSnapshot

protected void storeSnapshot(org.axonframework.eventsourcing.DomainEventMessage<?> snapshot,
                             org.axonframework.serialization.Serializer serializer)

Specified by:

storeSnapshot in class org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine

readSnapshotData

protected Optional<? extends org.axonframework.eventsourcing.eventstore.DomainEventData<?>> readSnapshotData(String aggregateIdentifier)

Specified by:

readSnapshotData in class org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine

fetchDomainEvents

protected List<? extends org.axonframework.eventsourcing.eventstore.DomainEventData<?>> fetchDomainEvents(String aggregateIdentifier,
                                                                                                          long firstSequenceNumber,
                                                                                                          int batchSize)

Specified by:

fetchDomainEvents in class org.axonframework.eventsourcing.eventstore.BatchingEventStorageEngine

fetchTrackedEvents

protected List<? extends org.axonframework.eventsourcing.eventstore.TrackedEventData<?>> fetchTrackedEvents(org.axonframework.eventsourcing.eventstore.TrackingToken lastToken,
                                                                                                            int batchSize)

Specified by:

fetchTrackedEvents in class org.axonframework.eventsourcing.eventstore.BatchingEventStorageEngine

lastSequenceNumberFor

public Optional<Long> lastSequenceNumberFor(String aggregateIdentifier)

createTailToken

public org.axonframework.eventsourcing.eventstore.TrackingToken createTailToken()

createHeadToken

public org.axonframework.eventsourcing.eventstore.TrackingToken createHeadToken()

createTokenAt

public org.axonframework.eventsourcing.eventstore.TrackingToken createTokenAt(Instant dateTime)