You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by kw...@apache.org on 2015/12/28 23:41:24 UTC
svn commit: r1722019 [2/6] - in /qpid/java/trunk/doc/book/src: ./
java-broker/ java-broker/concepts/ java-broker/management/channels/
java-broker/management/managing/ java-broker/runtime/ java-broker/security/
java-perftests/ jms-client-0-8/
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Concepts.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Concepts.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Concepts.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Concepts.xml Mon Dec 28 22:41:23 2015
@@ -20,27 +20,17 @@
-->
-<chapter id="Java-Broker-Concepts">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts">
<title>Concepts</title>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Overview.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Broker.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-RemoteReplicationNodes.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Virtualhosts.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Exchanges.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Queues.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Ports.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Authentication-Providers.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="concepts/Java-Broker-Concepts-Other-Services.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Overview.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Broker.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-RemoteReplicationNodes.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Virtualhosts.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Exchanges.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Queues.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Ports.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Authentication-Providers.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="concepts/Java-Broker-Concepts-Other-Services.xml"/>
</chapter>
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Exchanges-Binding-Arguments.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Exchanges-Binding-Arguments.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Exchanges-Binding-Arguments.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Exchanges-Binding-Arguments.xml Mon Dec 28 22:41:23 2015
@@ -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="">
-<title></title>
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="">
+<title/>
</section>
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Getting-Started.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Getting-Started.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Getting-Started.xml Mon Dec 28 22:41:23 2015
@@ -1,8 +1,4 @@
<?xml version="1.0"?>
-<!DOCTYPE entities [
-<!ENTITY % entities SYSTEM "commonEntities.xml">
-%entities;
-]>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -24,10 +20,10 @@
-->
-<chapter id="Java-Broker-Getting-Started">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Getting-Started">
<title>Getting Started</title>
- <section role="h2" id="Java-Broker-Getting-Started-Introduction">
+ <section role="h2" xml:id="Java-Broker-Getting-Started-Introduction">
<title>Introduction</title>
<para>
This section describes how to start and stop the Java Broker, and outlines the various command line options.
@@ -39,12 +35,12 @@
<xref linkend="Java-Broker-Management-Channel-Web-Console"/>.
</para>
</section>
- <section role="h2" id="Java-Broker-Getting-Started-Starting-Stopping-Windows">
+ <section role="h2" xml:id="Java-Broker-Getting-Started-Starting-Stopping-Windows">
<title>Starting/Stopping the broker on Windows</title>
<para>Firstly change to the installation directory used during the <link linkend="Java-Broker-Installation-InstallationWindows">installation</link>
and ensure that the <link linkend="Java-Broker-Installation-InstallationWindows-SettingQPIDWORK">QPID_WORK environment variable is set</link>.</para>
<para>Now use the <command>qpid-server.bat</command> to start the server</para>
- <programlisting><![CDATA[bin\qpid-server.bat]]></programlisting>
+ <programlisting>bin\qpid-server.bat</programlisting>
<para>Output similar to the following will be seen:</para>
<screen>[Broker] BRK-1006 : Using configuration : C:\qpidwork\config.json
[Broker] BRK-1001 : Startup : Version: &qpidCurrentRelease; Build: 1478262
@@ -61,12 +57,12 @@
<link linkend="Java-Broker-Management-Channel-REST-API-Operations">REST operation broker/shutdown</link>.
</para>
</section>
- <section role="h2" id="Java-Broker-Getting-Started-Starting-Stopping-Unix">
+ <section role="h2" xml:id="Java-Broker-Getting-Started-Starting-Stopping-Unix">
<title>Starting/Stopping the broker on Unix</title>
<para>Firstly change to the installation directory used during the <link linkend="Java-Broker-Installation-InstallationUnix">installation</link>
and ensure that the <link linkend="Java-Broker-Installation-InstallationUnix-SettingQPIDWORK">QPID_WORK environment variable is set</link>.</para>
<para>Now use the <command>qpid-server</command> script to start the server:</para>
- <programlisting><![CDATA[bin/qpid-server]]></programlisting>
+ <programlisting>bin/qpid-server</programlisting>
<para>Output similar to the following will be seen:</para>
<screen>[Broker] BRK-1006 : Using configuration : /var/qpidwork/config.json
[Broker] BRK-1001 : Startup : Version: &qpidCurrentRelease; Build: exported
@@ -83,7 +79,7 @@
<command>bin/qpid.stop</command> script, use <command>kill -TERM <pid></command>, or
the <link linkend="Java-Broker-Management-Channel-REST-API-Operations">REST operation broker/shutdown</link>.</para>
</section>
- <section role="h2" id="Java-Broker-Getting-Started-Logging">
+ <section role="h2" xml:id="Java-Broker-Getting-Started-Logging">
<title>Log file</title>
<para>The Java Broker writes a log file to record both details of its normal operation and any exceptional
conditions. By default the log file is written within the log subdirectory beneath the work directory
@@ -91,7 +87,7 @@
<computeroutput>%QPID_WORK%\log\qpid.log</computeroutput> (Windows).</para>
<para>For details of how to control the logging, see <xref linkend="Java-Broker-Runtime-Logging"/></para>
</section>
- <section role="h2" id="Java-Broker-Getting-Started-CommandLine">
+ <section role="h2" xml:id="Java-Broker-Getting-Started-CommandLine">
<title>Using the command line</title>
<para>The Java Broker understands a number of command line options which may be used to customise the configuration.</para>
<para>
@@ -101,11 +97,11 @@
<xref linkend="Java-Broker-Management-Channel-Web-Console"/>.
</para>
<para>To see usage information for all command line options, use the <option>--help</option> option</para>
- <programlisting><![CDATA[bin/qpid-server --help]]></programlisting>
- <screen><![CDATA[usage: Qpid [-cic <path>] [-h] [-icp <path>] [-mm] [-mmhttp <port>]
- [-mmpass <password>] [-mmqv] [-os]
- [-prop <name=value>] [-props <path>] [-sp <path>] [-st <type>] [-v]
- -cic,--create-initial-config <path> create a copy of the
+ <programlisting>bin/qpid-server --help</programlisting>
+ <screen>usage: Qpid [-cic <path>] [-h] [-icp <path>] [-mm] [-mmhttp <port>]
+ [-mmpass <password>] [-mmqv] [-os]
+ [-prop <name=value>] [-props <path>] [-sp <path>] [-st <type>] [-v]
+ -cic,--create-initial-config <path> create a copy of the
initial config file,
either to an
optionally specified
@@ -114,7 +110,7 @@
in the current
directory
-h,--help print this message
- -icp,--initial-config-path <path> set the location of
+ -icp,--initial-config-path <path> set the location of
initial JSON config
to use when
creating/overwriting
@@ -124,10 +120,10 @@
management mode,
disabling the AMQP
ports
- -mmhttp,--management-mode-http-port <port> override http
+ -mmhttp,--management-mode-http-port <port> override http
management port in
management mode
- -mmpass,--management-mode-password <password> Set the password for
+ -mmpass,--management-mode-password <password> Set the password for
the management mode
user mm_admin
-mmqv,--management-mode-quiesce-virtualhosts make virtualhosts
@@ -139,26 +135,26 @@
with the current
initial
configuration
- -prop,--config-property <name=value> set a configuration
+ -prop,--config-property <name=value> set a configuration
property to use when
resolving variables
in the broker
configuration store,
with format
"name=value"
- -props,--system-properties-file <path> set the location of
+ -props,--system-properties-file <path> set the location of
initial properties
file to set
otherwise unset
system properties
- -sp,--store-path <path> use given
+ -sp,--store-path <path> use given
configuration store
location
- -st,--store-type <type> use given broker
+ -st,--store-type <type> use given broker
configuration store
type
-v,--version print the version
information and exit
-]]></screen>
+</screen>
</section>
</chapter>
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-High-Availability.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-High-Availability.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-High-Availability.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-High-Availability.xml Mon Dec 28 22:41:23 2015
@@ -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
@@ -23,10 +19,11 @@
under the License.
-->
-<chapter id="Java-Broker-High-Availability">
+
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-High-Availability">
<title>High Availability</title>
- <section id="Java-Broker-High-Availability-GeneralIntroduction">
+ <section xml:id="Java-Broker-High-Availability-GeneralIntroduction">
<title>General Introduction</title>
<para>The term High Availability (HA) usually refers to having a number of instances of a
service such as a Message Broker available so that should a service unexpectedly fail, or
@@ -41,10 +38,9 @@
the event the active node becomes unavailable. </para>
</section>
- <section id="Java-Broker-High-Availability-OverviewOfHA">
+ <section xml:id="Java-Broker-High-Availability-OverviewOfHA">
<title>Overview of HA within the Java Broker</title>
- <para>The Java Broker provides a HA implementation offering an <emphasis role="bold"
- >Active/Passive</emphasis> mode of operation. When using HA, many instances of the Java
+ <para>The Java Broker provides a HA implementation offering an <emphasis role="bold">Active/Passive</emphasis> mode of operation. When using HA, many instances of the Java
Broker work together to form an high availability group of two or more nodes.</para>
<para>The remainder of this section now talks about the specifics of how HA is achieved in terms
of the <link linkend="Java-Broker-Concepts">concepts</link> introduced earlier in this
@@ -76,7 +72,7 @@
separate Broker instances. A client is connected to the virtualhost node that is in the master
role. The two virtualhost nodes <literal>weather1</literal> and <literal>weather3</literal>
are replicas and are receiving a stream of updates.</para>
- <figure id="Java-Broker-High-Availability-OverviewOfHA-Figure">
+ <figure xml:id="Java-Broker-High-Availability-OverviewOfHA-Figure">
<title>3-node group deployed across three Brokers.</title>
<mediaobject>
<imageobject>
@@ -88,25 +84,21 @@
</mediaobject>
</figure>
<para>Currently, the only virtualhost/virtualhost node type offering HA is BDB HA. Internally,
- this leverages the HA capabilities of the Berkeley DB JE edition. BDB JE is an <link
- linkend="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE">optional dependency</link> of
+ this leverages the HA capabilities of the Berkeley DB JE edition. BDB JE is an <link linkend="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE">optional dependency</link> of
the Broker.</para>
<note>
<para>The Java Broker HA solution is incompatible with the HA solution offered by the CPP
Broker. It is not possible to co-locate Java and CPP Brokers within the same group.</para>
</note>
</section>
- <section id="Java-Broker-High-Availability-CreatingGroup">
+ <section xml:id="Java-Broker-High-Availability-CreatingGroup">
<title>Creating a group</title>
<para>This section describes how to create a group. At a high level, creating a group involves
first creating the first node standalone, then creating subsequent nodes referencing the first
node so the nodes can introduce themselves and gradually the group is built up.</para>
- <para>A group is created through either <link
- linkend="Java-Broker-Management-Channel-Web-Console">Web Management</link> or the <link
- linkend="Java-Broker-Management-Channel-REST-API">REST API</link>. These instructions
+ <para>A group is created through either <link linkend="Java-Broker-Management-Channel-Web-Console">Web Management</link> or the <link linkend="Java-Broker-Management-Channel-REST-API">REST API</link>. These instructions
presume you are using Web Management. To illustrate the example it builds the group
- illustrated in figure <xref linkend="Java-Broker-High-Availability-OverviewOfHA-Figure"
- /></para>
+ illustrated in figure <xref linkend="Java-Broker-High-Availability-OverviewOfHA-Figure"/></para>
<para><orderedlist>
<listitem>
<para>Install a Broker on each machine that will be used to host the group. As messaging
@@ -229,16 +221,15 @@
</figure></para>
</section>
- <section id="Java-Broker-High-Availability-Behaviour">
+ <section xml:id="Java-Broker-High-Availability-Behaviour">
<title>Behaviour of the Group</title>
<para>This section first describes the behaviour of the group in its default configuration. It
then goes on to talk about the various controls that are available to override it. It
- describes the controls available that affect the <ulink
- url="http://en.wikipedia.org/wiki/ACID#Durability">durability</ulink> of transactions and
+ describes the controls available that affect the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://en.wikipedia.org/wiki/ACID#Durability">durability</link> of transactions and
the data consistency between the master and replicas and thus make trade offs between
performance and reliability.</para>
- <section id="Java-Broker-High-Availability-Behaviour-Default-Behaviour">
+ <section xml:id="Java-Broker-High-Availability-Behaviour-Default-Behaviour">
<title>Default Behaviour</title>
<para>Let's first look at the behaviour of a group in default configuration.</para>
<para>In the default configuration, for any messaging work to be done, there must be at least
@@ -280,7 +271,7 @@
trade off between durability and performance. We will see more about how to control this
trade off later.</para>
</section>
- <section id="Java-Broker-High-Availability-Behaviour-SynchronizationPolicy">
+ <section xml:id="Java-Broker-High-Availability-Behaviour-SynchronizationPolicy">
<title>Synchronization Policy</title>
<para>The <emphasis>synchronization policy</emphasis> dictates what a node must do when it
receives a transaction before it acknowledges that transaction to the rest of the
@@ -305,12 +296,11 @@
</listitem>
</itemizedlist></para>
<para>It is possible to assign a one policy to the master and a different policy to the
- replicas. These are configured as <link
- linkend="Java-Broker-Management-Managing-Virtualhost-Attributes">attributes on the
+ replicas. These are configured as <link linkend="Java-Broker-Management-Managing-Virtualhost-Attributes">attributes on the
virtualhost</link>. By default the master uses <emphasis>SYNC</emphasis> and replicas use
<emphasis>NO_SYNC</emphasis>.</para>
</section>
- <section id="Java-Broker-High-Availability-Behaviour-NodePriority">
+ <section xml:id="Java-Broker-High-Availability-Behaviour-NodePriority">
<title>Node Priority</title>
<para>Node priority can be used to influence the behaviour of the election algorithm. It is
useful in the case were you want to favour some nodes over others. For instance, if you wish
@@ -337,8 +327,7 @@
</listitem>
</itemizedlist>
</para>
- <para>Node priority is configured as an <link
- linkend="Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">attribute on the
+ <para>Node priority is configured as an <link linkend="Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">attribute on the
virtualhost node</link> and can be changed at runtime and is effective immediately.</para>
<important>
<para>Use of the Never priority can lead to transaction loss. For example, consider a group
@@ -347,11 +336,10 @@
running behind for some reason (perhaps a full-GC). If a Master failure were to occur at
that moment, the replicas would elect Replica-1 even though Replica-2 had the most recent
transaction.</para>
- <para>Transaction loss is reported by message <link
- linkend="Java-Broker-Appendix-Operation-Logging-Message-HA-1014">HA-1014</link>.</para>
+ <para>Transaction loss is reported by message <link linkend="Java-Broker-Appendix-Operation-Logging-Message-HA-1014">HA-1014</link>.</para>
</important>
</section>
- <section id="Java-Broker-High-Availability-Behaviour-MinimumNumberOfNodes">
+ <section xml:id="Java-Broker-High-Availability-Behaviour-MinimumNumberOfNodes">
<title>Required Minimum Number Of Nodes</title>
<para>This controls the required minimum number of nodes to complete a transaction and to
elect a new master. By default, the required number of nodes is set to
@@ -367,27 +355,23 @@
just this one node?</para>
<para>In this case, Required Number of Nodes can be reduced to 1 on the remain node, allowing
the node to elect itself and service to be restored from the singleton. Required minimum
- number of nodes is configured as an <link
- linkend="Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">attribute on the
+ number of nodes is configured as an <link linkend="Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">attribute on the
virtualhost node</link> and can be changed at runtime and is effective immediately.</para>
<important>
<para>The attribute must be used cautiously. Careless use will lead to lost transactions and
- can lead to a <ulink url="http://en.wikipedia.org/wiki/Split-brain_(computing)"
- >split-brain</ulink> in the event of a network partition. If used to temporarily restore
+ can lead to a <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://en.wikipedia.org/wiki/Split-brain_(computing)">split-brain</link> in the event of a network partition. If used to temporarily restore
service from fewer than quorum nodes, it is <emphasis>imperative</emphasis> to revert it
to the Default value as the failed nodes are restored.</para>
- <para>Transaction loss is reported by message <link
- linkend="Java-Broker-Appendix-Operation-Logging-Message-HA-1014">HA-1014</link>.</para>
+ <para>Transaction loss is reported by message <link linkend="Java-Broker-Appendix-Operation-Logging-Message-HA-1014">HA-1014</link>.</para>
</important>
</section>
- <section id="Java-Broker-High-Availability-Behaviour-DesignatedPrimary">
+ <section xml:id="Java-Broker-High-Availability-Behaviour-DesignatedPrimary">
<title>Designated Primary</title>
<para>This attribute applies to the groups of two only.</para>
<para> In a group of two, if a node were to fail then in default configuration work will cease
as quorum no longer exists. A single node cannot elect itself master. </para>
<para>The designated primary flag allows a node in a two node group to elect itself master and
- to operate sole. Designated Primary is configured as an <link
- linkend="Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">attribute on the
+ to operate sole. Designated Primary is configured as an <link linkend="Java-Broker-Management-Managing-Virtualhost-Nodes-Attributes">attribute on the
virtualhost node</link> and can be changed at runtime and is effective immediately.</para>
<para>For example, consider a group of two where the master fails. Service will be interrupted
as the remaining node cannot elect itself master. To allow it to become master, apply the
@@ -395,17 +379,15 @@
from one node.</para>
<important>
<para>It is imperative not to allow designated primary to be set on both nodes at once. To
- do so will mean, in the event of a network partition, a <ulink
- url="http://en.wikipedia.org/wiki/Split-brain_(computing)">split-brain</ulink> will
+ do so will mean, in the event of a network partition, a <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://en.wikipedia.org/wiki/Split-brain_(computing)">split-brain</link> will
occur.</para>
- <para>Transaction loss is reported by message <link
- linkend="Java-Broker-Appendix-Operation-Logging-Message-HA-1014">HA-1014</link>.</para>
+ <para>Transaction loss is reported by message <link linkend="Java-Broker-Appendix-Operation-Logging-Message-HA-1014">HA-1014</link>.</para>
</important>
</section>
</section>
- <section id="Java-Broker-High-Availability-NodeOperations">
+ <section xml:id="Java-Broker-High-Availability-NodeOperations">
<title>Node Operations</title>
- <section id="Java-Broker-High-Availability-NodeOperations-Lifecycle">
+ <section xml:id="Java-Broker-High-Availability-NodeOperations-Lifecycle">
<title>Lifecycle</title>
<para>Virtualhost nodes can be stopped, started and deleted.</para>
<itemizedlist>
@@ -450,7 +432,7 @@
<para>It is also possible to add nodes to an existing group using the procedure described
above.</para>
</section>
- <section id="Java-Broker-High-Availability-NodeOperations-TransferMaster">
+ <section xml:id="Java-Broker-High-Availability-NodeOperations-TransferMaster">
<title>Transfer Master</title>
<para>This operation allows the mastership to be moved from node to node. This is useful for
restoring a business as usual state after a failure.</para>
@@ -477,19 +459,18 @@
</section>
</section>
- <section id="Java-Broker-High-Availability-ClientFailover">
+ <section xml:id="Java-Broker-High-Availability-ClientFailover">
<title>Client failover</title>
<para>As mentioned above, the clients need to be able to find the location of the active
virtualhost within the group.</para>
- <para>Clients can do this using a static technique, for example , utilising the <ulink
- url="&qpidjmsdocClientConectionUrl;">failover feature of the Qpid connection url</ulink>
+ <para>Clients can do this using a static technique, for example , utilising the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&qpidjmsdocClientConectionUrl;">failover feature of the Qpid connection url</link>
where the client has a list of all the nodes, and tries each node in sequence until it
discovers the node with the active virtualhost.</para>
<para>Another possibility is a dynamic technique utilising a proxy or Virtual IP (VIP). These
require other software and/or hardware and are outside the scope of this document.</para>
</section>
- <section id="Java-Broker-High-Availability-DiskSpace">
+ <section xml:id="Java-Broker-High-Availability-DiskSpace">
<title>Disk space requirements</title>
<para>In the case where node in a group are down, the master must keep the data they are missing
for them to allow them to return to the replica role quickly.</para>
@@ -499,7 +480,7 @@
<literal>je.rep.repStreamTimeout</literal>.</para>
</section>
- <section id="Java-Broker-High-Availability-Network-Requirements">
+ <section xml:id="Java-Broker-High-Availability-Network-Requirements">
<title>Network Requirements</title>
<para>The HA Cluster performance depends on the network bandwidth, its use by existing traffic,
and quality of service.</para>
@@ -509,7 +490,7 @@
in a separate network not impacted by any other traffic.</para>
</section>
- <section id="Java-Broker-High-Availability-Security">
+ <section xml:id="Java-Broker-High-Availability-Security">
<title>Security</title>
<para>The replication stream between the master and the replicas is insecure and can be
intercepted by anyone having access to the replication network.</para>
@@ -517,14 +498,14 @@
separate network protected from general access and/or utilise SSH-tunnels/IPsec.</para>
</section>
- <section id="Java-Broker-High-Availability-Backup">
+ <section xml:id="Java-Broker-High-Availability-Backup">
<title>Backups</title>
<para>It is recommend to use the hot backup script to periodically backup every node in the
group. <xref linkend="Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB-HA"/>.</para>
</section>
- <section id="Java-Broker-High-Availability-Reset-Group-Infomational">
+ <section xml:id="Java-Broker-High-Availability-Reset-Group-Infomational">
<title>Reset Group Information</title>
<para>BDB JE internally stores details of the group within its database. There are some
circumstances when resetting this information is useful.<itemizedlist>
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml Mon Dec 28 22:41:23 2015
@@ -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,15 +20,14 @@
-->
-<chapter id="Java-Broker-Initial-Configuration">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Initial-Configuration">
<title>Initial Configuration</title>
- <section id="Java-Broker-Initial-Configuration-Introduction">
+ <section xml:id="Java-Broker-Initial-Configuration-Introduction">
<title>Introduction</title>
<para>This section describes how to perform initial configuration on the command line. Once
- the Broker is started, subsequent management is performed using the <link
- linkend="Java-Broker-Management-Channel">Management interfaces</link></para>
+ the Broker is started, subsequent management is performed using the <link linkend="Java-Broker-Management-Channel">Management interfaces</link></para>
<para> The configuration for each component is stored as an entry in the broker
configuration store, currently implemented as a JSON file which persists changes to
disk, BDB or Derby database or an in-memory store which does not. The following
@@ -68,20 +67,15 @@
<para> Broker startup involves two configuration related items, the 'Initial Configuration'
and the Configuration Store. When the broker is started, if a Configuration Store does
- not exist at the current <link linkend="Java-Broker-Initial-Configuration-Location"
- >store location</link> then one will be initialised with the current <link
- linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
- Configuration'</link>. Unless otherwise requested to <link
- linkend="Java-Broker-Initial-Configuration-Location">overwrite the configuration
+ not exist at the current <link linkend="Java-Broker-Initial-Configuration-Location">store location</link> then one will be initialised with the current <link linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
+ Configuration'</link>. Unless otherwise requested to <link linkend="Java-Broker-Initial-Configuration-Location">overwrite the configuration
store</link> then subsequent broker restarts will use the existing configuration
store and ignore the contents of the 'Initial Configuration'. </para>
</section>
- <section id="Java-Broker-Initial-Configuration-Location">
+ <section xml:id="Java-Broker-Initial-Configuration-Location">
<title>Configuration Store Location</title>
- <para> The broker will default to using <link
- linkend="Java-Broker-Initial-Configuration-Configuration-Properties"
- >${qpid.work_dir}</link>/config.json as the path for its configuration store unless
+ <para> The broker will default to using <link linkend="Java-Broker-Initial-Configuration-Configuration-Properties">${qpid.work_dir}</link>/config.json as the path for its configuration store unless
otherwise instructed. </para>
<para> The command line argument <emphasis>-sp</emphasis> (or
<emphasis>--store-path</emphasis>) can optionally be used to specify a different
@@ -91,34 +85,30 @@ $ ./qpid-server -sp ./my-broker-configur
</screen>
<para> If no configuration store exists at the specified/defaulted location when the broker
- starts then one will be initialised using the current <link
- linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
+ starts then one will be initialised using the current <link linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
Configuration'</link>. </para>
</section>
- <section id="Java-Broker-Initial-Configuration-Initial-Config-Location">
+ <section xml:id="Java-Broker-Initial-Configuration-Initial-Config-Location">
<title>'Initial Configuration' Location</title>
<para> The 'Initial Configuration' JSON file is used when initialising new broker
configuration stores. The broker will default to using an internal file within its jar
unless otherwise instructed. </para>
<para> The command line argument <emphasis>-icp </emphasis> (or
<emphasis>--initial-config-path</emphasis>) can be used to override the brokers
- internal file and supply a <link
- linkend="Java-Broker-Initial-Configuration-Create-Initial-Config">user-created
+ internal file and supply a <link linkend="Java-Broker-Initial-Configuration-Create-Initial-Config">user-created
one</link>:</para>
<screen>
$ ./qpid-server -icp ./my-initial-configuration.json
</screen>
- <para> If a Configuration Store already exists at the current <link
- linkend="Java-Broker-Initial-Configuration-Location">store location</link> then the
- current 'Initial Configuration' will be ignored unless otherwise requested to <link
- linkend="Java-Broker-Initial-Configuration-Location">overwrite the configuration
+ <para> If a Configuration Store already exists at the current <link linkend="Java-Broker-Initial-Configuration-Location">store location</link> then the
+ current 'Initial Configuration' will be ignored unless otherwise requested to <link linkend="Java-Broker-Initial-Configuration-Location">overwrite the configuration
store</link>
</para>
</section>
- <section id="Java-Broker-Initial-Configuration-Create-Initial-Config">
+ <section xml:id="Java-Broker-Initial-Configuration-Create-Initial-Config">
<title>Creating an 'Initial Configuration' JSON File</title>
<para> It is possible to have the broker output its default internal 'Initial Configuration'
@@ -136,25 +126,19 @@ $ ./qpid-server -cic ./initial-config.js
Store output as an initial configuration. Typically 'Initial Configuration' files would
not to contain IDs for the configured entities, so that IDs will be generated when the
configuration store is initialised and prevent use of the same IDs across multiple
- brokers, however it may prove useful to include IDs if using the Memory <link
- linkend="Java-Broker-Initial-Configuration-Type">Configuration Store Type</link>. </para>
- <para> It can be useful to use <link
- linkend="Java-Broker-Initial-Configuration-Configuration-Properties">Configuration
+ brokers, however it may prove useful to include IDs if using the Memory <link linkend="Java-Broker-Initial-Configuration-Type">Configuration Store Type</link>. </para>
+ <para> It can be useful to use <link linkend="Java-Broker-Initial-Configuration-Configuration-Properties">Configuration
Properties</link> within 'Initial Configuration' files to allow a degree of
customisation with an otherwise fixed file. </para>
- <para> For an example file, see <xref
- linkend="Java-Broker-Initial-Configuration-Example"
- />
+ <para> For an example file, see <xref linkend="Java-Broker-Initial-Configuration-Example"/>
</para>
</section>
- <section id="Java-Broker-Initial-Configuration-Overwrite-Config-Store">
+ <section xml:id="Java-Broker-Initial-Configuration-Overwrite-Config-Store">
<title>Overwriting An Existing Configuration Store</title>
- <para> If a configuration store already exists at the configured <link
- linkend="Java-Broker-Initial-Configuration-Location">store location</link> then it
- is used and the current <link
- linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
+ <para> If a configuration store already exists at the configured <link linkend="Java-Broker-Initial-Configuration-Location">store location</link> then it
+ is used and the current <link linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
Configuration'</link> is ignored. </para>
<para> The command line argument <emphasis>-os</emphasis> (or
<emphasis>--overwrite-store</emphasis>) can be used to force a new broker
@@ -165,12 +149,11 @@ $ ./qpid-server -os -icp ./my-initial-co
</screen>
<para> This can be useful to effectively play configuration into one or more broker to
pre-configure them to a particular state, or alternatively to ensure a broker is always
- started with a fixed configuration. In the latter case, use of the Memory <link
- linkend="Java-Broker-Initial-Configuration-Type">Configuration Store Type</link> may
+ started with a fixed configuration. In the latter case, use of the Memory <link linkend="Java-Broker-Initial-Configuration-Type">Configuration Store Type</link> may
also be useful. </para>
</section>
- <section id="Java-Broker-Initial-Configuration-Type">
+ <section xml:id="Java-Broker-Initial-Configuration-Type">
<title>Configuration Store Type</title>
<para> There are currently several implementations of the pluggable Broker Configuration Store:
<variablelist>
@@ -181,8 +164,7 @@ $ ./qpid-server -os -icp ./my-initial-co
<varlistentry>
<term>Memory</term>
<listitem><para>operates only in-memory and so does not retain changes across broker
- restarts and always relies on the current <link
- linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
+ restarts and always relies on the current <link linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
Configuration'</link> to provide the configuration to start the broker with.
</para></listitem>
</varlistentry>
@@ -219,7 +201,7 @@ $ ./qpid-server -st JDBC \
</screen>
</section>
- <section id="Java-Broker-Initial-Configuration-Configuration-Properties">
+ <section xml:id="Java-Broker-Initial-Configuration-Configuration-Properties">
<title>Customising Configuration using Configuration Properties</title>
<para> It is possible for 'Initial Configuration' (and Configuration Store) files to contain
${properties} that can be resolved to String values at startup, allowing a degree of
@@ -271,9 +253,7 @@ $ ./qpid-server -st JDBC \
</table>
</para>
- <para> Use of these core properties can be seen in the <link
- linkend="Java-Broker-Initial-Configuration-Example"
- >default 'Initial Configuration' example</link>. </para>
+ <para> Use of these core properties can be seen in the <link linkend="Java-Broker-Initial-Configuration-Example">default 'Initial Configuration' example</link>. </para>
<para> Configuration Properties can be set on the command line using the
<emphasis>-prop</emphasis> (or <emphasis>--configuration-property</emphasis>)
@@ -286,21 +266,20 @@ $ ./qpid-server -prop "qpid.amqp_port=10
is specified with the value 10000, overriding the default value of 5672, and similarly
the value 10001 is used to override the default HTTP port number of 8080. When using the
'Initial Configuration' to initialise a new Configuration Store (either at first broker
- startup, when requesting to <link linkend="Java-Broker-Initial-Configuration-Location"
- >overwrite the configuration store</link>) these new values will be used for the
+ startup, when requesting to <link linkend="Java-Broker-Initial-Configuration-Location">overwrite the configuration store</link>) these new values will be used for the
port numbers instead. </para>
<para> NOTE: When running the broker on Windows and starting it via the qpid-server.bat
file, the "name=value" argument MUST be quoted. </para>
</section>
- <section id="Java-Broker-Initial-Configuration-Example">
+ <section xml:id="Java-Broker-Initial-Configuration-Example">
<title>Example of JSON 'Initial Configuration'</title>
<para> An example of the default 'Initial Configuration' JSON file the broker uses is
provided below:</para>
<example>
<title>JSON 'Initial configuration' File</title>
- <programlisting><![CDATA[
+ <programlisting>
{
"name": "${broker.name}",
"modelVersion": "6.0",
@@ -385,7 +364,7 @@ $ ./qpid-server -prop "qpid.amqp_port=10
"name" : "httpManagement"
} ]
}
-]]></programlisting>
+</programlisting>
<para>In the configuration above the following entries are stored: <itemizedlist>
<listitem>
<para> Authentication Provider of type
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Installation.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Installation.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Installation.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Installation.xml Mon Dec 28 22:41:23 2015
@@ -1,8 +1,4 @@
<?xml version="1.0"?>
-<!DOCTYPE entities [
-<!ENTITY % entities SYSTEM "commonEntities.xml">
-%entities;
-]>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -24,16 +20,16 @@
-->
-<chapter id="Java-Broker-Installation">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Installation">
<title>Installation</title>
- <section role="h2" id="Java-Broker-Installation-Introduction">
+ <section role="h2" xml:id="Java-Broker-Installation-Introduction">
<title>Introduction</title>
<para>This document describes how to install the Java Broker on both Windows and UNIX
platforms.</para>
</section>
- <section role="h2" id="Java-Broker-Installation-Prerequistes">
+ <section role="h2" xml:id="Java-Broker-Installation-Prerequistes">
<title>Prerequisites</title>
- <section role="h3" id="Java-Broker-Installation-Prerequistes-Java">
+ <section role="h3" xml:id="Java-Broker-Installation-Prerequistes-Java">
<title>Java Platform</title>
<para> The Java Broker is an 100% Java implementation and as such it can be used on any
operating system supporting Java 1.7 or higher<footnote><para>Java Cryptography Extension (JCE)
@@ -42,11 +38,10 @@
<para> The broker has been tested with Java implementations from both Oracle and IBM. Whatever
platform you chose, it is recommended that you ensure it is patched with any critical
updates made available from the vendor. </para>
- <para> Verify that your JVM is installed properly by following <link
- linkend="Java-Broker-Miscellaneous-JVM-Verification">these instructions.</link>
+ <para> Verify that your JVM is installed properly by following <link linkend="Java-Broker-Miscellaneous-JVM-Verification">these instructions.</link>
</para>
</section>
- <section role="h3" id="Java-Broker-Installation-Prerequistes-Disk">
+ <section role="h3" xml:id="Java-Broker-Installation-Prerequistes-Disk">
<title>Disk</title>
<para>The Java Broker installation requires approximately 20MB of free disk space.</para>
<para>The Java Broker also requires a working directory. The working directory is used for the
@@ -60,7 +55,7 @@
<para>Be aware that there are additional considerations if you are considering hosting the
working directory on NFS.</para>
</section>
- <section role="h3" id="Java-Broker-Installation-Prerequistes-Memory">
+ <section role="h3" xml:id="Java-Broker-Installation-Prerequistes-Memory">
<title>Memory</title>
<para>Qpid caches messages in memory for performance reasons, so in general, the Broker will
benefit from as much memory as possible. However, on a 32bit JVM, the maximum addressable
@@ -69,7 +64,7 @@
<para>See <xref linkend="Java-Broker-Runtime-Memory"/> for a full description of how memory is
used.</para>
</section>
- <section role="h3" id="Java-Broker-Installation-Prerequistes-OperatingSystemAccount">
+ <section role="h3" xml:id="Java-Broker-Installation-Prerequistes-OperatingSystemAccount">
<title>Operating System Account</title>
<para>Installation or operation of Qpid does <emphasis>not</emphasis> require a privileged
account (i.e. root on UNIX platforms or Administrator on Windows). However it is suggested
@@ -78,22 +73,20 @@
</section>
</section>
- <section role="h2" id="Java-Broker-Installation-Download">
+ <section role="h2" xml:id="Java-Broker-Installation-Download">
<title>Download</title>
- <section role="h3" id="Java-Broker-Installation-Download-Release">
+ <section role="h3" xml:id="Java-Broker-Installation-Download-Release">
<title>Broker Release</title>
- <para>You can download the latest Java broker package from the <ulink url="&qpidDownloadUrl;"
- >Download Page</ulink>. </para>
+ <para>You can download the latest Java broker package from the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&qpidDownloadUrl;">Download Page</link>. </para>
<para> It is recommended that you confirm the integrity of the download by verifying the PGP
signature matches that available on the site. Instructions are given on the download page.
</para>
</section>
</section>
- <section role="h2" id="Java-Broker-Installation-InstallationWindows">
+ <section role="h2" xml:id="Java-Broker-Installation-InstallationWindows">
<title>Installation on Windows</title>
- <para> Firstly, verify that your JVM is installed properly by following <link
- linkend="Java-Broker-Miscellaneous-JVM-Verification-Windows">these instructions.</link>
+ <para> Firstly, verify that your JVM is installed properly by following <link linkend="Java-Broker-Miscellaneous-JVM-Verification-Windows">these instructions.</link>
</para>
<para>Now chose a directory for Qpid broker installation. This directory will be used for the
Qpid JARs and configuration files. It need not be the same location as the work directory used
@@ -118,7 +111,7 @@
3 File(s) 31,668 bytes
5 Dir(s) 25,981,767,680 bytes free
</screen>
- <section role="h3" id="Java-Broker-Installation-InstallationWindows-SettingQPIDWORK">
+ <section role="h3" xml:id="Java-Broker-Installation-InstallationWindows-SettingQPIDWORK">
<title>Setting the working directory</title>
<para>Qpid requires a work directory. This directory is used for the default location of the
Qpid log file and is used for the storage of persistent messages. The work directory can be
@@ -126,16 +119,14 @@
want to set the environment variable permanently via the Advanced System Settings in the
Control Panel.</para>
<screen>set QPID_WORK=C:\qpidwork</screen>
- <para>If the directory referred to by <link
- linkend="Java-Broker-Appendix-Environment-Variables-Qpid-Work">QPID_WORK</link> does not
+ <para>If the directory referred to by <link linkend="Java-Broker-Appendix-Environment-Variables-Qpid-Work">QPID_WORK</link> does not
exist, the Java Broker will attempt to create it on start-up.</para>
</section>
</section>
- <section role="h2" id="Java-Broker-Installation-InstallationUnix">
+ <section role="h2" xml:id="Java-Broker-Installation-InstallationUnix">
<title>Installation on UNIX platforms</title>
- <para> Firstly, verify that your JVM is installed properly by following <link
- linkend="Java-Broker-Miscellaneous-JVM-Verification-Unix">these instructions.</link>
+ <para> Firstly, verify that your JVM is installed properly by following <link linkend="Java-Broker-Miscellaneous-JVM-Verification-Unix">these instructions.</link>
</para>
<para>Now chose a directory for Qpid broker installation. This directory will be used for the
Qpid JARs and configuration files. It need not be the same location as the work directory used
@@ -159,25 +150,23 @@ drwxrwxr-x. 2 alex alex 4096 Nov 25 11:
-rw-r--r--. 1 alex alex 3409 Nov 24 23:38 NOTICE
-rw-r--r--. 1 alex alex 116 Nov 24 23:38 README.txt
</screen>
- <section role="h3" id="Java-Broker-Installation-InstallationUnix-SettingQPIDWORK">
+ <section role="h3" xml:id="Java-Broker-Installation-InstallationUnix-SettingQPIDWORK">
<title>Setting the working directory</title>
<para>Qpid requires a work directory. This directory is used for the default location of the
Qpid log file and is used for the storage of persistent messages. The work directory can be
set on the command-line (for the lifetime of the current shell), but you will normally want
to set the environment variable permanently the user's shell profile file (~/.bash_profile
for Bash etc).</para>
- <screen><![CDATA[export QPID_WORK=/var/qpidwork]]>
+ <screen>export QPID_WORK=/var/qpidwork
</screen>
- <para>If the directory referred to by <link
- linkend="Java-Broker-Appendix-Environment-Variables-Qpid-Work">QPID_WORK</link> does not
+ <para>If the directory referred to by <link linkend="Java-Broker-Appendix-Environment-Variables-Qpid-Work">QPID_WORK</link> does not
exist, the Java Broker will attempt to create it on start-up. </para>
</section>
</section>
- <section role="h2" id="Java-Broker-Installation-OptionalDependencies">
+ <section role="h2" xml:id="Java-Broker-Installation-OptionalDependencies">
<title>Optional Dependencies</title>
<para>If you wish to utilise storage options using Oracle BDB JE or an External Database, see
- <xref linkend="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE"/> and <xref
- linkend="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver"/> for details of
+ <xref linkend="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE"/> and <xref linkend="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver"/> for details of
installing their dependencies.</para>
</section>
</chapter>
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Introduction.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Introduction.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Introduction.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Introduction.xml Mon Dec 28 22:41:23 2015
@@ -1,8 +1,4 @@
<?xml version="1.0"?>
-<!DOCTYPE chapter[
-<!ENTITY % entities SYSTEM "commonEntities.xml">
-%entities;
-]>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -24,15 +20,14 @@
-->
-<chapter id="Java-Broker-Introduction">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Introduction">
<title>Introduction</title>
<para>The Java Broker is a powerful open-source message broker that implements all versions of the
- <ulink url="http://www.amqp.org"> Advanced Message Queuing Protocol (AMQP)</ulink>. The Java
- Broker is actually one of two message brokers provided by the <ulink
- url="http://qpid.apache.org">Apache Qpid project</ulink>: the Java Broker and the C++
+ <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.amqp.org"> Advanced Message Queuing Protocol (AMQP)</link>. The Java
+ Broker is actually one of two message brokers provided by the <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://qpid.apache.org">Apache Qpid project</link>: the Java Broker and the C++
Broker.</para>
- <para>This document relates to the Java Broker. The <ulink url="&qpidCppBook;">C++ Broker is
- described separately</ulink>.</para>
+ <para>This document relates to the Java Broker. The <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&qpidCppBook;">C++ Broker is
+ described separately</link>.</para>
<para><emphasis>Headline features</emphasis></para>
<itemizedlist mark="circle">
<listitem>
@@ -73,9 +68,7 @@
<para>Client support for end to end message encryption</para>
</listitem>
<listitem>
- <para>Pluggable storage architecture with implementations including <ulink
- url="http://db.apache.org/derby/">Apache Derby</ulink>, <ulink
- url="&oracleBdbProductOverviewUrl;">Oracle BDB JE</ulink><footnote>
+ <para>Pluggable storage architecture with implementations including <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://db.apache.org/derby/">Apache Derby</link>, <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&oracleBdbProductOverviewUrl;">Oracle BDB JE</link><footnote>
<para>Oracle BDB JE must be downloaded separately.</para>
</footnote>, and External Database</para>
</listitem>
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Channels.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Channels.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Channels.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Channels.xml Mon Dec 28 22:41:23 2015
@@ -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 @@
-->
-<chapter id="Java-Broker-Management-Channel">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Management-Channel">
<title>Management Channels</title>
<para>The Broker can be managed over a number of different channels.</para>
<itemizedlist>
@@ -40,4 +40,3 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/channels/Java-Broker-Management-Channel-AMQP-Intrinsic.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/channels/Java-Broker-Management-Channel-QMF.xml"/>
</chapter>
-
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml Mon Dec 28 22:41:23 2015
@@ -1,10 +1,5 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE chapter 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
or more contributor license agreements. See the NOTICE file
@@ -25,7 +20,7 @@
-->
-<chapter id="Java-Broker-Management-Managing-Entities">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Management-Managing-Entities">
<title>Managing Entities</title>
<para>This section describes how to manage entities within the Broker. The principles underlying
entity management are the same regardless of entity type. For this reason, this section begins
@@ -33,7 +28,7 @@
<para>Since not all channels support the management of all entity type, this section commences
with a table showing which entity type is supported by each channel.</para>
- <section id="Java-Broker-Management-Managing-Entities-General">
+ <section xml:id="Java-Broker-Management-Managing-Entities-General">
<title>General Description</title>
<para>The following description applies to all entities within the Broker regardless of their
type.</para>
@@ -66,8 +61,7 @@
<listitem>
<para>The System Context entity (the ultimate ancestor of all object) has a context too.
It is read only and is populated with all Java System Properties. Thus it can be
- influenced from the Broker's external environment. See <link
- linkend="Java-Broker-Appendix-Environment-Variables-Qpid-Opts">QPID_OPTS </link>
+ influenced from the Broker's external environment. See <link linkend="Java-Broker-Appendix-Environment-Variables-Qpid-Opts">QPID_OPTS </link>
environment variable.</para>
</listitem>
<listitem>
@@ -86,34 +80,19 @@
features are described along with the entities key attributes, key context variables, details
of the entities lifecycle and any other operations.</para>
</section>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Broker.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-VirtualhostNodes.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Virtualhosts.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-RemoteReplicationNodes.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Exchanges.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Queues.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Consumers.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Ports.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Authentication-Providers.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Keystores.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Truststores.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Group-Providers.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Access-Control-Providers.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="management/managing/Java-Broker-Management-Managing-Plugins-HTTP.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Broker.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-VirtualhostNodes.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Virtualhosts.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-RemoteReplicationNodes.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Exchanges.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Queues.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Consumers.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Ports.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Authentication-Providers.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Keystores.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Truststores.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Group-Providers.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Access-Control-Providers.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="management/managing/Java-Broker-Management-Managing-Plugins-HTTP.xml"/>
</chapter>
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Runtime.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Runtime.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Runtime.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Runtime.xml Mon Dec 28 22:41:23 2015
@@ -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,15 +20,12 @@
-->
-<chapter id="Java-Broker-Runtime">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Runtime">
<title>Runtime</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="runtime/Java-Broker-Runtime-Log-Files.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="runtime/Java-Broker-Runtime-Disk-Space-Management.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
- href="runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="runtime/Java-Broker-Runtime-Disk-Space-Management.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="runtime/Java-Broker-Runtime-Producer-Transaction-Timeout.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="runtime/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="runtime/Java-Broker-Runtime-Close-On-No-Route.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="runtime/Java-Broker-Runtime-Flow-To-Disk.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="runtime/Java-Broker-Runtime-Background-Recovery.xml"/>
Modified: qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Security.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Security.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Security.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/Java-Broker-Security.xml Mon Dec 28 22:41:23 2015
@@ -20,7 +20,7 @@
-->
-<chapter id="Java-Broker-Security">
+<chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Security">
<title>Security</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security/Java-Broker-Security-Authentication-Providers.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security/Java-Broker-Security-Group-Providers.xml"/>
Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Authentication-Providers.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Authentication-Providers.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Authentication-Providers.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Authentication-Providers.xml Mon Dec 28 22:41:23 2015
@@ -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-Concepts-Authentication-Providers">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts-Authentication-Providers">
<title>Authentication Providers</title>
<para>
<emphasis>Authentication Providers</emphasis> are used by <emphasis>Ports</emphasis> to authenticate connections.
Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Broker.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Broker.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Broker.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Broker.xml Mon Dec 28 22:41:23 2015
@@ -19,7 +19,8 @@
under the License.
-->
-<section id="Java-Broker-Concepts-Broker">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts-Broker">
<title>Broker</title>
<para>The <emphasis>Broker</emphasis> is the outermost entity within the system.</para>
<para>The Broker is backed by storage. This storage is used to record the durable entities that exist beneath it.</para>
Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml Mon Dec 28 22:41:23 2015
@@ -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-Concepts-Exchanges">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts-Exchanges">
<title>Exchanges</title>
<para>An <emphasis>Exchange</emphasis> is a named entity within the <emphasis>Virtualhost</emphasis> which receives
messages from producers and routes them to matching <emphasis>Queue</emphasis>s within the <emphasis>Virtualhost</emphasis>.</para>
@@ -31,7 +31,7 @@
<para>Applications can make use of the pre-declared exchanges, or they may declare their own. The number of exchanges within a <emphasis>Virtualhost</emphasis> is
limited only by resource constraints.</para>
<para>The behaviour when an <emphasis>Exchange</emphasis> is unable to route a message to any queue is defined in <xref linkend="Java-Broker-Concepts-Exchanges-UnroutableMessage"/></para>
- <section id="Java-Broker-Concepts-Exchanges-Predeclared">
+ <section xml:id="Java-Broker-Concepts-Exchanges-Predeclared">
<title>Predeclared Exchanges</title>
<para>Each <emphasis>Virtualhost</emphasis> pre-declares the following exchanges:
<itemizedlist>
@@ -47,7 +47,7 @@
bindings within this exchange.</para>
<para>Applications may not declare exchanges with names beginning with "<literal>amq.</literal>". Such names are reserved for system use.</para>
</section>
- <section id="Java-Broker-Concepts-Exchanges-Types">
+ <section xml:id="Java-Broker-Concepts-Exchanges-Types">
<title>Exchange Types</title>
<para>
The following Exchange types are supported.
@@ -59,7 +59,7 @@
</itemizedlist>
These exchange types are described in the following sub-sections.</para>
- <section id="Java-Broker-Concepts-Exchanges-Types-Direct">
+ <section xml:id="Java-Broker-Concepts-Exchanges-Types-Direct">
<title>Direct</title>
<para>The direct exchange type routes messages to queues based on an exact match between
the routing key of the message, and the binding key used to bind the queue to the exchange. Additional
@@ -84,7 +84,7 @@
<para>The routing key of the blue message matches no binding keys, so the message is unroutable. It is handled as described
in <xref linkend="Java-Broker-Concepts-Exchanges-UnroutableMessage"/>.</para>
</section>
- <section id="Java-Broker-Concepts-Exchanges-Types-Topic">
+ <section xml:id="Java-Broker-Concepts-Exchanges-Types-Topic">
<title>Topic</title>
<para>This exchange type is used to support the classic publish/subscribe paradigm.</para>
<para>The topic exchange is capable of routing messages to queues based on wildcard matches between the routing key and the
@@ -94,7 +94,7 @@
<para>Additional filter rules may be specified using a <link linkend="Java-Broker-Concepts-Exchanges-BindingArguments-JMSSelector">
binding argument specifying a JMS message selector</link>.</para>
<para>The following three figures help explain how the topic exchange functions.</para>
- <para></para>
+ <para/>
<figure>
<title>Topic exchange - exact match on topic name</title>
<mediaobject>
@@ -141,7 +141,7 @@
<para>The properties of purple message cause no expressions to evaluate true, so the message is unroutable. It is handled as described in
<xref linkend="Java-Broker-Concepts-Exchanges-UnroutableMessage"/>.</para>
</section>
- <section id="Java-Broker-Concepts-Exchanges-Types-Fanout">
+ <section xml:id="Java-Broker-Concepts-Exchanges-Types-Fanout">
<title>Fanout</title>
<para>The fanout exchange type routes messages to all queues bound to the exchange, regardless of the message's routing key.</para>
<para>Filter rules may be specified using a <link linkend="Java-Broker-Concepts-Exchanges-BindingArguments-JMSSelector">
@@ -155,7 +155,7 @@
</mediaobject>
</figure>
</section>
- <section id="Java-Broker-Concepts-Exchanges-Types-Headers">
+ <section xml:id="Java-Broker-Concepts-Exchanges-Types-Headers">
<title>Headers</title>
<para>The headers exchange type routes messages to queues based on header properties within the message. The message is passed to
a queue if the header properties of the message satisfy the <link linkend="Java-Broker-Concepts-Exchanges-BindingArguments-x-match">
@@ -163,17 +163,17 @@
</para>
</section>
</section>
- <section id="Java-Broker-Concepts-Exchanges-BindingArguments">
+ <section xml:id="Java-Broker-Concepts-Exchanges-BindingArguments">
<title>Binding Arguments</title>
<para>Binding arguments are used by certain exchange types to further filter messages.</para>
- <section id="Java-Broker-Concepts-Exchanges-BindingArguments-JMSSelector">
+ <section xml:id="Java-Broker-Concepts-Exchanges-BindingArguments-JMSSelector">
<title>JMS Selector</title>
<para>The binding argument <literal>x-filter-jms-selector</literal> specifies a JMS selector conditional expression. The expression
is written in terms of message header and message property names. If the expression evaluates to true, the message is routed to the queue.
This type of binding argument is understood by exchange types direct, topic and fanout.<footnote><para>
This is a Qpid specific extension.</para></footnote>.</para>
</section>
- <section id="Java-Broker-Concepts-Exchanges-BindingArguments-x-match">
+ <section xml:id="Java-Broker-Concepts-Exchanges-BindingArguments-x-match">
<title>x-match</title>
<para>The binding argument <literal>x-match</literal> is understood by exchange type headers. It can take two values, dictating how the
rest of the name value pairs are treated during matching.</para>
@@ -188,7 +188,7 @@
message headers and has that same value.</para>
</section>
</section>
- <section id="Java-Broker-Concepts-Exchanges-UnroutableMessage">
+ <section xml:id="Java-Broker-Concepts-Exchanges-UnroutableMessage">
<title>Unrouteable Messages</title>
<para>If an exchange is unable to route a message to any queues, the Broker will:
<itemizedlist>
Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Other-Services.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Other-Services.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Other-Services.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Other-Services.xml Mon Dec 28 22:41:23 2015
@@ -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,41 +20,41 @@
-->
-<section id="Java-Broker-Concepts-Other-Services">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts-Other-Services">
<title>Other Services</title>
<para>
The Broker can also have <emphasis>Access Control Providers</emphasis>, <emphasis>Group Providers</emphasis>,
<emphasis>Keystores</emphasis>, <emphasis>Trustores</emphasis> and [Management] <emphasis>Plugins</emphasis> configured.
</para>
- <section id="Java-Broker-Concepts-Access-Control-Providers">
+ <section xml:id="Java-Broker-Concepts-Access-Control-Providers">
<title>Access Control Providers</title>
<para><emphasis>Access Control Providers</emphasis> are used to authorize various operations relating to Broker objects.</para>
<para>Access Control Provider configuration and management details are covered in <xref linkend="Java-Broker-Security-ACLs"/>.</para>
</section>
- <section id="Java-Broker-Concepts-Group-Providers">
+ <section xml:id="Java-Broker-Concepts-Group-Providers">
<title>Group Providers</title>
<para><emphasis>Group Providers</emphasis> are used to aggregate authenticated user principals into groups
which can be then be used in Access Control rules applicable to the whole group.</para>
<para>Group Provider configuration and management is covered in <xref linkend="Java-Broker-Security-Group-Providers"/>.</para>
</section>
- <section id="Java-Broker-Concepts-Keystores">
+ <section xml:id="Java-Broker-Concepts-Keystores">
<title>Keystores</title>
<para><emphasis>Keystores</emphasis> are used to configure SSL private and public keys and certificates
for the SSL transports on Ports.</para>
<para>Keystore configuration and management is covered in <xref linkend="Java-Broker-Management-Managing-Keystores"/>.</para>
</section>
- <section id="Java-Broker-Concepts-Truststores">
+ <section xml:id="Java-Broker-Concepts-Truststores">
<title>Truststores</title>
<para><emphasis>Truststores</emphasis> are used to configure SSL certificates for trusting Client Certificate
on SSL ports or making SSL connections to other external services like LDAP, etc.</para>
<para>Truststore configuration and management is covered in <xref linkend="Java-Broker-Management-Managing-Truststores"/>.</para>
</section>
- <section id="Java-Broker-Concepts-Loggers">
+ <section xml:id="Java-Broker-Concepts-Loggers">
<title>Loggers</title>
<para><emphasis>Loggers</emphasis> are responsible for producing a log of events from either the Broker as a whole, or
an individual Virtualhost. These are described in <xref linkend="Java-Broker-Runtime-Logging"/>.</para>
Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml Mon Dec 28 22:41:23 2015
@@ -19,7 +19,8 @@
under the License.
-->
-<section id="Java-Broker-Concepts-Overview">
+
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts-Overview">
<title>Overview</title>
<para>The Broker comprises a number of entities. This section summaries the purpose of each of
the entities and describes the relationships between them. These details are developed further
Modified: qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Ports.xml
URL: http://svn.apache.org/viewvc/qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Ports.xml?rev=1722019&r1=1722018&r2=1722019&view=diff
==============================================================================
--- qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Ports.xml (original)
+++ qpid/java/trunk/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Ports.xml Mon Dec 28 22:41:23 2015
@@ -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-Concepts-Ports">
+<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="Java-Broker-Concepts-Ports">
<title>Ports</title>
<para> The Broker supports configuration of <emphasis>Ports</emphasis> to specify the particular
AMQP messaging and HTTP management connectivity it offers for use. </para>
@@ -43,8 +43,7 @@
<para> Additionally, HTTP ports can be configured for use by the associated management
plugin. </para>
- <para>This diagram explains how Ports, <link
- linkend="Java-Broker-Concepts-Authentication-Providers">Authentication Providers</link>
+ <para>This diagram explains how Ports, <link linkend="Java-Broker-Concepts-Authentication-Providers">Authentication Providers</link>
and an Access Control Provider work together to allow an application to form a connection to
a Virtualhost.<figure>
<title>Control flow during Authentication</title>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org