io.axoniq.axonserver.connector.query.impl

Class QueryChannelImpl

java.lang.Object

io.axoniq.axonserver.connector.impl.AbstractAxonServerChannel<QueryProviderOutbound>

io.axoniq.axonserver.connector.query.impl.QueryChannelImpl

All Implemented Interfaces:

QueryChannel

public class QueryChannelImpl
extends AbstractAxonServerChannel<QueryProviderOutbound>
implements QueryChannel

QueryChannel implementation, serving as the query connection between AxonServer and a client application.

Constructor Summary

Constructors

Constructor and Description
QueryChannelImpl(ClientIdentification clientIdentification, String context, int permits, int permitsBatch, ScheduledExecutorService executor, AxonServerManagedChannel channel) Constructs a QueryChannelImpl.

Method Summary

Modifier and Type	Method and Description
void	connect() Connect this channel with AxonServer.
void	disconnect() Disconnect this channel from AxonServer.
boolean	isReady() Validate whether this channel has all required streams connected with AxonServer.
CompletableFuture<Void>	prepareDisconnect() Prepares this QueryChannel to disconnect, by unsubscribing all registered query handlers.
ResultStream<QueryResponse>	query(QueryRequest query) Sends the given query to AxonServer for routing to the appropriate handlers.
void	reconnect() Reconnect this channel with AxonServer.
Registration	registerQueryHandler(QueryHandler handler, QueryDefinition... queryDefinitions) Registers the given handler to handle incoming queries defined through the given queryTypes.
SubscriptionQueryResult	subscriptionQuery(QueryRequest query, SerializedObject updateResponseType, int bufferSize, int fetchSize) Sends out a subscription query to AxonServer for routing to the appropriate handler.

Methods inherited from class io.axoniq.axonserver.connector.impl.AbstractAxonServerChannel

processAck, scheduleImmediateReconnect, scheduleReconnect, sendInstruction

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryChannelImpl

public QueryChannelImpl(ClientIdentification clientIdentification,
                        String context,
                        int permits,
                        int permitsBatch,
                        ScheduledExecutorService executor,
                        AxonServerManagedChannel channel)

Constructs a QueryChannelImpl.

Parameters:

clientIdentification - client information identifying whom has connected. This information is used to pass on to message

permits - an int defining the number of permits this channel has

permitsBatch - an int defining the number of permits to be consumed from prior to requesting additional permits for this channel

executor - a ScheduledExecutorService used to schedule reconnects of this channel

channel - the AxonServerManagedChannel used to form the connection with AxonServer

Method Detail

connect

public void connect()

Description copied from class: AbstractAxonServerChannel

Connect this channel with AxonServer.

Specified by:

connect in class AbstractAxonServerChannel<QueryProviderOutbound>

registerQueryHandler

public Registration registerQueryHandler(QueryHandler handler,
                                         QueryDefinition... queryDefinitions)

Description copied from interface: QueryChannel

Registers the given handler to handle incoming queries defined through the given queryTypes. Duplicate handlers can be registered.

Specified by:

registerQueryHandler in interface QueryChannel

Parameters:

handler - the handler to handle incoming queries with

queryDefinitions - the QueryDefinitions to register the handler for

Returns:

a registration which allows the query handler to be deregistered

query

public ResultStream<QueryResponse> query(QueryRequest query)

Description copied from interface: QueryChannel

Sends the given query to AxonServer for routing to the appropriate handlers.

Specified by:

query in interface QueryChannel

Parameters:

query - the QueryRequest to send

Returns:

a ResultStream providing the results of query execution

subscriptionQuery

public SubscriptionQueryResult subscriptionQuery(QueryRequest query,
                                                 SerializedObject updateResponseType,
                                                 int bufferSize,
                                                 int fetchSize)

Description copied from interface: QueryChannel

Sends out a subscription query to AxonServer for routing to the appropriate handler. Allows for receiving an initial query result followed by a stream of updates.

Specified by:

subscriptionQuery in interface QueryChannel

Parameters:

query - the subscription QueryRequest to send

updateResponseType - the type of updates expected from this subscription query

bufferSize - the number of updates to be buffered by the update result stream

fetchSize - the number of updates to be consumed from the update stream prior to refilling it

Returns:

the SubscriptionQueryResult containing the initial result and update stream

disconnect

public void disconnect()

Description copied from class: AbstractAxonServerChannel

Disconnect this channel from AxonServer.

Specified by:

disconnect in class AbstractAxonServerChannel<QueryProviderOutbound>

reconnect

public void reconnect()

Description copied from class: AbstractAxonServerChannel

Reconnect this channel with AxonServer.

Specified by:

reconnect in class AbstractAxonServerChannel<QueryProviderOutbound>

prepareDisconnect

public CompletableFuture<Void> prepareDisconnect()

Description copied from interface: QueryChannel

Prepares this QueryChannel to disconnect, by unsubscribing all registered query handlers. Will wait with a certain cut off until all acknowledgments of unsubscribing have been received.

This method should be used if a connected client wants to disconnect from AxonServer.

Specified by:

prepareDisconnect in interface QueryChannel

Returns:

a CompletableFuture of Void to react when all query handlers have been unsubscribed

isReady

public boolean isReady()

Description copied from class: AbstractAxonServerChannel

Validate whether this channel has all required streams connected with AxonServer. If the state of the channel does not require any active streams, it is considered ready and will return true.

Specified by:

isReady in class AbstractAxonServerChannel<QueryProviderOutbound>

Returns:

true if this channel is connected with AxonServer or does not require any active connections, false otherwise