org.axonframework.config

Class SagaConfiguration<S>

java.lang.Object

org.axonframework.config.SagaConfiguration<S>

All Implemented Interfaces:

ModuleConfiguration

public class SagaConfiguration<S>
extends Object
implements ModuleConfiguration

Module Configuration implementation that defines a Saga. This component allows the configuration of the type of Event Processor used, as well as where to store Saga instances.

Method Summary

Modifier and Type	Method and Description
SagaConfiguration<S>	configureErrorHandler(Function<Configuration,ErrorHandler> errorHandler) Configures the ErrorHandler to use when an error occurs processing an Event.
SagaConfiguration<S>	configureMessageMonitor(Function<Configuration,MessageMonitor<? super EventMessage<?>>> messageMonitor) Configures a MessageMonitor to be used to monitor Events processed on by the Saga being configured.
SagaConfiguration<S>	configureRollbackConfiguration(Function<Configuration,RollbackConfiguration> rollbackConfiguration) Defines the policy to roll back or commit a Unit of Work in case exceptions occur.
SagaConfiguration<S>	configureSagaStore(Function<Configuration,SagaStore<? super S>> sagaStoreBuilder) Configures the Saga Store to use to store Saga instances of this type.
SagaConfiguration<S>	configureTokenStore(Function<Configuration,TokenStore> tokenStore) Registers the given tokenStore for use by a TrackingProcessor for the Saga being configured.
SagaConfiguration<S>	configureTrackingProcessor(Function<Configuration,TrackingEventProcessorConfiguration> trackingEventProcessorConfiguration) Registers the TrackingEventProcessorConfiguration to use when building the processor for this Saga type.
SagaConfiguration<S>	configureTransactionManager(Function<Configuration,TransactionManager> transactionManager) Defines the Transaction Manager to use when processing Events for this Saga.
EventProcessor	getProcessor() Returns the processor that processed events for the Saga in this Configuration.
AnnotatedSagaManager<S>	getSagaManager() Returns the SagaManager responsible for managing the lifecycle and invocation of Saga instances of the type defined in this Configuration
SagaRepository<S>	getSagaRepository() Returns the SagaRepository instance used to load Saga instances in this Configuration.
SagaStore<? super S>	getSagaStore() Returns the Saga Store used by the Saga defined in this Configuration.
void	initialize(Configuration config) Initialize the module configuration using the given global config
SagaConfiguration<S>	registerHandlerInterceptor(Function<Configuration,MessageHandlerInterceptor<? super EventMessage<?>>> handlerInterceptorBuilder) Registers the handler interceptor provided by the given handlerInterceptorBuilder function with the processor defined in this configuration.
void	shutdown() Invoked prior to shutdown of the application.
void	start() Invoked when the Configuration is started.
static <S> SagaConfiguration<S>	subscribingSagaManager(Class<S> sagaType) Initialize a configuration for a Saga of given sagaType, using a Subscribing Event Processor to process incoming Events.
static <S> SagaConfiguration<S>	subscribingSagaManager(Class<S> sagaType, Function<Configuration,SubscribableMessageSource<EventMessage<?>>> messageSourceBuilder) Initialize a configuration for a Saga of given sagaType, using a Subscribing Event Processor to process incoming Events from the message source provided by given messageSourceBuilder
static <S> SagaConfiguration<S>	subscribingSagaManager(Class<S> sagaType, Function<Configuration,SubscribableMessageSource<EventMessage<?>>> messageSourceBuilder, Function<Configuration,EventProcessingStrategy> eventProcessingStrategy) Initialize a configuration for a Saga of given sagaType, using a Subscribing Event Processor to process incoming Events from the message source provided by given messageSourceBuilder.
static <S> SagaConfiguration<S>	trackingSagaManager(Class<S> sagaType) Initialize a configuration for a Saga of given sagaType, using a Tracking Event Processor to process incoming Events.
static <S> SagaConfiguration<S>	trackingSagaManager(Class<S> sagaType, Function<Configuration,StreamableMessageSource<TrackedEventMessage<?>>> messageSourceBuilder) Initialize a configuration for a Saga of given sagaType, using a Tracking Event Processor to process incoming Events from a Message Source provided by given messageSourceBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

