org.axonframework.eventhandling

Class SubscribingEventProcessor.Builder

java.lang.Object

org.axonframework.eventhandling.AbstractEventProcessor.Builder

org.axonframework.eventhandling.SubscribingEventProcessor.Builder

Enclosing class:

SubscribingEventProcessor

public static class SubscribingEventProcessor.Builder
extends AbstractEventProcessor.Builder

Builder class to instantiate a SubscribingEventProcessor.

The RollbackConfigurationType defaults to a RollbackConfigurationType.ANY_THROWABLE, the ErrorHandler is defaulted to a PropagatingErrorHandler, the MessageMonitor defaults to a EventProcessorSpanFactory is defaulted to a DefaultEventProcessorSpanFactory backed by a NoOpSpanFactory, the MessageMonitor defaults to a NoOpMessageMonitor, the EventProcessingStrategy defaults to a DirectEventProcessingStrategy and the TransactionManager defaults to the NoTransactionManager.INSTANCE. The Event Processor name, EventHandlerInvoker and SubscribableMessageSource are hard requirements and as such should be provided.

Field Summary

Fields inherited from class org.axonframework.eventhandling.AbstractEventProcessor.Builder

name

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SubscribingEventProcessor	build() Initializes a SubscribingEventProcessor as specified through this Builder.
SubscribingEventProcessor.Builder	errorHandler(ErrorHandler errorHandler) Sets the ErrorHandler invoked when an UnitOfWork is rolled back during processing.
SubscribingEventProcessor.Builder	eventHandlerInvoker(EventHandlerInvoker eventHandlerInvoker) Sets the EventHandlerInvoker which will handle all the individual EventMessages.
SubscribingEventProcessor.Builder	messageMonitor(MessageMonitor<? super EventMessage<?>> messageMonitor) Sets the MessageMonitor to monitor EventMessages before and after they're processed.
SubscribingEventProcessor.Builder	messageSource(SubscribableMessageSource<? extends EventMessage<?>> messageSource) Sets the SubscribableMessageSource (e.g.
SubscribingEventProcessor.Builder	name(String name) Sets the name of this EventProcessor implementation.
SubscribingEventProcessor.Builder	processingStrategy(EventProcessingStrategy processingStrategy) Sets the EventProcessingStrategy determining whether events are processed directly or asynchronously.
SubscribingEventProcessor.Builder	rollbackConfiguration(RollbackConfiguration rollbackConfiguration) Sets the RollbackConfiguration specifying the rollback behavior of the UnitOfWork while processing a batch of events.
SubscribingEventProcessor.Builder	spanFactory(EventProcessorSpanFactory spanFactory) Sets the EventProcessorSpanFactory implementation to use for providing tracing capabilities.
SubscribingEventProcessor.Builder	spanFactory(SpanFactory spanFactory) Deprecated.
SubscribingEventProcessor.Builder	transactionManager(TransactionManager transactionManager) Sets the TransactionManager used when processing EventMessages.
protected void	validate() Validates whether the fields contained in this Builder are set accordingly.

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

name

public SubscribingEventProcessor.Builder name(@Nonnull
                                              String name)

Description copied from class: AbstractEventProcessor.Builder

Sets the name of this EventProcessor implementation.

Overrides:

name in class AbstractEventProcessor.Builder

Parameters:

name - a String defining this EventProcessor implementation

Returns:

the current Builder instance, for fluent interfacing

eventHandlerInvoker

public SubscribingEventProcessor.Builder eventHandlerInvoker(@Nonnull
                                                             EventHandlerInvoker eventHandlerInvoker)

Description copied from class: AbstractEventProcessor.Builder

Sets the EventHandlerInvoker which will handle all the individual EventMessages.

Overrides:

eventHandlerInvoker in class AbstractEventProcessor.Builder

Parameters:

eventHandlerInvoker - the EventHandlerInvoker which will handle all the individual EventMessages

Returns:

the current Builder instance, for fluent interfacing

rollbackConfiguration

public SubscribingEventProcessor.Builder rollbackConfiguration(@Nonnull
                                                               RollbackConfiguration rollbackConfiguration)

Sets the RollbackConfiguration specifying the rollback behavior of the UnitOfWork while processing a batch of events.. Defaults to a RollbackConfigurationType.ANY_THROWABLE)

