Package org.axonframework.modelling.saga

Class AnnotatedSagaManager<T>

java.lang.Object

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

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

Type Parameters:

T - The type of Saga managed by this instance

All Implemented Interfaces:

org.axonframework.eventhandling.EventHandlerInvoker, org.axonframework.messaging.ScopeAware

public class AnnotatedSagaManager<T>
extends AbstractSagaManager<T>

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

Since:

0.7

Author:

Allard Buijze

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static <T> AnnotatedSagaManager.Builder<T>	builder()	Instantiate a Builder to be able to create a AnnotatedSagaManager.
boolean	canHandle(org.axonframework.eventhandling.EventMessage<?> eventMessage, org.axonframework.eventhandling.Segment segment)
protected Set<AssociationValue>	extractAssociationValues(org.axonframework.eventhandling.EventMessage<?> event)	Extracts the AssociationValues from the given event as relevant for a Saga of given sagaType.
protected SagaInitializationPolicy	getSagaCreationPolicy(org.axonframework.eventhandling.EventMessage<?> event)	Returns the Saga Initialization Policy for a Saga of the given sagaType and event.

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

canResolve, createSagaIdentifier, getSagaType, handle, matchesSegment, performReset, performReset, send, 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

canHandleType, segmentReleased

Constructor Details

AnnotatedSagaManager

protected AnnotatedSagaManager(AnnotatedSagaManager.Builder<T> builder)

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

The sagaFactory is defaulted to a sagaType.newInstance() call throwing a SagaInstantiationException if it fails, the SagaManagerSpanFactory defaults to a DefaultSagaManagerSpanFactory backed by a NoOpSpanFactory, and the ListenerInvocationErrorHandler is defaulted to a LoggingErrorHandler. The SagaRepository and sagaType are hard requirements and as such should be provided.

Will assert that the SagaRepository, sagaType, sagaFactory and ListenerInvocationErrorHandler 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. All Sagas managed by this Saga manager must be instanceOf this Saga type.

Parameters:

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

Method Details

builder

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

Instantiate a Builder to be able to create a AnnotatedSagaManager.

The sagaFactory is defaulted to a sagaType.newInstance() call throwing a SagaInstantiationException if it fails, the ListenerInvocationErrorHandler is defaulted to a LoggingErrorHandler and the SagaManagerSpanFactory is defaulted to a DefaultSagaManagerSpanFactory backed by a NoOpSpanFactory.

This Builder either allows directly setting a SagaModel of generic type T, or it will generate one based of the required sagaType field of type Class. Thus, either the SagaModel or the sagaType should be provided. All Sagas managed by this instances must be instanceOf this saga type. Additionally, the SagaRepository and sagaType are hard requirements and as such should be provided.

Type Parameters:

T - a generic specifying the Saga type managed by this AbstractSagaManager implementation

Returns:

a Builder to be able to create a AnnotatedSagaManager

canHandle

public boolean canHandle(@Nonnull
 org.axonframework.eventhandling.EventMessage<?> eventMessage,
 @Nonnull
 org.axonframework.eventhandling.Segment segment)

getSagaCreationPolicy

protected SagaInitializationPolicy getSagaCreationPolicy(org.axonframework.eventhandling.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(org.axonframework.eventhandling.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