org.axonframework.axonserver.connector.query

Class AxonServerQueryBus

java.lang.Object

org.axonframework.axonserver.connector.query.AxonServerQueryBus

All Implemented Interfaces:

org.axonframework.messaging.Distributed<org.axonframework.queryhandling.QueryBus>, org.axonframework.messaging.MessageDispatchInterceptorSupport<org.axonframework.queryhandling.QueryMessage<?,?>>, org.axonframework.messaging.MessageHandlerInterceptorSupport<org.axonframework.queryhandling.QueryMessage<?,?>>, org.axonframework.queryhandling.QueryBus

public class AxonServerQueryBus
extends Object
implements org.axonframework.queryhandling.QueryBus, org.axonframework.messaging.Distributed<org.axonframework.queryhandling.QueryBus>

Axon QueryBus implementation that connects to Axon Server to submit and receive queries and query responses. Delegates incoming queries to the provided localSegment.

Since:

4.0

Author:

Marc Gathier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AxonServerQueryBus.Builder Builder class to instantiate an AxonServerQueryBus.

Constructor Summary

Constructors

Constructor and Description
AxonServerQueryBus(AxonServerQueryBus.Builder builder) Instantiate a AxonServerQueryBus based on the fields contained in the AxonServerQueryBus.Builder.

Method Summary

Modifier and Type	Method and Description
static AxonServerQueryBus.Builder	builder() Instantiate a Builder to be able to create an AxonServerQueryBus.
void	disconnect() Disconnect the query bus from Axon Server, by unsubscribing all known query handlers.
org.axonframework.queryhandling.QueryBus	localSegment()
<Q,R> CompletableFuture<org.axonframework.queryhandling.QueryResponseMessage<R>>	query(org.axonframework.queryhandling.QueryMessage<Q,R> queryMessage)
org.axonframework.queryhandling.QueryUpdateEmitter	queryUpdateEmitter()
org.axonframework.common.Registration	registerDispatchInterceptor(org.axonframework.messaging.MessageDispatchInterceptor<? super org.axonframework.queryhandling.QueryMessage<?,?>> dispatchInterceptor)
org.axonframework.common.Registration	registerHandlerInterceptor(org.axonframework.messaging.MessageHandlerInterceptor<? super org.axonframework.queryhandling.QueryMessage<?,?>> interceptor)
<Q,R> Stream<org.axonframework.queryhandling.QueryResponseMessage<R>>	scatterGather(org.axonframework.queryhandling.QueryMessage<Q,R> queryMessage, long timeout, TimeUnit timeUnit)
CompletableFuture<Void>	shutdownDispatching() Shutdown the query bus asynchronously for dispatching queries to Axon Server.
void	start() Start the Axon Server QueryBus implementation.
<R> org.axonframework.common.Registration	subscribe(String queryName, Type responseType, org.axonframework.messaging.MessageHandler<? super org.axonframework.queryhandling.QueryMessage<?,R>> handler)
<Q,I,U> org.axonframework.queryhandling.SubscriptionQueryResult<org.axonframework.queryhandling.QueryResponseMessage<I>,org.axonframework.queryhandling.SubscriptionQueryUpdateMessage<U>>	subscriptionQuery(org.axonframework.queryhandling.SubscriptionQueryMessage<Q,I,U> query, org.axonframework.queryhandling.SubscriptionQueryBackpressure backPressure, int updateBufferSize)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.queryhandling.QueryBus

subscriptionQuery

Constructor Detail

AxonServerQueryBus

public AxonServerQueryBus(AxonServerQueryBus.Builder builder)

Instantiate a AxonServerQueryBus based on the fields contained in the AxonServerQueryBus.Builder.

Parameters:

builder - the AxonServerQueryBus.Builder used to instantiate a AxonServerQueryBus instance

Method Detail

builder

public static AxonServerQueryBus.Builder builder()

