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/02 16:45:29 UTC
[1/3] qpid-broker-j git commit: NO-JIRA: [Broker-J Tools] Change
MemoryConsumptionTestClient so it no longer assumes the Qpid JMS 0-x client.
Repository: qpid-broker-j
Updated Branches:
refs/heads/master a0bc7d64e -> d22f7a574
NO-JIRA: [Broker-J Tools] Change MemoryConsumptionTestClient so it no longer assumes the Qpid JMS 0-x client.
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/d22f7a57
Tree: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/tree/d22f7a57
Diff: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/diff/d22f7a57
Branch: refs/heads/master
Commit: d22f7a5742380078ca23d23b2ac0b0ef7f33bf85
Parents: deb4ff8
Author: Keith Wall <kw...@apache.org>
Authored: Thu Nov 2 16:42:38 2017 +0000
Committer: Keith Wall <kw...@apache.org>
Committed: Thu Nov 2 16:45:15 2017 +0000
----------------------------------------------------------------------
.../qpid/tools/MemoryConsumptionTestClient.java | 41 ++++++++++++++------
1 file changed, 30 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/d22f7a57/tools/src/main/java/org/apache/qpid/tools/MemoryConsumptionTestClient.java
----------------------------------------------------------------------
diff --git a/tools/src/main/java/org/apache/qpid/tools/MemoryConsumptionTestClient.java b/tools/src/main/java/org/apache/qpid/tools/MemoryConsumptionTestClient.java
index 2ab04a2..c1c3b68 100644
--- a/tools/src/main/java/org/apache/qpid/tools/MemoryConsumptionTestClient.java
+++ b/tools/src/main/java/org/apache/qpid/tools/MemoryConsumptionTestClient.java
@@ -64,13 +64,13 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/* TODO this program assumes addresses understood by the Qpid JMS Client 0-x. */
public class MemoryConsumptionTestClient
{
private static final Logger LOGGER = LoggerFactory.getLogger(MemoryConsumptionTestClient.class);
- private static final String QUEUE_NAME_PREFIX = "BURL:direct://amq.direct//memory-test-queue";
- private static final String DURABLE_SUFFIX = "?durable='true'";
+ private static final String JNDI_PROPERTIES_ARG = "jndiProperties";
+ private static final String JNDI_CONNECTION_FACTORY_ARG = "jndiConnectionFactory";
+ private static final String JNDI_DESTINATION_ARG = "jndiDestination";
public static final String CONNECTIONS_ARG = "connections";
public static final String SESSIONS_ARG = "sessions";
@@ -85,6 +85,9 @@ public class MemoryConsumptionTestClient
public static final String JMX_USER_ARG = "jmxuser";
public static final String JMX_USER_PASSWORD_ARG = "jmxpassword";
+ private static final String JNDI_PROPERTIES_DEFAULT = "stress-test-client-qpid-jms-client-0-x.properties";
+ private static final String JNDI_CONNECTION_FACTORY_DEFAULT = "qpidConnectionFactory";
+ private static final String JNDI_DESTINATION_DEFAULT = "stressTestQueue";
public static final String CONNECTIONS_DEFAULT = "1";
public static final String SESSIONS_DEFAULT = "1";
public static final String PRODUCERS_DEFAULT = "1";
@@ -101,6 +104,9 @@ public class MemoryConsumptionTestClient
public static void main(String[] args) throws Exception
{
Map<String,String> options = new HashMap<>();
+ options.put(JNDI_PROPERTIES_ARG, JNDI_PROPERTIES_DEFAULT);
+ options.put(JNDI_CONNECTION_FACTORY_ARG, JNDI_CONNECTION_FACTORY_DEFAULT);
+ options.put(JNDI_DESTINATION_ARG, JNDI_DESTINATION_DEFAULT);
options.put(CONNECTIONS_ARG, CONNECTIONS_DEFAULT);
options.put(SESSIONS_ARG, SESSIONS_DEFAULT);
options.put(PRODUCERS_ARG, PRODUCERS_DEFAULT);
@@ -148,12 +154,14 @@ public class MemoryConsumptionTestClient
private void runTest(Map<String,String> options) throws Exception
{
+ String jndiProperties = options.get(JNDI_PROPERTIES_ARG);
+ String connectionFactoryString = options.get(JNDI_CONNECTION_FACTORY_ARG);
int numConnections = Integer.parseInt(options.get(CONNECTIONS_ARG));
int numSessions = Integer.parseInt(options.get(SESSIONS_ARG));
int numProducers = Integer.parseInt(options.get(PRODUCERS_ARG));
int numMessage = Integer.parseInt(options.get(MESSAGE_COUNT_ARG));
int messageSize = Integer.parseInt(options.get(MESSAGE_SIZE_ARG));
- String queueString = QUEUE_NAME_PREFIX + DURABLE_SUFFIX;
+ String queueString = options.get(JNDI_DESTINATION_ARG);
int deliveryMode = Boolean.valueOf(options.get(PERSISTENT_ARG)) ? DeliveryMode.PERSISTENT : DeliveryMode.NON_PERSISTENT;
long receiveTimeout = Long.parseLong(options.get(TIMEOUT_ARG));
boolean transacted = Boolean.valueOf(options.get(TRANSACTED_ARG));
@@ -162,14 +170,9 @@ public class MemoryConsumptionTestClient
// Load JNDI properties
- Properties properties = new Properties();
- try(InputStream is = this.getClass().getClassLoader().getResourceAsStream(
- "stress-test-client-qpid-jms-client-0-x.properties"))
- {
- properties.load(is);
- }
+ Context ctx = getInitialContext(jndiProperties);
+ final ConnectionFactory conFac = (ConnectionFactory) ctx.lookup(connectionFactoryString);
- ConnectionFactory conFac = createConnectionFactory(properties);
Destination destination = ensureQueueCreated(queueString, conFac);
Map<Connection, List<Session>> connectionsAndSessions = openConnectionsAndSessions(numConnections, numSessions, transacted, conFac);
publish(numMessage, messageSize, numProducers, deliveryMode, destination, connectionsAndSessions);
@@ -246,6 +249,22 @@ public class MemoryConsumptionTestClient
return connectionAndSessions;
}
+ private Context getInitialContext(final String jndiProperties) throws IOException, NamingException
+ {
+ Properties properties = new Properties();
+ try(InputStream is = this.getClass().getClassLoader().getResourceAsStream(jndiProperties))
+ {
+ if (is != null)
+ {
+ properties.load(is);
+ return new InitialContext(properties);
+ }
+ }
+
+ System.out.printf(MemoryConsumptionTestClient.class.getSimpleName() + ": Failed to find '%s' on classpath, using fallback\n", jndiProperties);
+ return new InitialContext();
+ }
+
private Destination ensureQueueCreated(String queueURL, ConnectionFactory connectionFactory) throws JMSException
{
Connection connection = connectionFactory.createConnection();
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org
[3/3] qpid-broker-j git commit: QPID-7916: Rename Docbook from
AMQP-Messaging-Broker-Java-Book to Apache-Qpid-Broker-J-Book
Posted by kw...@apache.org.
QPID-7916: Rename Docbook from AMQP-Messaging-Broker-Java-Book to Apache-Qpid-Broker-J-Book
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/a24321bd
Tree: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/tree/a24321bd
Diff: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/diff/a24321bd
Branch: refs/heads/master
Commit: a24321bda073a1f4a6472a13276df49c03fd2cf9
Parents: a0bc7d6
Author: Keith Wall <kw...@apache.org>
Authored: Wed Nov 1 13:46:50 2017 +0000
Committer: Keith Wall <kw...@apache.org>
Committed: Thu Nov 2 16:45:15 2017 +0000
----------------------------------------------------------------------
doc/java-broker/pom.xml | 4 +-
.../docbkx/AMQP-Messaging-Broker-Java-Book.xml | 44 --------------------
.../src/docbkx/Apache-Qpid-Broker-J-Book.xml | 44 ++++++++++++++++++++
3 files changed, 46 insertions(+), 46 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/a24321bd/doc/java-broker/pom.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/pom.xml b/doc/java-broker/pom.xml
index 779cd91..1054933 100644
--- a/doc/java-broker/pom.xml
+++ b/doc/java-broker/pom.xml
@@ -51,9 +51,9 @@
<groupId>com.agilejava.docbkx</groupId>
<artifactId>docbkx-maven-plugin</artifactId>
<configuration>
- <includes>AMQP-Messaging-Broker-Java-Book.xml</includes>
+ <includes>Apache-Qpid-Broker-J-Book.xml</includes>
<postProcess>
- <copy file="${docbook.target}/AMQP-Messaging-Broker-Java-Book.html" tofile="${docbook.target}/index.html" />
+ <copy file="${docbook.target}/Apache-Qpid-Broker-J-Book.html" tofile="${docbook.target}/index.html" />
</postProcess>
</configuration>
</plugin>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/a24321bd/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml b/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml
deleted file mode 100644
index ee8aa96..0000000
--- a/doc/java-broker/src/docbkx/AMQP-Messaging-Broker-Java-Book.xml
+++ /dev/null
@@ -1,44 +0,0 @@
-<?xml version="1.0"?>
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-
-<book xmlns="http://docbook.org/ns/docbook" version="5.0">
- <title>Apache Qpid Broker-J</title>
-
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Introduction.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Installation.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Getting-Started.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Concepts.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Initial-Configuration.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Management-Channels.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Management-Managing-Entities.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Security.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Runtime.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-High-Availability.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Backup-And-Recovery.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Environment-Variables.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-System-Properties.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Operational-Logging-Messages.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Statistics-Reporting.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Queue-Alerts.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Miscellaneous.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Queue-Declaration-Arguments.xml"/>
-</book>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/a24321bd/doc/java-broker/src/docbkx/Apache-Qpid-Broker-J-Book.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Apache-Qpid-Broker-J-Book.xml b/doc/java-broker/src/docbkx/Apache-Qpid-Broker-J-Book.xml
new file mode 100644
index 0000000..ee8aa96
--- /dev/null
+++ b/doc/java-broker/src/docbkx/Apache-Qpid-Broker-J-Book.xml
@@ -0,0 +1,44 @@
+<?xml version="1.0"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<book xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <title>Apache Qpid Broker-J</title>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Introduction.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Installation.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Getting-Started.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Concepts.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Initial-Configuration.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Management-Channels.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Management-Managing-Entities.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Security.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Runtime.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-High-Availability.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Backup-And-Recovery.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Environment-Variables.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-System-Properties.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Operational-Logging-Messages.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Statistics-Reporting.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Queue-Alerts.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Miscellaneous.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Appendix-Queue-Declaration-Arguments.xml"/>
+</book>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org
[2/3] qpid-broker-j git commit: QPID-8001: [Broker-J] [Documentation]
Updates for v7.0.0.
Posted by kw...@apache.org.
QPID-8001: [Broker-J] [Documentation] Updates for v7.0.0.
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/deb4ff80
Tree: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/tree/deb4ff80
Diff: http://git-wip-us.apache.org/repos/asf/qpid-broker-j/diff/deb4ff80
Branch: refs/heads/master
Commit: deb4ff803bcced53ba7fe2d72436bc7144e9dd3d
Parents: a24321b
Author: Keith Wall <kw...@apache.org>
Authored: Thu Nov 2 16:40:20 2017 +0000
Committer: Keith Wall <kw...@apache.org>
Committed: Thu Nov 2 16:45:15 2017 +0000
----------------------------------------------------------------------
...er-Appendix-Operational-Logging-Messages.xml | 143 ++++++++++---------
...ker-Appendix-Queue-Declaration-Arguments.xml | 50 +++++++
...ava-Broker-Appendix-Statistics-Reporting.xml | 10 +-
.../Java-Broker-Appendix-System-Properties.xml | 7 -
.../docbkx/Java-Broker-High-Availability.xml | 10 +-
.../src/docbkx/Java-Broker-Installation.xml | 6 +-
.../src/docbkx/Java-Broker-Introduction.xml | 18 +--
.../docbkx/Java-Broker-Management-Channels.xml | 1 -
...Java-Broker-Management-Managing-Entities.xml | 1 -
.../concepts/Java-Broker-Concepts-Exchanges.xml | 18 ++-
.../concepts/Java-Broker-Concepts-Overview.xml | 13 +-
.../concepts/Java-Broker-Concepts-Queues.xml | 141 +++++-------------
.../Java-Broker-Concepts-Virtualhosts.xml | 10 +-
.../src/docbkx/images/Broker-MessageFlow.png | Bin 36827 -> 36840 bytes
.../src/docbkx/images/VirtualHost-Model.png | Bin 24672 -> 24613 bytes
.../Java-Broker-Management-Channel-QMF.xml | 26 ----
.../Java-Broker-Management-Channel-REST-API.xml | 42 ++----
...oker-Management-Managing-Entities-Matrix.xml | 128 -----------------
...ava-Broker-Management-Managing-Keystores.xml | 2 +-
.../Java-Broker-Runtime-Close-On-No-Route.xml | 34 ++---
.../Java-Broker-Runtime-Flow-To-Disk.xml | 11 +-
...-Runtime-Handling-Undeliverable-Messages.xml | 54 ++++---
.../runtime/Java-Broker-Runtime-Memory.xml | 6 +-
...ker-Runtime-Producer-Transaction-Timeout.xml | 6 +
24 files changed, 275 insertions(+), 462 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml
index 7363d3e..bf4460b 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Operational-Logging-Messages.xml
@@ -357,30 +357,6 @@
management credentials that may be used connect to the Broker.</para>
</entry>
</row>
- <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1014">
- <entry morerows="1">BRK-1014</entry>
- <entry>Message flow to disk active : Message memory use <replaceable>size of all
- messages</replaceable> exceeds threshold <replaceable>threshold
- size</replaceable></entry>
- </row>
- <row>
- <entry>
- <para>Indicates that the memory space occupied by messages has exceeded the
- threshold so the flow to disk feature has been activated.</para>
- </entry>
- </row>
- <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1015">
- <entry morerows="1">BRK-1015</entry>
- <entry>Message flow to disk inactive : Message memory use <replaceable>size of all
- messages</replaceable> within threshold <replaceable>threshold
- size</replaceable></entry>
- </row>
- <row>
- <entry>
- <para>Indicates that the memory space occupied by messages has fallen below the
- threshold so the flow to disk feature has been deactivated.</para>
- </entry>
- </row>
<row xml:id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1016">
<entry morerows="1">BRK-1016</entry>
<entry>Fatal error : <replaceable>root cause</replaceable> : See log file for more information</entry>
@@ -399,6 +375,15 @@
<para>Process identifier (PID) of the Broker process.</para>
</entry>
</row>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1018">
+ <entry morerows="1">BRK-1018</entry>
+ <entry>Operation : <replaceable>operation name</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that the named operation has been invoked</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -515,28 +500,6 @@
shutdown.</para>
</entry>
</row>
- <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1003">
- <entry morerows="1">VHT-1003</entry>
- <entry><replaceable>virtualhostname</replaceable> :
- <replaceable>delivered|received</replaceable> : <replaceable>size</replaceable> kB/s
- peak : <replaceable>size</replaceable> bytes total</entry>
- </row>
- <row>
- <entry>
- <para>Statistic - bytes delivered or received by the virtualhost.</para>
- </entry>
- </row>
- <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1004">
- <entry morerows="1">VHT-1004</entry>
- <entry><replaceable>virtualhostname</replaceable> :
- <replaceable>delivered|received</replaceable> : <replaceable>size</replaceable> msg/s
- peak : <replaceable>size</replaceable> msgs total</entry>
- </row>
- <row>
- <entry>
- <para>Statistic - messages delivered or received by the virtualhost.</para>
- </entry>
- </row>
<row xml:id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1005">
<entry morerows="1">VHT-1005</entry>
<entry>Unexpected fatal error</entry>
@@ -567,6 +530,15 @@
when the usage of file system containing Virtualhost message falls under predefined limit.</para>
</entry>
</row>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1008">
+ <entry morerows="1">VHT-1008</entry>
+ <entry>Operation : <replaceable>operation name</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that the named operation has been invoked</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -649,28 +621,13 @@
</para>
</entry>
</row>
- <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1014">
- <entry morerows="1">QUE-1014</entry>
- <entry>Message flow to disk active : Message memory use <replaceable>size of all
- messages</replaceable> exceeds threshold <replaceable>threshold
- size</replaceable></entry>
- </row>
- <row>
- <entry>
- <para>Indicates that the memory space occupied by messages for this queue
- has exceeded thevthreshold so the flow to disk feature has been activated.</para>
- </entry>
- </row>
- <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1015">
- <entry morerows="1">QUE-1015</entry>
- <entry>Message flow to disk inactive : Message memory use <replaceable>size of all
- messages</replaceable> within threshold <replaceable>threshold
- size</replaceable></entry>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1016">
+ <entry morerows="1">QUE-1016</entry>
+ <entry>Operation : <replaceable>operation name</replaceable></entry>
</row>
<row>
<entry>
- <para>Indicates that the memory space occupied by messages for this queue has fallen
- below the threshold so the flow to disk feature has been deactivated.</para>
+ <para>Indicates that the named operation has been invoked</para>
</entry>
</row>
</tbody>
@@ -717,6 +674,15 @@
one queue. queue has exceeded its permitted capacity. See <xref linkend="Java-Broker-Concepts-Exchanges-UnroutableMessage"/> for details.</para>
</entry>
</row>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-EXH-1004">
+ <entry morerows="1">EXH-1004</entry>
+ <entry>Operation : <replaceable>operation name</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that the named operation has been invoked</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -998,6 +964,15 @@
</para>
</entry>
</row>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1014">
+ <entry morerows="1">CHN-1014</entry>
+ <entry>Operation : <replaceable>operation name</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that the named operation has been invoked</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -1045,7 +1020,15 @@
</para>
</entry>
</row>
-
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-SUB-1004">
+ <entry morerows="1">SUB-1004</entry>
+ <entry>Operation : <replaceable>operation name</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that the named operation has been invoked</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -1520,6 +1503,34 @@
with a web browser.</para>
</entry>
</row>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1008">
+ <entry morerows="1">PRT-1008</entry>
+ <entry>Connection from <replaceable>address</replaceable> rejected</entry>
+ </row>
+ <row>
+ <entry>
+ <para>Incoming connection is rejected because the port's connection limits are
+ already reached.</para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1009">
+ <entry morerows="1">PRT-1009</entry>
+ <entry>FAILED to bind <replaceable>name</replaceable> service to <replaceable>port number</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>The given port number could not be bound because it is already in-use.</para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1010">
+ <entry morerows="1">PRT-1010</entry>
+ <entry>Operation : <replaceable>operation name</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that the named operation has been invoked</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml
index b62dba2..3304a70 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Declaration-Arguments.xml
@@ -120,6 +120,56 @@ my-queue; {create: always, node: {x-declare: {arguments:{'x-qpid-capacity': 1024
</para>
</entry>
</row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-X-Qpid-Priorities">
+ <entry>
+ <para>x-qpid-priorities</para>
+ </entry>
+ <entry>
+ <para>Specifies a priority queue with given number priorities</para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Qpid-Sort-Key">
+ <entry>
+ <para>qpid.queue_sort_key</para>
+ </entry>
+ <entry>
+ <para>Specifies sorted queue with given message property used to sort the entries</para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Qpid-Last-Value-Key">
+ <entry>
+ <para>qpid.last_value_queue_key</para>
+ </entry>
+ <entry>
+ <para>Specifies lvq queue with given message property used to conflate the entries</para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-Qpid-Ensure-Nondestructive-Consumers">
+ <entry>
+ <para>qpid.ensure_nondestructive_consumers</para>
+ </entry>
+ <entry>
+ <para>Set to true if the queue should make all consumers attached to it behave
+ non-destructively. (Default is false).</para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-X-Qpid-Maximum-Delivery-Count">
+ <entry>
+ <para>x-qpid-maximum-delivery-count</para>
+ </entry>
+ <entry>
+ <para>Specifies this queue's maximum delivery count.</para>
+ </entry>
+ </row>
+ <row xml:id="Java-Broker-Appendix-Queue-Declare-Arguments-X-Qpid-Maximum-Delivery-Count">
+ <entry>
+ <para>x-qpid-dlq-enabled</para>
+ </entry>
+ <entry>
+ <para>If set <literal>true</literal>, a dead letter queue will be automatically created
+ and assigned as this queue's <literal>alternateBinding</literal>.</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/Java-Broker-Appendix-Statistics-Reporting.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Statistics-Reporting.xml b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Statistics-Reporting.xml
index ddc39b2..4fecce5 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Statistics-Reporting.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Statistics-Reporting.xml
@@ -78,15 +78,13 @@
</example>
<para>
Once enabled, an example statistic report output written to the log might look like this:
- <example>
- <screen><![CDATA[2017-10-15 13:03:12,993 INFO [virtualhost-default-pool-0] (q.s.Queue) - Statistics: default/myqueue: queueDepthMessages=0, queueDepthBytes=0 B
+ <screen><![CDATA[2017-10-15 13:03:12,993 INFO [virtualhost-default-pool-0] (q.s.Queue) - Statistics: default/myqueue: queueDepthMessages=0, queueDepthBytes=0 B
2017-10-15 13:03:22,979 INFO [virtualhost-default-pool-2] (q.s.Queue) - Statistics: default/myqueue: queueDepthMessages=3, queueDepthBytes=345 B
2017-10-15 13:03:32,981 INFO [virtualhost-default-pool-2] (q.s.Queue) - Statistics: default/myqueue: queueDepthMessages=3, queueDepthBytes=345 B]]></screen>
- </example>
</para>
<para>Removing a statistic report pattern from the same queue:</para>
<example>
- <title>Diabling statistics for a single queue using the REST API and cURL</title>
+ <title>Disabling statistics for a single queue using the REST API and cURL</title>
<screen><![CDATA[curl --user admin --data '{"name" : "qpid.queue.statisticsReportPattern"}' https://localhost:8080/api/latest/queue/default/default/myqueue/setContextVariable]]></screen>
</example>
<para>Adding a statistic reporting pattern to all queues:</para>
@@ -96,10 +94,8 @@
</example>
<para>
Once enabled, an example statistic report for a virtualhost with two queues might look like this:
- <example>
- <screen><![CDATA[2017-10-15 13:17:42,918 INFO [virtualhost-default-pool-1] (q.s.Queue) - Statistics: default/myqueue1: oldestMessageAge=PT1M24S
+ <screen><![CDATA[2017-10-15 13:17:42,918 INFO [virtualhost-default-pool-1] (q.s.Queue) - Statistics: default/myqueue1: oldestMessageAge=PT1M24S
2017-10-15 13:17:42,918 INFO [virtualhost-default-pool-1] (q.s.Queue) - Statistics: default/myqueue2: oldestMessageAge=PT0S]]></screen>
- </example>
</para>
</section>
</appendix>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/Java-Broker-Appendix-System-Properties.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Appendix-System-Properties.xml b/doc/java-broker/src/docbkx/Java-Broker-Appendix-System-Properties.xml
index e8c5e3f..561061d 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Appendix-System-Properties.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Appendix-System-Properties.xml
@@ -43,13 +43,6 @@
<entry>Factor to determine the maximum length of that may elapse between heartbeats being
received from the peer before a connection is deemed to have been broken.</entry>
</row>
- <row xml:id="Java-Broker-Appendix-System-Properties-Broker-Dead-Letter-Exchange-Suffix">
- <entry>qpid.broker_dead_letter_exchange_suffix</entry>
- <entry>_DLE</entry>
- <entry>Used with the <xref linkend="Java-Broker-Runtime-Handling-Undeliverable-Messages-Dead-Letter-Queues"/>
- feature. Governs the suffix used when generating a name for a Dead Letter
- Exchange.</entry>
- </row>
<row xml:id="Java-Broker-Appendix-System-Properties-Broker-Dead-Letter-Queue-Suffix">
<entry>qpid.broker_dead_letter_queue_suffix</entry>
<entry>_DLQ</entry>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/Java-Broker-High-Availability.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-High-Availability.xml b/doc/java-broker/src/docbkx/Java-Broker-High-Availability.xml
index 6b42484..739a78b 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-High-Availability.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-High-Availability.xml
@@ -66,8 +66,8 @@
master currently resides. When in replica role, the node sole responsibility is to consume a
replication stream in order that it remains up to date with the master.</para>
<para>Messaging clients discover the active virtualhost.This can be achieved using a static
- technique (for instance, a failover url (a feature of a Apache Qpid JMS Client for AMQP 0-9-1/0-10)), or a dynamic one
- utilising some kind of proxy or virtual IP (VIP).</para>
+ technique (for instance, a failover url (a feature of the Apache Qpid JMS and Apache Qpid JMS AMQP 0-x clients),
+ or a dynamic one utilising some kind of proxy or virtual IP (VIP).</para>
<para>The figure that follows illustrates a group formed of three virtualhost nodes from three
separate Broker instances. A client is connected to the virtualhost node that is in the master
role. The two virtualhost nodes <literal>weather1</literal> and <literal>weather3</literal>
@@ -472,9 +472,9 @@
<title>Client failover</title>
<para>As mentioned above, the clients need to be able to find the location of the active
virtualhost within the group.</para>
- <para>Clients can do this using a static technique, for example , utilising the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="${qpidJmsClient08Book}JMS-Client-0-8-Connection-URL.html">failover feature of the Qpid connection url</link>
- where the client has a list of all the nodes, and tries each node in sequence until it
- discovers the node with the active virtualhost.</para>
+ <para>Clients can do this using a static technique, for example , utilising the failover feature of the Apache Qpid
+ JMS and Apache Qpid JMS AMQP 0-x clients where the client has a list of all the nodes, and tries each node in
+ sequence until it discovers the node with the active virtualhost.</para>
<para>Another possibility is a dynamic technique utilising a proxy or Virtual IP (VIP). These
require other software and/or hardware and are outside the scope of this document.</para>
</section>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 c9a3b9d..d40d465 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Installation.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Installation.xml
@@ -32,9 +32,9 @@
<section role="h3" xml:id="Java-Broker-Installation-Prerequistes-Java">
<title>Java Platform</title>
<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 policy file are required for some features</para></footnote>. This includes Linux, Solaris, Mac OS X, and
- Windows Vista/7/8/10.</para>
+ 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>
<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/deb4ff80/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 8f2daf6..b40a141 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Introduction.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Introduction.xml
@@ -49,7 +49,10 @@
</footnote></para>
</listitem>
<listitem>
- <para>Supports for all versions of the AMQP protocol</para>
+ <para>Supports for all versions of the AMQP protocol (0-8, 0-9, 0-91, 0-10 and 1.0).</para>
+ </listitem>
+ <listitem>
+ <para>Supports for AMQP over websockets.</para>
</listitem>
<listitem>
<para>Automatic message translation, allowing clients using different AMQP versions to communicate with each other.</para>
@@ -62,12 +65,11 @@
<para>Support for message compression</para>
</listitem>
<listitem>
- <para>Client support for end to end message encryption</para>
- </listitem>
- <listitem>
- <para>Pluggable storage architecture with implementations including <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://db.apache.org/derby/">Apache Derby</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="${oracleBdbProductOverviewUrl}">Oracle BDB JE</link><footnote>
- <para>Oracle BDB JE must be downloaded separately.</para>
- </footnote>, and External Database</para>
+ <para>Pluggable storage architecture with implementations including <link
+ xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://db.apache.org/derby/">Apache
+ Derby</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="${oracleBdbProductOverviewUrl}">
+ Oracle BDB JE</link>, and External Databases.
+ </para>
</listitem>
<listitem>
<para>Web based management interface and programmatic management interfaces via REST.</para>
@@ -77,7 +79,7 @@
</listitem>
<listitem>
<para>High availability (HA) support.<footnote>
- <para>HA currently only available to users of the optional BDB JE HA based message store.</para>
+ <para>HA currently only available with the Oracle BDB JE message store option.</para>
</footnote></para>
</listitem>
</itemizedlist>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/Java-Broker-Management-Channels.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Management-Channels.xml b/doc/java-broker/src/docbkx/Java-Broker-Management-Channels.xml
index a3fda3e..9211056 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Management-Channels.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Management-Channels.xml
@@ -38,5 +38,4 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/channels/Java-Broker-Management-Channel-Web-Console.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/channels/Java-Broker-Management-Channel-REST-API.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/channels/Java-Broker-Management-Channel-AMQP-Intrinsic.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/channels/Java-Broker-Management-Channel-QMF.xml"/>
</chapter>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/Java-Broker-Management-Managing-Entities.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Management-Managing-Entities.xml b/doc/java-broker/src/docbkx/Java-Broker-Management-Managing-Entities.xml
index 99319d7..dd19182 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Management-Managing-Entities.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Management-Managing-Entities.xml
@@ -80,7 +80,6 @@
features are described along with the entities key attributes, key context variables, details
of the entities lifecycle and any other operations.</para>
</section>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Broker.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-VirtualhostNodes.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Virtualhosts.xml"/>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 1c1c7af..f8095e5 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
@@ -24,6 +24,11 @@
<title>Exchanges</title>
<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
+ 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>
<para>The server provides a set of exchange types with each exchange type implementing a different routing algorithm. For details of how
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 "<literal>amq.</literal>". These are defined in
@@ -192,13 +197,12 @@
<title>Unrouteable Messages</title>
<para>If an exchange is unable to route a message to any queues, the Broker will:
<itemizedlist>
- <listitem><para>If using the AMQP 1.0 protocol, and an alternate exchange has been set on the exchange, the message is routed to the alternate exchange.
- The alternate exchange routes the message according to its routing algorithm and its binding table. If the message is still unroutable,
- the message is discarded unless the sending link has requested the <literal>REJECT_UNROUTABLE</literal> target capability, or the Exchange has its
- <literal>unroutableMessageBehaviour</literal> attribute set to <literal>REJECT</literal>.</para></listitem>
- <listitem><para>If using the AMQP 0-10 protocol, and an alternate exchange has been set on the exchange, the message is routed to the alternate exchange.
- The alternate exchange routes the message according to its routing algorithm and its binding table. If the message is still unroutable,
- the message is discarded.</para></listitem>
+ <listitem><para>If using the AMQP 1.0 protocol, and an alternate binding has been set on the exchange, the message is routed to the alternate.
+ If the message is still unroutable after considering the alternate binding, the message is discarded unless the sending link has requested the
+ <literal>REJECT_UNROUTABLE</literal> target capability, or the Exchange has its <literal>unroutableMessageBehaviour</literal> attribute set to
+ <literal>REJECT</literal>.</para></listitem>
+ <listitem><para>If using the AMQP 0-10 protocol, and an alternate binding has been set on the exchange, the message is routed to the alternate.
+ If the message is still unroutable after considering the alternate binding,the message is discarded.</para></listitem>
<listitem><para>If using AMQP protocols 0-8..0-9-1, and the publisher set the mandatory flag and the<link linkend="Java-Broker-Runtime-Close-Connection-When-No-Route">
close when no route</link> feature did not close the connection, the message is returned to the Producer.</para></listitem>
<listitem><para>Otherwise, the message is discarded.</para></listitem>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 8dce5da..45d1a27 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
@@ -26,9 +26,20 @@
the entities and describes the relationships between them. These details are developed further
in the sub-sections that follow.</para>
<para>The most important entity is the <emphasis>Virtualhost</emphasis>. A virtualhost is an
- independent namespace in which messaging is performed. A <emphasis>virtualhost</emphasis> exists
+ independent container in which messaging is performed. A <emphasis>virtualhost</emphasis> exists
in a container called a <emphasis>virtualhost node</emphasis>. A virtualhost node has exactly
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
+ 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.
+ </para>
+ <para><emphasis>Queue</emphasis>s are named entities that hold/buffer messages for later delivery to
+ consumer applications.
+ </para>
<para><emphasis>Ports</emphasis> accept connections for messaging and management. The Broker
supports any number of ports. When connecting for messaging, the user specifies a virtualhost
name to indicate the virtualhost to which it is to be connected.</para>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 9e3ea19..ac0d925 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
@@ -23,10 +23,14 @@
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts-Queues">
<title>Queues</title>
<para><emphasis>Queue</emphasis>s are named entities within a <link linkend="Java-Broker-Concepts-Virtualhosts">Virtualhost</link> that
- hold/buffer messages for later delivery to consumer applications. An <link linkend="Java-Broker-Concepts-Exchanges">Exchange</link> for passing messages to a queue.
- 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 the ability to group messages
- together for delivery to a single consumer.</para>
+ 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>
+ <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
+ are described below too.</para>
<section xml:id="Java-Broker-Concepts-Queues-Types">
<title>Types</title>
<para>The Broker supports four different queue types, each with different delivery semantics.<itemizedlist>
@@ -88,46 +92,6 @@
will never be "replaced".</para>
</section>
</section>
- <section xml:id="Java-Broker-Concepts-Queues-QueueDeclareArguments">
- <title>Queue Declare Arguments</title>
- <para>To create a priority, sorted or LVQ queue programmatically from AMQP, pass the
- appropriate queue-declare arguments.</para>
- <table>
- <title>Queue-declare arguments understood for priority, sorted and LVQ queues</title>
- <tgroup cols="4">
- <thead>
- <row>
- <entry>Queue type</entry>
- <entry>Argument name</entry>
- <entry>Argument name</entry>
- <entry>Argument Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>priority</entry>
- <entry>x-qpid-priorities</entry>
- <entry>java.lang.Integer</entry>
- <entry>Specifies a priority queue with given number priorities</entry>
- </row>
- <row>
- <entry>sorted</entry>
- <entry>qpid.queue_sort_key</entry>
- <entry>java.lang.String</entry>
- <entry>Specifies sorted queue with given message property used to sort the
- entries</entry>
- </row>
- <row>
- <entry>lvq</entry>
- <entry>qpid.last_value_queue_key</entry>
- <entry>java.lang.String</entry>
- <entry>Specifies lvq queue with given message property used to conflate the
- entries</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
<section xml:id="Java-Broker-Concepts-Queues-Message-Grouping">
<title>Messaging Grouping</title>
<para> The broker allows messaging applications to classify a set of related messages as
@@ -161,7 +125,7 @@
message's assigned group.
</para>
</section>
- <section xml:id="Java-Broker-Concepts-Queues-BrokerRole">
+ <section xml:id="Java-Broker-Concepts-Queues-BrokerRole">
<title> The Role of the Broker in Message Grouping </title>
<para> The broker will apply the following processing on each grouped message: <itemizedlist>
<listitem>
@@ -218,36 +182,7 @@
first message of group "A" is in the process of being consumed by a client, then the
remaining "A" messages are blocked, but the messages of the "B" group are available for
consumption by other consumers - even though it is "behind" group "A" in the queue. </para>
-</section>
-</section>
- <section xml:id="Java-Broker-Concepts-Queues-SetLowPrefetch">
- <title>Using low pre-fetch with special queue types</title>
- <para>Qpid clients receive buffered messages in batches, sized according to the pre-fetch value.
- The current default is 500. </para>
- <para>However, if you use the default value you will probably <emphasis>not</emphasis> see
- desirable behaviour when using priority, sorted, lvq or grouped queues. Once the broker has
- sent a message to the client its delivery order is then fixed, regardless of the special
- 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
- 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
- environment (using -D) before creating your consumer. </para>
- <para>A default for all client connections can be set via a system property: </para>
- <programlisting>
--Dmax_prefetch=1
-</programlisting>
- <para> The prefetch can be also be adjusted on a per connection basis by adding a
- <varname>maxprefetch</varname> value to the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="${qpidJmsClient08Book}JMS-Client-0-8-Connection-URL.html">Connection URLs</link>
- </para>
- <programlisting>
-amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://localhost:5672'
-</programlisting>
- <para>Setting the Qpid pre-fetch to 1 will give exact queue-type semantics as perceived by the
- client however, this brings a performance cost. You could test with a slightly higher
- pre-fetch to trade-off between throughput and exact semantics.</para>
+ </section>
</section>
<section xml:id="Java-Broker-Concepts-Queue-EnsureNonDestructiveConsumers">
<title>Forcing all consumers to be non-destructive</title>
@@ -266,30 +201,7 @@ amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://loc
only seeing messages that arrive after the point at which the consumer is created, all
messages which have not been removed due to TTL expiry (or, in the case of LVQs,
overwirtten by newer values for the same key).</para>
- <para>A queue can be created to enforce all consumers are non-destructive. This can be
- be achieved using the following queue declare argument:</para>
- <table>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Argument Name</entry>
- <entry>Argument Type</entry>
- <entry>Argument Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>qpid.ensure_nondestructive_consumers</entry>
- <entry>java.lang.Boolean</entry>
- <entry>Set to true if the queue should make all consumers attached to it behave
- non-destructively. (Default is false).</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>Through the <link linkend="Java-Broker-Management-Channel-REST-API">REST</link> api,
- the equivalent attribute is named <varname>ensureNondestructiveConsumers</varname>.
- </para>
+ <para>A queue can be created to enforce all consumers are non-destructive.</para>
<section>
<title>Bounding size using min/max TTL</title>
<para>For queues other than LVQs, having only non-destructive consumers could mean that
@@ -298,8 +210,7 @@ amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://loc
all messages have the same TTL you could also set the minimum TTL to the same value.
</para>
<para>Minimum/Maximum TTL for a queue can be set though the HTTP Management UI, using the
- REST API or by hand editing the configuration file (for JSON configuration stores).
- The attribute names are <varname>minimumMessageTtl</varname> and
+ REST API. The attribute names are <varname>minimumMessageTtl</varname> and
<varname>maximumMessageTtl</varname> and the TTL value is given in milliseconds.</para>
</section>
<section>
@@ -317,8 +228,10 @@ amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://loc
arriving messages should be sent. A replay period of 3600 indicates that only
messages sent in the last hour - along with any newly arriving messages - should be
sent.</para>
+ <para>When using the Qpid JMS AMQP 0-x, the consumer declaration can be hinted using the
+ address.</para>
<table>
- <title>Setting the replay period</title>
+ <title>Setting the replay period using a Qpid JMS AMQP 0-x address</title>
<tgroup cols="2">
<thead>
<row>
@@ -361,7 +274,7 @@ amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://loc
</screen>
</section>
</section>
- <section xml:id="Java-Broker-Concepts-Queue-HoldingEntries">
+ <section xml:id="Java-Broker-Concepts-Queue-HoldingEntries">
<title>Holding messages on a Queue</title>
<para>Sometimes it is required that while a message has been placed on a queue, it is not released to consumers
until some external condition is met. </para>
@@ -377,9 +290,9 @@ amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://loc
be released from the Queue to consumers until this time has been reached.
</para>
</section>
- </section>
+ </section>
- <section xml:id="Java-Broker-Concepts-Queue-OverflowPolicy">
+ <section xml:id="Java-Broker-Concepts-Queue-OverflowPolicy">
<title>Controlling Queue Size</title>
<para>
<emphasis>Overflow Policy</emphasis>
@@ -444,5 +357,21 @@ amqp://guest:guest@client1/development?maxprefetch='1'&brokerlist='tcp://loc
The Broker issues Operational log messages when the queue sizes are breached. These are documented
at <xref linkend="Java-Broker-Appendix-Operation-Logging-Message-List-Queue"/>.
</para>
- </section>
+ </section>
+ <section xml:id="Java-Broker-Concepts-Queues-SetLowPrefetch">
+ <title>Using low pre-fetch with special queue types</title>
+ <para>Messaging clients may buffered messages for performance reasons. In Qpid, this is commonly known as
+ <emphasis>pre-fetch</emphasis></para>
+ <para>When using some of the messaging features described on this section, using prefetch can give
+ unexpected behaviour. Once the broker has sent a message to the client its delivery order is then fixed,
+ regardless of the special 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
+ 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>Using pre-fetch of 1 will give exact queue-type semantics as perceived by the
+ client however, this brings a performance cost. You could test with a slightly higher
+ pre-fetch to trade-off between throughput and exact semantics.</para>
+ <para>See the messaging client documentation for details of how to configure prefetch.</para>
+ </section>
</section>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 b35435d..a070c60 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
@@ -22,23 +22,23 @@
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts-Virtualhosts">
<title>Virtualhosts</title>
- <para>A virtualhost is a namespace in which messaging is performed. Virtualhosts are independent;
+ <para>A virtualhost is a container in which messaging is performed. Virtualhosts are independent;
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>
<para>A virtualhost is identified by a name which must be unique broker-wide. Clients use the name
to identify the virtualhost to which they wish to connect when they connect.</para>
- <para>A virtualhost exists in a container called a virtualhost node.</para>
+ <para>A virtualhost exists in a virtualhost node.</para>
<para>The virtualhost comprises a number of entities. This section summaries the purpose of
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.</para>
+ messages from producers and routes them to matching Queues. When using AMQP 0-8, 0-9, 0-91, 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
applications.</para>
- <para><emphasis>Bindings</emphasis> are relationships between Exchanges and Queue that facilitate
- routing of messages from the Exchange to the Queue.</para>
<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
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/images/Broker-MessageFlow.png
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/images/Broker-MessageFlow.png b/doc/java-broker/src/docbkx/images/Broker-MessageFlow.png
index b687dfe..4902c46 100644
Binary files a/doc/java-broker/src/docbkx/images/Broker-MessageFlow.png and b/doc/java-broker/src/docbkx/images/Broker-MessageFlow.png differ
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/images/VirtualHost-Model.png
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/images/VirtualHost-Model.png b/doc/java-broker/src/docbkx/images/VirtualHost-Model.png
index cb04401..0e2654d 100644
Binary files a/doc/java-broker/src/docbkx/images/VirtualHost-Model.png and b/doc/java-broker/src/docbkx/images/VirtualHost-Model.png differ
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-QMF.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-QMF.xml b/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-QMF.xml
deleted file mode 100644
index 7bee8be..0000000
--- a/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-QMF.xml
+++ /dev/null
@@ -1,26 +0,0 @@
-<?xml version="1.0"?>
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-
-<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Management-Channel-QMF">
- <title>QMF</title>
- <para>QMF is provided by an optional plugin.</para>
-</section>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 a33b176..138dac6 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
@@ -25,7 +25,7 @@
<section xml:id="Java-Broker-Management-Channel-REST-API-Introduction">
<title>Introduction</title>
<para>This section describes the REST API provided by the Apache Qpid Broker-J. The REST API is intended
- for use by developers who wish to automate the management or monitoring of the Qpid Broker. It
+ for use by developers who wish to automate the management or monitoring of the Broker. It
is also very useful for adhoc monitoring on the command line using tools such as
<literal>curl</literal>.</para>
<para>The REST API provides access to all of the Broker's entities using hierarchical paths
@@ -150,28 +150,16 @@
</section>
<section xml:id="Java-Broker-Management-Channel-REST-API-Get">
<title>Retrieving Configured Object details</title>
- <para>Method GET is used to retrieve ConfiguredObject attributes values and children
- hierarchy.</para>
- <para>A particular ConfiguredObject details can be retrieved using full ConfiguredObject URI
- (the one ending with configured object name)</para>
- <para>A collection of ConfiguredObjects can be retrieved using parent URI. Request parameters
- (having the same name as attributes) can be used to filter the returned configured
- objects.</para>
- <para>The REST URI (/api/latest/>category</*) are hierarchical. It is permitted to replace
- REST URI elements with an "asterisks" in GET requests to denote all object of a particular
- type. Additionally, trailing object type in the URL hierarchy can be omitted. In this case GET
- request will return all of the object underneath of the current object.</para>
- <para>For example, for binding URL <literal>http://localhost:8080/api/latest/binding/<vhost
- node>/<vhost>/<exchange>/<queue>/<binding></literal> replacing of
- <literal><exchange></literal> with "asterisks"
- (<literal>http://localhost:8080/api/<ver>/binding/<vhost
- node>/<vhost>/*/<queue>/<binding></literal>) will result in the GET
- response containing the list of bindings for all of the exchanges in the virtualhost having
- the given name and given queue.</para>
- <para>If <literal><binding></literal> and <literal><queue></literal> are omitted in
- binding REST URL (<literal>http://localhost:8080/api/<ver>/binding/<vhost
- node>/<vhost>/<exchangename></literal>) the GET request will result in
- returning all bindings for all queues for the given exchange in the virtual host. </para>
+ <para>Method GET is used to retrieve an object's attributes values and statistics.</para>
+ <para>To retrieve a single object, use its full URI. For instance, to retrieve a single queue:</para>
+ <screen>GET /api/latest/queue/vhn/vh/my-queue</screen>
+ <para>To retrieve all objects beneath a parent, pass the parent's URI. For instance, to retrieve
+ 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.
+ 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>
<variablelist>
<varlistentry>
@@ -324,13 +312,7 @@ curl --user admin -X PUT -d '{"durable":true}' http://localhost:8080/api/latest
curl --user admin -X PUT -d '{"durable":true,"type":"priority"}' http://localhost:8080/api/latest/queue/<vhostnode name>/<vhostname>/<queuename>
</programlisting>
</example>
- <example>
- <title>Example of binding a queue to an exchange using curl</title>
- <programlisting>
-curl --user admin -X PUT -d '{}' http://localhost:8080/api/latest/binding/<vhostnode name>/<vhostname>/<exchangename>/<queue-name>/<binding-name>
- </programlisting>
- </example>
- <para> NOTE: These curl examples utilise unsecure HTTP transport. To use the examples it is
+ <para> NOTE: These curl examples utilise an unsecured HTTP transport. To use the examples it is
first necessary enable Basic authentication for HTTP within the HTTP Management Configuration
(it is off by default). For details see <xref linkend="Java-Broker-Management-Managing-Plugin-HTTP"/>
</para>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml b/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml
deleted file mode 100644
index 20a57a5..0000000
--- a/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml
+++ /dev/null
@@ -1,128 +0,0 @@
-<?xml version="1.0"?>
-<!--
-
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
--->
-
-<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Management-Managing-Entities-Matrix">
- <title>Entity/Management Channel Support Matrix</title>
- <para>This tables indicates which management channels support the creation (C), update (U), or
- deletion (D) of different entities within the Broker.</para>
- <table frame="all">
- <title>Entity/Management Matrix</title>
- <tgroup cols="4" align="left" colsep="1" rowsep="1">
- <colspec colname="entity"/>
- <colspec colname="http"/>
- <colspec colname="amqp"/>
- <thead>
- <row>
- <entry>Entity</entry>
- <entry>HTTP</entry>
- <entry>AMQP</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Broker</entry>
- <entry>U</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Virtualhost Node</entry>
- <entry>C/U/D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Virtualhost</entry>
- <entry>C/U/D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Remote Replication Node</entry>
- <entry>U/D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Exchange</entry>
- <entry>C/D</entry>
- <entry>C/D</entry>
- </row>
- <row>
- <entry>Queue</entry>
- <entry>C/D</entry>
- <entry>C/D</entry>
- </row>
- <row>
- <entry>Binding</entry>
- <entry>C/D</entry>
- <entry>C/D</entry>
- </row>
- <row>
- <entry>Port</entry>
- <entry>C/U/D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Authentication Providers</entry>
- <entry>C/U/D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Group Providers</entry>
- <entry>C//D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Access Control Provider</entry>
- <entry>C//D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Keystores</entry>
- <entry>C//D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Truststores</entry>
- <entry>C//D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Users</entry>
- <entry>C//D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Groups</entry>
- <entry>C//D</entry>
- <entry>No</entry>
- </row>
- <row>
- <entry>Loggers</entry>
- <entry>C/U/D</entry>
- <entry>No</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <important>
- <title>Note</title>
- <para>It is currently only possible to modify a entity's context using the HTTP channel.</para>
- </important>
-</section>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Keystores.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Keystores.xml b/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Keystores.xml
index 0f4958f..d6cbe67 100644
--- a/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Keystores.xml
+++ b/doc/java-broker/src/docbkx/management/managing/Java-Broker-Management-Managing-Keystores.xml
@@ -49,7 +49,7 @@
<listitem>
<para><emphasis>Auto Generated Self Signed</emphasis> has the ability to
generate a self signed certificate and produce a truststore
- suitable for use by an application using the Apache Qpid JMS client for AMQP 0-9-1/0-10.</para>
+ suitable for use by an application using the Apache Qpid JMS and Apache Qpid JMS AMQP 0-x clients.</para>
<para>The use of self signed certficates is not recommended for production
use.</para>
</listitem>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Close-On-No-Route.xml
----------------------------------------------------------------------
diff --git a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Close-On-No-Route.xml b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Close-On-No-Route.xml
index b4f2c83..3ebb22f 100644
--- a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Close-On-No-Route.xml
+++ b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Close-On-No-Route.xml
@@ -30,7 +30,7 @@
in either message being bounced back (if it is mandatory or immediate) or discarded on broker side otherwise.
</para>
<para>
- When a 'mandatory' message is returned back, the Apache Qpid JMS client for AMQP 0-9-1/0-10 conveys this by delivering
+ When a 'mandatory' message is returned, the Apache Qpid JMS AMQP 0-x clients conveys this by delivering
an <emphasis>AMQNoRouteException</emphasis> through the configured ExceptionListener on the Connection.
This does not cause channel or connection closure, however it requires a special exception handling
on client side in order to deal with <emphasis>AMQNoRouteExceptions</emphasis>.
@@ -47,29 +47,23 @@
<note>
<para>This feature affects only transacted sessions.</para>
<para>
- The Apache Qpid JMS client for AMQP 0-9-1/0-10 sends 'mandatory' messages when using Queue destinations
- and 'non-mandatory' messages when using Topic destinations.
+ By default, the Apache Qpid JMS AMQP 0-x produces mandatory messages when using queue destinations. Topic
+ destinations produce 'non-mandatory' messages.
</para>
</note>
</section>
<section xml:id="Java-Broker-Runtime-Close-Connection-When-No-Route-Configuration">
- <title>Configuring <emphasis>closeWhenNoRoute</emphasis></title>
+ <title>Configuring
+ <emphasis>closeWhenNoRoute</emphasis>
+ </title>
<para>
- The Broker attribute <emphasis>closeWhenNoRoute</emphasis> can be set to specify this feature on broker side.
- By default, it is turned on. Setting <emphasis>closeWhenNoRoute</emphasis> to <emphasis>false</emphasis> switches it off.
+ The Port attribute <emphasis>closeWhenNoRoute</emphasis> can be set to specify this feature on broker side.
+ By default, it is turned on. Setting <emphasis>closeWhenNoRoute</emphasis> to <emphasis>false</emphasis> switches
+ it off.
</para>
- <para>
- Setting the <emphasis>closeWhenNoRoute</emphasis> in the JMS client connection URL can override the broker configuration
- on a connection specific basis, for example :
- </para>
- <example>
- <title>Disable feature to close connection on unroutable messages with client URL</title>
- <screen>
-amqp://guest:guest@clientid/?brokerlist='tcp://localhost:5672'&closeWhenNoRoute='false'</screen>
- </example>
- <para>
- If no value is specified on the client the broker setting will be used. If client setting is specified then it will take precedence
- over the broker-wide configuration. If the client specifies and broker does not support this feature the warning will be logged.
- </para>
- </section>
+ <para>See the <link xmlns:xlink="http://www.w3.org/1999/xlink"
+ xlink:href="${qpidJmsClient08Book}JMS-Client-0-8-Connection-URL.html">Qpid JMS AMQP 0-x client
+ documentation</link> for details of enabling this feature client side.
+ </para>
+ </section>
</section>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 5280b1a..7511a66 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
@@ -27,19 +27,16 @@
limit is reached any new transient messages and all existing transient messages will be
transferred to disk. Newly arriving transient messages will continue to go to the disk until the
cumulative size of all messages falls below the limit once again.</para>
- <para>By default the Broker makes 40% of the max direct available memory for messages. This memory is
+ <para>By default the Broker makes 75% of the max direct available memory for messages. This memory is
divided between all the queues across all virtual hosts defined on the Broker with a percentage
calculated according to their current queue size. These calculations are refreshed periodically
by the housekeeping cycle.</para>
<para>For example if there are two queues, one containing 75MB and the second 100MB messages
- respectively and the Broker has 1GB direct memory with the default of 40% available for messages.
- The first queue will have a target size of 170MB and the second 230MB. Once 400MB is taken by
+ respectively and the Broker has 1GB direct memory with the default of 75% available for messages.
+ The first queue will have a target size of 320MB and the second 430MB. Once 750MB is taken by
messages, messages will begin to flow to disk. New messages will cease to flow to disk when
- their cumulative size falls beneath 400MB.</para>
+ 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>
- <para>Log message <link linkend="Java-Broker-Appendix-Operation-Logging-Message-BRK-1014">BRK-1014</link> is written when the feature activates. Once the total space of all messages
- decreases below the threshold, the message <link linkend="Java-Broker-Appendix-Operation-Logging-Message-BRK-1015">BRK-1015</link> is written
- to show that the feature is no longer active.</para>
</section>
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 fccdeed..46c0c9a 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
@@ -46,39 +46,33 @@
<section role="h2" xml:id="Java-Broker-Runtime-Handling-Undeliverable-Messages-Maximum-Delivery-Count">
<title>Maximum Delivery Count</title>
- <para> Maximum delivery count is a property of a queue. If a consumer application is unable to
- process a message more than the specified number of times, then the broker will either route the
- message to a dead-letter queue (if one has been defined), or will discard the message. </para>
- <para> In order for a maximum delivery count to be enforced, the consuming client
+ <para> Maximum delivery count is an attribute of a queue. If a consumer application is unable to
+ process a message more than the specified number of times, then the Broker will either route the
+ message via the queue's <emphasis>alternate binding</emphasis> (if one has been defined), or will
+ discard the message.</para>
+ <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>
+ <note>
+ <para> When using AMQP 0-9..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.</para>
- <para>If the consuming client 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 AMQP 0-9-1, 0-9, or 0-8 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>
- <para>It is possible to determine the number of times a message has been sent to a consumer via
- the Management interfaces, but is not possible to determine this information from a message client.
- Specifically, the optional JMS message header <property>JMSXDeliveryCount</property> is not
- supported.</para>
- <para>Maximum Delivery Count can be specified when a new queue is created or using the the
- queue declare property <property>x-qpid-maximum-delivery-count</property></para>
+ 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
+ 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>
</section>
-
<section role="h2" xml:id="Java-Broker-Runtime-Handling-Undeliverable-Messages-Dead-Letter-Queues">
- <title>Dead Letter Queues (DLQ)</title>
- <para>A Dead Letter Queue (DLQ) acts as an destination for messages that have somehow exceeded the
- normal bounds of processing and is utilised to prevent disruption to flow of other messages. When
- a DLQ is enabled for a given queue if a consuming client indicates it no longer wishes the
- receive the message (typically by exceeding a Maximum Delivery Count) then the message is moved
- onto the DLQ and removed from the original queue. </para>
- <para>The DLQ feature causes generation of a Dead Letter Exchange and a Dead Letter Queue. These
- are named convention QueueName<emphasis>_DLE</emphasis> and QueueName<emphasis>_DLQ</emphasis>.</para>
- <para>DLQs can be enabled when a new queue is created
- or using the queue declare property <property>x-qpid-dlq-enabled</property>.</para>
+ <title>Alternate Binding</title>
+ <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>
<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/deb4ff80/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 b37b769..50d69b5 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
@@ -157,7 +157,7 @@
<section xml:id="Java-Broker-Runtime-Memory-Low-Memory-Direct">
<title>Low on Direct Memory</title>
<para>
- When the broker detects that it uses 40% of available direct memory it will start flowing incoming transient messages to disk and reading them back before delivery.
+ When the broker detects that it uses 75% of available direct memory it will start flowing incoming transient messages to disk and reading them back before delivery.
This will prevent the broker from running out of direct memory but may degrade performance by requiring disk I/O.
</para>
</section>
@@ -174,10 +174,10 @@
1.5 GB direct memory
</listitem>
<listitem>
- 5% of heap reserved for the JE cache.
+ 5% of heap reserved for the BDB JE cache.
</listitem>
<listitem>
- Start flow-to-disk at 40% direct memory utilisation.
+ Start flow-to-disk at 75% direct memory utilisation.
</listitem>
</itemizedlist>
As an example, this would accommodate a broker with 50 connections, each serving 5 sessions, and each session having 1000 messages of 1 kB on queues in the broker.
http://git-wip-us.apache.org/repos/asf/qpid-broker-j/blob/deb4ff80/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 252aec0..37abae5 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
@@ -24,6 +24,12 @@
<title>Producer Transaction Timeout</title>
<section role="h2" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-GeneralInformation">
<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
+ </para>
+ </note>
<para> The transaction timeout mechanism is used to control broker resources when clients
producing messages using transactional sessions hang or otherwise become unresponsive, or simply
begin a transaction and keep using it without ever calling <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="${oracleJeeDocUrl}javax/jms/Session.html#commit">Session#commit()</link>.</para>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org