org.axonframework.axonserver.connector

Class AxonServerConnectionManager

java.lang.Object

org.axonframework.axonserver.connector.AxonServerConnectionManager

public class AxonServerConnectionManager
extends Object

The component which manages all the connections which an Axon client can establish with an Axon Server instance. Does so by creating Channels per context and providing them as the means to dispatch/receive messages.

Since:

4.0

Author:

Marc Gathier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AxonServerConnectionManager.Builder Builder class to instantiate an AxonServerConnectionManager.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AxonServerConnectionManager(AxonServerConfiguration axonServerConfiguration) Deprecated. in favor of using the AxonServerConnectionManager.Builder (with the convenience builder() method)to instantiate an Axon Server Connection Manager
	AxonServerConnectionManager(AxonServerConfiguration axonServerConfiguration, TagsConfiguration tagsConfiguration) Deprecated. in favor of using the AxonServerConnectionManager.Builder (with the convenience builder() method)to instantiate an Axon Server Connection Manager
protected	AxonServerConnectionManager(AxonServerConnectionManager.Builder builder) Instantiate a AxonServerConnectionManager based on the fields contained in the AxonServerConnectionManager.Builder.

Method Summary

Modifier and Type	Method and Description
void	addDisconnectListener(Consumer<String> action) Registers a disconnect listener which executes a given action when a connection is disconnected.
void	addDisconnectListener(String context, Runnable action) Registers a disconnect listener which executes a given action when the connection is disconnected for given the context.
void	addReconnectInterceptor(Function<Consumer<String>,Consumer<String>> interceptor) Registers an interceptor that may alter the behavior on an incoming "reconnect request" from the server.
void	addReconnectListener(Consumer<String> action) Registers a reconnect listener that executes given action when a connection is re-established.
void	addReconnectListener(String context, Runnable action) Registers a reconnect listener for the given context that executes given action when a connection is re-established for the given context.
static AxonServerConnectionManager.Builder	builder() Instantiate a Builder to be able to create an AxonServerConnectionManager.
void	disconnect() Disconnects any active connections, forcing a new connection to be established when one is requested.
void	disconnect(String context) Disconnects any active connection for the given context, forcing a new connection to be established when one is requested.
void	disconnectExceptionally(String context, Throwable cause) Forces a disconnection from AxonServer for the specified context.
io.grpc.Channel	getChannel() Returns a Channel for the default context, opening one if necessary.
io.grpc.Channel	getChannel(String context) Returns a Channel representing the connection for the given context, opening one if necessary.
io.grpc.stub.StreamObserver<CommandProviderOutbound>	getCommandStream(String context, io.grpc.stub.StreamObserver<CommandProviderInbound> inboundCommandStream) Opens a Stream for incoming commands from AxonServer in the given context.
String	getDefaultContext() Returns the name of the default context of this application.
io.grpc.stub.StreamObserver<PlatformInboundInstruction>	getPlatformStream(String context, io.grpc.stub.StreamObserver<PlatformOutboundInstruction> outboundInstructionStream) Opens a Stream for platform instructions in given context.
io.grpc.stub.StreamObserver<QueryProviderOutbound>	getQueryStream(String context, io.grpc.stub.StreamObserver<QueryProviderInbound> inboundQueryStream) Opens a Stream for incoming queries from AxonServer in the given context.
boolean	isConnected(String context) Returns true if a gRPC channel for the specific context is opened between client and AxonServer.
void	onOutboundInstruction(BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler) Registers a handler to handle instructions from AxonServer.
void	onOutboundInstruction(BiPredicate<String,PlatformOutboundInstruction.RequestCase> handlerSelector, BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler) Registers a handler to handle instructions from AxonServer.
void	onOutboundInstruction(PlatformOutboundInstruction.RequestCase requestCase, BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler) Registers a handler to handle instructions from AxonServer.
void	onOutboundInstruction(PlatformOutboundInstruction.RequestCase requestCase, Consumer<PlatformOutboundInstruction> consumer) Deprecated. in favor of onOutboundInstruction(String, PlatformOutboundInstruction.RequestCase, Consumer) as the context should be specified on any outbound instruction
void	onOutboundInstruction(String context, BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler) Registers a handler to handle instructions from AxonServer.
void	onOutboundInstruction(String context, PlatformOutboundInstruction.RequestCase requestCase, BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler) Registers a handler to handle instructions from AxonServer.
void	onOutboundInstruction(String context, PlatformOutboundInstruction.RequestCase requestCase, Consumer<PlatformOutboundInstruction> consumer) Registers a handler to handle instructions from AxonServer.
void	send(String context, PlatformInboundInstruction instruction) Send the given instruction for given context to AxonServer.
void	shutdown() Stops the Connection Manager, closing any active connections and preventing new connections from being created.

