org.axonframework.axonserver.connector.query

Class AxonServerQueryBus

java.lang.Object

org.axonframework.axonserver.connector.query.AxonServerQueryBus

All Implemented Interfaces:

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

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

Constructor Summary

Constructors

Constructor and Description

AxonServerQueryBus(AxonServerConnectionManager axonServerConnectionManager, AxonServerConfiguration configuration, org.axonframework.queryhandling.QueryUpdateEmitter updateEmitter, org.axonframework.queryhandling.QueryBus localSegment, org.axonframework.serialization.Serializer messageSerializer, org.axonframework.serialization.Serializer genericSerializer, QueryPriorityCalculator priorityCalculator) Creates an instance of the Axon Server QueryBus client.

Method Summary

Modifier and Type	Method and Description
void	disconnect()
org.axonframework.queryhandling.QueryBus	localSegment() Returns the local segment configured for this instance.
void	on(QueryProviderInbound.RequestCase requestCase, Consumer<QueryProviderInbound> consumer)
<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)
<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(AxonServerConnectionManager axonServerConnectionManager,
                          AxonServerConfiguration configuration,
                          org.axonframework.queryhandling.QueryUpdateEmitter updateEmitter,
                          org.axonframework.queryhandling.QueryBus localSegment,
                          org.axonframework.serialization.Serializer messageSerializer,
                          org.axonframework.serialization.Serializer genericSerializer,
                          QueryPriorityCalculator priorityCalculator)

Creates an instance of the Axon Server QueryBus client. Will connect to an Axon Server instance to submit and receive queries and query responses.

Parameters:

axonServerConnectionManager - a AxonServerConnectionManager which creates the connection to an Axon Server platform

configuration - the AxonServerConfiguration containing specifics like the client and component names used to identify the application in Axon Server among others

updateEmitter - the QueryUpdateEmitter used to emits incremental updates to subscription queries

localSegment - a QueryBus handling the incoming queries for the local application

messageSerializer - a Serializer used to de-/serialize the payload and metadata of query messages and responses

genericSerializer - a Serializer used for communication of other objects than query message and response, payload and metadata

priorityCalculator - a QueryPriorityCalculator calculating the request priority based on the content, and adds this priority to the request

Method Detail

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

disconnect

public void disconnect()

localSegment

public org.axonframework.queryhandling.QueryBus localSegment()

Returns the local segment configured for this instance. The local segment is responsible for publishing queries to handlers in the local JVM.

Returns:

the local segment of the Query Bus

on

public void on(QueryProviderInbound.RequestCase requestCase,
               Consumer<QueryProviderInbound> consumer)

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

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<?,?>>