org.axonframework.eventhandling.saga

Class AnnotatedSagaManager<T>

java.lang.Object

org.axonframework.eventhandling.saga.AbstractSagaManager<T>

org.axonframework.eventhandling.saga.AnnotatedSagaManager<T>

Type Parameters:

T - The type of Saga managed by this instance

All Implemented Interfaces:

EventHandlerInvoker, ScopeAware

public class AnnotatedSagaManager<T>
extends AbstractSagaManager<T>

Implementation of the SagaManager that uses annotations on the Sagas to describe the lifecycle management. Unlike the SimpleSagaManager, this implementation can manage several types of Saga in a single AnnotatedSagaManager.

Since:

0.7

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor and Description
AnnotatedSagaManager(Class<T> sagaType, SagaRepository<T> sagaRepository) Initialize the AnnotatedSagaManager using given repository to load sagas.
AnnotatedSagaManager(Class<T> sagaType, SagaRepository<T> sagaRepository, ParameterResolverFactory parameterResolverFactory, HandlerDefinition handlerDefinition, ListenerInvocationErrorHandler listenerInvocationErrorHandler) Initialize the AnnotatedSagaManager using given repository to load sagas.
AnnotatedSagaManager(Class<T> sagaType, SagaRepository<T> sagaRepository, ParameterResolverFactory parameterResolverFactory, ListenerInvocationErrorHandler listenerInvocationErrorHandler) Initialize the AnnotatedSagaManager using given repository to load sagas.
AnnotatedSagaManager(Class<T> sagaType, SagaRepository<T> sagaRepository, Supplier<T> sagaFactory) Initialize the AnnotatedSagaManager using given repository to load sagas and sagaFactory to create new sagas.
AnnotatedSagaManager(Class<T> sagaType, SagaRepository<T> sagaRepository, Supplier<T> sagaFactory, SagaModel<T> sagaMetaModel, ListenerInvocationErrorHandler listenerInvocationErrorHandler) Initialize the AnnotatedSagaManager using given repository to load sagas, the sagaFactory to create new sagas and the sagaMetaModel to delegate messages to the saga instances.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(EventMessage<?> eventMessage, Segment segment) Check whether or not this invoker has handlers that can handle the given eventMessage for a given segment.
protected Set<AssociationValue>	extractAssociationValues(EventMessage<?> event) Extracts the AssociationValues from the given event as relevant for a Saga of given sagaType.
protected SagaInitializationPolicy	getSagaCreationPolicy(EventMessage<?> event) Returns the Saga Initialization Policy for a Saga of the given sagaType and event.

Methods inherited from class org.axonframework.eventhandling.saga.AbstractSagaManager

canResolve, createSagaIdentifier, getSagaType, handle, matchesSegment, performReset, send, setSuppressExceptions, supportsReset

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.eventhandling.EventHandlerInvoker

handle

Constructor Detail

AnnotatedSagaManager

public AnnotatedSagaManager(Class<T> sagaType,
                            SagaRepository<T> sagaRepository)

Initialize the AnnotatedSagaManager using given repository to load sagas. To create a new saga this manager uses newInstance(Class). Uses a AnnotationSagaMetaModelFactory for the saga's meta model.

Parameters:

sagaType - the saga target type

sagaRepository - The repository providing access to the Saga instances

AnnotatedSagaManager

public AnnotatedSagaManager(Class<T> sagaType,
                            SagaRepository<T> sagaRepository,
                            ParameterResolverFactory parameterResolverFactory,
                            ListenerInvocationErrorHandler listenerInvocationErrorHandler)

Initialize the AnnotatedSagaManager using given repository to load sagas. To create a new saga this manager uses newInstance(Class). Uses a AnnotationSagaMetaModelFactory for the saga's meta model.

Parameters:

sagaType - The saga target type

sagaRepository - The repository providing access to the Saga instances

parameterResolverFactory - The ParameterResolverFactory instance to resolve parameter values for annotated handlers with

listenerInvocationErrorHandler - The error handler to invoke when an error occurs

AnnotatedSagaManager

public AnnotatedSagaManager(Class<T> sagaType,
                            SagaRepository<T> sagaRepository,
                            ParameterResolverFactory parameterResolverFactory,
                            HandlerDefinition handlerDefinition,
                            ListenerInvocationErrorHandler listenerInvocationErrorHandler)

Initialize the AnnotatedSagaManager using given repository to load sagas. To create a new saga this manager uses newInstance(Class). Uses a AnnotationSagaMetaModelFactory for the saga's meta model.

Parameters:

sagaType - The saga target type

sagaRepository - The repository providing access to the Saga instances

parameterResolverFactory - The ParameterResolverFactory instance to resolve parameter values for annotated handlers with

handlerDefinition - The handler definition used to create concrete handlers

listenerInvocationErrorHandler - The error handler to invoke when an error occurs

AnnotatedSagaManager

public AnnotatedSagaManager(Class<T> sagaType,
                            SagaRepository<T> sagaRepository,
                            Supplier<T> sagaFactory)

Initialize the AnnotatedSagaManager using given repository to load sagas and sagaFactory to create new sagas. Uses a AnnotationSagaMetaModelFactory for the saga's meta model.

Parameters:

sagaType - The saga target type

sagaRepository - The repository providing access to the Saga instances

sagaFactory - The factory for new saga instances of type T

AnnotatedSagaManager

public AnnotatedSagaManager(Class<T> sagaType,
                            SagaRepository<T> sagaRepository,
                            Supplier<T> sagaFactory,
                            SagaModel<T> sagaMetaModel,
                            ListenerInvocationErrorHandler listenerInvocationErrorHandler)

Initialize the AnnotatedSagaManager using given repository to load sagas, the sagaFactory to create new sagas and the sagaMetaModel to delegate messages to the saga instances.

Parameters:

sagaType - The saga target type

sagaRepository - The repository providing access to the Saga instances

sagaFactory - The factory for new saga instances of type T

sagaMetaModel - The meta model to delegate messages to a saga instance

listenerInvocationErrorHandler - The error handler to invoke when an error occurs

Method Detail

canHandle

public boolean canHandle(EventMessage<?> eventMessage,
                         Segment segment)

Description copied from interface: EventHandlerInvoker

Check whether or not this invoker has handlers that can handle the given eventMessage for a given segment.

Parameters:

eventMessage - The message to be processed

segment - The segment for which the event handler should be invoked

Returns:

true if the invoker has one or more handlers that can handle the given message, false otherwise

getSagaCreationPolicy

protected SagaInitializationPolicy getSagaCreationPolicy(EventMessage<?> event)

Description copied from class: AbstractSagaManager

Returns the Saga Initialization Policy for a Saga of the given sagaType and event. This policy provides the conditions to create new Saga instance, as well as the initial association of that saga.

Specified by:

getSagaCreationPolicy in class AbstractSagaManager<T>

Parameters:

event - The Event that is being dispatched to Saga instances

Returns:

the initialization policy for the Saga

extractAssociationValues

protected Set<AssociationValue> extractAssociationValues(EventMessage<?> event)

Description copied from class: AbstractSagaManager

Extracts the AssociationValues from the given event as relevant for a Saga of given sagaType. A single event may be associated with multiple values.

Specified by:

extractAssociationValues in class AbstractSagaManager<T>

Parameters:

event - The event containing the association information

Returns:

the AssociationValues indicating which Sagas should handle given event