Methods inherited from class java.lang.Object

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

Constructor Detail

AxonServerConnectionManager

@Deprecated
public AxonServerConnectionManager(AxonServerConfiguration axonServerConfiguration)

Deprecated. in favor of using the AxonServerConnectionManager.Builder (with the convenience builder() method)to instantiate an Axon Server Connection Manager

Initializes the Axon Server Connection Manager with the connect information. An empty TagsConfiguration is used in this case.

Parameters:

axonServerConfiguration - the configuration of Axon Server used to correctly establish connections

AxonServerConnectionManager

@Deprecated
public AxonServerConnectionManager(AxonServerConfiguration axonServerConfiguration,
                                               TagsConfiguration tagsConfiguration)

Deprecated. in favor of using the AxonServerConnectionManager.Builder (with the convenience builder() method)to instantiate an Axon Server Connection Manager

Initializes the Axon Server Connection Manager with connect information and tags configuration.

Parameters:

axonServerConfiguration - the configuration of Axon Server used to correctly establish connections

tagsConfiguration - the TagsConfiguration used to add the tags of this instance as client information

AxonServerConnectionManager

protected AxonServerConnectionManager(AxonServerConnectionManager.Builder builder)

Instantiate a AxonServerConnectionManager based on the fields contained in the AxonServerConnectionManager.Builder.

Parameters:

builder - the AxonServerConnectionManager.Builder used to instantiate a AxonServerConnectionManager instance

Method Detail

builder

public static AxonServerConnectionManager.Builder builder()

Instantiate a Builder to be able to create an AxonServerConnectionManager.

The TagsConfiguration is defaulted to TagsConfiguration.TagsConfiguration() and the ScheduledExecutorService defaults to an instance using a single thread with an AxonThreadFactory tied to it. The AxonServerConfiguration is a hard requirements and as such should be provided.

Returns:

a Builder to be able to create a AxonServerConnectionManager

getChannel

public io.grpc.Channel getChannel()

Returns a Channel for the default context, opening one if necessary.

Returns:

a Channel for the default context

getChannel

public io.grpc.Channel getChannel(String context)

Returns a Channel representing the connection for the given context, opening one if necessary.

Parameters:

context - the context for which to open a connection

Returns:

the Channel corresponding to the given context

addReconnectListener

public void addReconnectListener(String context,
                                 Runnable action)

Registers a reconnect listener for the given context that executes given action when a connection is re-established for the given context.

Parameters:

context - the context to register the reconnect listener for

action - the action to perform when the connection for the given context is re-established

addReconnectListener

public void addReconnectListener(Consumer<String> action)

Registers a reconnect listener that executes given action when a connection is re-established. The parameter of the invoked action is the name of the context for which the application was lost.

Parameters:

action - the action to perform when a connection is re-established

addDisconnectListener

public void addDisconnectListener(String context,
                                  Runnable action)

Registers a disconnect listener which executes a given action when the connection is disconnected for given the context.

Parameters:

context - the context to register the disconnect listener for

action - the action to perform when the connection for the given context is disconnected

addDisconnectListener

public void addDisconnectListener(Consumer<String> action)

Registers a disconnect listener which executes a given action when a connection is disconnected. The parameter of the invoked action is the name of the context for which the connection was lost.

Parameters:

action - the action to perform when a connection is disconnected

addReconnectInterceptor

public void addReconnectInterceptor(Function<Consumer<String>,Consumer<String>> interceptor)

Registers an interceptor that may alter the behavior on an incoming "reconnect request" from the server. This request occurs when AxonServer requests connections to be established on another node than the current one.

The registered interceptor may deny these requests by blocking the call to the input Consumer.

Parameters:

interceptor - a function altering the original reconnect request

getCommandStream

public io.grpc.stub.StreamObserver<CommandProviderOutbound> getCommandStream(String context,
                                                                             io.grpc.stub.StreamObserver<CommandProviderInbound> inboundCommandStream)

Opens a Stream for incoming commands from AxonServer in the given context. While either reuse an existing Channel or create a new one.

Parameters:

context - the context to open the command stream for

inboundCommandStream - the callback to invoke with incoming command messages

Returns:

the stream to send command subscription instructions and execution results to AxonServer over

getQueryStream

