Module io.axoniq.connector.axonserver
Package io.axoniq.axonserver.connector

Interface AxonServerConnection

  • All Known Implementing Classes:
    ContextConnection
    public interface AxonServerConnection
    Interface exposing available operations on a connection to AxonServer. In multi-context connections, each connection to a context will be represented by its own instance.

    • Method Detail

      • isConnectionFailed

        boolean isConnectionFailed()
        Indicates whether the underlying connection failed. This may occur when AxonServer cannot be reached.
        Returns:
        true when the underlying connection failed, otherwise false

      • isReady

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

      • isConnected

        boolean isConnected()
        Indicates whether the underlying connection is active. This means a network connection has been made with an AxonServer instance.
        Returns:
        true if a network connection to AxonServer is available, otherwise false

      • disconnect

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

      • controlChannel

        ControlChannel controlChannel()
        Returns the channel on which platform control messages can be sent and received.
        Returns:
        the channel for platform instructions

      • commandChannel

        CommandChannel commandChannel()
        Returns the channel on which Command related interactions can be performed with AxonServer.
        Returns:
        the channel for Command messaging

      • eventChannel

        EventChannel eventChannel()
        Returns the channel on which Event related interactions can be performed with AxonServer.
        Returns:
        the channel for Event messaging

      • dcbEventChannel

        DcbEventChannel dcbEventChannel()
        Returns the channel on which Event related interactions can be performed with Axon Server using the Dynamic Consistency Boundary concept.
        Returns:
        the channel for Event messaging

      • queryChannel

        QueryChannel queryChannel()
        Returns the channel on which Query related interactions can be performed with AxonServer.
        Returns:
        the channel for Query messaging

      • snapshotChannel

        SnapshotChannel snapshotChannel()
        Returns the channel on which Snapshotting can be performed with AxonServer.
        Returns:
        the channel for Snapshotting

      • eventTransformationChannel

        EventTransformationChannel eventTransformationChannel()
        Returns the channel on which Event transformations can be performed with AxonServer.
        Returns:
        the channel for Event transformations

      • adminChannel

        AdminChannel adminChannel()
        Returns the channel on which administration messages can be sent and received
        Returns:
        the channel for Admin messaging