org.axonframework.queryhandling

Class SimpleQueryBus.Builder

java.lang.Object

org.axonframework.queryhandling.SimpleQueryBus.Builder

Enclosing class:

SimpleQueryBus

public static class SimpleQueryBus.Builder
extends Object

Builder class to instantiate a SimpleQueryBus.

The MessageMonitor is defaulted to NoOpMessageMonitor, TransactionManager to NoTransactionManager, QueryInvocationErrorHandler to LoggingQueryInvocationErrorHandler, the QueryUpdateEmitter to SimpleQueryUpdateEmitter and the QueryBusSpanFactory defaults to a DefaultQueryBusSpanFactory backed by a NoOpSpanFactory.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SimpleQueryBus	build() Initializes a SimpleQueryBus as specified through this Builder.
SimpleQueryBus.Builder	duplicateQueryHandlerResolver(DuplicateQueryHandlerResolver duplicateQueryHandlerResolver) Sets the duplicate query handler resolver.
SimpleQueryBus.Builder	errorHandler(QueryInvocationErrorHandler errorHandler) Sets the QueryInvocationErrorHandler to handle exceptions during query handler invocation.
SimpleQueryBus.Builder	messageMonitor(MessageMonitor<? super QueryMessage<?,?>> messageMonitor) Sets the MessageMonitor used to monitor query messages.
SimpleQueryBus.Builder	queryUpdateEmitter(QueryUpdateEmitter queryUpdateEmitter) Sets the QueryUpdateEmitter used to emits updates for the QueryBus.subscriptionQuery(SubscriptionQueryMessage).
SimpleQueryBus.Builder	spanFactory(QueryBusSpanFactory spanFactory) Sets the QueryBusSpanFactory implementation to use for providing tracing capabilities.
SimpleQueryBus.Builder	spanFactory(SpanFactory spanFactory) Deprecated. Use spanFactory(QueryBusSpanFactory) instead as it provides more configurability.
SimpleQueryBus.Builder	transactionManager(TransactionManager transactionManager) Sets the TransactionManager used to manage the query handling transactions.
protected void	validate() Validate 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

messageMonitor

public SimpleQueryBus.Builder messageMonitor(@Nonnull
                                             MessageMonitor<? super QueryMessage<?,?>> messageMonitor)

Sets the MessageMonitor used to monitor query messages. Defaults to a NoOpMessageMonitor.

Parameters:

messageMonitor - a MessageMonitor used to monitor query messages

Returns:

the current Builder instance, for fluent interfacing

duplicateQueryHandlerResolver

public SimpleQueryBus.Builder duplicateQueryHandlerResolver(DuplicateQueryHandlerResolver duplicateQueryHandlerResolver)

Sets the duplicate query handler resolver. This determines which registrations are added to the query bus when multiple handlers are detected for the same query.

DuplicateQueryHandlerResolution contains good examples on this and will most of the time suffice. The bus defaults to DuplicateQueryHandlerResolution.logAndAccept().

Parameters:

duplicateQueryHandlerResolver - The DuplicateQueryHandlerResolver to use when multiple registrations are detected

Returns:

the current Builder instance, for fluent interfacing

transactionManager

public SimpleQueryBus.Builder transactionManager(@Nonnull
                                                 TransactionManager transactionManager)

Sets the TransactionManager used to manage the query handling transactions. Defaults to a NoTransactionManager.

Parameters:

transactionManager - a TransactionManager used to manage the query handling transactions

Returns:

the current Builder instance, for fluent interfacing

errorHandler

public SimpleQueryBus.Builder errorHandler(@Nonnull
                                           QueryInvocationErrorHandler errorHandler)

Sets the QueryInvocationErrorHandler to handle exceptions during query handler invocation. Defaults to a LoggingQueryInvocationErrorHandler using this instance it's Logger.

Parameters:

errorHandler - a QueryInvocationErrorHandler to handle exceptions during query handler invocation

Returns:

the current Builder instance, for fluent interfacing

queryUpdateEmitter

public SimpleQueryBus.Builder queryUpdateEmitter(@Nonnull
                                                 QueryUpdateEmitter queryUpdateEmitter)

Sets the QueryUpdateEmitter used to emits updates for the QueryBus.subscriptionQuery(SubscriptionQueryMessage). Defaults to a SimpleQueryUpdateEmitter.

Parameters:

queryUpdateEmitter - the QueryUpdateEmitter used to emits updates for the QueryBus.subscriptionQuery(SubscriptionQueryMessage)

Returns:

the current Builder instance, for fluent interfacing

spanFactory

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

Deprecated. Use spanFactory(QueryBusSpanFactory) instead as it provides more configurability.

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

Parameters:

spanFactory - The SpanFactory implementation

Returns:

The current Builder instance, for fluent interfacing.

spanFactory

public SimpleQueryBus.Builder spanFactory(@Nonnull
                                          QueryBusSpanFactory spanFactory)

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

Parameters:

spanFactory - The QueryBusSpanFactory implementation.

Returns:

The current Builder instance, for fluent interfacing.

build

public SimpleQueryBus build()

Initializes a SimpleQueryBus as specified through this Builder.

Returns:

a SimpleQueryBus as specified through this Builder

validate

protected void validate()
                 throws AxonConfigurationException

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

Throws:

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