org.axonframework.axonserver.connector.query

Class AxonServerQueryBus.Builder

java.lang.Object

org.axonframework.axonserver.connector.query.AxonServerQueryBus.Builder

Enclosing class:

AxonServerQueryBus

public static class AxonServerQueryBus.Builder
extends Object

Builder class to instantiate an AxonServerQueryBus.

The QueryPriorityCalculator is defaulted to QueryPriorityCalculator.defaultQueryPriorityCalculator() and the TargetContextResolver defaults to a lambda returning the AxonServerConfiguration.getContext() as the context. The ExecutorServiceBuilder defaults to ExecutorServiceBuilder.defaultQueryExecutorServiceBuilder(). The QueryBusSpanFactory defaults to a DefaultQueryBusSpanFactory backed by a NoOpSpanFactory. The AxonServerConnectionManager, the AxonServerConfiguration, the local QueryBus, the QueryUpdateEmitter, and the message and generic Serializers are hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AxonServerQueryBus.Builder	axonServerConnectionManager(AxonServerConnectionManager axonServerConnectionManager) Sets the AxonServerConnectionManager used to create connections between this application and an Axon Server instance.
AxonServerQueryBus	build() Initializes a AxonServerQueryBus as specified through this Builder.
protected QuerySerializer	buildQuerySerializer() Build a QuerySerializer using the configured messageSerializer, genericSerializer and configuration.
protected SubscriptionMessageSerializer	buildSubscriptionMessageSerializer() Build a SubscriptionMessageSerializer using the configured messageSerializer, genericSerializer and configuration.
AxonServerQueryBus.Builder	configuration(AxonServerConfiguration configuration) Sets the AxonServerConfiguration used to configure several components within the Axon Server Query Bus, like setting the client id or the number of query handling threads used.
AxonServerQueryBus.Builder	defaultContext(String defaultContext) Sets the default context for this event store to connect to.
AxonServerQueryBus.Builder	enabledLocalSegmentShortCut() Enables shortcut to local QueryBus.
AxonServerQueryBus.Builder	executorServiceBuilder(ExecutorServiceBuilder executorServiceBuilder) Deprecated. in favor of using the queryExecutorServiceBuilder(ExecutorServiceBuilder) method
AxonServerQueryBus.Builder	genericSerializer(Serializer genericSerializer) Sets the generic Serializer used to de-/serialize incoming and outgoing query ResponseType implementations.
AxonServerQueryBus.Builder	instructionAckSource(InstructionAckSource<io.axoniq.axonserver.grpc.query.QueryProviderOutbound> instructionAckSource) Deprecated. in through use of the AxonServer java connector
AxonServerQueryBus.Builder	localSegment(QueryBus localSegment) Sets the local QueryBus used to dispatch incoming queries to the local environment.
AxonServerQueryBus.Builder	messageSerializer(Serializer messageSerializer) Sets the message Serializer used to de-/serialize incoming and outgoing queries and query responses.
AxonServerQueryBus.Builder	priorityCalculator(QueryPriorityCalculator priorityCalculator) Sets the QueryPriorityCalculator used to deduce the priority of an incoming query among other queries, to give precedence over high(er) valued queries for example.
AxonServerQueryBus.Builder	queryExecutorServiceBuilder(ExecutorServiceBuilder executorServiceBuilder) Sets the ExecutorServiceBuilder which builds an ExecutorService based on a given AxonServerConfiguration and BlockingQueue of Runnable.
AxonServerQueryBus.Builder	queryInProgressAwait(Duration queryInProgressAwait) Sets the query in progress await timeout used to await the successful termination of queries in progress.
AxonServerQueryBus.Builder	queryResponseExecutorServiceBuilder(ExecutorServiceBuilder executorServiceBuilder) Sets the ExecutorServiceBuilder which builds an ExecutorService based on a given AxonServerConfiguration and BlockingQueue of Runnable.
AxonServerQueryBus.Builder	requestStreamFactory(Function<UpstreamAwareStreamObserver<io.axoniq.axonserver.grpc.query.QueryProviderInbound>,io.grpc.stub.StreamObserver<io.axoniq.axonserver.grpc.query.QueryProviderOutbound>> requestStreamFactory) Deprecated. in through use of the AxonServer java connector
AxonServerQueryBus.Builder	spanFactory(QueryBusSpanFactory spanFactory) Sets the QueryBusSpanFactory implementation to use for providing tracing capabilities.
AxonServerQueryBus.Builder	spanFactory(SpanFactory spanFactory) Deprecated. Use spanFactory(QueryBusSpanFactory) instead as it provides more configurability.
AxonServerQueryBus.Builder	targetContextResolver(TargetContextResolver<? super QueryMessage<?,?>> targetContextResolver) Sets the TargetContextResolver used to resolve the target (bounded) context of an ingested QueryMessage.
AxonServerQueryBus.Builder	updateEmitter(QueryUpdateEmitter updateEmitter) Sets the QueryUpdateEmitter which can be used to emit updates to queries.
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

