Package org.apache.activemq.artemis.core.server

Interface RemoteBrokerConnection

public interface RemoteBrokerConnection
A remote broker connection defines a view of the remote end of an active BrokerConnection.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Returns the name of the broker connection as defined on the remote server; this value is unique on the remote server but is only unique on the local end when combined with the unique node Id from which the broker connection was initiated.
    String
    getNodeId()
    Returns the node Id of the remote broker that created the incoming connection.
    String
    getProtocol()
    Returns the protocol that underlies the broker connection implementation.
    void
    initialize()
    Handles initialization when the remote connection is setup.
    void
    shutdown()
    Handles cleanup when the remote connection is closed or becomes disconnect.

  • Method Details

    • initialize

      void initialize() throws Exception
      Handles initialization when the remote connection is setup.
      Throws:
      Exception - if an error occurs during initialization.

    • shutdown

      void shutdown() throws Exception
      Handles cleanup when the remote connection is closed or becomes disconnect.
      Throws:
      Exception - if an error occurs during shutdown.

    • getName

      String getName()
      Returns the name of the broker connection as defined on the remote server; this value is unique on the remote server but is only unique on the local end when combined with the unique node Id from which the broker connection was initiated.
      Returns:
      the name of the broker connection as defined on the remote server; this value is unique on the remote server but is only unique on the local end when combined with the unique node Id from which the broker connection was initiated

    • getNodeId

      String getNodeId()
      Returns the node Id of the remote broker that created the incoming connection.
      Returns:
      the node Id of the remote broker that created the incoming connection

    • getProtocol

      String getProtocol()
      Returns the protocol that underlies the broker connection implementation.
      Returns:
      the protocol that underlies the broker connection implementation