org.axonframework.queryhandling

Class DefaultQueryGateway

java.lang.Object

org.axonframework.queryhandling.DefaultQueryGateway

All Implemented Interfaces:

QueryGateway

public class DefaultQueryGateway
extends Object
implements QueryGateway

Implementation of the QueryGateway interface that allows the registration of dispatchInterceptors.

Since:

3.1

Author:

Marc Gathier, Allard Buijze, Steven van Beelen

Constructor Summary

Constructors

Constructor and Description
DefaultQueryGateway(QueryBus queryBus, MessageDispatchInterceptor<? super QueryMessage<?,?>>... dispatchInterceptors) Initializes the gateway to send queries to the given queryBus and invoking given dispatchInterceptors prior to publication ont he query bus.

Method Summary

Modifier and Type	Method and Description
<R,Q> CompletableFuture<R>	query(String queryName, Q query, ResponseType<R> responseType) Sends given query over the QueryBus, expecting a response in the form of responseType from a single source.
<R,Q> Stream<R>	scatterGather(String queryName, Q query, ResponseType<R> responseType, long timeout, TimeUnit timeUnit) Sends given query over the QueryBus, expecting a response in the form of responseType from several sources.

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.QueryGateway

query, query, query, scatterGather, send, send, send, send

Constructor Detail

DefaultQueryGateway

@SafeVarargs
public DefaultQueryGateway(QueryBus queryBus,
                                         MessageDispatchInterceptor<? super QueryMessage<?,?>>... dispatchInterceptors)

Initializes the gateway to send queries to the given queryBus and invoking given dispatchInterceptors prior to publication ont he query bus.

Parameters:

queryBus - The bus to deliver messages on

dispatchInterceptors - The interceptors to invoke prior to publication on the bus

Method Detail

query

public <R,Q> CompletableFuture<R> query(String queryName,
                                        Q query,
                                        ResponseType<R> responseType)

Description copied from interface: QueryGateway

Sends given query over the QueryBus, expecting a response in the form of responseType from a single source. Execution may be asynchronous, depending on the QueryBus implementation.

Specified by:

query in interface QueryGateway

Type Parameters:

R - The response class contained in the given responseType

Q - The query class

Parameters:

queryName - A String describing the query to be executed

query - The query to be sent

responseType - The ResponseType used for this query

Returns:

A CompletableFuture containing the query result as dictated by the given responseType

scatterGather

public <R,Q> Stream<R> scatterGather(String queryName,
                                     Q query,
                                     ResponseType<R> responseType,
                                     long timeout,
                                     TimeUnit timeUnit)

Description copied from interface: QueryGateway

Sends given query over the QueryBus, expecting a response in the form of responseType from several sources. The stream is completed when a timeout occurs or when all results are received. Execution may be asynchronous, depending on the QueryBus implementation.

Specified by:

scatterGather in interface QueryGateway

Type Parameters:

R - The response class contained in the given responseType

Q - The query class

Parameters:

queryName - A String describing the query to be executed

query - The query to be sent

responseType - The ResponseType used for this query

timeout - A timeout of long for the query

timeUnit - The selected TimeUnit for the given timeout

Returns:

A stream of results.