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 2016/01/25 17:02:11 UTC
svn commit: r1726649 [4/6] - in /qpid/java/branches/6.0.x: ./ doc/book/src/
doc/book/src/java-broker/ doc/book/src/java-broker/concepts/
doc/book/src/java-broker/management/channels/
doc/book/src/java-broker/management/managing/ doc/book/src/java-broke...
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,18 +20,17 @@
-->
-<section id="Java-Broker-Management-Managing-Virtualhosts">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Management-Managing-Virtualhosts">
<title>VirtualHosts</title>
<para>A virtualhost is a independent namespace in which messaging is performed. Virtualhosts are
responsible for the storage of message data.</para>
<para>Virtualhosts can only be managed by the HTTP management channel.</para>
- <section id="Java-Broker-Management-Managing-Virtualhosts-Types">
+ <section xml:id="Java-Broker-Management-Managing-Virtualhosts-Types">
<title>Types</title>
<para>The following virtualhost types are supported. <itemizedlist>
<listitem>
<para>BDB - Virtualhost backed with Oracle BDB <footnote>
- <para>Oracle BDB JE is optional. See <xref
- linkend="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE"/>.</para>
+ <para>Oracle BDB JE is optional. See <xref linkend="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE"/>.</para>
</footnote></para>
</listitem>
<listitem>
@@ -42,8 +41,7 @@
</listitem>
<listitem>
<para>JDBC - Virtualhost backed with an external database <footnote>
- <para>JDBC 4.0 compatible drivers must be available. See <xref
- linkend="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver"/></para>
+ <para>JDBC 4.0 compatible drivers must be available. See <xref linkend="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver"/></para>
</footnote></para>
</listitem>
<listitem>
@@ -58,19 +56,18 @@
</itemizedlist>
</para>
</section>
- <section id="Java-Broker-Management-Managing-Virtualhost-Context">
+ <section xml:id="Java-Broker-Management-Managing-Virtualhost-Context">
<title>Context</title>
<para>
<itemizedlist>
<listitem>
- <para><emphasis>use_async_message_store_recovery</emphasis> Controls the <link
- linkend="Java-Broker-Runtime-Background-Recovery">background recovery</link>
+ <para><emphasis>use_async_message_store_recovery</emphasis> Controls the <link linkend="Java-Broker-Runtime-Background-Recovery">background recovery</link>
feature.</para>
</listitem>
</itemizedlist>
</para>
</section>
- <section id="Java-Broker-Management-Managing-Virtualhost-Attributes">
+ <section xml:id="Java-Broker-Management-Managing-Virtualhost-Attributes">
<title>Attributes</title>
<para>
<itemizedlist>
@@ -85,8 +82,7 @@
<listitem>
<para><emphasis>Store overflow/underflow</emphasis>. Some virtualhosts have the ability to
limit the of the cumulative size of all the messages contained within the store. This
- feature is described in detail <xref linkend="Java-Broker-Runtime-Disk-Space-Management"
- />.</para>
+ feature is described in detail <xref linkend="Java-Broker-Runtime-Disk-Space-Management"/>.</para>
</listitem>
<listitem>
<para><emphasis>Connection thread pool size</emphasis>. Number of worker threads
@@ -101,17 +97,15 @@
</listitem>
<listitem>
<para><emphasis>Store transaction timeouts</emphasis>. Warns of long running producer
- transactions. See <xref linkend="Java-Broker-Runtime-Producer-Transaction-Timeout"
- /></para>
+ transactions. See <xref linkend="Java-Broker-Runtime-Producer-Transaction-Timeout"/></para>
</listitem>
<listitem>
- <para><emphasis>Synchronization policy</emphasis>. HA only. See <xref
- linkend="Java-Broker-High-Availability-Behaviour-SynchronizationPolicy"/></para>
+ <para><emphasis>Synchronization policy</emphasis>. HA only. See <xref linkend="Java-Broker-High-Availability-Behaviour-SynchronizationPolicy"/></para>
</listitem>
</itemizedlist>
</para>
</section>
- <section id="Java-Broker-Management-Managing-Virtualhost-Children">
+ <section xml:id="Java-Broker-Management-Managing-Virtualhost-Children">
<title>Children</title>
<para>
<itemizedlist>
@@ -128,7 +122,7 @@
</itemizedlist>
</para>
</section>
- <section id="Java-Broker-Management-Managing-Virtualhost-Lifecycle">
+ <section xml:id="Java-Broker-Management-Managing-Virtualhost-Lifecycle">
<title>Lifecycle</title>
<para>
<itemizedlist>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Background-Recovery.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Background-Recovery.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Background-Recovery.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Background-Recovery.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,7 +20,7 @@
-->
-<section id="Java-Broker-Runtime-Background-Recovery">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Background-Recovery">
<title>Background Recovery</title>
<para>On startup of the Broker, or restart of a Virtualhost, the Broker restores all durable
queues and their messages from disk. In the Broker's default mode the Virtualhosts do not become
@@ -34,15 +34,12 @@
still to be recovered from disk. There is an exception for the out of order queue types whilst
background recovery is in flight. For instance, with priority queues older lower priority
messages may be delivered before newer, higher priority.</para>
- <para>To activate the feature, set a <link
- linkend="Java-Broker-Management-Managing-Entities-General">context variable</link>
+ <para>To activate the feature, set a <link linkend="Java-Broker-Management-Managing-Entities-General">context variable</link>
<literal>use_async_message_store_recovery</literal> at the desired Virtualhost, or at Broker or
higher to enable the feature broker-wide.</para>
<note>
<para>The background recovery feature does not write operational log messages to indicate its
- progress. This means messages <link
- linkend="Java-Broker-Appendix-Operation-Logging-Message-MST-1004">MST-1004</link> and <link
- linkend="Java-Broker-Appendix-Operation-Logging-Message-MST-1005">MST-1005</link> will not
+ progress. This means messages <link linkend="Java-Broker-Appendix-Operation-Logging-Message-MST-1004">MST-1004</link> and <link linkend="Java-Broker-Appendix-Operation-Logging-Message-MST-1005">MST-1005</link> will not
be seen.</para>
</note>
</section>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Close-On-No-Route.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Close-On-No-Route.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Close-On-No-Route.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Close-On-No-Route.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -19,10 +19,11 @@
under the License.
-->
-<section id="Java-Broker-Runtime-Close-Connection-When-No-Route">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Close-Connection-When-No-Route">
<title>Closing client connections on unroutable mandatory messages</title>
- <section id="Java-Broker-Runtime-Close-Connection-When-No-Route-Summary">
+ <section xml:id="Java-Broker-Runtime-Close-Connection-When-No-Route-Summary">
<title>Summary</title>
<para>
Due to asynchronous nature of AMQP 0-8/0-9/0-9-1 protocols sending a message with a routing key for which no queue binding exist results
@@ -51,7 +52,7 @@
</para>
</note>
</section>
- <section id="Java-Broker-Runtime-Close-Connection-When-No-Route-Configuration">
+ <section xml:id="Java-Broker-Runtime-Close-Connection-When-No-Route-Configuration">
<title>Configuring <emphasis>closeWhenNoRoute</emphasis></title>
<para>
The Broker attribute <emphasis>closeWhenNoRoute</emphasis> can be set to specify this feature on broker side.
@@ -63,8 +64,8 @@
</para>
<example>
<title>Disable feature to close connection on unroutable messages with client URL</title>
- <screen><![CDATA[
-amqp://guest:guest@clientid/?brokerlist='tcp://localhost:5672'&closeWhenNoRoute='false']]></screen>
+ <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
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Connection-Limit.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Connection-Limit.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Connection-Limit.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Connection-Limit.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,7 +20,7 @@
-->
-<section id="Java-Broker-Runtime-Connection-Limit">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Connection-Limit">
<title>Connection Limits</title>
<para>
Each connection to the Broker consumes resources while it is connected. In order to protect
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,10 +20,10 @@
-->
-<section id="Qpid-Producer-Flow-Control">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Qpid-Producer-Flow-Control">
<title>Producer Flow Control</title>
- <section role="h2" id="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control-GeneralInformation">
+ <section role="h2" xml:id="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control-GeneralInformation">
<title>General Information</title>
<para>
The Java Broker supports a flow control mechanism to which can be used to prevent either a single queue
@@ -31,7 +31,7 @@
next.
</para>
</section>
- <section role="h2" id="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control-ServerConfiguration">
+ <section role="h2" xml:id="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control-ServerConfiguration">
<title>Server Configuration</title>
<section role="h3">
<title>Configuring a Queue to use flow control</title>
@@ -111,8 +111,7 @@ MESSAGE [con:2(guest@anonymous(713889609
<para>
The Broker will also impose flow control if the filesystem hosting a virtualhost
- exceeds a <link
- linkend="Java-Broker-Management-Managing-Broker-Context-StoreFilesystemMaxUsagePercent">
+ exceeds a <link linkend="Java-Broker-Management-Managing-Broker-Context-StoreFilesystemMaxUsagePercent">
configured percentage.</link>.
</para>
@@ -135,7 +134,7 @@ MESSAGE [con:2(guest@anonymous(713889609
</section><!-- Server configuration -->
- <section role="h2" id="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control-ClientImpact">
+ <section role="h2" xml:id="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control-ClientImpact">
<title>Client impact and configuration</title>
<para>
If a producer sends to a queue which is overfull, the broker will respond by
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,7 +20,7 @@
-->
-<section id="Java-Broker-Runtime-Disk-Space-Management">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Disk-Space-Management">
<title>Disk Space Management</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml"/>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Flow-To-Disk.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Flow-To-Disk.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Flow-To-Disk.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Flow-To-Disk.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,7 +20,7 @@
-->
-<section id="Java-Broker-Runtime-Flow-To-Disk">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Flow-To-Disk">
<title>Flow to Disk</title>
<para>Flow to disk limits the amount of <link linkend="Java-Broker-Runtime-Memory">direct and heap memory</link>
that can be occupied by messages. Once this
@@ -39,9 +39,7 @@
<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
+ <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>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml Mon Jan 25 16:02:09 2016
@@ -1,8 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE entities [
-<!ENTITY % entities SYSTEM "../commonEntities.xml">
-%entities;
-]>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -24,10 +20,10 @@
-->
-<section id="Java-Broker-Runtime-Handling-Undeliverable-Messages">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Handling-Undeliverable-Messages">
<title>Handing Undeliverable Messages</title>
- <section role="h2" id="Java-Broker-Runtime-Handling-Undeliverable-Messages-Introduction">
+ <section role="h2" xml:id="Java-Broker-Runtime-Handling-Undeliverable-Messages-Introduction">
<title>Introduction</title>
<para> Messages that cannot be delivered successfully to a consumer (for instance, because the
client is using a transacted session and rolls-back the transaction) can be made available on
@@ -48,15 +44,13 @@
described in the following sections.</para>
</section>
- <section role="h2" id="Java-Broker-Runtime-Handling-Undeliverable-Messages-Maximum-Delivery-Count">
+ <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
- <emphasis>must</emphasis> call <ulink url="&oracleJeeDocUrl;javax/jms/Session.html#rollback()"
- >Session#rollback()</ulink> (or <ulink url="&oracleJeeDocUrl;javax/jms/Session.html#recover()"
- >Session#recover()</ulink> if the session is not transacted). It is during the Broker's
+ <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>
@@ -74,7 +68,7 @@
queue declare property <property>x-qpid-maximum-delivery-count</property></para>
</section>
- <section role="h2" id="Java-Broker-Runtime-Handling-Undeliverable-Messages-Dead-Letter-Queues">
+ <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
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Log-Files.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Log-Files.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Log-Files.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Log-Files.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,7 +20,7 @@
-->
-<section id="Java-Broker-Runtime-Logging">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Logging">
<title>Logging</title>
<para>This section describes the flexible logging capabilities of the Java Broker.</para>
<para>
@@ -50,7 +50,7 @@
the logging subsystem. Next, you find a description of the default configuration. The section
then concludes with a in-depth description of the loggers themselves and how they may be
configured.</para>
- <section id="Java-Broker-Runtime-Logging-Concepts">
+ <section xml:id="Java-Broker-Runtime-Logging-Concepts">
<title>Concepts</title>
<para>The logging subsystem uses two concepts:</para>
@@ -78,7 +78,7 @@
</itemizedlist>
</para>
</section>
- <section id="Java-Broker-Runtime-Logging-Default-Configuration">
+ <section xml:id="Java-Broker-Runtime-Logging-Default-Configuration">
<title>Default Configuration</title>
<para>The default configuration is designed to be suitable for use without change in small
production environments. It has the following characteristics:</para>
@@ -89,8 +89,7 @@
rolled automatically when the file reaches 100MB. A maximum history of one file is
retained. On restart the the log will be appended to.</para>
<para>The log contains: <itemizedlist>
- <listitem><para>All operational logging events. See <xref
- linkend="Java-Broker-Appendix-Operation-Logging"/>.</para></listitem>
+ <listitem><para>All operational logging events. See <xref linkend="Java-Broker-Appendix-Operation-Logging"/>.</para></listitem>
<listitem><para>Log events from Qpid itself deemed informational or
higher.</para></listitem>
<listitem><para>Log events from Qpid's dependencies (such as Derby or Jetty) that are
@@ -112,7 +111,7 @@
investigation is in progress and revert the setting later, all without the need to restart the
Broker.</para>
</section>
- <section id="Java-Broker-Runtime-Logging-Loggers">
+ <section xml:id="Java-Broker-Runtime-Logging-Loggers">
<title>Loggers</title>
<para>Loggers are responsible for the writing of a log. The log includes log events that match a
Logger's inclusion rules.</para>
@@ -124,11 +123,10 @@
<para>Loggers can be added or removed at runtime, without restarting the Broker. However changes
to a Logger's configuration such as filenames and rolling options don't take effect until the
next restart. Changes to a Logger's inclusion rules take effect immediately.</para>
- <para>All loggers allow the log event layout to be customised. Loggers understand <ulink
- url="http://logback.qos.ch/manual/layouts.html#ClassicPatternLayout"> Logback Classic
- Pattern Layouts</ulink>. </para>
+ <para>All loggers allow the log event layout to be customised. Loggers understand <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://logback.qos.ch/manual/layouts.html#ClassicPatternLayout"> Logback Classic
+ Pattern Layouts</link>. </para>
<para>The following sections describes each Logger implementation in detail.</para>
- <section id="Java-Broker-Runtime-Logging-Loggers-FileLogger">
+ <section xml:id="Java-Broker-Runtime-Logging-Loggers-FileLogger">
<title>FileLogger</title>
<para>A <emphasis>FileLogger</emphasis> - writes a log file to the filesystem. The name and
location of the log file, the rolling configuration, and compression options can be
@@ -149,12 +147,12 @@
Broker is restarted. If not ticked, the Broker will append to the existing log file until it
needs to be rolled.</para>
</section>
- <section id="Java-Broker-Runtime-Logging-Loggers-ConsoleLogger">
+ <section xml:id="Java-Broker-Runtime-Logging-Loggers-ConsoleLogger">
<title>ConsoleLogger</title>
<para><emphasis>ConsoleLogger</emphasis> - writes a log file standard out or standard
error.</para>
</section>
- <section id="Java-Broker-Runtime-Logging-Loggers-SyslogLogger">
+ <section xml:id="Java-Broker-Runtime-Logging-Loggers-SyslogLogger">
<title>SyslogLogger</title>
<para><emphasis>SyslogLogger</emphasis> - writes a log file to a syslog daemon using the
<literal>USER</literal> facility. The hostname and port number of the syslog daemon can be
@@ -164,15 +162,14 @@
distinguish the logging generated by this Qpid instance, from other Qpid instances, or other
applications using the <literal>USER</literal>.</para>
</section>
- <section id="Java-Broker-Runtime-Logging-Loggers-MemoryLogger">
+ <section xml:id="Java-Broker-Runtime-Logging-Loggers-MemoryLogger">
<title>MemoryLogger</title>
<para><emphasis>MemoryLogger</emphasis> - writes a log file to a circular in-memory buffer. By
default the circular buffer holds the last 4096 log events. The contents of the buffer can
- be viewed via Management. See <xref
- linkend="Java-Broker-Runtime-Logging-Management-MemoryLogger"/></para>
+ be viewed via Management. See <xref linkend="Java-Broker-Runtime-Logging-Management-MemoryLogger"/></para>
</section>
</section>
- <section id="Java-Broker-Runtime-Logging-InclusionRules">
+ <section xml:id="Java-Broker-Runtime-Logging-InclusionRules">
<title>Inclusion Rules</title>
<para>A <emphasis>Logger</emphasis> has one or more <emphasis>inclusion rules</emphasis>. These
govern what appears in the log. A Logger with no inclusion rules will log nothing.</para>
@@ -200,7 +197,7 @@
</itemizedlist>
</para>
</section>
- <section id="Java-Broker-Runtime-Logging-Management">
+ <section xml:id="Java-Broker-Runtime-Logging-Management">
<title>Logging Management</title>
<para>The logging subsystem can be completely managed from the Web Management Console or the
REST API. You can: <itemizedlist>
@@ -215,12 +212,11 @@
<para> The figure that follows shows a FileLogger. The attributes area shows the configuration
of the Logger. The inclusion rule table shows the rules that are associated with the Logger.
The area towards the bottom of the tab allows the log files to be downloaded to the browser.
- <figure id="Java-Broker-Runtime-Logging-Management-FileLogger">
+ <figure xml:id="Java-Broker-Runtime-Logging-Management-FileLogger">
<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="900px"/>
</imageobject>
<textobject>
<phrase>Viewing a file logger</phrase>
@@ -228,13 +224,11 @@
</mediaobject>
</figure>
</para>
- <para> The figure below shows the editing of the level of an inclusion rule. <figure
- id="Java-Broker-Runtime-Logging-Management-InclusionRule">
+ <para> The figure below shows the editing of the level of an inclusion rule. <figure xml:id="Java-Broker-Runtime-Logging-Management-InclusionRule">
<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="900px"/>
</imageobject>
<textobject>
<phrase>Editing an inclusion rule</phrase>
@@ -243,13 +237,11 @@
</figure>
</para>
<para> The figure below shows a Memory Logger. Note that the Memory Logger provides access to
- the cached message via the viewer towards the bottom on the tab. <figure
- id="Java-Broker-Runtime-Logging-Management-MemoryLogger">
+ the cached message via the viewer towards the bottom on the tab. <figure xml:id="Java-Broker-Runtime-Logging-Management-MemoryLogger">
<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="900px"/>
</imageobject>
<textobject>
<phrase>Viewing a memory logger</phrase>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Memory.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Memory.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Memory.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Memory.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,9 +20,9 @@
-->
-<section id="Java-Broker-Runtime-Memory">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Memory">
<title>Memory</title>
- <section id="Java-Broker-Runtime-Memory-Introduction">
+ <section xml:id="Java-Broker-Runtime-Memory-Introduction">
<title>Introduction</title>
<para>
Understanding how the Qpid broker uses memory is essential to running a high performing and reliable service.
@@ -38,7 +38,7 @@
Finally, <xref linkend="Java-Broker-Runtime-Memory-Tuning"/> gives some advice on tuning your broker.
</para>
</section>
- <section id="Java-Broker-Runtime-Memory-Types">
+ <section xml:id="Java-Broker-Runtime-Memory-Types">
<title>Types of Memory</title>
<para>
While Java has a couple of different internal memory types we will focus on the two types that are relevant to the Qpid broker.
@@ -66,12 +66,12 @@
</para>
</section>
</section>
- <section id="Java-Broker-Runtime-Memory-Usage">
+ <section xml:id="Java-Broker-Runtime-Memory-Usage">
<title>Memory Usage in the Broker</title>
<para>
This section lists some note worthy users of memory within the broker and where possible lists their usage of heap and direct memory.
Note that to ensure smooth performance some heap memory should remain unused by the application and be reserved for the JVM to do house keeping and garbage collection.
- <ulink url="https://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/util/DbCacheSize.html">Some guides</ulink> advise to reserve up to 30% of heap memory for the JVM.
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="https://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/util/DbCacheSize.html">Some guides</link> advise to reserve up to 30% of heap memory for the JVM.
</para>
<section>
<title>Broker</title>
@@ -105,7 +105,7 @@
After being flown to disk messages need to be re-read from disk before delivery.
</para>
</section>
- <section id="Java-Broker-Runtime-Memory-Usage-BDB">
+ <section xml:id="Java-Broker-Runtime-Memory-Usage-BDB">
<title>Message Store</title>
<section>
<title>Berkeley DB (BDB)</title>
@@ -114,8 +114,8 @@
BDB uses a mandatory cache for navigating and organising its database structure.
Sizing and tuning this cache is a topic of its own and would go beyond the scope of this guide.
Suffice to say that by default Qpid uses 5% of heap memory for BDB caches (each Virtual Host uses a separate cache) or 10 MB per BDB store, whichever is greater.
- See the <ulink url="http://www.oracle.com/us/products/database/berkeley-db/je">official webpage</ulink> especially <ulink url="http://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/util/DbCacheSize.html">this page</ulink> for more information.
- For those interested, Qpid uses <ulink url="http://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/CacheMode.html#EVICT_LN">EVICT_LN</ulink> as its default JE cacheMode.
+ See the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.oracle.com/us/products/database/berkeley-db/je">official webpage</link> especially <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/util/DbCacheSize.html">this page</link> for more information.
+ For those interested, Qpid uses <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://docs.oracle.com/cd/E17277_02/html/java/com/sleepycat/je/CacheMode.html#EVICT_LN">EVICT_LN</link> as its default JE cacheMode.
</para>
<para>
Note that due to licensing concerns Qpid does not ship the BDB JE jar files.
@@ -136,9 +136,9 @@
</para>
</section>
</section>
- <section id="Java-Broker-Runtime-Memory-Low-Memory">
+ <section xml:id="Java-Broker-Runtime-Memory-Low-Memory">
<title>Low Memory Conditions</title>
- <section id="Java-Broker-Runtime-Memory-Low-Memory-Heap">
+ <section xml:id="Java-Broker-Runtime-Memory-Low-Memory-Heap">
<title>Low on Heap Memory</title>
<para>
When the broker runs low on heap memory performance will degrade because the JVM will trigger full garbage collection (GC) events in a struggle to free memory.
@@ -147,7 +147,7 @@
Should the heap memory demands rise even further the JVM will eventually throw an OutOfMemoryError which will cause the broker to shut down.
</para>
</section>
- <section id="Java-Broker-Runtime-Memory-Low-Memory-Direct">
+ <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.
@@ -155,7 +155,7 @@
</para>
</section>
</section>
- <section id="Java-Broker-Runtime-Memory-Defaults">
+ <section xml:id="Java-Broker-Runtime-Memory-Defaults">
<title>Defaults</title>
<para>
By default Qpid uses these settiongs:
@@ -177,7 +177,7 @@
This means a total of 250 concurrent sessions and a total of 250000 messages without flowing messages to disk.
</para>
</section>
- <section id="Java-Broker-Runtime-Memory-Tuning">
+ <section xml:id="Java-Broker-Runtime-Memory-Tuning">
<title>Memory Tuning the Broker</title>
<section>
<title>Java Tuning</title>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Message-Compression.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Message-Compression.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Message-Compression.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Message-Compression.xml Mon Jan 25 16:02:09 2016
@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -20,7 +20,7 @@
-->
-<section id="Java-Broker-Runtime-Message-Compression">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Message-Compression">
<title>Message Compression</title>
<para>The Java Broker supports<footnote><para>Message compression is not yet supported for the 1.0
protocol.</para></footnote> message compression. This feature works in co-operation with Qpid
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml Mon Jan 25 16:02:09 2016
@@ -1,8 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE entities [
-<!ENTITY % entities SYSTEM "../commonEntities.xml">
-%entities;
-]>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -24,14 +20,13 @@
-->
-<section id="Java-Broker-Runtime-Producer-Transaction-Timeout">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout">
<title>Producer Transaction Timeout</title>
- <section role="h2" id="Java-Broker-Runtime-Producer-Transaction-Timeout-GeneralInformation">
+ <section role="h2" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-GeneralInformation">
<title>General Information</title>
<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 <ulink
- url="&oracleJeeDocUrl;javax/jms/Session.html#commit">Session#commit()</ulink>.</para>
+ 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>
<para>Users can choose to configure an idleWarn or openWarn threshold, after which the identified
transaction should be logged as a WARN level alert as well as (more importantly) an idleClose or
openClose threshold after which the transaction and the connection it applies to will be
@@ -41,7 +36,7 @@
deployment.</para>
<para>The following section provide more details on this feature and its use.</para>
</section>
- <section role="h2" id="Java-Broker-Runtime-Producer-Transaction-Timeout-Purpose">
+ <section role="h2" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-Purpose">
<title>Purpose</title>
<para> This feature has been introduced to address the scenario where an open transaction on the
broker holds an open transaction on the persistent store. This can have undesirable consequences
@@ -49,59 +44,57 @@
result in a rapid increase in disk usage size, bounded only by available space, due to growth of
the transaction log. </para>
</section>
- <section role="h2" id="Java-Broker-Runtime-Producer-Transaction-Timeout-Scope">
+ <section role="h2" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-Scope">
<title>Scope</title>
- <para>Note that only <ulink url="&oracleJeeDocUrl;javax/jms/MessageProducer.html"
- >MessageProducer</ulink> clients will be affected by a transaction timeout, since store
+ <para>Note that only <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&oracleJeeDocUrl;javax/jms/MessageProducer.html">MessageProducer</link> clients will be affected by a transaction timeout, since store
transaction lifespan on a consumer only spans the execution of the call to Session#commit() and
there is no scope for a long-lived transaction to arise.</para>
<para>It is also important to note that the transaction timeout mechanism is purely a JMS
transaction timeout, and unrelated to any other timeouts in the Qpid client library and will have
no impact on any RDBMS your application may utilise.</para>
</section>
- <section role="h2" id="Java-Broker-Runtime-Producer-Transaction-Timeout-Effect">
+ <section role="h2" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-Effect">
<title>Effect</title>
<para>Full details of configuration options are provided in the sections that follow. This section
gives a brief overview of what the Transaction Timeout feature can do.</para>
- <section role="h3" id="Java-Broker-Runtime-Producer-Transaction-Timeout-Effect-Broker-Side">
+ <section role="h3" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-Effect-Broker-Side">
<title>Broker Logging and Connection Close</title>
<para>When the openWarn or idleWarn specified threshold is exceeded, the broker will log a WARN
level alert with details of the connection and channel on which the threshold has been exceeded,
along with the age of the transaction.</para>
<para>When the openClose or idleClose specified threshold value is exceeded, the broker will
- throw an exception back to the client connection via the <ulink
- url="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">ExceptionListener</ulink>, log the
+ throw an exception back to the client connection via the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">ExceptionListener</link>, log the
action and then close the connection.</para>
<para>The example broker log output shown below is where the idleWarn threshold specified is
lower than the idleClose threshold and the broker therefore logs the idle transaction 3 times
before the close threshold is triggered and the connection closed out.</para>
- <screen><![CDATA[CHN-1008 : Idle Transaction : 13,116 ms
+ <screen>CHN-1008 : Idle Transaction : 13,116 ms
CHN-1008 : Idle Transaction : 14,116 ms
CHN-1008 : Idle Transaction : 15,118 ms
-CHN-1003 : Close]]>
+CHN-1003 : Close
</screen>
<para>The second example broker log output shown below illustrates the same mechanism operating
on an open transaction.</para>
- <screen><![CDATA[
+ <screen>
CHN-1007 : Open Transaction : 12,406 ms
CHN-1007 : Open Transaction : 13,406 ms
CHN-1007 : Open Transaction : 14,406 ms
-CHN-1003 : Close]]>
+CHN-1003 : Close
</screen>
</section>
- <section role="h3" id="Java-Broker-Runtime-Producer-Transaction-Timeout-Effect-Client-Side">
+ <section role="h3" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-Effect-Client-Side">
<title>Client Side Effect</title>
<para>After a Close threshold has been exceeded, the trigger client will receive this exception
- on its <ulink url="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">exception
- listener</ulink>, prior to being disconnected:</para>
+ on its <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&oracleJeeDocUrl;javax/jms/ExceptionListener.html">exception
+ listener</link>, prior to being disconnected:</para>
<computeroutput>org.apache.qpid.AMQConnectionClosedException: Error: Idle transaction timed out
[error code 506: resource error]</computeroutput>
<para>Any later attempt to use the connection will result in this exception being thrown:</para>
- <screen><![CDATA[Producer: Caught an Exception: javax.jms.IllegalStateException: Object org.apache.qpid.client.AMQSession_0_8@129b0e1 has been closed
+ <screen>Producer: Caught an Exception: javax.jms.IllegalStateException: Object org.apache.qpid.client.AMQSession_0_8@129b0e1 has been closed
javax.jms.IllegalStateException: Object org.apache.qpid.client.AMQSession_0_8@129b0e1 has been closed
at org.apache.qpid.client.Closeable.checkNotClosed(Closeable.java:70)
at org.apache.qpid.client.AMQSession.checkNotClosed(AMQSession.java:555)
- at org.apache.qpid.client.AMQSession.createBytesMessage(AMQSession.java:573)]]>
+ at org.apache.qpid.client.AMQSession.createBytesMessage(AMQSession.java:573)
</screen>
<para>Thus clients must be able to handle this case successfully, reconnecting where required and
registering an exception listener on all connections. This is critical, and must be communicated
@@ -109,9 +102,9 @@ CHN-1003 : Close]]>
</section>
</section>
- <section role="h2" id="Java-Broker-Runtime-Producer-Transaction-Timeout-Configuration">
+ <section role="h2" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-Configuration">
<title>Configuration</title>
- <section role="h3" id="Java-Broker-Runtime-Producer-Transaction-Timeout-Configuration-Overview">
+ <section role="h3" xml:id="Java-Broker-Runtime-Producer-Transaction-Timeout-Configuration-Overview">
<title>Configuration</title>
<para>The transaction timeouts can be specified when a new virtualhost is created or an exiting
virtualhost is edited.</para>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-ACLs.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-ACLs.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-ACLs.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-ACLs.xml Mon Jan 25 16:02:09 2016
@@ -1,5 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +20,7 @@
-->
-<section id="Java-Broker-Security-ACLs">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-ACLs">
<title>Access Control Lists</title>
<para>
In Qpid, Access Control Lists (ACLs) specify which actions can be performed by each authenticated user.
@@ -58,7 +57,7 @@
</itemizedlist>
</para>
- <section role="h3" id="Java-Broker-Security-ACLs-WriteACL">
+ <section role="h3" xml:id="Java-Broker-Security-ACLs-WriteACL">
<title>
Writing .acl files
</title>
@@ -123,7 +122,7 @@
</note>
</section>
- <section role="h4" id="Java-Broker-Security-ACLs-Syntax">
+ <section role="h4" xml:id="Java-Broker-Security-ACLs-Syntax">
<title>
Syntax
</title>
@@ -145,7 +144,7 @@
ALL ALL # A broken line
</programlisting>
</section>
- <table id="table-Java-Broker-Security-ACLs-Syntax_permissions">
+ <table xml:id="table-Java-Broker-Security-ACLs-Syntax_permissions">
<title>List of ACL permission</title>
<tgroup cols="2">
<tbody>
@@ -168,7 +167,7 @@
</tbody>
</tgroup>
</table>
- <table id="table-Java-Broker-Security-ACLs-Syntax_actions">
+ <table xml:id="table-Java-Broker-Security-ACLs-Syntax_actions">
<title>List of ACL actions</title>
<tgroup cols="4">
<thead>
@@ -250,12 +249,12 @@
<entry><command>SHUTDOWN</command> </entry>
<entry><para>Allows/denies the specific user to shutdown the Broker.</para> </entry>
<entry><para>BROKER</para></entry>
- <entry><para></para></entry>
+ <entry><para/></entry>
</row>
</tbody>
</tgroup>
</table>
- <table id="table-Java-Broker-Security-ACLs-Syntax_objects">
+ <table xml:id="table-Java-Broker-Security-ACLs-Syntax_objects">
<title>List of ACL objects</title>
<tgroup cols="4">
<thead>
@@ -324,7 +323,7 @@
</tbody>
</tgroup>
</table>
- <table id="table-Java-Broker-Security-ACLs-Syntax_properties">
+ <table xml:id="table-Java-Broker-Security-ACLs-Syntax_properties">
<title>List of ACL properties</title>
<tgroup cols="2">
<tbody>
@@ -380,7 +379,7 @@
<para>
The rule matches if any of the address ranges match the IPv4 address of the messaging client.
The address ranges are specified using either Classless Inter-Domain Routing notation
- (e.g. 192.168.1.0/24; see <ulink url="http://tools.ietf.org/html/rfc4632">RFC 4632</ulink>)
+ (e.g. 192.168.1.0/24; see <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://tools.ietf.org/html/rfc4632">RFC 4632</link>)
or wildcards (e.g. 192.169.1.*).
</para>
</entry>
@@ -403,8 +402,8 @@
</para>
<para>
You can modify the time-to-live of cached results using the *.ttl properties described on the
- Java <ulink url="http://docs.oracle.com/javase/6/docs/technotes/guides/net/properties.html">Networking
- Properties</ulink> page.
+ Java <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://docs.oracle.com/javase/6/docs/technotes/guides/net/properties.html">Networking
+ Properties</link> page.
</para>
<para>
For example, you can either set system property sun.net.inetaddr.ttl from the command line
@@ -433,7 +432,7 @@
</tbody>
</tgroup>
</table>
- <table id="table-Java-Broker-Security-ACLs-Syntax_javacomponents">
+ <table xml:id="table-Java-Broker-Security-ACLs-Syntax_javacomponents">
<title>List of ACL JMX Components</title>
<tgroup cols="2">
<tbody>
@@ -468,7 +467,7 @@
</tbody>
</tgroup>
</table>
- <table id="table-Java-Broker-Security-ACLs-Queue-Exchnage-Operations">
+ <table xml:id="table-Java-Broker-Security-ACLs-Queue-Exchnage-Operations">
<title>ACL for Queue management operations invoked via REST interfaces</title>
<tgroup cols="4">
<tbody>
@@ -499,7 +498,7 @@
</tbody>
</tgroup>
</table>
- <section role="h4" id="Java-Broker-Security-ACLs-WorkedExamples">
+ <section role="h4" xml:id="Java-Broker-Security-ACLs-WorkedExamples">
<title>
Worked Examples
</title>
@@ -507,7 +506,7 @@
Here are some example ACLs illustrating common use cases.
In addition, note that the Java broker provides a complete example ACL file, located at etc/broker_example.acl.
</para>
- <section role="h4" id="Java-Broker-Security-ACLs-WorkedExample1">
+ <section role="h4" xml:id="Java-Broker-Security-ACLs-WorkedExample1">
<title>
Worked example 1 - Management rights
</title>
@@ -531,7 +530,7 @@ ACL ALLOW readonly ACCESS ALL
ACL DENY-LOG ALL ALL
</programlisting>
</section>
- <section role="h4" id="Java-Broker-Security-ACLs-WorkedExample2">
+ <section role="h4" xml:id="Java-Broker-Security-ACLs-WorkedExample2">
<title>
Worked example 2 - User maintainer group
</title>
@@ -554,7 +553,7 @@ ACL DENY ALL ALL USER
ACL DENY-LOG ALL ALL
</programlisting>
</section>
- <section role="h4" id="Java-Broker-Security-ACLs-WorkedExample3">
+ <section role="h4" xml:id="Java-Broker-Security-ACLs-WorkedExample3">
<title>
Worked example 3 - Request/Response messaging
</title>
@@ -590,7 +589,7 @@ ACL ALLOW server PUBLISH EXCHANGE name="
ACL DENY-LOG all all
</programlisting>
</section>
- <section role="h4" id="Java-Broker-Security-ACLs-WorkedExample4">
+ <section role="h4" xml:id="Java-Broker-Security-ACLs-WorkedExample4">
<title>
Worked example 4 - firewall-like access control
</title>
@@ -626,7 +625,7 @@ ACL DENY-LOG messaging-users ACCESS VIRT
ACL DENY-LOG all all
</programlisting>
</section>
- <section role="h4" id="Java-Broker-Security-ACLs-WorkedExample5">
+ <section role="h4" xml:id="Java-Broker-Security-ACLs-WorkedExample5">
<title>
Worked example 5 - REST management ACL example
</title>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Anonymous.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Anonymous.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Anonymous.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Anonymous.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +19,8 @@
under the License.
-->
-<section id="Java-Broker-Security-Anonymous-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-Anonymous-Provider">
<title>Anonymous</title>
<para> The Anonymous Authentication Provider will allow users to connect with or without
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Base64MD5PasswordFile.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Base64MD5PasswordFile.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Base64MD5PasswordFile.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Base64MD5PasswordFile.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +19,8 @@
under the License.
-->
-<section id="Java-Broker-Security-Base64MD5PasswordFile-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-Base64MD5PasswordFile-Provider">
<title>Base64MD5 Password File <emphasis>(Deprecated)</emphasis></title>
<para><emphasis>This provider is deprecated and will be removed in a future release. The
<link linkend="Java-Broker-Security-MD5-Provider">MD5</link> provider should be used
@@ -40,4 +39,4 @@
pairs separated by colon character. The password is stored MD5 digest/Base64 encoded. This
file must not be modified externally whilst the Broker is running.</para>
</section>
-</section>
\ No newline at end of file
+</section>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-External.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-External.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-External.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-External.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +19,8 @@
under the License.
-->
-<section id="Java-Broker-Security-External-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-External-Provider">
<title>External (SSL Client Certificates)</title>
<para> When <link linkend="Java-Broker-Management-Managing-Truststores"> requiring SSL Client
@@ -32,8 +31,7 @@
<para>
<emphasis role="bold">Note:</emphasis> The External Authentication Provider should typically
- only be used on the AMQP/HTTP ports, in conjunction with <link
- linkend="Java-Broker-Management-Managing-Ports">SSL client certificate
+ only be used on the AMQP/HTTP ports, in conjunction with <link linkend="Java-Broker-Management-Managing-Ports">SSL client certificate
authentication</link>. It is not intended for other uses such as the JMX management port and
will treat any non-sasl authentication processes on these ports as successful with the given
username. As such you should configure another Authentication Provider for use on JMX
@@ -43,8 +41,6 @@
be configured. If attribute "Use the full DN as the Username" is set to "true" the full DN is
used as an authenticated principal name. If attribute "Use the full DN as the Username" is set
to "false" the user name CN part is used as the authenticated principal name. Setting the
- field to "false" is particular useful when <link linkend="Java-Broker-Security-ACLs"
- >ACL</link> is required, as at the moment, ACL does not support commas in the user name.
+ field to "false" is particular useful when <link linkend="Java-Broker-Security-ACLs">ACL</link> is required, as at the moment, ACL does not support commas in the user name.
</para>
</section>
-
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Kerberos.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Kerberos.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Kerberos.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Kerberos.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +19,8 @@
under the License.
-->
-<section id="Java-Broker-Security-Kerberos-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-Kerberos-Provider">
<title>Kerberos</title>
<para> Kereberos Authentication Provider uses java GSS-API SASL mechanism to authenticate the
@@ -37,7 +36,7 @@
<para>Where qpid.conf would look something like this:</para>
- <programlisting><![CDATA[
+ <programlisting>
com.sun.security.jgss.accept {
com.sun.security.auth.module.Krb5LoginModule required
useKeyTab=true
@@ -47,8 +46,8 @@ com.sun.security.jgss.accept {
useSubjectCredsOnly=false
kdc="kerberos.example.com"
keyTab="/path/to/keytab-file"
- principal="<name>/<host>";
-};]]></programlisting>
+ principal="<name>/<host>";
+};</programlisting>
<para> Where realm, kdc, keyTab and principal should obviously be set correctly for the
environment where you are running (see the existing documentation for the C++ broker about
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-LDAP.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-LDAP.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-LDAP.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-LDAP.xml Mon Jan 25 16:02:09 2016
@@ -1,10 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
-[
-<!ENTITY % entities SYSTEM "../commonEntities.xml">
-%entities;
-]>
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -25,7 +19,8 @@
under the License.
-->
-<section id="Java-Broker-Security-LDAP-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-LDAP-Provider">
<title>Simple LDAP</title>
<para> The Simple LDAP authenticates connections against a Directory (LDAP). </para>
@@ -46,10 +41,7 @@
</itemizedlist> Additionally, the following optional fields can be specified: <itemizedlist>
<listitem>
<para><emphasis>LDAP context factory</emphasis> is a fully qualified class name for the
- JNDI LDAP context factory. This class must implement the <ulink
- url="&oracleJdkDocUrl;javax/naming/spi/InitialContextFactory.html"
- >InitialContextFactory</ulink> interface and produce instances of <ulink
- url="&oracleJdkDocUrl;javax/naming/directory/DirContext.html">DirContext</ulink>. If
+ JNDI LDAP context factory. This class must implement the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&oracleJdkDocUrl;javax/naming/spi/InitialContextFactory.html">InitialContextFactory</link> interface and produce instances of <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&oracleJdkDocUrl;javax/naming/directory/DirContext.html">DirContext</link>. If
not specified a default value of <literal>com.sun.jndi.ldap.LdapCtxFactory</literal> is
used.</para>
</listitem>
@@ -59,8 +51,7 @@
be used for both searches and authentications.</para>
</listitem>
<listitem>
- <para><emphasis>Truststore name</emphasis> is a name of <link
- linkend="Java-Broker-Management-Managing-Truststores-Attributes">configured
+ <para><emphasis>Truststore name</emphasis> is a name of <link linkend="Java-Broker-Management-Managing-Truststores-Attributes">configured
truststore</link>. Use this if connecting to a Directory over SSL (i.e. ldaps://)
which is protected by a certificate signed by a private CA (or utilising a self-signed
certificate).</para>
@@ -93,7 +84,6 @@
<para> If the search returns a match, or is configured in <literal>bind without search</literal>
mode, the Authentication Provider then attempts to bind to the LDAP server with the given name
- and the password. Note that <ulink
- url="&oracleJdkDocUrl;javax/naming/Context.html#SECURITY_AUTHENTICATION">simple security
- authentication</ulink> is used so the Directory receives the password in the clear. </para>
+ and the password. Note that <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&oracleJdkDocUrl;javax/naming/Context.html#SECURITY_AUTHENTICATION">simple security
+ authentication</link> is used so the Directory receives the password in the clear. </para>
</section>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-MD5.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-MD5.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-MD5.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-MD5.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -19,17 +17,17 @@
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
+
-->
-<section id="Java-Broker-Security-MD5-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-MD5-Provider">
<title>MD5 Provider</title>
<para> MD5 Provider uses the Broker configuration itself to store the database of
- users (unlike the <link linkend="Java-Broker-Security-Base64MD5PasswordFile-Provider"
- >Base64MD5 Password File</link>, there is no separate password file). Rather than store the
+ users (unlike the <link linkend="Java-Broker-Security-Base64MD5PasswordFile-Provider">Base64MD5 Password File</link>, there is no separate password file). Rather than store the
unencrypted user password (as the Plain provider does) it instead stores the MD5 password
digest. This can be further encrypted using the
- facilities described in <xref linkend="Java-Broker-Security-Configuration-Encryption"
- />.</para>
+ facilities described in <xref linkend="Java-Broker-Security-Configuration-Encryption"/>.</para>
<para>For this provider user credentials can be added, removed or changed using
Management.</para>
-</section>
\ No newline at end of file
+</section>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-MD5PasswordFile.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-MD5PasswordFile.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-MD5PasswordFile.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-MD5PasswordFile.xml Mon Jan 25 16:02:09 2016
@@ -1,8 +1,6 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?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
@@ -10,20 +8,21 @@
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 id="Java-Broker-Security-Base64MD5PasswordFile-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-Base64MD5PasswordFile-Provider">
<title>Base64MD5 Password File <emphasis>(Deprecated)</emphasis></title>
- <para><emphasis>This provider is deprecated and will be removed in a future release. The <link
- linkend="Java-Broker-Security-MD5-Provider">MD5</link> provider should be used
+ <para><emphasis>This provider is deprecated and will be removed in a future release. The <link linkend="Java-Broker-Security-MD5-Provider">MD5</link> provider should be used
instead.</emphasis></para>
<para> Base64MD5PasswordFile Provider uses local file to store and manage user credentials
similar to PlainPasswordFile but instead of storing a password the MD5 password digest
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Plain.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Plain.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Plain.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-Plain.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,11 +19,11 @@
under the License.
-->
-<section id="Java-Broker-Security-Plain-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-Plain-Provider">
<title>Plain</title>
<para>The Plain Provider uses the Broker configuration itself to store the database of users
- (unlike the <link linkend="Java-Broker-Security-PlainPasswordFile-Provider"
- >PlainPasswordFile</link>, there is no separate password file). As the name suggests,
+ (unlike the <link linkend="Java-Broker-Security-PlainPasswordFile-Provider">PlainPasswordFile</link>, there is no separate password file). As the name suggests,
the user data (including password) is not hashed in any way. In order to provide encryption,
the facilities described in <xref linkend="Java-Broker-Security-Configuration-Encryption"/>
must be used.</para>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-PlainPasswordFile.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-PlainPasswordFile.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-PlainPasswordFile.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-PlainPasswordFile.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,10 +19,10 @@
under the License.
-->
-<section id="Java-Broker-Security-PlainPasswordFile-Provider">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-PlainPasswordFile-Provider">
<title>Plain Password File <emphasis>(Deprecated)</emphasis></title>
- <para><emphasis>This provider is deprecated and will be removed in a future release. The <link
- linkend="Java-Broker-Security-Plain-Provider">Plain</link> provider should be used
+ <para><emphasis>This provider is deprecated and will be removed in a future release. The <link linkend="Java-Broker-Security-Plain-Provider">Plain</link> provider should be used
instead.</emphasis></para>
<para> The PlainPasswordFile Provider uses local file to store and manage user credentials. When
creating an authentication provider the path to the file needs to be specified. If specified
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-ScramSha.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-ScramSha.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-ScramSha.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers-ScramSha.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,13 +19,13 @@
under the License.
-->
-<section id="Java-Broker-Security-ScramSha-Providers">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-ScramSha-Providers">
<title>SCRAM SHA</title>
<para>The SCRAM SHA Providers uses the Broker configuration itself to store the database of
users. The users'
passwords are stored as salted SHA digested password. This can be further encrypted using the
- facilities described in <xref linkend="Java-Broker-Security-Configuration-Encryption"
- />.</para>
+ facilities described in <xref linkend="Java-Broker-Security-Configuration-Encryption"/>.</para>
<para>There are two variants of this provider, SHA1 and SHA256. SHA256 is recommended whenever
possible. SHA1 is provided with compatibility with clients utilising JDK 1.6 (which does not
support SHA256).</para>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Authentication-Providers.xml Mon Jan 25 16:02:09 2016
@@ -1,6 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -22,7 +20,7 @@
-->
-<section id="Java-Broker-Security-Authentication-Providers">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-Authentication-Providers">
<title>Authentication Providers</title>
<para> In order to successfully establish a connection to the Java Broker, the connection must be
@@ -65,4 +63,3 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Security-Authentication-Providers-MD5.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Java-Broker-Security-Authentication-Providers-Base64MD5PasswordFile.xml"/>
</section>
-
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Configuration-Encryption.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Configuration-Encryption.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Configuration-Encryption.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Configuration-Encryption.xml Mon Jan 25 16:02:09 2016
@@ -1,5 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +20,7 @@
-->
-<section id="Java-Broker-Security-Configuration-Encryption">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-Configuration-Encryption">
<title>Configuration Encryption</title>
<para> The Broker is capable of encrypting passwords and other security items stored in the
Broker's configuration. This is means that items such as keystore/truststore passwords, JDBC
@@ -36,20 +35,18 @@
<important>
<para>If the keyfile is lost or corrupted, the secrets will be irrecoverable.</para>
</important>
- <section id="Java-Broker-Security-Configuration-Encryption-Configuration">
+ <section xml:id="Java-Broker-Security-Configuration-Encryption-Configuration">
<title>Configuration</title>
- <para>The <literal>AESKeyFile</literal> encyptor provider is enabled/disabled via the <link
- linkend="Java-Broker-Management-Managing-Broker">Broker attributes</link> within the
+ <para>The <literal>AESKeyFile</literal> encyptor provider is enabled/disabled via the <link linkend="Java-Broker-Management-Managing-Broker">Broker attributes</link> within the
Web Management Console. On enabling the provider, any existing passwords within the
configuration will be automatically rewritten in the encrypted form.</para>
- <para>Note that passwords stored by the Authentication Providers <link
- linkend="Java-Broker-Security-PlainPasswordFile-Provider">PlainPasswordFile</link> and.
+ <para>Note that passwords stored by the Authentication Providers <link linkend="Java-Broker-Security-PlainPasswordFile-Provider">PlainPasswordFile</link> and.
<link linkend="Java-Broker-Security-Base64MD5PasswordFile-Provider">PlainPasswordFile</link>
with the external password files are <emphasis>not</emphasis> encrypted by the key. Use the
Scram Authentication Managers instead; these make use of the Configuration Encryption when
storing the users' passwords. </para>
</section>
- <section id="Java-Broker-Security-Configuration-Encryption-Alternate-Implementations">
+ <section xml:id="Java-Broker-Security-Configuration-Encryption-Alternate-Implementations">
<title>Alternate Implementations</title>
<para>If the <literal>AESKeyFile</literal> encryptor implementation does not meet the needs of
the user, perhaps owing to the security standards of their institution, the
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Group-Providers.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Group-Providers.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Group-Providers.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/security/Java-Broker-Security-Group-Providers.xml Mon Jan 25 16:02:09 2016
@@ -1,5 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-
+<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -21,7 +20,7 @@
-->
-<section id="Java-Broker-Security-Group-Providers">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security-Group-Providers">
<title>Group Providers</title>
<para>
The Java broker utilises GroupProviders to allow assigning users to groups for use in <link linkend="Java-Broker-Security-ACLs">ACLs</link>.
@@ -30,7 +29,7 @@
Group Providers can be added into the Broker. All of them will be checked for the presence of the groups for a given authenticated user.
</para>
- <section role="h3" id="File-Group-Manager">
+ <section role="h3" xml:id="File-Group-Manager">
<title>GroupFile Provider</title>
<para>
The <emphasis>GroupFile</emphasis> Provider allows specifying group membership in a flat file on disk.
@@ -41,7 +40,7 @@
the creation will be aborted.
</para>
- <section role="h4" id="File-Group-Manager-FileFormat">
+ <section role="h4" xml:id="File-Group-Manager-FileFormat">
<title>File Format</title>
<para>
The groups file has the following format:
@@ -60,7 +59,7 @@
</section>
</section>
- <section role="h3" id="Java-Broker-Security-Group-Providers-ManagedGroupProvider">
+ <section role="h3" xml:id="Java-Broker-Security-Group-Providers-ManagedGroupProvider">
<title>ManagedGroupProvider</title>
<para>
The <emphasis>ManagedGroupProvider</emphasis> allows specifying group membership as part of broker configuration.
Propchange: qpid/java/branches/6.0.x/doc/book/src/java-perftests/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Jan 25 16:02:09 2016
@@ -7,3 +7,4 @@
/qpid/branches/mcpierce-QPID-4719/qpid/doc/book/src/java-perftests:1477004-1477093
/qpid/branches/qpid-2935/qpid/doc/book/src/java-perftests:1061302-1072333
/qpid/branches/qpid-3346/qpid/doc/book/src/java-perftests:1144319-1179855
+/qpid/java/trunk/doc/book/src/java-perftests:1722019
Modified: qpid/java/branches/6.0.x/doc/book/src/java-perftests/JMS-Performance-Test-Framework.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-perftests/JMS-Performance-Test-Framework.xml?rev=1726649&r1=1726648&r2=1726649&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-perftests/JMS-Performance-Test-Framework.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-perftests/JMS-Performance-Test-Framework.xml Mon Jan 25 16:02:09 2016
@@ -20,7 +20,7 @@
-->
-<book xmlns:xi="http://www.w3.org/2001/XInclude">
+<book xmlns="http://docbook.org/ns/docbook" version="5.0">
<title>JMS Performance Test Framework</title>
<chapter>
<para>
@@ -33,7 +33,7 @@
This document explains how to use the framework.
</para>
- <section id="how-it-works">
+ <section xml:id="how-it-works">
<title>How it works</title>
<para>
First, you need to <emphasis>run a message broker</emphasis>. This can be Qpid, ActiveMQ etc
@@ -60,7 +60,7 @@
</para>
</section>
- <section id="test-definitions">
+ <section xml:id="test-definitions">
<title>Test definitions</title>
<para>
Test definition files specify details about the messages to send,
@@ -79,7 +79,7 @@
</para>
</section>
- <section id="example-usage">
+ <section xml:id="example-usage">
<title>Example usage</title>
<para>
The <filename>perftests/etc/</filename> folder contains shell scripts that can be used to run the performance
@@ -88,7 +88,7 @@
</para>
</section>
- <section id="instructions">
+ <section xml:id="instructions">
<title>Instructions</title>
<para>
<itemizedlist>
@@ -114,7 +114,7 @@
</itemizedlist>
</para>
- <section id="running-clients-in-a-separate-process">
+ <section xml:id="running-clients-in-a-separate-process">
<title>Running the clients in a separate process</title>
<para>
When using a large number of clients, you may get more representative
@@ -138,7 +138,7 @@
</section>
</section>
- <section id="writing-results-to-a-jdbc-database">
+ <section xml:id="writing-results-to-a-jdbc-database">
<title>Writing results to a JDBC database</title>
<para>
For most use cases, writing results to a CSV file is acceptable. However, there are some cases
@@ -163,7 +163,7 @@
</para>
</section>
- <section id="caveats-for-non-qpid-jms-providers">
+ <section xml:id="caveats-for-non-qpid-jms-providers">
<title>Caveats for non-Qpid JMS providers</title>
<para>
If you are not using the Qpid broker, you must create one or more queues before
@@ -194,7 +194,7 @@
</para>
</section>
- <section id="when-production-is-slower-than-consumption">
+ <section xml:id="when-production-is-slower-than-consumption">
<title>When message production is slower than consumption</title>
<para>
A given test configuration may cause messages to be produced faster than they are consumed.
@@ -207,7 +207,7 @@
<listitem>
Use your JMS provider's built-in features for throttling incoming messages.
In the case of Qpid, this is done by configuring the queue to enforce flow control, like so:
- <screen><![CDATA[
+ <screen>
{
"_tests":[
{
@@ -224,14 +224,14 @@
],
...
}
- }]]>
+ }
</screen>
</listitem>
</itemizedlist>
</para>
</section>
- <section id="visualising-test-results">
+ <section xml:id="visualising-test-results">
<title>Visualising test results</title>
<para>
The module visualisation-jfc can be used to generate charts as .png files from the results
@@ -264,7 +264,7 @@
</itemizedlist>
</para>
</section>
- <section id="visualising-test-results-queries">
+ <section xml:id="visualising-test-results-queries">
<title>Queries</title>
<para>
The query in the chart definition file is an ANSI SQL query. If reading from a CSV file the SQL table name
Propchange: qpid/java/branches/6.0.x/doc/book/src/jms-client-0-8/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Mon Jan 25 16:02:09 2016
@@ -7,4 +7,4 @@
/qpid/branches/mcpierce-QPID-4719/qpid/doc/book/src/jms-client-0-8:1477004-1477093
/qpid/branches/qpid-2935/qpid/doc/book/src/jms-client-0-8:1061302-1072333
/qpid/branches/qpid-3346/qpid/doc/book/src/jms-client-0-8:1144319-1179855
-/qpid/java/trunk/doc/book/src/jms-client-0-8:1716086,1716489
+/qpid/java/trunk/doc/book/src/jms-client-0-8:1716086,1716489,1722019
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org