Module io.axoniq.connector.axonserver

Package io.axoniq.axonserver.connector.command.impl

Class CommandChannelImpl

java.lang.Object

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

io.axoniq.axonserver.connector.command.impl.CommandChannelImpl

All Implemented Interfaces:

CommandChannel

public class CommandChannelImpl
extends AbstractAxonServerChannel<CommandProviderOutbound>
implements CommandChannel

CommandChannel implementation, serving as the command connection between AxonServer and a client application.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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 CommandChannel to disconnect, by unsubscribing all registered command handlers.
void	reconnect()	Reconnect this channel with AxonServer.
Registration	registerCommandHandler(Function<Command,CompletableFuture<CommandResponse>> handler, int loadFactor, String... commandNames)	Registers the given handler to handle incoming commands with given commandNames, using the given loadFactor.
CompletableFuture<CommandResponse>	sendCommand(Command command)	Sends the give Command to AxonServer for routing to an 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

CommandChannelImpl

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

Constructs a CommandChannelImpl.

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<CommandProviderOutbound>

reconnect

public void reconnect()

Description copied from class: AbstractAxonServerChannel

Reconnect this channel with AxonServer.

Specified by:

reconnect in class AbstractAxonServerChannel<CommandProviderOutbound>

disconnect

public void disconnect()

Description copied from class: AbstractAxonServerChannel

Disconnect this channel from AxonServer.

Specified by:

disconnect in class AbstractAxonServerChannel<CommandProviderOutbound>

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<CommandProviderOutbound>

Returns:

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

registerCommandHandler

public Registration registerCommandHandler(Function<Command,CompletableFuture<CommandResponse>> handler,
                                           int loadFactor,
                                           String... commandNames)

Description copied from interface: CommandChannel

Registers the given handler to handle incoming commands with given commandNames, using the given loadFactor. If handlers had already been registered for any of the given command names, this registration replaces the existing one for those command names. Other commands remain unaffected.

Specified by:

registerCommandHandler in interface CommandChannel

Parameters:

handler - the handler to handle incoming commands with

loadFactor - the relative load factor for this handler

commandNames - the names of the commands to register the handler for

Returns:

a registration which allows the command handler to be deregistered

sendCommand

public CompletableFuture<CommandResponse> sendCommand(Command command)

Description copied from interface: CommandChannel

Sends the give Command to AxonServer for routing to an appropriate handler.

Specified by:

sendCommand in interface CommandChannel

Parameters:

command - the command to send

Returns:

a CompletableFuture providing the result of command execution

prepareDisconnect

public CompletableFuture<Void> prepareDisconnect()

Description copied from interface: CommandChannel

Prepares this CommandChannel to disconnect, by unsubscribing all registered command 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 CommandChannel

Returns:

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