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

Interface BrokerConnection

All Superinterfaces:

ActiveMQComponent

public interface BrokerConnection
extends ActiveMQComponent

A broker connection defines a server connection created to provide services between this server and another instance.

Method Summary

Modifier and Type	Method	Description
BrokerConnectConfiguration	getConfiguration()	Returns the configuration that was used to create this broker connection.
String	getName()	Returns the unique name of the broker connection.
String	getProtocol()	Returns the protocol that underlies the broker connection implementation.
default void	initialize()
boolean	isConnected()	Returns true if the broker connection is currently connected to the remote.
default void	shutdown()

Methods inherited from interface org.apache.activemq.artemis.core.server.ActiveMQComponent

asyncStop, isStarted, start, stop

Method Details

initialize

default void initialize()
                 throws Exception

Throws:

Exception

shutdown

default void shutdown()
               throws Exception

Throws:

Exception

getName

String getName()

Returns the unique name of the broker connection.

Returns:

the unique name of the broker connection

getProtocol

String getProtocol()

Returns the protocol that underlies the broker connection implementation.

Returns:

the protocol that underlies the broker connection implementation

isConnected

boolean isConnected()

Returns true if the broker connection is currently connected to the remote.

Returns:

true if the broker connection is currently connected to the remote

getConfiguration

BrokerConnectConfiguration getConfiguration()

Returns the configuration that was used to create this broker connection.

Returns:

the configuration that was used to create this broker connection