Module io.axoniq.connector.axonserver

Package io.axoniq.axonserver.connector.impl

Class ContextConnection

java.lang.Object

io.axoniq.axonserver.connector.impl.ContextConnection

All Implemented Interfaces:

AxonServerConnection

public class ContextConnection
extends Object
implements AxonServerConnection

Implementation of the AxonServerConnection, carrying context information with the overall connection. The context information can be used to support the notion of bounded contexts or multi-tenancy for example.

Constructor Summary

Constructors

Constructor	Description
ContextConnection(ClientIdentification clientIdentification, ScheduledExecutorService executorService, AxonServerManagedChannel connection, long processorInfoUpdateFrequency, int commandPermits, int queryPermits, String context, Consumer<ContextConnection> onShutdown)	Construct a ContextConnection carrying context information.

Method Summary

Modifier and Type	Method	Description
AdminChannel	adminChannel()	Returns the channel on which administration messages can be sent and received
CommandChannel	commandChannel()	Returns the channel on which Command related interactions can be performed with AxonServer.
void	connect()	Ensure there is a connection with the ControlChannel this connection provides.
ControlChannel	controlChannel()	Returns the channel on which platform control messages can be sent and received.
DcbEventChannel	dcbEventChannel()	Returns the channel on which Event related interactions can be performed with Axon Server using the Dynamic Consistency Boundary concept.
void	disconnect()	Disconnects all communication channels and terminates any active network connections to AxonServer.
EventChannel	eventChannel()	Returns the channel on which Event related interactions can be performed with AxonServer.
EventTransformationChannel	eventTransformationChannel()	Returns the channel on which Event transformations can be performed with AxonServer.
AxonServerManagedChannel	getManagedChannel()	Retrieve the AxonServerManagedChannel used to create connection with.
boolean	isConnected()	Indicates whether the underlying connection is active.
boolean	isConnectionFailed()	Indicates whether the underlying connection failed.
boolean	isReady()	Indicates whether the connection is ready to process and receive instructions.
QueryChannel	queryChannel()	Returns the channel on which Query related interactions can be performed with AxonServer.
SnapshotChannel	snapshotChannel()	Returns the channel on which Snapshotting can be performed with AxonServer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextConnection

public ContextConnection(ClientIdentification clientIdentification,
                         ScheduledExecutorService executorService,
                         AxonServerManagedChannel connection,
                         long processorInfoUpdateFrequency,
                         int commandPermits,
                         int queryPermits,
                         String context,
                         Consumer<ContextConnection> onShutdown)

Construct a ContextConnection carrying context information.

Parameters:

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

executorService - a ScheduledExecutorService used to schedule reconnects in the channels this connection provides

connection - the AxonServerManagedChannel used to form the connections with AxonServer

processorInfoUpdateFrequency - the update frequency in milliseconds of event processor information

commandPermits - the number of permits for command streams

queryPermits - the number of permits for query streams

context - the context this connection belongs to

onShutdown - a shutdown hook to invoke whenever this ContextConnection disconnects

Method Detail

isConnectionFailed

public boolean isConnectionFailed()

Description copied from interface: AxonServerConnection

Indicates whether the underlying connection failed. This may occur when AxonServer cannot be reached.

Specified by:

isConnectionFailed in interface AxonServerConnection

Returns:

true when the underlying connection failed, otherwise false

isReady

public boolean isReady()

Description copied from interface: AxonServerConnection

Indicates whether the connection is ready to process and receive instructions. A connection is considered ready when it is connected (see AxonServerConnection.isConnected() and if all previously active communication channels (e.g. command, query, instruction) have been activated.

Specified by:

isReady in interface AxonServerConnection

Returns:

true if the underlying connection is ready, otherwise false

isConnected

public boolean isConnected()

Description copied from interface: AxonServerConnection

Indicates whether the underlying connection is active. This means a network connection has been made with an AxonServer instance.

Specified by:

isConnected in interface AxonServerConnection

Returns:

true if a network connection to AxonServer is available, otherwise false

disconnect

public void disconnect()

Description copied from interface: AxonServerConnection

Disconnects all communication channels and terminates any active network connections to AxonServer. No more operations can be performed on this connection after invoking disconnect().

Specified by:

disconnect in interface AxonServerConnection

controlChannel

public ControlChannel controlChannel()

Description copied from interface: AxonServerConnection

Returns the channel on which platform control messages can be sent and received.

Specified by:

controlChannel in interface AxonServerConnection

Returns:

the channel for platform instructions

connect

public void connect()

Ensure there is a connection with the ControlChannel this connection provides.

commandChannel

public CommandChannel commandChannel()

Description copied from interface: AxonServerConnection

Returns the channel on which Command related interactions can be performed with AxonServer.

Specified by:

commandChannel in interface AxonServerConnection

Returns:

the channel for Command messaging

eventChannel

public EventChannel eventChannel()

Description copied from interface: AxonServerConnection

Returns the channel on which Event related interactions can be performed with AxonServer.

Specified by:

eventChannel in interface AxonServerConnection

Returns:

the channel for Event messaging

snapshotChannel

public SnapshotChannel snapshotChannel()

Description copied from interface: AxonServerConnection

Returns the channel on which Snapshotting can be performed with AxonServer.

Specified by:

snapshotChannel in interface AxonServerConnection

Returns:

the channel for Snapshotting

dcbEventChannel

public DcbEventChannel dcbEventChannel()

Description copied from interface: AxonServerConnection

Returns the channel on which Event related interactions can be performed with Axon Server using the Dynamic Consistency Boundary concept.

Specified by:

dcbEventChannel in interface AxonServerConnection

Returns:

the channel for Event messaging

queryChannel

public QueryChannel queryChannel()

Description copied from interface: AxonServerConnection

Returns the channel on which Query related interactions can be performed with AxonServer.

Specified by:

queryChannel in interface AxonServerConnection

Returns:

the channel for Query messaging

eventTransformationChannel

public EventTransformationChannel eventTransformationChannel()

Description copied from interface: AxonServerConnection

Returns the channel on which Event transformations can be performed with AxonServer.

Specified by:

eventTransformationChannel in interface AxonServerConnection

Returns:

the channel for Event transformations

adminChannel

public AdminChannel adminChannel()

Description copied from interface: AxonServerConnection

Returns the channel on which administration messages can be sent and received

Specified by:

adminChannel in interface AxonServerConnection

Returns:

the channel for Admin messaging

getManagedChannel

public AxonServerManagedChannel getManagedChannel()

Retrieve the AxonServerManagedChannel used to create connection with.

Returns:

the AxonServerManagedChannel used to create connection with