subscribingSagaManager

public static <S> SagaConfiguration<S> subscribingSagaManager(Class<S> sagaType)

Initialize a configuration for a Saga of given sagaType, using a Subscribing Event Processor to process incoming Events.

Type Parameters:

S - The type of Saga configured in this configuration

Parameters:

sagaType - The type of Saga to handle events with

Returns:

a SagaConfiguration instance, ready for further configuration

subscribingSagaManager

public static <S> SagaConfiguration<S> subscribingSagaManager(Class<S> sagaType,
                                                              Function<Configuration,SubscribableMessageSource<EventMessage<?>>> messageSourceBuilder)

Initialize a configuration for a Saga of given sagaType, using a Subscribing Event Processor to process incoming Events from the message source provided by given messageSourceBuilder

Type Parameters:

S - The type of Saga configured in this configuration

Parameters:

sagaType - The type of Saga to handle events with

messageSourceBuilder - The function providing the message source based on the configuration

Returns:

a SagaConfiguration instance, ready for further configuration

subscribingSagaManager

public static <S> SagaConfiguration<S> subscribingSagaManager(Class<S> sagaType,
                                                              Function<Configuration,SubscribableMessageSource<EventMessage<?>>> messageSourceBuilder,
                                                              Function<Configuration,EventProcessingStrategy> eventProcessingStrategy)

Initialize a configuration for a Saga of given sagaType, using a Subscribing Event Processor to process incoming Events from the message source provided by given messageSourceBuilder.

This methods allows a custom EventProcessingStrategy to be provided, in case handlers shouldn't be invoked in the thread that delivers the message.

Type Parameters:

S - The type of Saga configured in this configuration

Parameters:

sagaType - The type of Saga to handle events with

messageSourceBuilder - The function providing the message source based on the configuration

eventProcessingStrategy - The strategy to use to invoke the event handlers.

Returns:

a SagaConfiguration instance, ready for further configuration

trackingSagaManager

public static <S> SagaConfiguration<S> trackingSagaManager(Class<S> sagaType)

Initialize a configuration for a Saga of given sagaType, using a Tracking Event Processor to process incoming Events. Note that a Token Store should be configured in the global configuration, or the Saga Manager will default to an in-memory token store, which is not recommended for production environments.

Type Parameters:

S - The type of Saga configured in this configuration

Parameters:

sagaType - The type of Saga to handle events with

Returns:

a SagaConfiguration instance, ready for further configuration

trackingSagaManager

public static <S> SagaConfiguration<S> trackingSagaManager(Class<S> sagaType,
                                                           Function<Configuration,StreamableMessageSource<TrackedEventMessage<?>>> messageSourceBuilder)

Initialize a configuration for a Saga of given sagaType, using a Tracking Event Processor to process incoming Events from a Message Source provided by given messageSourceBuilder. Note that a Token Store should be configured in the global configuration, or the Saga Manager will default to an in-memory token store, which is not recommended for production environments.

Type Parameters:

S - The type of Saga configured in this configuration

Parameters:

sagaType - The type of Saga to handle events with

messageSourceBuilder - The function providing the message source based on the configuration

Returns:

a SagaConfiguration instance, ready for further configuration

configureSagaStore

public SagaConfiguration<S> configureSagaStore(Function<Configuration,SagaStore<? super S>> sagaStoreBuilder)

Configures the Saga Store to use to store Saga instances of this type. By default, Sagas are stored in the Saga Store configured in the global Configuration. This method can be used to override the store for specific Sagas.

Parameters:

sagaStoreBuilder - The builder that returns a fully initialized Saga Store instance based on the global Configuration

Returns:

this SagaConfiguration instance, ready for further configuration

registerHandlerInterceptor

public SagaConfiguration<S> registerHandlerInterceptor(Function<Configuration,MessageHandlerInterceptor<? super EventMessage<?>>> handlerInterceptorBuilder)

Registers the handler interceptor provided by the given handlerInterceptorBuilder function with the processor defined in this configuration.

Parameters:

handlerInterceptorBuilder - The function to create the interceptor based on the current configuration

Returns:

this SagaConfiguration instance, ready for further configuration

configureTrackingProcessor

