This is an automated email from the ASF dual-hosted git repository.
robbie pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/activemq-artemis.git
The following commit(s) were added to refs/heads/main by this push:
new 6442270e2d ARTEMIS-4369: add clarifying note to docs around transport
options for broker-connections
6442270e2d is described below
commit 6442270e2d90e501f8eaf0abb1102e8e28952474
Author: Robbie Gemmell <[email protected]>
AuthorDate: Fri Jul 21 10:43:15 2023 +0100
ARTEMIS-4369: add clarifying note to docs around transport options for
broker-connections
---
docs/user-manual/en/amqp-broker-connections.md | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/docs/user-manual/en/amqp-broker-connections.md
b/docs/user-manual/en/amqp-broker-connections.md
index 0f10ff9b0b..198b508c87 100644
--- a/docs/user-manual/en/amqp-broker-connections.md
+++ b/docs/user-manual/en/amqp-broker-connections.md
@@ -26,7 +26,7 @@ To define an AMQP broker connection, add an
`<amqp-connection>` element within t
</broker-connections>
```
-- `uri`: tcp://host:myport (this is a required argument)
+- `uri`: tcp://host:myport[?options] (this is a required argument)
- `name`: Name of the connection used for management purposes
- `user`: User name with which to connect to the endpoint (this is an optional
argument)
- `password`: Password with which to connect to the endpoint (this is an
optional argument)
@@ -34,6 +34,8 @@ To define an AMQP broker connection, add an
`<amqp-connection>` element within t
- `reconnect-attempts`: default is -1 meaning infinite
- `auto-start` : Should the broker connection start automatically with the
broker. Default is `true`. If false it is necessary to call a management
operation to start it.
+Note that the connection URI options for transport settings such as enabling
and configuring TLS are common with other Artemis connector URIs. See [the
transport doc](configuring-transports.md#configuring-netty-ssl) for more. An
example configuration for a TLS AMQP broker-connection can be found in the
broker examples at ./examples/features/broker-connection/amqp-sending-overssl.
+
*Notice:* If auto-start is disabled on the broker connection, the start of the
broker connection will only happen after the management method
`startBrokerConnection(connectionName)` is called on the ServerController.
*Important*: The target endpoint needs permission for all operations that are
configured. Therefore, If a security manager is being used, ensure that you
perform the configured operations with a user with sufficient permissions.
