org.axonframework.mongo.eventsourcing.eventstore.documentpercommit

Class DocumentPerCommitStorageStrategy

java.lang.Object

org.axonframework.mongo.eventsourcing.eventstore.AbstractMongoEventStorageStrategy

org.axonframework.mongo.eventsourcing.eventstore.documentpercommit.DocumentPerCommitStorageStrategy

All Implemented Interfaces:

StorageStrategy

public class DocumentPerCommitStorageStrategy
extends AbstractMongoEventStorageStrategy

Implementation of a Mongo StorageStrategy that stores one Document per commit of a batch of events.

For instance, one command commonly gives rise to more than one event. Using this strategt all events for that single command will be grouped in a single Mongo Document.

Field Summary

Fields inherited from class org.axonframework.mongo.eventsourcing.eventstore.AbstractMongoEventStorageStrategy

ORDER_ASC, ORDER_DESC

Constructor Summary

Constructors

Constructor and Description
DocumentPerCommitStorageStrategy() Initializes a DocumentPerCommitStorageStrategy with default event entry and commit entry configuration.
DocumentPerCommitStorageStrategy(CommitEntryConfiguration commitEntryConfiguration) Initializes a DocumentPerCommitStorageStrategy with default event entry and given commitEntryConfiguration.
DocumentPerCommitStorageStrategy(EventEntryConfiguration eventConfiguration, CommitEntryConfiguration commitEntryConfiguration, Duration lookBackTime) Initializes a DocumentPerCommitStorageStrategy with given eventConfiguration and commitEntryConfiguration.

Method Summary

Modifier and Type	Method and Description
protected Stream<org.bson.Document>	createEventDocuments(List<? extends EventMessage<?>> events, Serializer serializer) Returns a stream of Mongo documents that represent the given batch of events.
protected org.bson.Document	createSnapshotDocument(DomainEventMessage<?> snapshot, Serializer serializer) Returns a Mongo document for given snapshot event.
void	ensureIndexes(com.mongodb.client.MongoCollection<org.bson.Document> eventsCollection, com.mongodb.client.MongoCollection<org.bson.Document> snapshotsCollection) Ensure that the correct indexes are in place.
protected Stream<? extends DomainEventData<?>>	extractEvents(org.bson.Document object) Retrieves event data from the given Mongo object.
protected DomainEventData<?>	extractSnapshot(org.bson.Document object) Retrieves snapshot event data from the given Mongo object.

Methods inherited from class org.axonframework.mongo.eventsourcing.eventstore.AbstractMongoEventStorageStrategy

appendEvents, appendSnapshot, deleteSnapshots, eventConfiguration, findDomainEvents, findLastSnapshot, findTrackedEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentPerCommitStorageStrategy

public DocumentPerCommitStorageStrategy()

Initializes a DocumentPerCommitStorageStrategy with default event entry and commit entry configuration.

DocumentPerCommitStorageStrategy

public DocumentPerCommitStorageStrategy(CommitEntryConfiguration commitEntryConfiguration)

Initializes a DocumentPerCommitStorageStrategy with default event entry and given commitEntryConfiguration.

Parameters:

commitEntryConfiguration - object that configures the naming of commit entry properties

DocumentPerCommitStorageStrategy

public DocumentPerCommitStorageStrategy(EventEntryConfiguration eventConfiguration,
                                        CommitEntryConfiguration commitEntryConfiguration,
                                        Duration lookBackTime)

Initializes a DocumentPerCommitStorageStrategy with given eventConfiguration and commitEntryConfiguration.

Parameters:

eventConfiguration - object that configures the naming of event entry properties

commitEntryConfiguration - object that configures the naming of event entry properties

lookBackTime - the maximum time to look back when fetching new events while tracking.

Method Detail

createEventDocuments

protected Stream<org.bson.Document> createEventDocuments(List<? extends EventMessage<?>> events,
                                                         Serializer serializer)

Description copied from class: AbstractMongoEventStorageStrategy

Returns a stream of Mongo documents that represent the given batch of events. The given list of events represents events produced in the context of a single unit of work. Uses the given serializer to serialize event payload and metadata.

Specified by:

createEventDocuments in class AbstractMongoEventStorageStrategy

Parameters:

events - the events to convert to Mongo documents

serializer - the serializer to convert the events' payload and metadata

Returns:

stream of Mongo documents from the given event batch

createSnapshotDocument

protected org.bson.Document createSnapshotDocument(DomainEventMessage<?> snapshot,
                                                   Serializer serializer)

Description copied from class: AbstractMongoEventStorageStrategy

Returns a Mongo document for given snapshot event. Uses the given serializer to serialize event payload and metadata.

Specified by:

createSnapshotDocument in class AbstractMongoEventStorageStrategy

Parameters:

snapshot - the snapshot to convert

serializer - the to convert the snapshot's payload and metadata

Returns:

a Mongo documents from given snapshot

extractEvents

protected Stream<? extends DomainEventData<?>> extractEvents(org.bson.Document object)

Description copied from class: AbstractMongoEventStorageStrategy

Retrieves event data from the given Mongo object.

Specified by:

extractEvents in class AbstractMongoEventStorageStrategy

Parameters:

object - the object to convert to event data

Returns:

stream of events from given document

extractSnapshot

protected DomainEventData<?> extractSnapshot(org.bson.Document object)

Description copied from class: AbstractMongoEventStorageStrategy

Retrieves snapshot event data from the given Mongo object.

Specified by:

extractSnapshot in class AbstractMongoEventStorageStrategy

Parameters:

object - the object to convert to snapshot data

Returns:

snapshot data contained in given document

ensureIndexes

public void ensureIndexes(com.mongodb.client.MongoCollection<org.bson.Document> eventsCollection,
                          com.mongodb.client.MongoCollection<org.bson.Document> snapshotsCollection)

Description copied from interface: StorageStrategy

Ensure that the correct indexes are in place.

Specified by:

ensureIndexes in interface StorageStrategy

Overrides:

ensureIndexes in class AbstractMongoEventStorageStrategy

Parameters:

eventsCollection - The collection containing the documents representing commits and events.

snapshotsCollection - The collection containing the document representing snapshots