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 2017/11/03 16:35:10 UTC
qpid-broker-j git commit: QPID-8001: [Broker-J] [Documentation]
Address review feedback from Lorenz Quack
Repository: qpid-broker-j
Updated Branches:
refs/heads/master 56c5cfd73 -> e2ae88790
QPID-8001: [Broker-J] [Documentation] Address review feedback from Lorenz Quack <lq...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/repo
Commit: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/commit/e2ae8879
Tree: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/tree/e2ae8879
Diff: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/diff/e2ae8879
Branch: refs/heads/master
Commit: e2ae887900bc86d83abf9049fc5b7dc8b8b9a37b
Parents: 56c5cfd
Author: Keith Wall <kw...@apache.org>
Authored: Fri Nov 3 16:33:54 2017 +0000
Committer: Keith Wall <kw...@apache.org>
Committed: Fri Nov 3 16:33:54 2017 +0000
----------------------------------------------------------------------
doc/java-broker/src/docbkx/Java-Broker-Installation.xml | 2 +-
doc/java-broker/src/docbkx/Java-Broker-Introduction.xml | 2 +-
.../src/docbkx/concepts/Java-Broker-Concepts-Exchanges.xml | 2 +-
.../src/docbkx/concepts/Java-Broker-Concepts-Overview.xml | 4 ++--
.../src/docbkx/concepts/Java-Broker-Concepts-Queues.xml | 2 +-
.../docbkx/concepts/Java-Broker-Concepts-Virtualhosts.xml | 2 +-
.../channels/Java-Broker-Management-Channel-REST-API.xml | 2 +-
.../src/docbkx/runtime/Java-Broker-Runtime-Flow-To-Disk.xml | 2 +-
.../Java-Broker-Runtime-Handling-Undeliverable-Messages.xml | 8 ++++----
.../src/docbkx/runtime/Java-Broker-Runtime-Memory.xml | 2 +-
.../Java-Broker-Runtime-Producer-Transaction-Timeout.xml | 4 ++--
11 files changed, 16 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/Java-Broker-Installation.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Installation.xml b/doc/java-broker/src/docbkx/Java-Broker-Installation.xml
index d40d465..1489711 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Installation.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Installation.xml
@@ -34,7 +34,7 @@
<para> The Apache Qpid Broker-J is an 100% Java implementation and as such it can be used on any
operating system supporting Java 1.8 or higher<footnote><para>Java Cryptography Extension (JCE)
Unlimited Strength extension must be installed or enabled for some features.</para></footnote>. This includes Linux,
- Solaris, Mac OS X, andWindows 7/8/10 etc.</para>
+ Solaris, Mac OS X, and Windows 7/8/10 etc.</para>
<para> The broker has been tested with Java implementations from both Oracle and IBM. Whatever
platform you chose, it is recommended that you ensure it is patched with any critical
updates made available from the vendor. </para>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/Java-Broker-Introduction.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Introduction.xml b/doc/java-broker/src/docbkx/Java-Broker-Introduction.xml
index b40a141..439980c 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Introduction.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Introduction.xml
@@ -49,7 +49,7 @@
</footnote></para>
</listitem>
<listitem>
- <para>Supports for all versions of the AMQP protocol (0-8, 0-9, 0-91, 0-10 and 1.0).</para>
+ <para>Supports for all versions of the AMQP protocol (0-8, 0-9, 0-9-1, 0-10 and 1.0).</para>
</listitem>
<listitem>
<para>Supports for AMQP over websockets.</para>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Exchanges.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Exchanges.xml b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Exchanges.xml
index f8095e5..d8e83d8 100644
--- a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Exchanges.xml
+++ b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Exchanges.xml
@@ -25,7 +25,7 @@
<para>An <emphasis>Exchange</emphasis> is a named entity within the <emphasis>Virtualhost</emphasis> which receives
messages from producers and routes them to matching <emphasis>Queue</emphasis>s within the <emphasis>Virtualhost</emphasis>.</para>
<para>
- When using AMQP 0-8, 0-9, 0-91, or 0-10, the exchange is the only way ingressing a message into the virtualhost. When using AMQP
+ When using AMQP 0-8, 0-9, 0-9-1, or 0-10, the exchange is the only way ingressing a message into the virtualhost. When using AMQP
1.0, the application may route messages using an exchange (to take advantage of exchange's routing behaviours), or it may route direcly
to a queue (if point to point messaging is required).
</para>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Overview.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Overview.xml b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Overview.xml
index 45d1a27..3ebf2fe 100644
--- a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Overview.xml
+++ b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Overview.xml
@@ -31,8 +31,8 @@
one virtualhost.</para>
<para>An <emphasis>Exchange</emphasis> accepts messages from a producer application and routes these
to one or more <emphasis>Queues</emphasis> according to pre-arranged criteria called
- <emphasis>bindings</emphasis>. Exchange are an AMQP 0-8, 0-9, 0-91, 0-10 concept. They exist to
- produce useful messaging behaviours such as fanout. When using AMQP 0-8, 0-9, 0-91, or 0-10, the
+ <emphasis>bindings</emphasis>. Exchange are an AMQP 0-8, 0-9, 0-9-1, 0-10 concept. They exist to
+ produce useful messaging behaviours such as fanout. When using AMQP 0-8, 0-9, 0-9-1, or 0-10, the
exchange is the only way ingressing a message into the virtualhost. When using AMQP
1.0, the application may route messages using an exchange (to take advantage of advanced behaviours)
or it may publish messages direct to a queue.
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
index ac0d925..0f4b435 100644
--- a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
+++ b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Queues.xml
@@ -26,7 +26,7 @@
hold/buffer messages for later delivery to consumer applications.</para>
<para>Messages arrive on queues either from <link linkend="Java-Broker-Concepts-Exchanges">Exchanges</link>, or when
using the AMQP 1.0 protocol, the producing application can direct messages straight to the queue. For
- AMQP 0-8, 0-9, 0-91, or 0-10, the exchange is the only way ingressing a message into a queue.</para>
+ AMQP 0-8, 0-9, 0-9-1, or 0-10, the exchange is the only way ingressing a message into a queue.</para>
<para>Consumers subscribe to a queue in order to receive messages from it.</para>
<para>The Broker supports different queue types, each with different delivery semantics. Queues also have a range of other
features such as the ability to group messages together for delivery to a single consumer. These additional features
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhosts.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhosts.xml b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhosts.xml
index a070c60..410329d 100644
--- a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhosts.xml
+++ b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Virtualhosts.xml
@@ -34,7 +34,7 @@
each of the entities and describes the relationships between them. These details are developed
further in the sub-sections that follow.</para>
<para><emphasis>Exchanges</emphasis> is a named entity within the Virtual Host which receives
- messages from producers and routes them to matching Queues. When using AMQP 0-8, 0-9, 0-91, 0-10
+ messages from producers and routes them to matching Queues. When using AMQP 0-8, 0-9, 0-9-1, 0-10
the exchange is the only way ingressing a message into the virtualhost. When using AMQP 1.0
producers may route messages via exchanges or direct to queues.</para>
<para><emphasis>Queues</emphasis> are named entities that hold messages for delivery to consumer
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-API.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-API.xml b/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-API.xml
index 138dac6..834470f 100644
--- a/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-API.xml
+++ b/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-API.xml
@@ -157,7 +157,7 @@
all queues beneath the virtualhost called <literal>vh</literal>. A collection will be returned.
</para>
<screen>GET /api/latest/queue/vhn/vh</screen>
- <para>Request parameters (with the same name an attribute) are used to filter the returned collection.
+ <para>Request parameters (with the same name as an attribute) are used to filter the returned collection.
For instance, to filter those queues of type <literal>standard</literal>:</para>
<screen>GET /api/latest/queue/vhn/vh?type=standard</screen>
<para>Additional parameters supported in GET requests:</para>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Flow-To-Disk.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Flow-To-Disk.xml b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Flow-To-Disk.xml
index 7511a66..01dbf1a 100644
--- a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Flow-To-Disk.xml
+++ b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Flow-To-Disk.xml
@@ -38,5 +38,5 @@
their cumulative size falls beneath 750MB.</para>
<para>Flow to disk is configured by Broker context variable
<literal>broker.flowToDiskThreshold</literal>. It is expressed as a size in bytes and defaults
- to 40% of the JVM maximum heap size.</para>
+ to 75% of the JVM maximum heap size.</para>
</section>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml
index 46c0c9a..52c5f27 100644
--- a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml
+++ b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml
@@ -53,16 +53,16 @@
<para>When using AMQP 1.0 the current delivery count of a message is available to the consuming
application via the<literal>message-count</literal> message header (exposed via the
<literal>JMSXDeliveryCount</literal> JMS message property when using JMS). When using the
- AMQP 0-9..0-10 protocol this information is not available.</para>
+ AMQP 0-8..0-10 protocols this information is not available.</para>
<note>
- <para> When using AMQP 0-9..0-10, in order for a maximum delivery count to be enforced, the consuming application
+ <para> When using AMQP 0-8..0-10, in order for a maximum delivery count to be enforced, the consuming application
<emphasis>must</emphasis> call <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#rollback()">Session#rollback()</link> (or <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#recover()">Session#recover()</link> if the session is not transacted). It is during the Broker's
processing of Session#rollback() (or Session#recover()) that if a message has been seen
at least the maximum number of times then it will move the message to the DLQ or discard the
message. If the consuming application fails in another manner, for instance, closes the connection, the
message will not be re-routed and consumer application will see the same poison message again
once it reconnects.</para>
- <para> If the consuming application is using Qpid JMS Client 0-x and using AMQP 0-9-1, 0-9, or 0-8
+ <para> If the consuming application is using Qpid JMS Client 0-x and using AMQP 0-8, 0-9, or 0-9-1
protocols, it is necessary to set the client system property <varname>qpid.reject.behaviour</varname> or
connection or binding URL option <varname>rejectbehaviour</varname> to the value <literal>server</literal>.</para>
</note>
@@ -72,7 +72,7 @@
<para>Once the maximum delivery count is exceeded, if the queue has an <literal>alternateBinding</literal>
specified, the Broker automatically routes the message via the alternate binding. The alternate binding
would normally specify a queue designated for that purpose of receiving the undeliverable messages.
- By convention such queues are known as a dead-letter queues or simply a DLQs.</para>
+ By convention such queues are known as dead-letter queues or simply DLQs.</para>
<caution>
<title>Avoid excessive queue depth</title>
<para>Applications making use of DLQs <emphasis>should</emphasis> make provision for the frequent
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Memory.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Memory.xml b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Memory.xml
index 4b9c93c..3462910 100644
--- a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Memory.xml
+++ b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Memory.xml
@@ -227,7 +227,7 @@
<para>
<informalequation>
<mathphrase>
- memory<subscript>heap</subscript> = 15 MB + 20 KB * N<subscript>sessions</subscript> + 1.5 KB * N<subscript>messages</subscript> + 100 KB * N<subscript>connections</subscript>
+ memory<subscript>heap</subscript> = 15 MB + 20 kB * N<subscript>sessions</subscript> + 1.5 kB * N<subscript>messages</subscript> + 100 kB * N<subscript>connections</subscript>
</mathphrase>
</informalequation>
</para>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/e2ae8879/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml
index 37abae5..2931f67 100644
--- a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml
+++ b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml
@@ -26,8 +26,8 @@
<title>General Information</title>
<note>
<para>
- This feature is not implemented for producing applications using AMQP 1.0. If a long running transaction is suspect
- use the
+ This feature is not implemented for producing applications using AMQP 1.0. If a long running transaction is suspected
+ examine the connection statistic <literal>oldestTransactionStartTime</literal> to confirm if this is the case.
</para>
</note>
<para> The transaction timeout mechanism is used to control broker resources when clients
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org