You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by kw...@apache.org on 2015/08/14 18:35:20 UTC

svn commit: r1695939 - in /qpid/java/trunk: client/src/main/java/org/apache/qpid/client/url/ doc/book/src/java-broker/concepts/ doc/book/src/jms-client-0-8/

Author: kwall
Date: Fri Aug 14 16:35:19 2015
New Revision: 1695939

URL: http://svn.apache.org/r1695939
Log:
QPID-6692: [Documentation] Minor corrections to the Java Broker and JMS client documentation

Work by Lorenz Quack <qu...@gmail.com>

Modified:
    qpid/java/trunk/client/src/main/java/org/apache/qpid/client/url/URLParser.java
    qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml
    qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Queues.xml
    qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml
    qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml

Modified: qpid/java/trunk/client/src/main/java/org/apache/qpid/client/url/URLParser.java
URL: http://svn.apache.org/viewvc/qpid/java/trunk/client/src/main/java/org/apache/qpid/client/url/URLParser.java?rev=1695939&r1=1695938&r2=1695939&view=diff
==============================================================================
--- qpid/java/trunk/client/src/main/java/org/apache/qpid/client/url/URLParser.java (original)
+++ qpid/java/trunk/client/src/main/java/org/apache/qpid/client/url/URLParser.java Fri Aug 14 16:35:19 2015
@@ -44,7 +44,7 @@ public class URLParser
     private void parseURL(String fullURL) throws URLSyntaxException
     {
         // Connection URL format
-        // amqp://[user:pass@][clientid]/virtualhost?brokerlist='tcp://host:port?option=\'value\',option=\'value\';tcp://host:port?option=\'value\'',failover='method?option=\'value\',option='value''"
+        // amqp://[user:pass@][clientid]/[virtualhost]?brokerlist='tcp://host:port?option=\'value\',option=\'value\';tcp://host:port?option=\'value\'',failover='method?option=\'value\',option='value''"
         // Options are of course optional except for requiring a single broker in the broker list.
         try
         {

Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml?rev=1695939&r1=1695938&r2=1695939&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml Fri Aug 14 16:35:19 2015
@@ -28,12 +28,12 @@
   these exchanges types work see <xref linkend="Java-Broker-Concepts-Exchanges-Types"/> below.</para>
  <para>The server predeclares a number of exchange instances with names starting with &quot;<literal>amq.</literal>&quot;. These are defined in
   <xref linkend="Java-Broker-Concepts-Exchanges-Predeclared"/>.</para>
- <para>Applications can make use the pre-declared exchanges, or they may declare their own. The number of exchanges within a virtual host is
+ <para>Applications can make use of the pre-declared exchanges, or they may declare their own. The number of exchanges within a <emphasis>Virtualhost</emphasis> is
   limited only by resource constraints.</para>
- <para>The behaviour when an exchange is unable to route a message to any queue is defined in <xref linkend="Java-Broker-Concepts-Exchanges-UnroutableMessage"/></para>
+ <para>The behaviour when an <emphasis>Exchange</emphasis> is unable to route a message to any queue is defined in <xref linkend="Java-Broker-Concepts-Exchanges-UnroutableMessage"/></para>
  <section id="Java-Broker-Concepts-Exchanges-Predeclared">
   <title>Predeclared Exchanges</title>
-  <para>Each virtual host pre-declares the following exchanges:
+  <para>Each <emphasis>Virtualhost</emphasis> pre-declares the following exchanges:
    <itemizedlist>
     <listitem><para>amq.direct (an instance of a direct exchange)</para></listitem>
     <listitem><para>amq.topic (an instance of a topic exchange)</para></listitem>

Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Queues.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Queues.xml?rev=1695939&r1=1695938&r2=1695939&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Queues.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Queues.xml Fri Aug 14 16:35:19 2015
@@ -233,7 +233,7 @@
       behaviour of the queue. </para>
     <para>For example, if using a priority queue and a prefetch of 100, and 100 messages arrive with
       priority 2, the broker will send these messages to the client. If then a new message arrives
-      will priority 1, the broker cannot leap frog messages of lower priority. The priority 1 will
+      with priority 1, the broker cannot leap frog messages of lower priority. The priority 1 will
       be delivered at the front of the next batch of messages to be sent to the client.</para>
     <para> So, you need to set the prefetch values for your client (consumer) to make this sensible.
       To do this set the Java system property <varname>max_prefetch</varname> on the client
@@ -333,7 +333,7 @@ amqp://guest:guest@client1/development?m
             <tbody>
               <row>
                 <entry>Addressing</entry>
-                <entry>myqueue ; { link : { x-subscribe: { arguments : { x-qpid-replay-period : '3600' } } } }</entry>
+                <entry>myqueue : { link : { x-subscribe: { arguments : { x-qpid-replay-period : '3600' } } } }</entry>
               </row>
               <row>
                 <entry>Binding URL</entry>

Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml?rev=1695939&r1=1695938&r2=1695939&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml Fri Aug 14 16:35:19 2015
@@ -23,7 +23,7 @@
 <section id="Java-Broker-Concepts-Virtualhosts">
   <title>Virtualhosts</title>
   <para>A virtualhost is a namespace in which messaging is performed. Virtualhosts are independent;
-    the messaging goes on a within a virtualhost is independent of any messaging that goes on in
+    the messaging that goes on within one virtualhost is independent of any messaging that goes on in
     another virtualhost. For instance, a queue named <emphasis>foo</emphasis> defined in one
     virtualhost is completely independent of a queue named <emphasis>foo</emphasis> in another
     virtualhost.</para>
@@ -42,7 +42,7 @@
   <para><emphasis>Connections</emphasis> represent a live connection to the virtualhost from a
     messaging client.</para>
   <para>A <emphasis>Session</emphasis> represents a context for the production or consumption of
-    messages. Connection support many Sessions.</para>
+    messages. A Connection can have many Sessions.</para>
   <para>A <emphasis>Consumer</emphasis> represents a live consumer that is attached to queue.</para>
   <para> The following diagram depicts the Virtualhost model: <figure>
       <title>Virtualhost Model</title>

Modified: qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml?rev=1695939&r1=1695938&r2=1695939&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml (original)
+++ qpid/java/trunk/doc/book/src/jms-client-0-8/JMS-Client-Connection-URL.xml Fri Aug 14 16:35:19 2015
@@ -31,7 +31,7 @@
 	<para> In JNDI properties, a Connection URL specifies options for a connection. The format for a
 		Connection URL is: </para>
 
-	<programlisting><![CDATA[amqp://[<user>:<pass>@][<clientid>]<virtualhost>[?<option>='<value>'[&<option>=&'<value>']]]]></programlisting>
+	<programlisting><![CDATA[amqp://[<user>:<pass>@][<clientid>]/[<virtualhost>][?<option>='<value>'[&<option>='<value>']*]]]></programlisting>
 	<para> For instance, the following Connection URL specifies a user name, a password, a client
 		ID, a virtual host ("test"), a broker list with a single broker: a TCP host with the host
 		name <quote>localhost</quote> using port 5672: </para>
@@ -163,12 +163,12 @@
 	</table>
 	<para> Broker lists are specified using a URL in this format: </para>
 
-	<programlisting><![CDATA[brokerlist=<transport>://<host>[:<;port>](?<param>='<value>')(&<param>='<value>')*]]></programlisting>
+	<programlisting><![CDATA[brokerlist='<transport>://<host>[:<port>][?<param>='<value>'[&<param>='<value>']*]']]></programlisting>
 	<para> For instance, this is a typical broker list: </para>
 
 	<programlisting><![CDATA[brokerlist='tcp://localhost:5672']]></programlisting>
 
-	<para> A broker list can contain more than one broker address; if so, the connection is made to
+	<para> A broker list can contain more than one broker address separated by semicolons (;). If so, the connection is made to
 		the first broker in the list that is available.
 		<!--In general, it is better to use the failover
 		exchange when using multiple brokers, since it allows applications to fail over if a broker



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org