public io.grpc.stub.StreamObserver<QueryProviderOutbound> getQueryStream(String context,
                                                                         io.grpc.stub.StreamObserver<QueryProviderInbound> inboundQueryStream)

Opens a Stream for incoming queries from AxonServer in the given context. While either reuse an existing Channel or create a new one.

Parameters:

context - the context to open the query stream for

inboundQueryStream - the callback to invoke with incoming query messages

Returns:

the stream to send query subscription instructions and query responses to AxonServer over

getPlatformStream

public io.grpc.stub.StreamObserver<PlatformInboundInstruction> getPlatformStream(String context,
                                                                                 io.grpc.stub.StreamObserver<PlatformOutboundInstruction> outboundInstructionStream)

Opens a Stream for platform instructions in given context. It assumes that channel with given context is already opened.

Parameters:

context - the context

outboundInstructionStream - the callback to invoke outbounding instructions

Returns:

the stream to send instructions

onOutboundInstruction

@Deprecated
public void onOutboundInstruction(PlatformOutboundInstruction.RequestCase requestCase,
                                              Consumer<PlatformOutboundInstruction> consumer)

Deprecated. in favor of onOutboundInstruction(String, PlatformOutboundInstruction.RequestCase, Consumer) as the context should be specified on any outbound instruction

Registers a handler to handle instructions from AxonServer on the default context.

Parameters:

requestCase - the type of instruction to respond to

consumer - the handler of the instruction

onOutboundInstruction

public void onOutboundInstruction(String context,
                                  PlatformOutboundInstruction.RequestCase requestCase,
                                  Consumer<PlatformOutboundInstruction> consumer)

Registers a handler to handle instructions from AxonServer.

Parameters:

context - the context for which the instruction is intended

requestCase - the type of instruction to respond to

consumer - the handler of the instruction

onOutboundInstruction

public void onOutboundInstruction(PlatformOutboundInstruction.RequestCase requestCase,
                                  BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler)

Registers a handler to handle instructions from AxonServer.

Parameters:

requestCase - the type of instruction to respond to

handler - the handler of the instruction

onOutboundInstruction

public void onOutboundInstruction(String context,
                                  BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler)

Registers a handler to handle instructions from AxonServer.

Parameters:

context - the context

handler - the handler of the instruction

onOutboundInstruction

public void onOutboundInstruction(BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler)

Registers a handler to handle instructions from AxonServer.

Parameters:

handler - the handler of the instruction

onOutboundInstruction

public void onOutboundInstruction(String context,
                                  PlatformOutboundInstruction.RequestCase requestCase,
                                  BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler)

Registers a handler to handle instructions from AxonServer.

Parameters:

context - the context

requestCase - the type of instruction to respond to

handler - the handler of the instruction

onOutboundInstruction

public void onOutboundInstruction(BiPredicate<String,PlatformOutboundInstruction.RequestCase> handlerSelector,
                                  BiConsumer<PlatformOutboundInstruction,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> handler)

Registers a handler to handle instructions from AxonServer.

Parameters:

handlerSelector - selects a handler based on context and request case

handler - the handler of the instruction

send

public void send(String context,
                 PlatformInboundInstruction instruction)

Send the given instruction for given context to AxonServer. Will not send anything if no Channel can be created or found for the given context.

Parameters:

context - the context for which the instruction is intended

instruction - the message containing information for AxonServer to process

disconnectExceptionally

public void disconnectExceptionally(String context,
                                    Throwable cause)

Forces a disconnection from AxonServer for the specified context.

Parameters:

context - the (Bounded) Context for which the disconnection is required

cause - the cause of the disconnection

isConnected

public boolean isConnected(String context)

Returns true if a gRPC channel for the specific context is opened between client and AxonServer.

Parameters:

context - the (Bounded) Context for for which is verified the AxonServer connection through the gRPC channel

Returns:

if the gRPC channel is opened, false otherwise

shutdown

@ShutdownHandler(phase=-134217728)
public void shutdown()

Stops the Connection Manager, closing any active connections and preventing new connections from being created. This shutdown operation is performed in the Phase.EXTERNAL_CONNECTIONS phase.

disconnect

public void disconnect(String context)

Disconnects any active connection for the given context, forcing a new connection to be established when one is requested.

Parameters:

context - the context for which the connection must be disconnected

disconnect

public void disconnect()

Disconnects any active connections, forcing a new connection to be established when one is requested.

getDefaultContext

public String getDefaultContext()

Returns the name of the default context of this application.

Returns:

the name of the default context of this application