Repository: qpid-jms Updated Branches: refs/heads/master bc6c7a3ab -> f19b01cb4
QPIDJMS-210 Add documentation for the WebSocket transport Project: http://git-wip-us.apache.org/repos/asf/qpid-jms/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-jms/commit/f19b01cb Tree: http://git-wip-us.apache.org/repos/asf/qpid-jms/tree/f19b01cb Diff: http://git-wip-us.apache.org/repos/asf/qpid-jms/diff/f19b01cb Branch: refs/heads/master Commit: f19b01cb45ac1c01a5c34ffa7e7ec0a137700b5a Parents: bc6c7a3 Author: Timothy Bish <[email protected]> Authored: Tue Sep 27 12:58:13 2016 -0400 Committer: Timothy Bish <[email protected]> Committed: Tue Sep 27 12:58:13 2016 -0400 ---------------------------------------------------------------------- qpid-jms-docs/Configuration.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-jms/blob/f19b01cb/qpid-jms-docs/Configuration.md ---------------------------------------------------------------------- diff --git a/qpid-jms-docs/Configuration.md b/qpid-jms-docs/Configuration.md index d9c05bf..40f9fb7 100644 --- a/qpid-jms-docs/Configuration.md +++ b/qpid-jms-docs/Configuration.md @@ -67,7 +67,11 @@ The basic format of the clients Connection URI is as follows: amqp[s]://hostname:port[?option=value[&option2=value...]] -Where the *amqps* scheme is specified to use SSL/TLS, the hostname segment from the URI can be used by the JVM for the +or for WebSocket connections + + amqpws[s]://hostname:port[/path][?option=value[&option2=value...]] + +Where the *amqps* and *amqpwss* scheme is specified to use SSL/TLS, the hostname segment from the URI can be used by the JVM for the TLS SNI (Server Name Indication) extension in order to communicate the desired server hostname during a TLS handshake. The SNI extension will be automatically included if a Fully Qualified name (e.g myhost.mydomain) is specified, but not when an unqualified name (e.g myhost) or bare IP address are used. @@ -173,6 +177,15 @@ The complete set of SSL Transport options is listed below: + **transport.verifyHost** Whether to verify that the hostname being connected to matches with the provided server certificate. Defaults to true. + **transport.keyAlias** The alias to use when selecting a keypair from the keystore if required to send a client certificate to the server. No default. +### Websocket Transport Configuration options + +The WebSocket (WS) Transport extends the TCP and SSL Transports to provide both unsecured and secured Websocket connectivity and is enabled using the *amqpws* amd *amqpwss* URI schemes. The unsecured WS Transport extends the basic TCP transport which means all the normal TCP Transport configuration options also apply to the WS Transport, similarly the WSS Transport extends the SSL Transport which means both the TCP and SSL Transport options are available for configuration. + +A simple SSL/TLS based client URI is shown below: + + amqpws[s]://myhost.mydomain:5671/[optional-path] + + ### AMQP Configuration options These options apply to the behaviour of certain AMQP functionality. --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