public SagaConfiguration<S> configureTrackingProcessor(Function<Configuration,TrackingEventProcessorConfiguration> trackingEventProcessorConfiguration)

Registers the TrackingEventProcessorConfiguration to use when building the processor for this Saga type.

Note that the provided configuration is ignored when a subscribing processor is being used.

Parameters:

trackingEventProcessorConfiguration - The function to create the configuration instance

Returns:

this SagaConfiguration instance, ready for further configuration

configureTokenStore

public SagaConfiguration<S> configureTokenStore(Function<Configuration,TokenStore> tokenStore)

Registers the given tokenStore for use by a TrackingProcessor for the Saga being configured. The TokenStore is ignored when a Subscribing Processor has been configured.

Parameters:

tokenStore - The function returning a TokenStore based on the given Configuration

Returns:

this SagaConfiguration instance, ready for further configuration

configureErrorHandler

public SagaConfiguration<S> configureErrorHandler(Function<Configuration,ErrorHandler> errorHandler)

Configures the ErrorHandler to use when an error occurs processing an Event.

The default is to propagate errors, causing the processors to release their token and go into a retry loop.

Parameters:

errorHandler - The function to create the ErrorHandler

Returns:

this SagaConfiguration instance, ready for further configuration

configureRollbackConfiguration

public SagaConfiguration<S> configureRollbackConfiguration(Function<Configuration,RollbackConfiguration> rollbackConfiguration)

Defines the policy to roll back or commit a Unit of Work in case exceptions occur.

Defaults to roll back on all exceptions.

Parameters:

rollbackConfiguration - The function providing the RollbackConfiguration to use

Returns:

this SagaConfiguration instance, ready for further configuration

configureTransactionManager

public SagaConfiguration<S> configureTransactionManager(Function<Configuration,TransactionManager> transactionManager)

Defines the Transaction Manager to use when processing Events for this Saga. Typically, this transaction manager will manage the transaction around storing of the tokens and Saga instances.

Defaults to the Transaction Manager defined in the main Configuration.

Parameters:

transactionManager - The function providing the TransactionManager to use

Returns:

this SagaConfiguration instance, ready for further configuration

configureMessageMonitor

public SagaConfiguration<S> configureMessageMonitor(Function<Configuration,MessageMonitor<? super EventMessage<?>>> messageMonitor)

Configures a MessageMonitor to be used to monitor Events processed on by the Saga being configured.

Parameters:

messageMonitor - The function to create the MessageMonitor

Returns:

this SagaConfiguration instance, ready for further configuration

initialize

public void initialize(Configuration config)

Description copied from interface: ModuleConfiguration

Initialize the module configuration using the given global config

Specified by:

initialize in interface ModuleConfiguration

Parameters:

config - the global configuration, providing access to generic components

start

public void start()

Description copied from interface: ModuleConfiguration

Invoked when the Configuration is started.

Specified by:

start in interface ModuleConfiguration

See Also:

Configuration.start()

getProcessor

public EventProcessor getProcessor()

Returns the processor that processed events for the Saga in this Configuration.

Returns:

The EventProcessor defined in this Configuration

Throws:

IllegalStateException - when this configuration hasn't been initialized yet

getSagaStore

public SagaStore<? super S> getSagaStore()

Returns the Saga Store used by the Saga defined in this Configuration. If none has been explicitly defined, it will return the Saga Store of the main Configuration.

Returns:

The Saga Store defined in this Configuration

Throws:

IllegalStateException - when this configuration hasn't been initialized yet

getSagaRepository

public SagaRepository<S> getSagaRepository()

Returns the SagaRepository instance used to load Saga instances in this Configuration.

Returns:

the SagaRepository defined in this Configuration

Throws:

IllegalStateException - when this configuration hasn't been initialized yet

getSagaManager

public AnnotatedSagaManager<S> getSagaManager()

Returns the SagaManager responsible for managing the lifecycle and invocation of Saga instances of the type defined in this Configuration

Returns:

The SagaManager defined in this configuration

Throws:

IllegalStateException - when this configuration hasn't been initialized yet

shutdown

public void shutdown()

Description copied from interface: ModuleConfiguration

Invoked prior to shutdown of the application.

Specified by:

shutdown in interface ModuleConfiguration

See Also:

Configuration.shutdown()