org.axonframework.modelling.saga

Class AnnotatedSagaManager.Builder<T>

java.lang.Object

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

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

Type Parameters:

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

Enclosing class:

AnnotatedSagaManager<T>

public static class AnnotatedSagaManager.Builder<T>
extends AbstractSagaManager.Builder<T>

Builder class to instantiate a AnnotatedSagaManager.

The sagaFactory is defaulted to a sagaType.newInstance() call throwing a SagaInstantiationException if it fails, the SpanFactory defaults to a NoOpSpanFactory, and the ListenerInvocationErrorHandler is defaulted to a LoggingErrorHandler.

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.

Field Summary

Fields inherited from class org.axonframework.modelling.saga.AbstractSagaManager.Builder

sagaType

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AnnotatedSagaManager<T>	build() Initializes a AnnotatedSagaManager as specified through this Builder.
protected SagaModel<T>	buildSagaModel() Instantiate the SagaModel of generic type T describing the structure of the Saga this AbstractSagaManager implementation will manage.
AnnotatedSagaManager.Builder<T>	handlerDefinition(HandlerDefinition handlerDefinition) Sets the HandlerDefinition used to create concrete handlers for the given sagaType.
AnnotatedSagaManager.Builder<T>	listenerInvocationErrorHandler(ListenerInvocationErrorHandler listenerInvocationErrorHandler) Sets the ListenerInvocationErrorHandler invoked when an error occurs.
AnnotatedSagaManager.Builder<T>	parameterResolverFactory(ParameterResolverFactory parameterResolverFactory) Sets the ParameterResolverFactory used to resolve parameters for annotated handlers for the given sagaType.
AnnotatedSagaManager.Builder<T>	sagaFactory(Supplier<T> sagaFactory) Sets the sagaFactory of type Supplier responsible for creating new Saga instances.
AnnotatedSagaManager.Builder<T>	sagaModel(SagaModel<T> sagaModel) Sets the SagaModel of generic type T, describing the structure of the Saga this AbstractSagaManager implementation will manage.
AnnotatedSagaManager.Builder<T>	sagaRepository(SagaRepository<T> sagaRepository) Sets the SagaRepository of generic type T used to save and load Saga instances.
AnnotatedSagaManager.Builder<T>	sagaType(Class<T> sagaType) Sets the sagaType as a Class managed by this instance.
AnnotatedSagaManager.Builder<T>	spanFactory(SagaManagerSpanFactory spanFactory) Sets the SagaManagerSpanFactory implementation to use for providing tracing capabilities.
AnnotatedSagaManager.Builder<T>	spanFactory(SpanFactory spanFactory) Deprecated.

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

validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

sagaRepository

public AnnotatedSagaManager.Builder<T> sagaRepository(SagaRepository<T> sagaRepository)

Description copied from class: AbstractSagaManager.Builder

Sets the SagaRepository of generic type T used to save and load Saga instances.

Overrides:

sagaRepository in class AbstractSagaManager.Builder<T>

Parameters:

sagaRepository - a SagaRepository of generic type T used to save and load Saga instances

Returns:

the current Builder instance, for fluent interfacing

sagaType

public AnnotatedSagaManager.Builder<T> sagaType(Class<T> sagaType)

Description copied from class: AbstractSagaManager.Builder

Sets the sagaType as a Class managed by this instance.

Overrides:

sagaType in class AbstractSagaManager.Builder<T>

Parameters:

sagaType - the Class specifying the type of Saga managed by this instance

Returns:

the current Builder instance, for fluent interfacing

sagaFactory

public AnnotatedSagaManager.Builder<T> sagaFactory(Supplier<T> sagaFactory)

Description copied from class: AbstractSagaManager.Builder

Sets the sagaFactory of type Supplier responsible for creating new Saga instances. Defaults to a sagaType.newInstance() call throwing a SagaInstantiationException if it fails.

Overrides:

sagaFactory in class AbstractSagaManager.Builder<T>

Parameters:

sagaFactory - a Supplier of Saga type T responsible for creating new Saga instances

Returns:

the current Builder instance, for fluent interfacing

listenerInvocationErrorHandler

public AnnotatedSagaManager.Builder<T> listenerInvocationErrorHandler(ListenerInvocationErrorHandler listenerInvocationErrorHandler)

Description copied from class: AbstractSagaManager.Builder

Sets the ListenerInvocationErrorHandler invoked when an error occurs. Defaults to a LoggingErrorHandler.

Overrides:

listenerInvocationErrorHandler in class AbstractSagaManager.Builder<T>

Parameters:

listenerInvocationErrorHandler - a ListenerInvocationErrorHandler invoked when an error occurs

Returns:

the current Builder instance, for fluent interfacing

spanFactory

@Deprecated
public AnnotatedSagaManager.Builder<T> spanFactory(SpanFactory spanFactory)

Deprecated.

Description copied from class: AbstractSagaManager.Builder

Sets the SpanFactory implementation to use for providing tracing capabilities. Defaults to a NoOpSpanFactory, which provides no tracing capabilities.

Overrides:

spanFactory in class AbstractSagaManager.Builder<T>

Parameters:

spanFactory - The SpanFactory implementation

Returns:

The current Builder instance, for fluent interfacing.

spanFactory

public AnnotatedSagaManager.Builder<T> spanFactory(SagaManagerSpanFactory spanFactory)

Description copied from class: AbstractSagaManager.Builder

Sets the SagaManagerSpanFactory implementation to use for providing tracing capabilities. Defaults to a DefaultSagaManagerSpanFactory backed by a NoOpSpanFactory by default, which provides no tracing capabilities.

Overrides:

spanFactory in class AbstractSagaManager.Builder<T>

Parameters:

spanFactory - The SagaManagerSpanFactory implementation

Returns:

The current Builder instance, for fluent interfacing.

parameterResolverFactory

public AnnotatedSagaManager.Builder<T> parameterResolverFactory(ParameterResolverFactory parameterResolverFactory)

Sets the ParameterResolverFactory used to resolve parameters for annotated handlers for the given sagaType. Only used to instantiate a SagaModel if no SagaModel has been provided directly.

Parameters:

parameterResolverFactory - a ParameterResolverFactory used to resolve parameters for annotated handlers contained in the Aggregate

Returns:

the current Builder instance, for fluent interfacing

handlerDefinition

public AnnotatedSagaManager.Builder<T> handlerDefinition(HandlerDefinition handlerDefinition)

Sets the HandlerDefinition used to create concrete handlers for the given sagaType. Only used to instantiate a SagaModel if no SagaModel has been provided directly.

Parameters:

handlerDefinition - a HandlerDefinition used to create concrete handlers for the given sagaType.

Returns:

the current Builder instance, for fluent interfacing

sagaModel

public AnnotatedSagaManager.Builder<T> sagaModel(SagaModel<T> sagaModel)

Sets the SagaModel of generic type T, describing the structure of the Saga this AbstractSagaManager implementation will manage. If this is not provided directly, the sagaType will be used to instantiate a SagaModel.

Parameters:

sagaModel - the SagaModel of generic type T of the Saga this AbstractSagaManager implementation will manage

Returns:

the current Builder instance, for fluent interfacing

build

public AnnotatedSagaManager<T> build()

Initializes a AnnotatedSagaManager as specified through this Builder.

Returns:

a AnnotatedSagaManager as specified through this Builder

buildSagaModel

protected SagaModel<T> buildSagaModel()

Instantiate the SagaModel of generic type T describing the structure of the Saga this AbstractSagaManager implementation will manage.

Returns:

a SagaModel of generic type T describing the Saga this AbstractSagaManager implementation will manage