You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ro...@apache.org on 2016/04/07 18:43:59 UTC
svn commit: r1738151 - in /qpid/site:
docs/releases/qpid-dispatch-master/index.html
docs/releases/qpid-jms-master/docs/index.html
docs/releases/qpid-jms-master/index.html
input/releases/qpid-jms-master/docs/index.md
input/releases/qpid-jms-master/index.md
Author: robbie
Date: Thu Apr 7 16:43:59 2016
New Revision: 1738151
URL: http://svn.apache.org/viewvc?rev=1738151&view=rev
Log:
NO-JIRA: update the site with latest JMS client master docs
Modified:
qpid/site/docs/releases/qpid-dispatch-master/index.html
qpid/site/docs/releases/qpid-jms-master/docs/index.html
qpid/site/docs/releases/qpid-jms-master/index.html
qpid/site/input/releases/qpid-jms-master/docs/index.md
qpid/site/input/releases/qpid-jms-master/index.md
Modified: qpid/site/docs/releases/qpid-dispatch-master/index.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-dispatch-master/index.html?rev=1738151&r1=1738150&r2=1738151&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-dispatch-master/index.html (original)
+++ qpid/site/docs/releases/qpid-dispatch-master/index.html Thu Apr 7 16:43:59 2016
@@ -124,7 +124,7 @@ https://github.com/apache/qpid-proton/bl
incomplete. For a smoother experience, see the <a href="/releases/qpid-dispatch-0.5/index.html">current stable
release</a>.</p>
-<p>This content was generated at 12:49 on Tuesday, 05 April 2016.</p>
+<p>This content was generated at 12:55 on Tuesday, 05 April 2016.</p>
</div>
Modified: qpid/site/docs/releases/qpid-jms-master/docs/index.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-jms-master/docs/index.html?rev=1738151&r1=1738150&r2=1738151&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-jms-master/docs/index.html (original)
+++ qpid/site/docs/releases/qpid-jms-master/docs/index.html Thu Apr 7 16:43:59 2016
@@ -188,9 +188,14 @@ Topic topic = (Topic) context.lookup("my
<p>The basic format of the clients Connection URI is as follows:</p>
-<pre><code> amqp://hostname:port[?option=value[&option2=value...]]
+<pre><code> amqp[s]://hostname:port[?option=value[&option2=value...]]
</code></pre>
+<p>Where the <em>amqps</em> 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.</p>
+
<p>The client can be configured with a number of different settings using the URI while defining the ConnectionFactory, these are detailed in the following sections.</p>
<h3 id="jms-configuration-options">JMS Configuration options</h3>
@@ -215,9 +220,12 @@ Topic topic = (Topic) context.lookup("my
<li><strong>jms.topicPrefix</strong> Optional prefix value added to the name of any Topic created from a JMS Session.</li>
<li><strong>jms.closeTimeout</strong> Timeout value that controls how long the client waits on Connection close before returning. (By default the client waits 15 seconds for a normal close completion event).</li>
<li><strong>jms.connectTimeout</strong> Timeout value that controls how long the client waits on Connection establishment before returning with an error. (By default the client waits 15 seconds for a connection to be established before failing).</li>
+<li><strong>jms.sendTimeout</strong> Timeout value that controls how long the client waits on completion of a synchronous message send before returning an error (By default the client will wait indefinitely for a send to complete).</li>
+<li><strong>jms.requestTimeout</strong> Timeout value that controls how long the client waits on completion of various synchronous interactions with the remote peer before returning an error (By default the client will wait indefinitely for a request to complete</li>
<li><strong>jms.clientIDPrefix</strong> Optional prefix value that is used for generated Client ID values when a new Connection is created for the JMS ConnectionFactory. The default prefix is 'ID:'.</li>
<li><strong>jms.connectionIDPrefix</strong> Optional prefix value that is used for generated Connection ID values when a new Connection is created for the JMS ConnectionFactory. This connection ID is used when logging some information from the JMS Connection object so a configurable prefix can make breadcrumbing the logs easier. The default prefix is 'ID:'.</li>
<li><strong>jms.messageIDType</strong> Controls the type of the Message ID assigned to messages sent from the client. By default a generated String value is used on outgoing messages, other available types are UUID and UUID_STRING.</li>
+<li><strong>jms.populateJMSXUserID</strong> Controls whether a MessageProducer will populate the JMSXUserID value for each sent message using the authenticated username from the connection. This value defaults to false and the JMSXUserID for all sent message will not be populated.</li>
</ul>
<p>These values control how many messages the remote peer can send to the client and be held in a prefetch buffer for each consumer instance.</p>
@@ -260,9 +268,9 @@ Topic topic = (Topic) context.lookup("my
<p>The SSL Transport extends the TCP Transport and is enabled using the <em>amqps</em> URI scheme. Because the SSL Transport extends the functionality of the TCP based Transport all the TCP Transport options are valid on an SSL Transport URI.</p>
-<p>A simple SSL based client URI is shown below:</p>
+<p>A simple SSL/TLS based client URI is shown below:</p>
-<pre><code>amqps://localhost:5673
+<pre><code>amqps://myhost.mydomain:5671
</code></pre>
<p>The complete set of SSL Transport options is listed below:</p>
@@ -291,7 +299,7 @@ Topic topic = (Topic) context.lookup("my
<li><strong>amqp.idleTimeout</strong> The idle timeout in milliseconds after which the connection will be failed if the peer sends no AMQP frames. Default is 60000.</li>
<li><strong>amqp.vhost</strong> The vhost to connect to. Used to populate the Sasl and Open hostname fields. Default is the main hostname from the Connection URI.</li>
<li><strong>amqp.saslLayer</strong> Controls whether connections should use a SASL layer or not. Default is true.</li>
-<li><strong>amqp.saslMechanisms</strong> Which SASL mechanism(s) the client should allow selection of, if offered by the server and usable with the configured credentials. Comma separated if specifying more than 1 mechanism. Default is to allow selection from all the clients supported mechanisms, which are currently EXTERNAL, CRAM-MD5, PLAIN, and ANONYMOUS.</li>
+<li><strong>amqp.saslMechanisms</strong> Which SASL mechanism(s) the client should allow selection of, if offered by the server and usable with the configured credentials. Comma separated if specifying more than 1 mechanism. Default is to allow selection from all the clients supported mechanisms, which are currently EXTERNAL, SCRAM-SHA-256, SCRAM-SHA-1, CRAM-MD5, PLAIN, and ANONYMOUS.</li>
<li><strong>amqp.maxFrameSize</strong> The max-frame-size value in bytes that is advertised to the peer. Default is 1048576.</li>
</ul>
@@ -320,6 +328,7 @@ Topic topic = (Topic) context.lookup("my
<li><strong>failover.maxReconnectAttempts</strong> The number of reconnection attempts allowed before reporting the connection as failed to the client. The default is no limit or (-1).</li>
<li><strong>failover.startupMaxReconnectAttempts</strong> For a client that has never connected to a remote peer before this option control how many attempts are made to connect before reporting the connection as failed. The default is to use the value of maxReconnectAttempts.</li>
<li><strong>failover.warnAfterReconnectAttempts</strong> Controls how often the client will log a message indicating that failover reconnection is being attempted. The default is to log every 10 connection attempts.</li>
+<li><strong>failover.randomize</strong> When true the set of failover URIs is randomly shuffled prior to attempting to connect to one of them. This can help to distribute client connections more evenly across multiple remote peers. The default value for this setting is to false.</li>
</ul>
<p>The failover URI also supports defining 'nested' options as a means of specifying AMQP and transport option values applicable to all the individual nested broker URI's, which can be useful to avoid repetition. This is accomplished using the same "transport." and "amqp." URI options outlined earlier for a non-failover broker URI but prefixed with <em>failover.nested.</em>. For example, to apply the same value for the <em>amqp.vhost</em> option to every broker connected to you might have a URI like:</p>
Modified: qpid/site/docs/releases/qpid-jms-master/index.html
URL: http://svn.apache.org/viewvc/qpid/site/docs/releases/qpid-jms-master/index.html?rev=1738151&r1=1738150&r2=1738151&view=diff
==============================================================================
--- qpid/site/docs/releases/qpid-jms-master/index.html (original)
+++ qpid/site/docs/releases/qpid-jms-master/index.html Thu Apr 7 16:43:59 2016
@@ -124,7 +124,7 @@ https://github.com/apache/qpid-proton/bl
incomplete. For a smoother experience, see the
<a href="/releases/qpid-jms-0.8.0/index.html">current stable release</a>.</p>
-<p>This content was generated at 10:32 on Monday, 22 February 2016.</p>
+<p>This content was generated at 16:32 on Thursday, 07 April 2016.</p>
</div>
Modified: qpid/site/input/releases/qpid-jms-master/docs/index.md
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-jms-master/docs/index.md?rev=1738151&r1=1738150&r2=1738151&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-jms-master/docs/index.md (original)
+++ qpid/site/input/releases/qpid-jms-master/docs/index.md Thu Apr 7 16:43:59 2016
@@ -65,7 +65,12 @@ These objects could then be looked up fr
The basic format of the clients Connection URI is as follows:
- amqp://hostname:port[?option=value[&option2=value...]]
+ 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
+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.
The client can be configured with a number of different settings using the URI while defining the ConnectionFactory, these are detailed in the following sections.
@@ -90,9 +95,12 @@ The options apply to the behaviour of th
+ **jms.topicPrefix** Optional prefix value added to the name of any Topic created from a JMS Session.
+ **jms.closeTimeout** Timeout value that controls how long the client waits on Connection close before returning. (By default the client waits 15 seconds for a normal close completion event).
+ **jms.connectTimeout** Timeout value that controls how long the client waits on Connection establishment before returning with an error. (By default the client waits 15 seconds for a connection to be established before failing).
++ **jms.sendTimeout** Timeout value that controls how long the client waits on completion of a synchronous message send before returning an error (By default the client will wait indefinitely for a send to complete).
++ **jms.requestTimeout** Timeout value that controls how long the client waits on completion of various synchronous interactions with the remote peer before returning an error (By default the client will wait indefinitely for a request to complete
+ **jms.clientIDPrefix** Optional prefix value that is used for generated Client ID values when a new Connection is created for the JMS ConnectionFactory. The default prefix is 'ID:'.
+ **jms.connectionIDPrefix** Optional prefix value that is used for generated Connection ID values when a new Connection is created for the JMS ConnectionFactory. This connection ID is used when logging some information from the JMS Connection object so a configurable prefix can make breadcrumbing the logs easier. The default prefix is 'ID:'.
+ **jms.messageIDType** Controls the type of the Message ID assigned to messages sent from the client. By default a generated String value is used on outgoing messages, other available types are UUID and UUID_STRING.
++ **jms.populateJMSXUserID** Controls whether a MessageProducer will populate the JMSXUserID value for each sent message using the authenticated username from the connection. This value defaults to false and the JMSXUserID for all sent message will not be populated.
These values control how many messages the remote peer can send to the client and be held in a prefetch buffer for each consumer instance.
@@ -127,9 +135,10 @@ The complete set of TCP Transport option
The SSL Transport extends the TCP Transport and is enabled using the *amqps* URI scheme. Because the SSL Transport extends the functionality of the TCP based Transport all the TCP Transport options are valid on an SSL Transport URI.
-A simple SSL based client URI is shown below:
+A simple SSL/TLS based client URI is shown below:
+
+ amqps://myhost.mydomain:5671
- amqps://localhost:5673
The complete set of SSL Transport options is listed below:
@@ -154,7 +163,7 @@ These options apply to the behaviour of
+ **amqp.idleTimeout** The idle timeout in milliseconds after which the connection will be failed if the peer sends no AMQP frames. Default is 60000.
+ **amqp.vhost** The vhost to connect to. Used to populate the Sasl and Open hostname fields. Default is the main hostname from the Connection URI.
+ **amqp.saslLayer** Controls whether connections should use a SASL layer or not. Default is true.
-+ **amqp.saslMechanisms** Which SASL mechanism(s) the client should allow selection of, if offered by the server and usable with the configured credentials. Comma separated if specifying more than 1 mechanism. Default is to allow selection from all the clients supported mechanisms, which are currently EXTERNAL, CRAM-MD5, PLAIN, and ANONYMOUS.
++ **amqp.saslMechanisms** Which SASL mechanism(s) the client should allow selection of, if offered by the server and usable with the configured credentials. Comma separated if specifying more than 1 mechanism. Default is to allow selection from all the clients supported mechanisms, which are currently EXTERNAL, SCRAM-SHA-256, SCRAM-SHA-1, CRAM-MD5, PLAIN, and ANONYMOUS.
+ **amqp.maxFrameSize** The max-frame-size value in bytes that is advertised to the peer. Default is 1048576.
### Failover Configuration options
@@ -179,6 +188,7 @@ The complete set of configuration option
+ **failover.maxReconnectAttempts** The number of reconnection attempts allowed before reporting the connection as failed to the client. The default is no limit or (-1).
+ **failover.startupMaxReconnectAttempts** For a client that has never connected to a remote peer before this option control how many attempts are made to connect before reporting the connection as failed. The default is to use the value of maxReconnectAttempts.
+ **failover.warnAfterReconnectAttempts** Controls how often the client will log a message indicating that failover reconnection is being attempted. The default is to log every 10 connection attempts.
++ **failover.randomize** When true the set of failover URIs is randomly shuffled prior to attempting to connect to one of them. This can help to distribute client connections more evenly across multiple remote peers. The default value for this setting is to false.
The failover URI also supports defining 'nested' options as a means of specifying AMQP and transport option values applicable to all the individual nested broker URI's, which can be useful to avoid repetition. This is accomplished using the same "transport." and "amqp." URI options outlined earlier for a non-failover broker URI but prefixed with *failover.nested.*. For example, to apply the same value for the *amqp.vhost* option to every broker connected to you might have a URI like:
Modified: qpid/site/input/releases/qpid-jms-master/index.md
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-jms-master/index.md?rev=1738151&r1=1738150&r2=1738151&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-jms-master/index.md (original)
+++ qpid/site/input/releases/qpid-jms-master/index.md Thu Apr 7 16:43:59 2016
@@ -27,7 +27,7 @@ Code and documentation found here may be
incomplete. For a smoother experience, see the
[current stable release]({{current_jms_release_url}}/index.html).
-This content was generated at 10:32 on Monday, 22 February 2016.
+This content was generated at 16:32 on Thursday, 07 April 2016.
</div>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org