org.axonframework.mongo.eventhandling.saga.repository

Class SagaEntry<T>

java.lang.Object

org.axonframework.mongo.eventhandling.saga.repository.SagaEntry<T>

public class SagaEntry<T>
extends Object

Java representation of sagas stored in a mongo instance

Since:

2.0

Author:

Jettro Coenradie

Constructor Summary

Constructors

Constructor and Description
SagaEntry(org.bson.Document dbSaga) Initializes a Saga entry using a DBObject containing the Mongo Document
SagaEntry(String identifier, T saga, Set<AssociationValue> associationValues, Serializer serializer) Constructs a new SagaEntry for the given saga.

Method Summary

Modifier and Type	Method and Description
org.bson.Document	asDocument() Returns the Mongo Document representing the Saga provided in this entry.
Set<AssociationValue>	getAssociationValues() Get a set of all the Saga's associations.
T	getSaga(Serializer serializer) Returns the Saga instance stored in this entry.
String	getSagaId() Get the identifier of this Saga.
static org.bson.conversions.Bson	queryByIdentifier(String identifier) Returns the Mongo Query to find a Saga based on its identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

SagaEntry

public SagaEntry(String identifier,
                 T saga,
                 Set<AssociationValue> associationValues,
                 Serializer serializer)

Constructs a new SagaEntry for the given saga. The given saga must be serializable. The provided saga is not modified by this operation.

Parameters:

identifier - The identifier of the saga

saga - The saga to store

associationValues - The associations of the saga

serializer - The serialization mechanism to convert the Saga to a byte stream

SagaEntry

public SagaEntry(org.bson.Document dbSaga)

Initializes a Saga entry using a DBObject containing the Mongo Document

Parameters:

dbSaga - The mongo Document containing the serialized saga

Method Detail

getSaga

public T getSaga(Serializer serializer)

Returns the Saga instance stored in this entry.

Parameters:

serializer - The serializer to decode the Saga

Returns:

the Saga instance stored in this entry

getSagaId

public String getSagaId()

Get the identifier of this Saga.

Returns:

the saga identifier

getAssociationValues

public Set<AssociationValue> getAssociationValues()

Get a set of all the Saga's associations.

Returns:

association values of this Saga

asDocument

public org.bson.Document asDocument()

Returns the Mongo Document representing the Saga provided in this entry.

Returns:

the Mongo Document representing the Saga provided in this entry

queryByIdentifier

public static org.bson.conversions.Bson queryByIdentifier(String identifier)

Returns the Mongo Query to find a Saga based on its identifier.

Parameters:

identifier - The identifier of the saga to find

Returns:

the Query (as DBObject) to find a Saga in a Mongo Database