Red Hat SummitRed Hat AMQ 6
As of February 2025, Red Hat is no longer supporting Red Hat AMQ 6. If you are using AMQ 6, please upgrade: Migrating to AMQ 7.Chapter 14. Adding Client Connection Points
Abstract
Message brokers must explicitly create connection points for clients. These connection points are called transport connectors. Red Hat JBoss A-MQ supports a number of transport flavors to facilitate interoperability with the widest possible array of clients.
A message broker communicates with its clients using one or more ports. These ports are managed by the broker's configuration. There are two required components to add a client connection point to a broker:
- a
transportConnectorelement in the XML configuration template that provides the details for the connection point - an entry in the broker's
org.fusesource.mq.fabric.server.idPID's connectors property to activate the connection point
The
transportConnector element provides all of the details needed to create the connection point. This includes the type of transport being used, the host and port for the connection, and any transport properties needed. The connectors property is a space delimited list that specifies which transport connectors to activate.
Red Hat JBoss Fuse supports a number of different transport flavors. Each transport has its own set of strengths. For more information on the different transports see the Client Connectivity Guide and the Connection Reference.
14.1. Adding a Transport Connector to a Standalone Broker
Adding a transport connector definition
To add a transport connector definition:
- Open the broker's configuration template for editing.
- Locate the
transportConnectorselement. - Add a
transportConnectorelement as a child of thetransportConnectorselement. - Add a
nameattribute to the newtransportConnectorelement.Thenameattribute specifies a unique identifier for the transport connector. It is used in the connectors property to identify the transport to be activated. - Add a
uriattribute to the newtransportConnectorelement.Theuriattribute specifies the connection details used to instantiate the connector. Clients will use a similar URI to access the broker using this connector. For a complete list of the URIs see the Connection Reference. - Save the changes to the configuration template.
Note
The newly added transport connector is not available until it has been activated using the connectors property.
Activating a connector
To activate a transport connector in a standalone broker:
- Connect to the broker using a command console.
- Open the broker's
org.fusesource.mq.fabric.server.idPID for editing using the config:editcommand.JBossAMQ:karaf>config:edit org.fusesource.mq.fabric.server.098765NoteYou can use the config:list command to find the id for the broker. - Verify the value of the connectors property using the config:proplist command.
JBossAMQ:karaf>config:proplist connector - Change the value of the connectors property using the config:propset command.
JBossAMQ:karaf>config:propset connector "connector1 connector2..."connector1 specifies the name of a transport to activate. The value corresponds the value of thetransportConnectorelement'snameattribute. - Save the changes using the config:update command.
JBossAMQ:karaf>config:update
