org.axonframework.modelling.saga.repository

Class AnnotatedSagaRepository<T>

java.lang.Object

org.axonframework.modelling.saga.repository.LockingSagaRepository<T>

org.axonframework.modelling.saga.repository.AnnotatedSagaRepository<T>

Type Parameters:

T - generic type specifying the Saga type stored by this SagaRepository

All Implemented Interfaces:

SagaRepository<T>

public class AnnotatedSagaRepository<T>
extends LockingSagaRepository<T>

SagaRepository implementation extending from the LockingSagaRepository dealing with annotated Sagas. Will take care of the uniqueness of Saga instances in the JVM. That means it will prevent multiple instances of the same conceptual Saga (i.e. with same identifier) to exist within the JVM.

Since:

0.7

Author:

Allard Buijze

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnnotatedSagaRepository.Builder<T> Builder class to instantiate a AnnotatedSagaRepository.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnnotatedSagaRepository(AnnotatedSagaRepository.Builder<T> builder) Instantiate a AnnotatedSagaRepository based on the fields contained in the AnnotatedSagaRepository.Builder.

Method Summary

Modifier and Type	Method and Description
static <T> AnnotatedSagaRepository.Builder<T>	builder() Instantiate a Builder to be able to create an AnnotatedSagaRepository.
protected void	commit(AnnotatedSaga<T> saga) Commits the given modified saga to the underlying saga store.
protected void	deleteSaga(AnnotatedSaga<T> saga) Remove the given saga as well as all known association values pointing to it from the repository.
AnnotatedSaga<T>	doCreateInstance(String sagaIdentifier, Supplier<T> sagaFactory) Creates a new Saga instance.
AnnotatedSaga<T>	doLoad(String sagaIdentifier) Loads a known Saga instance by its unique identifier.
protected AnnotatedSaga<T>	doLoadSaga(String sagaIdentifier) Loads the saga with given sagaIdentifier from the underlying saga store and returns it as a AnnotatedSaga.
Set<String>	find(AssociationValue associationValue) Find saga instances of the given type that have been associated with the given associationValue.
protected void	storeSaga(AnnotatedSaga<T> saga) Stores a newly created Saga instance.
protected Set<String>	unsavedSagaResource(UnitOfWork<?> unitOfWork) Returns a set of identifiers of sagas that may have changed in the context of the given unitOfWork and have not been saved yet.
protected void	updateSaga(AnnotatedSaga<T> saga) Update a stored Saga, by replacing it with the given saga instance.

Methods inherited from class org.axonframework.modelling.saga.repository.LockingSagaRepository

createInstance, load

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedSagaRepository

protected AnnotatedSagaRepository(AnnotatedSagaRepository.Builder<T> builder)

Instantiate a AnnotatedSagaRepository based on the fields contained in the AnnotatedSagaRepository.Builder.

Will assert that the sagaType, SagaStore and ResourceInjector are not null, and will throw an AxonConfigurationException if any of them is null. Additionally, the provided builder's goal is to either build a SagaModel specifying generic T as the Saga type to be stored or derive it based on the given sagaType. The same argument applies to the MessageHandlerInterceptorMemberChain. All Sagas in this repository must be instanceOf this saga type.

Parameters:

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

Method Detail

builder

public static <T> AnnotatedSagaRepository.Builder<T> builder()

Instantiate a Builder to be able to create an AnnotatedSagaRepository.

The ResourceInjector is defaulted to a NoResourceInjector. This Builder either allows directly setting a SagaModel of generic type T, or it will generate it based of the required sagaType field of type Class. Same for the MessageHandlerInterceptorMemberChain Thus, either the SagaModel or the sagaType should be provided. All Saga in this repository must be instanceOf this saga type. Additionally, the sagaType and SagaStore are hard requirements and as such should be provided.

Type Parameters:

T - a generic specifying the Saga type contained in this SagaRepository implementation

Returns:

a Builder to be able to create a AnnotatedSagaRepository

doLoad

public AnnotatedSaga<T> doLoad(String sagaIdentifier)

Description copied from class: LockingSagaRepository

Loads a known Saga instance by its unique identifier. Due to the concurrent nature of Sagas, it is not unlikely for a Saga to have ceased to exist after it has been found based on associations. Therefore, a repository should return null in case a Saga doesn't exists, as opposed to throwing an exception.

Specified by:

doLoad in class LockingSagaRepository<T>

Parameters:

sagaIdentifier - The unique identifier of the Saga to load

Returns:

The Saga instance, or null if no such saga exists

doCreateInstance

public AnnotatedSaga<T> doCreateInstance(String sagaIdentifier,
                                         Supplier<T> sagaFactory)

Description copied from class: LockingSagaRepository

Creates a new Saga instance. The returned Saga will delegate event handling to the instance supplied by the given factoryMethod.

Specified by:

doCreateInstance in class LockingSagaRepository<T>

Parameters:

sagaIdentifier - the identifier to use for the new saga instance

sagaFactory - Used to create a new Saga delegate

Returns:

a new Saga instance wrapping an instance of type T

unsavedSagaResource

protected Set<String> unsavedSagaResource(UnitOfWork<?> unitOfWork)

Returns a set of identifiers of sagas that may have changed in the context of the given unitOfWork and have not been saved yet.

Parameters:

unitOfWork - the unit of work to inspect for unsaved sagas

Returns:

set of saga identifiers of unsaved sagas

commit

protected void commit(AnnotatedSaga<T> saga)

Commits the given modified saga to the underlying saga store. If the saga is not active anymore it will be deleted. Otherwise the stored saga and its associations will be updated.

Parameters:

saga - the saga to commit to the store

find

public Set<String> find(AssociationValue associationValue)

Description copied from interface: SagaRepository

Find saga instances of the given type that have been associated with the given associationValue.

Parameters:

associationValue - The value that the returned Sagas must be associated with

Returns:

A Set containing the found Saga instances. If none are found, an empty Set is returned. Will never return null.

deleteSaga

protected void deleteSaga(AnnotatedSaga<T> saga)

Remove the given saga as well as all known association values pointing to it from the repository. If no such saga exists, nothing happens.

Parameters:

saga - The saga instance to remove from the repository

updateSaga

protected void updateSaga(AnnotatedSaga<T> saga)

Update a stored Saga, by replacing it with the given saga instance.

Parameters:

saga - The saga that has been modified and needs to be updated in the storage

storeSaga

protected void storeSaga(AnnotatedSaga<T> saga)

Stores a newly created Saga instance.

Parameters:

saga - The newly created Saga instance to store.

doLoadSaga

protected AnnotatedSaga<T> doLoadSaga(String sagaIdentifier)

Loads the saga with given sagaIdentifier from the underlying saga store and returns it as a AnnotatedSaga. Resources of the saga will be injected using the ResourceInjector configured with the repository.

Parameters:

sagaIdentifier - the identifier of the saga to load

Returns:

AnnotatedSaga instance with the loaded saga