Instantiate a Builder to be able to create 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 AxonServerConnectionManager, the AxonServerConfiguration, the local QueryBus, the QueryUpdateEmitter, and the message and generic Serializers are hard requirements and as such should be provided.

Returns:

a Builder to be able to create a AxonServerQueryBus

start

@StartHandler(phase=536870911)
public void start()

Start the Axon Server QueryBus implementation.

subscribe

public <R> org.axonframework.common.Registration subscribe(String queryName,
                                                           Type responseType,
                                                           org.axonframework.messaging.MessageHandler<? super org.axonframework.queryhandling.QueryMessage<?,R>> handler)

Specified by:

subscribe in interface org.axonframework.queryhandling.QueryBus

query

public <Q,R> CompletableFuture<org.axonframework.queryhandling.QueryResponseMessage<R>> query(org.axonframework.queryhandling.QueryMessage<Q,R> queryMessage)

Specified by:

query in interface org.axonframework.queryhandling.QueryBus

scatterGather

public <Q,R> Stream<org.axonframework.queryhandling.QueryResponseMessage<R>> scatterGather(org.axonframework.queryhandling.QueryMessage<Q,R> queryMessage,
                                                                                           long timeout,
                                                                                           TimeUnit timeUnit)

Specified by:

scatterGather in interface org.axonframework.queryhandling.QueryBus

subscriptionQuery

public <Q,I,U> org.axonframework.queryhandling.SubscriptionQueryResult<org.axonframework.queryhandling.QueryResponseMessage<I>,org.axonframework.queryhandling.SubscriptionQueryUpdateMessage<U>> subscriptionQuery(org.axonframework.queryhandling.SubscriptionQueryMessage<Q,I,U> query,
                                                                                                                                                                                                                    org.axonframework.queryhandling.SubscriptionQueryBackpressure backPressure,
                                                                                                                                                                                                                    int updateBufferSize)

Specified by:

subscriptionQuery in interface org.axonframework.queryhandling.QueryBus

queryUpdateEmitter

public org.axonframework.queryhandling.QueryUpdateEmitter queryUpdateEmitter()

Specified by:

queryUpdateEmitter in interface org.axonframework.queryhandling.QueryBus

localSegment

public org.axonframework.queryhandling.QueryBus localSegment()

Specified by:

localSegment in interface org.axonframework.messaging.Distributed<org.axonframework.queryhandling.QueryBus>

registerHandlerInterceptor

public org.axonframework.common.Registration registerHandlerInterceptor(org.axonframework.messaging.MessageHandlerInterceptor<? super org.axonframework.queryhandling.QueryMessage<?,?>> interceptor)

Specified by:

registerHandlerInterceptor in interface org.axonframework.messaging.MessageHandlerInterceptorSupport<org.axonframework.queryhandling.QueryMessage<?,?>>

registerDispatchInterceptor

public org.axonframework.common.Registration registerDispatchInterceptor(org.axonframework.messaging.MessageDispatchInterceptor<? super org.axonframework.queryhandling.QueryMessage<?,?>> dispatchInterceptor)

Specified by:

registerDispatchInterceptor in interface org.axonframework.messaging.MessageDispatchInterceptorSupport<org.axonframework.queryhandling.QueryMessage<?,?>>

disconnect

@ShutdownHandler(phase=536870911)
public void disconnect()

Disconnect the query bus from Axon Server, by unsubscribing all known query handlers. This shutdown operation is performed in the Phase.INBOUND_QUERY_CONNECTOR phase.

shutdownDispatching

@ShutdownHandler(phase=0)
public CompletableFuture<Void> shutdownDispatching()

Shutdown the query bus asynchronously for dispatching queries to Axon Server. This process will wait for dispatched queries which have not received a response yet and will close off running subscription queries. This shutdown operation is performed in the Phase.OUTBOUND_QUERY_CONNECTORS phase.

Returns:

a completable future which is resolved once all query dispatching activities are completed