org.axonframework.eventstore.mongo

Class MongoEventStore

java.lang.Object

org.axonframework.eventstore.mongo.MongoEventStore

All Implemented Interfaces:

org.axonframework.eventstore.EventStore, org.axonframework.eventstore.management.EventStoreManagement, org.axonframework.eventstore.PartialStreamSupport, org.axonframework.eventstore.SnapshotEventStore, org.axonframework.upcasting.UpcasterAware

public class MongoEventStore
extends Object
implements org.axonframework.eventstore.SnapshotEventStore, org.axonframework.eventstore.management.EventStoreManagement, org.axonframework.upcasting.UpcasterAware, org.axonframework.eventstore.PartialStreamSupport

Implementation of the EventStore based on a MongoDB instance or replica set. Sharding and pairing are not explicitly supported.

This event store implementation needs a serializer as well as a MongoTemplate to interact with the mongo database.

Warning: This implementation is still in progress and may be subject to alterations. The implementation works, but has not been optimized to fully leverage MongoDB's features, yet.

Since:

2.0 (in incubator since 0.7)

Author:

Jettro Coenradie

Constructor Summary

Constructors

Constructor and Description
MongoEventStore(MongoTemplate mongo) Constructor that uses the default Serializer.
MongoEventStore(MongoTemplate mongoTemplate, org.axonframework.serializer.Serializer eventSerializer, StorageStrategy storageStrategy) Initialize the mongo event store with given mongoTemplate, eventSerializer and storageStrategy.
MongoEventStore(MongoTemplate mongoTemplate, StorageStrategy storageStrategy) Constructor that accepts a MongoTemplate and a custom StorageStrategy.
MongoEventStore(org.axonframework.serializer.Serializer eventSerializer, MongoTemplate mongo) Constructor that accepts a Serializer and the MongoTemplate.

Method Summary

Methods

Modifier and Type	Method and Description
void	appendEvents(String type, org.axonframework.domain.DomainEventStream events)
void	appendSnapshotEvent(String type, org.axonframework.domain.DomainEventMessage snapshotEvent)
void	ensureIndexes() Make sure an index is created on the collection that stores domain events.
MongoCriteriaBuilder	newCriteriaBuilder()
org.axonframework.domain.DomainEventStream	readEvents(String type, Object identifier)
org.axonframework.domain.DomainEventStream	readEvents(String type, Object identifier, long firstSequenceNumber)
org.axonframework.domain.DomainEventStream	readEvents(String type, Object identifier, long firstSequenceNumber, long lastSequenceNumber)
void	setUpcasterChain(org.axonframework.upcasting.UpcasterChain upcasterChain)
void	visitEvents(org.axonframework.eventstore.management.Criteria criteria, org.axonframework.eventstore.EventVisitor visitor)
void	visitEvents(org.axonframework.eventstore.EventVisitor visitor)

Methods inherited from class java.lang.Object

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

Constructor Detail

MongoEventStore

public MongoEventStore(org.axonframework.serializer.Serializer eventSerializer,
               MongoTemplate mongo)

Constructor that accepts a Serializer and the MongoTemplate. A Document-Per-Event storage strategy is used, causing each event to be stored in a separate Mongo Document.

Note: the SerializedType of Message Meta Data is not stored. Upon retrieval, it is set to the default value (name = "org.axonframework.domain.MetaData", revision = null). See SerializedMetaData.isSerializedMetaData(org.axonframework.serializer.SerializedObject)

Parameters:

eventSerializer - Your own Serializer

mongo - Mongo instance to obtain the database and the collections.

MongoEventStore

public MongoEventStore(MongoTemplate mongo)

Constructor that uses the default Serializer. A Document-Per-Event storage strategy is used, causing each event to be stored in a separate Mongo Document.

Parameters:

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

MongoEventStore

public MongoEventStore(MongoTemplate mongoTemplate,
               StorageStrategy storageStrategy)

Constructor that accepts a MongoTemplate and a custom StorageStrategy.

Parameters:

mongoTemplate - The template giving access to the required collections

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

MongoEventStore

public MongoEventStore(MongoTemplate mongoTemplate,
               org.axonframework.serializer.Serializer eventSerializer,
               StorageStrategy storageStrategy)

Initialize the mongo event store with given mongoTemplate, eventSerializer and storageStrategy.

Parameters:

mongoTemplate - The template giving access to the required collections

eventSerializer - The serializer to serialize events with

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

Method Detail

ensureIndexes

@PostConstruct
public void ensureIndexes()

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

appendEvents

public void appendEvents(String type,
                org.axonframework.domain.DomainEventStream events)

Specified by:

appendEvents in interface org.axonframework.eventstore.EventStore

readEvents

public org.axonframework.domain.DomainEventStream readEvents(String type,
                                                    Object identifier)

Specified by:

readEvents in interface org.axonframework.eventstore.EventStore

readEvents

public org.axonframework.domain.DomainEventStream readEvents(String type,
                                                    Object identifier,
                                                    long firstSequenceNumber)

Specified by:

readEvents in interface org.axonframework.eventstore.PartialStreamSupport

readEvents

public org.axonframework.domain.DomainEventStream readEvents(String type,
                                                    Object identifier,
                                                    long firstSequenceNumber,
                                                    long lastSequenceNumber)

Specified by:

readEvents in interface org.axonframework.eventstore.PartialStreamSupport

appendSnapshotEvent

public void appendSnapshotEvent(String type,
                       org.axonframework.domain.DomainEventMessage snapshotEvent)

Specified by:

appendSnapshotEvent in interface org.axonframework.eventstore.SnapshotEventStore

visitEvents

public void visitEvents(org.axonframework.eventstore.EventVisitor visitor)

Specified by:

visitEvents in interface org.axonframework.eventstore.management.EventStoreManagement

visitEvents

public void visitEvents(org.axonframework.eventstore.management.Criteria criteria,
               org.axonframework.eventstore.EventVisitor visitor)

Specified by:

visitEvents in interface org.axonframework.eventstore.management.EventStoreManagement

newCriteriaBuilder

public MongoCriteriaBuilder newCriteriaBuilder()

Specified by:

newCriteriaBuilder in interface org.axonframework.eventstore.management.EventStoreManagement

setUpcasterChain

public void setUpcasterChain(org.axonframework.upcasting.UpcasterChain upcasterChain)

Specified by:

setUpcasterChain in interface org.axonframework.upcasting.UpcasterAware