org.axonframework.queryhandling

Interface QueryGateway

All Known Implementing Classes:

DefaultQueryGateway

public interface QueryGateway

Interface towards the Query Handling components of an application. This interface provides a friendlier API toward the query bus.

Since:

3.1

Author:

Marc Gathier, Allard Buijze, Steven van Beelen

Method Summary

Modifier and Type	Method and Description
default <R,Q> CompletableFuture<R>	query(Q query, Class<R> responseType) Sends given query over the QueryBus, expecting a response with the given responseType from a single source.
default <R,Q> CompletableFuture<R>	query(Q query, ResponseType<R> responseType) Sends given query over the QueryBus, expecting a response in the form of responseType from a single source.
default <R,Q> CompletableFuture<R>	query(String queryName, Q query, Class<R> responseType) Sends given query over the QueryBus, expecting a response with the given responseType from a single source.
<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.
default <R,Q> Stream<R>	scatterGather(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.
<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.
default <R,Q> CompletableFuture<R>	send(Q query, Class<R> responseType) Deprecated. Use query(Object, Class) instead.
default <R,Q> Stream<R>	send(Q query, Class<R> responseType, long timeout, TimeUnit timeUnit) Deprecated. Use scatterGather(Object, ResponseType, long, TimeUnit) instead.
default <R,Q> Stream<R>	send(Q query, String queryName, Class<R> resultClass, long timeout, TimeUnit timeUnit) Deprecated. Use scatterGather(String, Object, ResponseType, long, TimeUnit) instead.
default <R,Q> CompletableFuture<R>	send(String queryName, Q query, Class<R> responseType) Deprecated. Use query(String, Object, Class) instead.

Method Detail

query

default <R,Q> CompletableFuture<R> query(Q query,
                                         Class<R> responseType)

Sends given query over the QueryBus, expecting a response with the given responseType from a single source. The query name will be derived from the provided query. Execution may be asynchronous, depending on the QueryBus implementation.

Type Parameters:

R - The response class contained in the given responseType

Q - The query class

Parameters:

query - The query to be sent

responseType - A Class describing the desired response type

Returns:

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

query

default <R,Q> CompletableFuture<R> query(String queryName,
                                         Q query,
                                         Class<R> responseType)

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

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

query

default <R,Q> CompletableFuture<R> query(Q query,
                                         ResponseType<R> responseType)

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

Type Parameters:

R - The response class contained in the given responseType

Q - The query class

Parameters:

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

query

<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. Execution may be asynchronous, depending on the QueryBus implementation.

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

default <R,Q> Stream<R> scatterGather(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. The stream is completed when a timeout occurs or when all results are received. The query name will be derived from the provided query. Execution may be asynchronous, depending on the QueryBus implementation.

Type Parameters:

R - The response class contained in the given responseType

Q - The query class

Parameters:

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.

scatterGather

<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. The stream is completed when a timeout occurs or when all results are received. Execution may be asynchronous, depending on the QueryBus implementation.

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.

send

@Deprecated
default <R,Q> CompletableFuture<R> send(String queryName,
                                                     Q query,
                                                     Class<R> responseType)

Deprecated. Use query(String, Object, Class) instead.

Sends given query to the query bus and expects a result of type resultClass. Execution may be asynchronous.

Type Parameters:

R - The type of result expected from query execution.

Q - The query class.

Parameters:

query - The query.

queryName - The name of the query.

responseType - The expected result type.

Returns:

A completable future that contains the first result of the query..

Throws:

NullPointerException - when query is null.

send

@Deprecated
default <R,Q> CompletableFuture<R> send(Q query,
                                                     Class<R> responseType)

Deprecated. Use query(Object, Class) instead.

Sends given query to the query bus and expects a result of type resultClass. Execution may be asynchronous.

Type Parameters:

R - The type of result expected from query execution.

Q - The query class.

Parameters:

query - The query.

responseType - The expected result type.

Returns:

A completable future that contains the first result of the query.

Throws:

NullPointerException - when query is null.

send

@Deprecated
default <R,Q> Stream<R> send(Q query,
                                          Class<R> responseType,
                                          long timeout,
                                          TimeUnit timeUnit)

Deprecated. Use scatterGather(Object, ResponseType, long, TimeUnit) instead.

Sends given query to the query bus and expects a stream of results with type responseType. The stream is completed when a timeout occurs or when all results are received.

Type Parameters:

R - The type of result expected from query execution.

Q - The query class.

Parameters:

query - The query.

responseType - The expected result type.

timeout - Timeout for the request.

timeUnit - Unit for the timeout.

Returns:

A stream of results.

Throws:

NullPointerException - when query is null.

send

@Deprecated
default <R,Q> Stream<R> send(Q query,
                                          String queryName,
                                          Class<R> resultClass,
                                          long timeout,
                                          TimeUnit timeUnit)

Deprecated. Use scatterGather(String, Object, ResponseType, long, TimeUnit) instead.

Sends given query to the query bus and expects a stream of results with name resultName. The stream is completed when a timeout occurs or when all results are received.

Type Parameters:

R - The type of result expected from query execution.

Q - The query class.

Parameters:

query - The query.

queryName - The name of the query.

resultClass - Type type of result.

timeout - Timeout for the request.

timeUnit - Unit for the timeout.

Returns:

A stream of results.