Overrides:

rollbackConfiguration in class AbstractEventProcessor.Builder

Parameters:

rollbackConfiguration - the RollbackConfiguration specifying the rollback behavior of the UnitOfWork while processing a batch of events.

Returns:

the current Builder instance, for fluent interfacing

errorHandler

public SubscribingEventProcessor.Builder errorHandler(@Nonnull
                                                      ErrorHandler errorHandler)

Description copied from class: AbstractEventProcessor.Builder

Sets the ErrorHandler invoked when an UnitOfWork is rolled back during processing. Defaults to a PropagatingErrorHandler.

Overrides:

errorHandler in class AbstractEventProcessor.Builder

Parameters:

errorHandler - the ErrorHandler invoked when an UnitOfWork is rolled back during processing

Returns:

the current Builder instance, for fluent interfacing

messageMonitor

public SubscribingEventProcessor.Builder messageMonitor(@Nonnull
                                                        MessageMonitor<? super EventMessage<?>> messageMonitor)

Description copied from class: AbstractEventProcessor.Builder

Sets the MessageMonitor to monitor EventMessages before and after they're processed. Defaults to a NoOpMessageMonitor.

Overrides:

messageMonitor in class AbstractEventProcessor.Builder

Parameters:

messageMonitor - a MessageMonitor to monitor EventMessages before and after they're processed

Returns:

the current Builder instance, for fluent interfacing

spanFactory

public SubscribingEventProcessor.Builder spanFactory(@Nonnull
                                                     EventProcessorSpanFactory spanFactory)

Description copied from class: AbstractEventProcessor.Builder

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

Overrides:

spanFactory in class AbstractEventProcessor.Builder

Parameters:

spanFactory - The SpanFactory implementation

Returns:

The current Builder instance, for fluent interfacing.

spanFactory

@Deprecated
public SubscribingEventProcessor.Builder spanFactory(@Nonnull
                                                                 SpanFactory spanFactory)

Deprecated.

Description copied from class: AbstractEventProcessor.Builder

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

Overrides:

spanFactory in class AbstractEventProcessor.Builder

Parameters:

spanFactory - The SpanFactory implementation

Returns:

The current Builder instance, for fluent interfacing.

messageSource

public SubscribingEventProcessor.Builder messageSource(@Nonnull
                                                       SubscribableMessageSource<? extends EventMessage<?>> messageSource)

Sets the SubscribableMessageSource (e.g. the EventBus) to which this EventProcessor implementation will subscribe itself to receive EventMessages.

Parameters:

messageSource - the SubscribableMessageSource (e.g. the EventBus) to which this EventProcessor implementation will subscribe itself to receive EventMessages

Returns:

the current Builder instance, for fluent interfacing

processingStrategy

public SubscribingEventProcessor.Builder processingStrategy(@Nonnull
                                                            EventProcessingStrategy processingStrategy)

Sets the EventProcessingStrategy determining whether events are processed directly or asynchronously. Defaults to a DirectEventProcessingStrategy.

Parameters:

processingStrategy - the EventProcessingStrategy determining whether events are processed directly or asynchronously

Returns:

the current Builder instance, for fluent interfacing

transactionManager

public SubscribingEventProcessor.Builder transactionManager(@Nonnull
                                                            TransactionManager transactionManager)

Sets the TransactionManager used when processing EventMessages.

Parameters:

transactionManager - the TransactionManager used when processing EventMessages

Returns:

the current Builder instance, for fluent interfacing

build

public SubscribingEventProcessor build()

Initializes a SubscribingEventProcessor as specified through this Builder.

Returns:

a SubscribingEventProcessor as specified through this Builder

validate

protected void validate()
                 throws AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Overrides:

validate in class AbstractEventProcessor.Builder

Throws:

AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications