You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by or...@apache.org on 2020/10/07 00:55:36 UTC
[qpid-broker-j] branch 7.1.x updated: QPID-8471:[Broker-J] Added
PDF support and column spec changes
This is an automated email from the ASF dual-hosted git repository.
orudyy pushed a commit to branch 7.1.x
in repository https://gitbox.apache.org/repos/asf/qpid-broker-j.git
The following commit(s) were added to refs/heads/7.1.x by this push:
new 5b9553e QPID-8471:[Broker-J] Added PDF support and column spec changes
5b9553e is described below
commit 5b9553e950acfb7b04bb8ef829b6f607c1a04e0a
Author: Dedeepya T <de...@yahoo.co.in>
AuthorDate: Fri Oct 2 11:37:23 2020 +0530
QPID-8471:[Broker-J] Added PDF support and column spec changes
---
.../Java-Broker-Appendix-Environment-Variables.xml | 3 ++
...roker-Appendix-Operational-Logging-Messages.xml | 35 ++++++++++++++++++++--
.../docbkx/Java-Broker-Appendix-Queue-Alerts.xml | 6 ++--
...Broker-Appendix-Queue-Declaration-Arguments.xml | 15 +++++++---
.../Java-Broker-Appendix-Statistics-Reporting.xml | 25 +++++++++-------
.../Java-Broker-Appendix-System-Properties.xml | 3 ++
.../src/docbkx/Java-Broker-High-Availability.xml | 8 ++---
.../docbkx/Java-Broker-Initial-Configuration.xml | 3 ++
.../Java-Broker-Management-Managing-Entities.xml | 4 +--
.../concepts/Java-Broker-Concepts-Exchanges.xml | 10 +++----
.../concepts/Java-Broker-Concepts-Overview.xml | 4 +--
.../docbkx/concepts/Java-Broker-Concepts-Ports.xml | 2 +-
.../concepts/Java-Broker-Concepts-Queues.xml | 2 ++
.../concepts/Java-Broker-Concepts-Virtualhosts.xml | 2 +-
.../Java-Broker-Management-Channel-REST-API.xml | 2 ++
...va-Broker-Management-Channel-REST-Query-API.xml | 6 ++++
.../Java-Broker-Management-Channel-Web-Console.xml | 12 ++++----
.../runtime/Java-Broker-Runtime-Consumers.xml | 2 ++
.../runtime/Java-Broker-Runtime-Log-Files.xml | 6 ++--
...Java-Broker-Security-AccessControlProviders.xml | 15 +++++++++-
doc/pom.xml | 3 +-
21 files changed, 123 insertions(+), 45 deletions(-)
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Environment-Variables.xml b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Environment-Variables.xml
index cbfd0f8..dbfe567 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Environment-Variables.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Environment-Variables.xml
@@ -29,6 +29,9 @@
<table pgwide="1">
<title>Environment variables</title>
<tgroup cols="3">
+ <colspec colnum="1" colname="envvar" colwidth="1*"/>
+ <colspec colnum="2" colname="default" colwidth="1*"/>
+ <colspec colnum="3" colname="purpose" colwidth="1*"/>
<thead>
<row>
<entry>Environment variable</entry>
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 23ecce6..2b85278 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
@@ -62,8 +62,7 @@
user id used by the client (myapp1), their IP, ephemeral port number and the name of the virtual
host. The message text itself gives us further details about the connection: the client id, the
protocol version in used, and details of the client's qpid library.</para>
- <screen>[con:8(myapp1@/127.0.0.1:52851/default)] CON-1001 : Open : Destination : AMQP(127.0.0.1:5672) :
- Protocol Version : 0-10 : Client ID : myapp1 : Client Version : ${project.version} : Client Product : qpid</screen>
+ <screen>[con:8(myapp1@/127.0.0.1:52851/default)] CON-1001 : Open : Destination : AMQP(127.0.0.1:5672) : Protocol Version : 0-10 : Client ID : myapp1 : Client Version : ${project.version} : Client Product : qpid</screen>
<para><literal><link linkend="Java-Broker-Appendix-Operation-Logging-Message-QUE-1001">QUE-1001</link></literal> is used when a queue is created. The connection actor
<literal>con</literal> tells us details of the connection performing the queue creation: the
user id used by the client (myapp1), the IP, ephemeral port number and the name of the virtual
@@ -76,6 +75,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Actor-Format">
<title>Actors Entities</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="actortype" colwidth="1*"/>
+ <colspec colnum="2" colname="purpose" colwidth="1*"/>
<thead>
<row>
<entry>Actor Type</entry>
@@ -143,6 +144,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Subject-Format">
<title>Subject Entities</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="subjtype" colwidth="1*"/>
+ <colspec colnum="2" colname="purpose" colwidth="1*"/>
<thead>
<row>
<entry>Subject Type</entry>
@@ -237,6 +240,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Broker">
<title>Broker Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -391,6 +396,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Management">
<title>Management Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -473,6 +480,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-VirtualHost">
<title>Virtual Host Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -545,6 +554,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Queue">
<title>Queue Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -636,6 +647,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Exchange">
<title>Exchange Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -690,6 +703,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Binding">
<title>Binding Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -723,6 +738,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Connection">
<title>Connection Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -852,6 +869,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Channel">
<title>Channel Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -980,6 +999,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Subscription">
<title>Subscription Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -1037,6 +1058,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-MessageStore">
<title>Message Store Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -1141,6 +1164,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-TransactionStore">
<title>Transaction Store Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -1214,6 +1239,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-ConfigurationStore">
<title>Configuration Store Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -1276,6 +1303,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-HA">
<title>HA Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
@@ -1441,6 +1470,8 @@
<table pgwide="1" xml:id="Java-Broker-Appendix-Operation-Logging-Message-List-Port">
<title>Port Log Messages</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="messageId" colwidth="1*"/>
+ <colspec colnum="2" colname="messageText" colwidth="1*"/>
<thead>
<row>
<entry>Message Id</entry>
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Alerts.xml b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Alerts.xml
index 0fe69e1..c45093f 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Alerts.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Appendix-Queue-Alerts.xml
@@ -28,15 +28,15 @@
<para>For example, if queue <literal>myqueue</literal> is configured with a message count alert of
1000, and then owing to a failure of a downstream system messages begin to accumulate on the
queue, the following alerts will be written periodically to the log. </para>
- <screen>
-INFO [default:VirtualHostHouseKeepingTask] (queue.NotificationCheck) - MESSAGE_COUNT_ALERT
- On Queue myqueue - 1272: Maximum count on queue threshold (1000) breached.
+ <screen>INFO [default:VirtualHostHouseKeepingTask] (queue.NotificationCheck) - MESSAGE_COUNT_ALERT On Queue myqueue - 1272: Maximum count on queue threshold (1000) breached.
</screen>
<para>Note that queue alerts are <emphasis>soft</emphasis> in nature; breaching the limit will
merely cause the alerts to be generated but messages will still be accepted to the queue.</para>
<table pgwide="1" xml:id="Java-Broker-Appendix-Queue-Alerts-Alerting-Messages">
<title>Queue Alerts</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="alertname" colwidth="1*"/>
+ <colspec colnum="2" colname="purpose" colwidth="1*"/>
<thead>
<row>
<entry>Alert Name</entry>
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 a36165a..8a5c179 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
@@ -28,8 +28,8 @@
<table xml:id="Java-Broker-Appendix-Supported-Queue-Declare-Arguments">
<title>Queue declare arguments</title>
<tgroup cols="2">
- <colspec colnum="1" colname="col1"/>
- <colspec colnum="2" colname="col2"/>
+ <colspec colnum="1" colname="argname" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
<spanspec spanname="both" namest="col1" nameend="col2"/>
<thead>
<row>
@@ -79,7 +79,11 @@
<emphasis>Address</emphasis>
based syntax as in the example below:
<screen><![CDATA[
-my-queue; {create: always, node: {x-declare: {arguments:{'qpid.max_count': 10000, 'qpid.max_size': 102400, 'qpid.policy_type: 'ring'}}}}
+my-queue; {create: always, node:
+{x-declare: {arguments:
+{'qpid.max_count': 10000,
+'qpid.max_size': 102400,
+'qpid.policy_type: 'ring'}}}}
]]></screen>
</para>
</entry>
@@ -115,7 +119,10 @@ my-queue; {create: always, node: {x-declare: {arguments:{'qpid.max_count': 10000
<para>The <emphasis>Producer Flow Control</emphasis> can be specified using
<emphasis>Address</emphasis> based syntax as in the example below:
<screen><![CDATA[
-my-queue; {create: always, node: {x-declare: {arguments:{'x-qpid-capacity': 102400, 'x-qpid-flow-resume-capacity': 8192000}}}}
+my-queue; {create: always, node:
+{x-declare: {arguments:
+{'x-qpid-capacity': 102400,
+'x-qpid-flow-resume-capacity': 8192000}}}}
]]></screen>
</para>
</entry>
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 4fecce5..6070e96 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
@@ -55,12 +55,12 @@
<literal>qpid.virtualhost.statisticsReportPattern</literal></para>
<para>The value of the context variable is a free text string containing reference(s) to the statistic names that
are to appear in the report. References are made by surrounding the name of the statistic with '$' and curly braces,
- thus <literal>${<statistic-name>}</literal>.</para>
+ thus <literal>\${<statistic-name>}</literal>.</para>
<para>Statistics references allow an optional formatters. The supported formatters are: <literal>:byteunit</literal>
(produces a human readable byte value e.g. 3 MiB), <literal>:duration</literal> (produces a ISO-8601 duration)and
<literal>:datetime</literal> (produces a ISO-8601 date/time).</para>
<para>For example, a statistic report pattern for the <literal>queue</literal> category specifying two queue
- statistic values: <literal>queueDepthMessages=${queueDepthMessages},queueDepthBytes=${queueDepthBytes:byteunit}</literal></para>
+ statistic values: <literal>queueDepthMessages=\${queueDepthMessages},queueDepthBytes=\${queueDepthBytes:byteunit}</literal></para>
<para>Like all context variables, the statistic report pattern can also reference the attributes of the entity
or even its ancestors. This feature can be exploited to include things like the name of the entity within the
report.</para>
@@ -74,28 +74,33 @@
cURL. This example uses <literal>ancestor</literal> references to include entity names:</para>
<example>
<title>Enabling statistics for a single queue using the REST API and cURL</title>
- <screen><![CDATA[curl --user admin --data '{"name" : "qpid.queue.statisticsReportPattern", "value" : "${ancestor:virtualhost:name}/${ancestor:queue:name}: queueDepthMessages=${queueDepthMessages}, queueDepthBytes=${queueDepthBytes:byteunit}"}' https://localhost:8080/api/latest/queue/default/default/myqueue/setContextVariable]]></screen>
+ <screen><![CDATA[curl --user admin --data '{"name" : "qpid.queue.statisticsReportPattern",
+"value" : "\${ancestor:virtualhost:name}/\${ancestor:queue:name}: queueDepthMessages=\${queueDepthMessages},
+queueDepthBytes=\${queueDepthBytes:byteunit}"}' https://localhost:8080/api/latest/queue/default/default/myqueue/setContextVariable]]></screen>
</example>
<para>
Once enabled, an example statistic report output written to the log might look like this:
- <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>
+ <screen><![CDATA[INFO [virtualhost-default-pool-0] (q.s.Queue)- Statistics: default/myqueue: queueDepthMessages=0, queueDepthBytes=0 B
+ INFO [virtualhost-default-pool-2] (q.s.Queue)- Statistics: default/myqueue: queueDepthMessages=3, queueDepthBytes=345 B
+ INFO [virtualhost-default-pool-2] (q.s.Queue)- Statistics: default/myqueue: queueDepthMessages=3, queueDepthBytes=345 B]]></screen>
</para>
<para>Removing a statistic report pattern from the same queue:</para>
<example>
<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>
+ <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>
<example>
<title>Enabling statistics for all queues using the REST API and cURL</title>
- <screen><![CDATA[curl --user admin --data '{"name" : "qpid.queue.statisticsReportPattern", "value" : "${ancestor:virtualhost:name}/${ancestor:queue:name}: oldestMessageAge=${oldestMessageAge:duration}"}' https://localhost:8080/api/latest/virtualhost/default/default/setContextVariable]]></screen>
+ <screen><![CDATA[curl --user admin --data '{"name" : "qpid.queue.statisticsReportPattern",
+"value" : "\${ancestor:virtualhost:name}/\${ancestor:queue:name}:
+oldestMessageAge=\${oldestMessageAge:duration}"}' https://localhost:8080/api/latest/virtualhost/default/default/setContextVariable]]></screen>
</example>
<para>
Once enabled, an example statistic report for a virtualhost with two queues might look like this:
- <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>
+ <screen><![CDATA[INFO [virtualhost-default-pool-1] (q.s.Queue)- Statistics: default/myqueue1: oldestMessageAge=PT1M24S
+ INFO [virtualhost-default-pool-1] (q.s.Queue)- Statistics: default/myqueue2: oldestMessageAge=PT0S]]></screen>
</para>
</section>
</appendix>
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 9929dbf..3b47e68 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
@@ -29,6 +29,9 @@
<table pgwide="1">
<title>System properties</title>
<tgroup cols="3">
+ <colspec colnum="1" colname="systemproperty" colwidth="1*"/>
+ <colspec colnum="2" colname="default" colwidth="1*"/>
+ <colspec colnum="3" colname="purpose" colwidth="1*"/>
<thead>
<row>
<entry>System property</entry>
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 739a78b..5f708ac 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-High-Availability.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-High-Availability.xml
@@ -76,7 +76,7 @@
<title>3-node group deployed across three Brokers.</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/HA-Overview.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/HA-Overview.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Diagram showing a 3 node group deployed across three Brokers</phrase>
@@ -152,7 +152,7 @@
<title>Creating 1st node in a group</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/HA-Create-1.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/HA-Create-1.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Creating 1st node in a group</phrase>
@@ -195,7 +195,7 @@
<title>Adding subsequent nodes to the group</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/HA-Create-2.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/HA-Create-2.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Adding subsequent nodes to the group</phrase>
@@ -211,7 +211,7 @@
<title>View of group from one node</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/HA-Create-3.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/HA-Create-3.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>View of group from one node</phrase>
diff --git a/doc/java-broker/src/docbkx/Java-Broker-Initial-Configuration.xml b/doc/java-broker/src/docbkx/Java-Broker-Initial-Configuration.xml
index 82ab64a..bd5fd64 100644
--- a/doc/java-broker/src/docbkx/Java-Broker-Initial-Configuration.xml
+++ b/doc/java-broker/src/docbkx/Java-Broker-Initial-Configuration.xml
@@ -193,6 +193,9 @@ $ ./qpid-server -st JDBC \
default values if not otherwise configured by the user: <table>
<title>Base Configuration Properties</title>
<tgroup cols="3">
+ <colspec colnum="1" colname="name" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
+ <colspec colnum="3" colname="value" colwidth="1*"/>
<thead>
<row>
<entry> Name </entry>
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 dd19182..7c4352d 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
@@ -53,7 +53,7 @@
<listitem>
<para>Attributes values can be expressed as a simple value (e.g. <literal>myName</literal>
or <literal>1234</literal>), in terms of context variables
- (e.g.<literal>${foo}</literal> or <literal>/data/${foo}/</literal>).</para>
+ (e.g.<literal>\${foo}</literal> or <literal>/data/\${foo}/</literal>).</para>
</listitem>
<listitem>
<para>Each entity has zero or more context variables.</para>
@@ -66,7 +66,7 @@
</listitem>
<listitem>
<para>When resolving an attribute's value, if the value contains a variable
- (e.g.<literal>${foo}</literal>), the variable is first resolved using the entity's own
+ (e.g.<literal>\${foo}</literal>), the variable is first resolved using the entity's own
context variables. If the entity has no definition for the context variable, the
entity's parent is tried, then its grandparent and so forth, all the way until the
SystemContext is reached.</para>
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 d8e83d8..764361e 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
@@ -78,7 +78,7 @@
<title>Direct exchange</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Exchange-Direct.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Exchange-Direct.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</figure>
@@ -104,7 +104,7 @@
<title>Topic exchange - exact match on topic name</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Exchange-Topic.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Exchange-Topic.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</figure>
@@ -115,7 +115,7 @@
<title>Topic exchange - matching on hierarchical topic patterns</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Exchange-Topic-Hierarchical.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Exchange-Topic-Hierarchical.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</figure>
@@ -131,7 +131,7 @@
<title>Topic exchange - matching on JMS message selector</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Exchange-Topic-JMSSelector.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Exchange-Topic-JMSSelector.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</figure>
@@ -155,7 +155,7 @@
<title>Fanout exchange</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Exchange-Fanout.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Exchange-Fanout.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
</mediaobject>
</figure>
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 3ebf2fe..714de6c 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
@@ -69,7 +69,7 @@
<title>Message Flow through Key Entities</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Broker-MessageFlow.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Broker-MessageFlow.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Message Flow through the Key Entities of the Broker</phrase>
@@ -82,7 +82,7 @@
<title>Broker Structure showing major entities</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Broker-Model.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Broker-Model.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Broker Structure</phrase>
diff --git a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Ports.xml b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Ports.xml
index cd8e72b..4bf7356 100644
--- a/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Ports.xml
+++ b/doc/java-broker/src/docbkx/concepts/Java-Broker-Concepts-Ports.xml
@@ -49,7 +49,7 @@
<title>Control flow during Authentication</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Broker-PortAuthFlow.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Broker-PortAuthFlow.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Control flow during Authentication</phrase>
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 0f4b435..1654270 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
@@ -233,6 +233,8 @@
<table>
<title>Setting the replay period using a Qpid JMS AMQP 0-x address</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="syntax" colwidth="1*"/>
+ <colspec colnum="2" colname="example" colwidth="1*"/>
<thead>
<row>
<entry>Syntax</entry>
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 410329d..c9c198b 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
@@ -49,7 +49,7 @@
<title>Virtualhost Model showing major entities</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/VirtualHost-Model.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/VirtualHost-Model.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Virtual Host Model</phrase>
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 834470f..3e5cbdb 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
@@ -211,6 +211,8 @@
<table>
<title>HTTP status codes returned by REST interfaces</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="statuscode" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
<thead>
<row>
<entry>Status code</entry>
diff --git a/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-Query-API.xml b/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-Query-API.xml
index 466e40f..a660ec7d 100644
--- a/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-Query-API.xml
+++ b/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-REST-Query-API.xml
@@ -51,6 +51,8 @@
<table>
<title>Query API URLs</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="queryurl" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
<thead>
<row>
<entry>Query API URL</entry>
@@ -86,6 +88,8 @@
<table>
<title>Query API request parameters</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="paramname" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
<thead>
<row>
<entry>Parameter Name</entry>
@@ -217,6 +221,8 @@
<table>
<title>Query API functions</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="functionname" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
<thead>
<row>
<entry>Function Name</entry>
diff --git a/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-Web-Console.xml b/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-Web-Console.xml
index 6091d51..59a7a9d 100644
--- a/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-Web-Console.xml
+++ b/doc/java-broker/src/docbkx/management/channels/Java-Broker-Management-Channel-Web-Console.xml
@@ -54,7 +54,7 @@
<title>Web Management Console - Authentication</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-Auth.png" format="PNG" scalefit="1" width="900px"/>
+ <imagedata fileref="images/Management-Web-Auth.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Web Console Authentication</phrase>
@@ -70,7 +70,7 @@
<title>Web Management Orientation - Console</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-Console.png" format="PNG" scalefit="1" width="900px"/>
+ <imagedata fileref="images/Management-Web-Console.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>The Web Console</phrase>
@@ -109,7 +109,7 @@
<title>Web Management Orientation - Tab</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-Tab.png" format="PNG" scalefit="1" width="900px"/>
+ <imagedata fileref="images/Management-Web-Tab.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>A tab within the Web Consle</phrase>
@@ -154,7 +154,7 @@
<title>Web Management Orientation - Add Dialogue</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-Add-Dialogue.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Management-Web-Add-Dialogue.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Example add dialogue showing field level help</phrase>
@@ -174,7 +174,7 @@
<title>Web Management Orientation - Edit Dialogue</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-Edit-Dialogue.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Management-Web-Edit-Dialogue.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Example edit dialogue</phrase>
@@ -200,7 +200,7 @@
<title>Web Management Orientation - Context Variables</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-ContextVar.png" format="PNG" scalefit="1"/>
+ <imagedata fileref="images/Management-Web-ContextVar.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Editing Context Variables</phrase>
diff --git a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Consumers.xml b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Consumers.xml
index 28b0935..ed27bab 100644
--- a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Consumers.xml
+++ b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Consumers.xml
@@ -67,6 +67,8 @@
<table>
<title>Setting the consumer priority</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="syntax" colwidth="1*"/>
+ <colspec colnum="2" colname="example" colwidth="1*"/>
<thead>
<row>
<entry>Syntax</entry>
diff --git a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml
index d1f93da..a26841c 100644
--- a/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml
+++ b/doc/java-broker/src/docbkx/runtime/Java-Broker-Runtime-Log-Files.xml
@@ -216,7 +216,7 @@
<title>Viewing a file logger</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-Logging-FileLogger.png" format="PNG" scalefit="1" width="900px"/>
+ <imagedata fileref="images/Management-Web-Logging-FileLogger.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Viewing a file logger</phrase>
@@ -228,7 +228,7 @@
<title>Editing an inclusion rule</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-Logging-InclusionRule.png" format="PNG" scalefit="1" width="900px"/>
+ <imagedata fileref="images/Management-Web-Logging-InclusionRule.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Editing an inclusion rule</phrase>
@@ -241,7 +241,7 @@
<title>Viewing a memory logger</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/Management-Web-Logging-MemoryLogger.png" format="PNG" scalefit="1" width="900px"/>
+ <imagedata fileref="images/Management-Web-Logging-MemoryLogger.png" format="PNG" scalefit="1" width="100%" contentdepth="100%"/>
</imageobject>
<textobject>
<phrase>Viewing a memory logger</phrase>
diff --git a/doc/java-broker/src/docbkx/security/Java-Broker-Security-AccessControlProviders.xml b/doc/java-broker/src/docbkx/security/Java-Broker-Security-AccessControlProviders.xml
index 0fecf48..c5b44b4 100644
--- a/doc/java-broker/src/docbkx/security/Java-Broker-Security-AccessControlProviders.xml
+++ b/doc/java-broker/src/docbkx/security/Java-Broker-Security-AccessControlProviders.xml
@@ -146,6 +146,8 @@
<table xml:id="table-Java-Broker-Security-AccessControlProviders-Syntax_permissions">
<title>List of ACL permission</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="command" colwidth="1*"/>
+ <colspec colnum="2" colname="action" colwidth="1*"/>
<tbody>
<row>
<entry><command>ALLOW</command></entry>
@@ -169,6 +171,10 @@
<table xml:id="table-Java-Broker-Security-AccessControlProviders-Syntax_actions">
<title>List of ACL actions</title>
<tgroup cols="4">
+ <colspec colnum="1" colname="action" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
+ <colspec colnum="3" colname="supportedtypes" colwidth="1*"/>
+ <colspec colnum="4" colname="supportedproperties" colwidth="1*"/>
<thead>
<row>
<entry><para>Action</para></entry>
@@ -261,7 +267,12 @@
</table>
<table xml:id="table-Java-Broker-Security-AccessControlProviders-Syntax_objects">
<title>List of ACL objects</title>
- <tgroup cols="4">
+ <tgroup cols="5">
+ <colspec colnum="1" colname="objecttype" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
+ <colspec colnum="3" colname="supportedactions" colwidth="1*"/>
+ <colspec colnum="4" colname="supportedproperties" colwidth="1*"/>
+ <colspec colnum="5" colname="allowedVHAcls" colwidth="1*"/>
<thead>
<row>
<entry><para>Object type</para></entry>
@@ -327,6 +338,8 @@
<table xml:id="table-Java-Broker-Security-AccessControlProviders-Syntax_properties">
<title>List of ACL properties</title>
<tgroup cols="2">
+ <colspec colnum="1" colname="name" colwidth="1*"/>
+ <colspec colnum="2" colname="description" colwidth="1*"/>
<tbody>
<row>
<entry><command>name</command> </entry>
diff --git a/doc/pom.xml b/doc/pom.xml
index 2c75db0..c5df9bc 100644
--- a/doc/pom.xml
+++ b/doc/pom.xml
@@ -110,10 +110,11 @@
<artifactId>docbkx-maven-plugin</artifactId>
<executions>
<execution>
- <id>docbook-html</id>
+ <id>docbook-generation</id>
<phase>compile</phase>
<goals>
<goal>generate-xhtml</goal>
+ <goal>generate-pdf</goal>
</goals>
</execution>
</executions>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org