Skip to content

Commit

Permalink
ARTEMIS-4369: add clarifying note to docs around transport options fo…
Browse files Browse the repository at this point in the history
…r broker-connections
  • Loading branch information
gemmellr committed Jul 21, 2023
1 parent 5e232c2 commit 6442270
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/user-manual/en/amqp-broker-connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,16 @@ 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)
- `retry-interval`: Time, in milliseconds to wait before retrying a connection after an error. The default value is `5000`.
- `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.
Expand Down

0 comments on commit 6442270

Please sign in to comment.