axonServerConnectionManager

public AxonServerQueryBus.Builder axonServerConnectionManager(AxonServerConnectionManager axonServerConnectionManager)

Sets the AxonServerConnectionManager used to create connections between this application and an Axon Server instance.

Parameters:

axonServerConnectionManager - an AxonServerConnectionManager used to create connections between this application and an Axon Server instance

Returns:

the current Builder instance, for fluent interfacing

configuration

public AxonServerQueryBus.Builder configuration(AxonServerConfiguration configuration)

Sets the AxonServerConfiguration used to configure several components within the Axon Server Query Bus, like setting the client id or the number of query handling threads used.

Parameters:

configuration - an AxonServerConfiguration used to configure several components within the Axon Server Query Bus

Returns:

the current Builder instance, for fluent interfacing

localSegment

public AxonServerQueryBus.Builder localSegment(QueryBus localSegment)

Sets the local QueryBus used to dispatch incoming queries to the local environment.

Parameters:

localSegment - a QueryBus used to dispatch incoming queries to the local environment

Returns:

the current Builder instance, for fluent interfacing

updateEmitter

public AxonServerQueryBus.Builder updateEmitter(QueryUpdateEmitter updateEmitter)

Sets the QueryUpdateEmitter which can be used to emit updates to queries. Required to honor the QueryBus.queryUpdateEmitter() contract.

Parameters:

updateEmitter - a QueryUpdateEmitter which can be used to emit updates to queries

Returns:

the current Builder instance, for fluent interfacing

messageSerializer

public AxonServerQueryBus.Builder messageSerializer(Serializer messageSerializer)

Sets the message Serializer used to de-/serialize incoming and outgoing queries and query responses.

Parameters:

messageSerializer - a Serializer used to de-/serialize incoming and outgoing queries and query responses

Returns:

the current Builder instance, for fluent interfacing

genericSerializer

public AxonServerQueryBus.Builder genericSerializer(Serializer genericSerializer)

Sets the generic Serializer used to de-/serialize incoming and outgoing query ResponseType implementations.

Parameters:

genericSerializer - a Serializer used to de-/serialize incoming and outgoing query ResponseType implementations.

Returns:

the current Builder instance, for fluent interfacing

priorityCalculator

public AxonServerQueryBus.Builder priorityCalculator(QueryPriorityCalculator priorityCalculator)

Sets the QueryPriorityCalculator used to deduce the priority of an incoming query among other queries, to give precedence over high(er) valued queries for example. Defaults to a QueryPriorityCalculator.defaultQueryPriorityCalculator().

Parameters:

priorityCalculator - a QueryPriorityCalculator used to deduce the priority of an incoming query among other queries

Returns:

the current Builder instance, for fluent interfacing

targetContextResolver

public AxonServerQueryBus.Builder targetContextResolver(TargetContextResolver<? super QueryMessage<?,?>> targetContextResolver)

Sets the TargetContextResolver used to resolve the target (bounded) context of an ingested QueryMessage. Defaults to returning the AxonServerConfiguration.getContext() on any type of query message being ingested.

Parameters:

targetContextResolver - a TargetContextResolver used to resolve the target (bounded) context of an ingested QueryMessage

Returns:

the current Builder instance, for fluent interfacing

executorServiceBuilder

@Deprecated
public AxonServerQueryBus.Builder executorServiceBuilder(ExecutorServiceBuilder executorServiceBuilder)

Deprecated. in favor of using the queryExecutorServiceBuilder(ExecutorServiceBuilder) method

Sets the ExecutorServiceBuilder which builds an ExecutorService based on a given AxonServerConfiguration and BlockingQueue of Runnable. This ExecutorService is used to process incoming queries with. Defaults to a ThreadPoolExecutor, using the AxonServerConfiguration.getQueryThreads() for the pool size, the given BlockingQueue as the work queue, and an AxonThreadFactory.

Note that it is highly recommended to use the given BlockingQueue if you are to provide you own executorServiceBuilder, as it ensures the query's priority is taken into consideration. Defaults to ExecutorServiceBuilder.defaultQueryExecutorServiceBuilder().

Parameters:

executorServiceBuilder - an ExecutorServiceBuilder used to build an ExecutorService based on the AxonServerConfiguration and a BlockingQueue

Returns:

the current Builder instance, for fluent interfacing

queryExecutorServiceBuilder

public AxonServerQueryBus.Builder queryExecutorServiceBuilder(ExecutorServiceBuilder executorServiceBuilder)

