org.axonframework.eventhandling.saga

Class AbstractSagaManager<T>

java.lang.Object

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

All Implemented Interfaces:

EventHandlerInvoker, MessageHandler<EventMessage<?>>

Direct Known Subclasses:

AnnotatedSagaManager

public abstract class AbstractSagaManager<T>
extends Object
implements EventHandlerInvoker

Abstract implementation of the SagaManager interface that provides basic functionality required by most SagaManager implementations. Provides support for Saga lifecycle management and asynchronous handling of events.

Since:

0.7

Author:

Allard Buijze

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSagaManager(Class<T> sagaType, SagaRepository<T> sagaRepository, Supplier<T> sagaFactory) Initializes the SagaManager with the given sagaRepository.

Method Summary

Modifier and Type	Method and Description
protected abstract Set<AssociationValue>	extractAssociationValues(EventMessage<?> event) Extracts the AssociationValues from the given event as relevant for a Saga of given sagaType.
protected abstract SagaInitializationPolicy	getSagaCreationPolicy(EventMessage<?> event) Returns the Saga Initialization Policy for a Saga of the given sagaType and event.
Class<T>	getSagaType() Returns the class of Saga managed by this SagaManager
Object	handle(EventMessage<?> event) Handles the given message.
void	setSuppressExceptions(boolean suppressExceptions) Sets whether or not to suppress any exceptions that are cause by invoking Sagas.

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

hasHandler

Constructor Detail

AbstractSagaManager

protected AbstractSagaManager(Class<T> sagaType,
                              SagaRepository<T> sagaRepository,
                              Supplier<T> sagaFactory)

Initializes the SagaManager with the given sagaRepository.

Parameters:

sagaType - The type of Saga Managed by this instance

sagaRepository - The repository providing the saga instances.

sagaFactory - The factory responsible for creating new Saga instances

Method Detail

handle

public Object handle(EventMessage<?> event)
              throws Exception

Description copied from interface: MessageHandler

Handles the given message.

Specified by:

handle in interface MessageHandler<EventMessage<?>>

Parameters:

event - The message to be processed.

Returns:

The result of the message processing.

Throws:

Exception - any exception that occurs during message handling

getSagaCreationPolicy

protected abstract SagaInitializationPolicy getSagaCreationPolicy(EventMessage<?> event)

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.

Parameters:

event - The Event that is being dispatched to Saga instances

Returns:

the initialization policy for the Saga

extractAssociationValues

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

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

Parameters:

event - The event containing the association information

Returns:

the AssociationValues indicating which Sagas should handle given event

setSuppressExceptions

public void setSuppressExceptions(boolean suppressExceptions)

Sets whether or not to suppress any exceptions that are cause by invoking Sagas. When suppressed, exceptions are logged. Defaults to true.

Parameters:

suppressExceptions - whether or not to suppress exceptions from Sagas.

getSagaType

public Class<T> getSagaType()

Returns the class of Saga managed by this SagaManager

Returns:

the managed saga type