Sets the ExecutorServiceBuilder which builds an ExecutorService based on a given AxonServerConfiguration and BlockingQueue of Runnable. This ExecutorService is used to process incoming queries with. Defaults to a ThreadPoolExecutor, using the AxonServerConfiguration.getQueryThreads() for the pool size, the given BlockingQueue as the work queue, and an AxonThreadFactory.

Note that it is highly recommended to use the given BlockingQueue if you are to provide you own executorServiceBuilder, as it ensures the query's priority is taken into consideration. Defaults to ExecutorServiceBuilder.defaultQueryResponseExecutorServiceBuilder().

Parameters:

executorServiceBuilder - an ExecutorServiceBuilder used to build an ExecutorService based on the AxonServerConfiguration and a BlockingQueue

Returns:

the current Builder instance, for fluent interfacing

queryResponseExecutorServiceBuilder

public AxonServerQueryBus.Builder queryResponseExecutorServiceBuilder(ExecutorServiceBuilder executorServiceBuilder)

Sets the ExecutorServiceBuilder which builds an ExecutorService based on a given AxonServerConfiguration and BlockingQueue of Runnable. This ExecutorService is used to process incoming query responses with. Defaults to a ThreadPoolExecutor, using the AxonServerConfiguration.getQueryResponseThreads() for the pool size, the given BlockingQueue as the work queue, and an AxonThreadFactory.

Note that it is highly recommended to use the given BlockingQueue if you are to provide you own executorServiceBuilder, as it ensures the query's priority is taken into consideration. Defaults to ExecutorServiceBuilder.defaultQueryExecutorServiceBuilder().

Parameters:

executorServiceBuilder - an ExecutorServiceBuilder used to build an ExecutorService based on the AxonServerConfiguration and a BlockingQueue

Returns:

the current Builder instance, for fluent interfacing

requestStreamFactory

@Deprecated
public AxonServerQueryBus.Builder requestStreamFactory(Function<UpstreamAwareStreamObserver<io.axoniq.axonserver.grpc.query.QueryProviderInbound>,io.grpc.stub.StreamObserver<io.axoniq.axonserver.grpc.query.QueryProviderOutbound>> requestStreamFactory)

Deprecated. in through use of the AxonServer java connector

Sets the request stream factory that creates a request stream based on upstream. Defaults to UpstreamAwareStreamObserver.getRequestStream().

Parameters:

requestStreamFactory - factory that creates a request stream based on upstream

Returns:

the current Builder instance, for fluent interfacing

instructionAckSource

@Deprecated
public AxonServerQueryBus.Builder instructionAckSource(InstructionAckSource<io.axoniq.axonserver.grpc.query.QueryProviderOutbound> instructionAckSource)

Deprecated. in through use of the AxonServer java connector

Sets the instruction ack source used to send instruction acknowledgements. Defaults to DefaultInstructionAckSource.

Parameters:

instructionAckSource - used to send instruction acknowledgements

Returns:

the current Builder instance, for fluent interfacing

defaultContext

public AxonServerQueryBus.Builder defaultContext(String defaultContext)

Sets the default context for this event store to connect to.

Parameters:

defaultContext - for this bus to connect to.

Returns:

the current Builder instance, for fluent interfacing

spanFactory

@Deprecated
public AxonServerQueryBus.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 AxonServerQueryBus.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.

enabledLocalSegmentShortCut

public AxonServerQueryBus.Builder enabledLocalSegmentShortCut()

Enables shortcut to local QueryBus. If query handlers are registered in the local environment they will be invoked directly instead of sending request to axon server.

Returns:

the current Builder instance, for fluent interfacing

queryInProgressAwait

public AxonServerQueryBus.Builder queryInProgressAwait(@Nonnull
                                                       Duration queryInProgressAwait)

Sets the query in progress await timeout used to await the successful termination of queries in progress. When this timeout is exceeded, the query in progress will be canceled.

Defaults to a Duration of 5 seconds.

Parameters:

queryInProgressAwait - The query in progress await timeout used to await the successful termination of queries in progress

Returns:

The current Builder instance, for fluent interfacing.

build

public AxonServerQueryBus build()

Initializes a AxonServerQueryBus as specified through this Builder.

Returns:

a AxonServerQueryBus as specified through this Builder

buildQuerySerializer

protected QuerySerializer buildQuerySerializer()

Build a QuerySerializer using the configured messageSerializer, genericSerializer and configuration.

Returns:

a QuerySerializer based on the configured messageSerializer, genericSerializer and configuration

buildSubscriptionMessageSerializer

protected SubscriptionMessageSerializer buildSubscriptionMessageSerializer()

Build a SubscriptionMessageSerializer using the configured messageSerializer, genericSerializer and configuration.

Returns:

a SubscriptionMessageSerializer based on the configured messageSerializer, genericSerializer and configuration

validate

protected void validate()
                 throws AxonConfigurationException

Validates 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