Author: kwall
Date: Mon Oct 6 06:56:59 2014
New Revision: 1629579
URL: http://svn.apache.org/r1629579
Log:
QPID-6108: [Java Broker Documentation] Updates for changes made during 0.30
* Remove references to virtualhost.xml
* Rework concepts section
* Rework management section to separate means of management from management of
the entities themselves
* Remove references message stores
* Update JVM defect to Java 7
* ACL updates
* Add Flow to Disk
Still further changes required flagged by TODO.
Added:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Channels.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Background-Recovery.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Flow-To-Disk.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-Configuration-Encryption.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Authentication-Providers.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Authentication-Providers.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Broker.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Exchanges.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Exchanges.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Other-Services.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Other-Services.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Ports.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Ports.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Queues.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-RemoteReplicationNodes.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhost-Nodes.xml
qpid/trunk/qpid/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml
qpid/trunk/qpid/doc/book/src/java-broker/images/Management-Web-Auth.png
qpid/trunk/qpid/doc/book/src/java-broker/images/Management-Web-Tab.png
qpid/trunk/qpid/doc/book/src/java-broker/management/
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-AMQP-Intrinsic.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-HTTP.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-JMX.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-JMX.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-QMF.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Queues.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-Web-Console.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Access-Control-Providers.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Authentication-Providers.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Broker.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Exchanges.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Group-Providers.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Keystores.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Plugins-HTTP.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Plugins-JMX.xml
- copied, changed from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Ports.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Queues.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-RemoteReplicationNodes.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-VirtualHostNodes.xml
qpid/trunk/qpid/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml
Removed:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Authentication-Providers.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Exchanges.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Other-Services.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Ports.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Queues.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts-Virtual-Hosts.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Config-Files.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-JMX.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Console.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Web-Management.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Exchanges.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Ports.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Queues-OtherTypes.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Queues.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-SSL.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Stores-BDB-Store.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Stores-Derby-Store.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Stores-HA-BDB-Store.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Stores-Memory-Store.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Stores-SQL-Store.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Stores.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Virtual-Hosts-Configuration.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Virtual-Hosts.xml
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Installation.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Introduction.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Handling-Undeliverable-Messages.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Log-Files.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Producer-Transaction-Timeout.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-ACLs.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-Authentication-Providers.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security-Group-Providers.xml
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Security.xml
qpid/trunk/qpid/doc/book/src/java-broker/images/Broker-Model.png
qpid/trunk/qpid/doc/book/src/java-broker/images/Management-Web-Console.png
qpid/trunk/qpid/doc/book/src/java-broker/images/VirtualHost-Model.png
qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-Book.xml
qpid/trunk/qpid/doc/book/src/jms-client-0-8/JMS-Client-JMS-Extensions.xml
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml
(original)
+++
qpid/trunk/qpid/doc/book/src/java-broker/AMQP-Messaging-Broker-Java-Book.xml
Mon Oct 6 06:56:59 2014
@@ -21,25 +21,21 @@
-->
<book xmlns:xi="http://www.w3.org/2001/XInclude";>
-<title>AMQP Messaging Broker (Java)</title>
+ <title>AMQP Messaging Broker (Java)</title>
-<xi:include href="Java-Broker-Introduction.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Installation.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Getting-Started.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Concepts.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Configuring-And-Managing.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Ports.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Virtual-Hosts.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Exchanges.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Queues.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Stores.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Security.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Runtime.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-High-Availability.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Virtual-Hosts-Configuration.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Miscellaneous.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Environment-Variables.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-System-Properties.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Operational-Logging-Messages.xml"/>
-<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Queue-Alerts.xml"/>
+ <xi:include href="Java-Broker-Introduction.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Installation.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Getting-Started.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Concepts.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Initial-Configuration.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Management-Channels.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Management-Managing-Entities.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Security.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Runtime.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-High-Availability.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Miscellaneous.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Environment-Variables.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-System-Properties.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Operational-Logging-Messages.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Appendix-Queue-Alerts.xml"/>
</book>
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
(original)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
Mon Oct 6 06:56:59 2014
@@ -26,6 +26,9 @@
<appendix id="Java-Broker-Appendix-Operation-Logging">
<title>Operational Logging</title>
+
+ <para> TODO add HA operation log messages</para>
+
<para>The Broker will, by default, produce structured log messages in
response to key events in
the lives of objects within the Broker. These consise messages are
designed to allow the user to
understand the actions of the Broker in retrospect. This is valuable for
problem diagnosis and
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml
(original)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml
Mon Oct 6 06:56:59 2014
@@ -43,16 +43,6 @@
</row>
</thead>
<tbody>
- <row id="Java-Broker-Appendix-System-Properties-Shared-Msg-Group">
- <entry>qpid.shared_msg_group</entry>
- <entry>
- <literal>qpid.no-group</literal>
- </entry>
- <entry>
- <para>Controls the default group for groups operating in 'shared
groups' mode. See <xref
-
linkend="Java-Broker-Queues-OtherTypes-Message-Grouping"/></para>
- </entry>
- </row>
<row
id="Java-Broker-Appendix-System-Properties-Broker-Heartbeat-Timeout-Factor">
<entry>qpid.broker_heartbeat_timeout_factor</entry>
<entry>2</entry>
@@ -92,24 +82,6 @@
<para>If set true, the Broker will produce operational logging
messages.</para>
</entry>
</row>
- <row
id="Java-Broker-Appendix-System-Properties-Broker-Amqp-Protocol-Excludes">
- <entry>qpid.broker_default_amqp_protocol_excludes</entry>
- <entry>none</entry>
- <entry>
- <para>Controls the AMQP protocol versions supported by the Broker.
The value of this
- property is a comma separated list of AMQP protocol versions
whose support should be
- disabled.</para>
- </entry>
- </row>
- <row
id="Java-Broker-Appendix-System-Properties-Broker-Amqp-Protocol-Includes">
- <entry>qpid.broker_default_amqp_protocol_includes</entry>
- <entry>none</entry>
- <entry>
- <para>Controls the AMQP protocol versions supported by the Broker.
The value of this
- property is a comma separated list of AMQP protocol versions
whose support should be
- enabled.</para>
- </entry>
- </row>
<row
id="Java-Broker-Appendix-System-Properties-Broker-Default-Supported-Protocol-Version-Reply">
<entry>qpid.broker_default_supported_protocol_version_reply</entry>
<entry>none</entry>
Modified: qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts.xml (original)
+++ qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Concepts.xml Mon Oct
6 06:56:59 2014
@@ -20,40 +20,25 @@
-->
-<chapter id="Java-Broker-Concepts">
- <title>Concepts</title>
+<chapter id="Java-Broker-Concepts">
+ <title>Concepts</title>
- <section id="Java-Broker-Concepts-Broker">
- <title>Broker</title>
- <para>
- The Qpid Broker has one or more <emphasis>Virtual Hosts</emphasis>
(independent containers of <emphasis>Queues</emphasis>,
- <emphasis>Exchanges</emphasis>, etc) sharing a connection,
authentication, and access control model via the configured
- <emphasis>Ports</emphasis>, <emphasis>Authentication
Providers</emphasis>, <emphasis>Group providers</emphasis> and
- <emphasis>Access Control Providers</emphasis>.
<emphasis>Keystores</emphasis> and <emphasis>Truststores</emphasis> can
- be defined on the broker level and linked to
<emphasis>Ports</emphasis> configured with an SSL transport. The Broker
- also provides management plugins to allow configuring and monitoring
it.
- </para>
- <para>
- The following diagram depicts the Broker model:
- <figure>
- <title>Broker Model</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/Broker-Model.png" format="PNG"
scalefit="1"/>
- </imageobject>
- <textobject>
- <phrase>Broker Model</phrase>
- </textobject>
- </mediaobject>
- </figure>
- These concepts will be expanded upon in the forthcoming pages.
- </para>
- </section>
-
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Concepts-Virtual-Hosts.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Concepts-Exchanges.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Concepts-Queues.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Concepts-Ports.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Concepts-Authentication-Providers.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Broker-Concepts-Other-Services.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/trunk/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
(original)
+++ qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
Mon Oct 6 06:56:59 2014
@@ -34,9 +34,9 @@
</para>
<para>
For additional details about the broker configuration store and related
command line arguments see
- <xref
linkend="Java-Broker-Configuring-And-Managing-Configuration-Store"/>.
+ <xref linkend="Java-Broker-Initial-Configuration"/>.
The broker is fully configurable via its Web Management Console, for
details of this see
- <xref linkend="Java-Broker-Configuring-And-Managing-Web-Console"/>.
+ <xref linkend="Java-Broker-Management-Channel-Web-Console"/>.
</para>
</section>
<section role="h2"
id="Java-Broker-Getting-Started-Starting-Stopping-Windows">
@@ -63,7 +63,7 @@
<para>The BRK-1004 message confirms that the Broker is ready for work.
The MNG-1002 and BRK-1002 confirm the ports to
which the Broker is listening (for HTTP/JMX management and AMQP
respectively).</para>
<para>To stop the Broker, use Control-C or use the Shutdown MBean from the
- <link
linkend="Java-Broker-Configuring-And-Managing-JMX-Management">JMX management
plugin</link>.</para>
+ <link linkend="Java-Broker-Management-Channel-JMX">JMX management
plugin</link>.</para>
</section>
<section role="h2" id="Java-Broker-Getting-Started-Starting-Stopping-Unix">
<title>Starting/Stopping the broker on Unix</title>
@@ -90,7 +90,7 @@
which the Broker is listening (for HTTP/JMX management and AMQP
respectively).</para>
<para>To stop the Broker, use Control-C from the controlling shell, use the
<command>bin/qpid.stop</command> script, use <command>kill -TERM
<pid></command>, or
- the Shutdown MBean from the <link
linkend="Java-Broker-Configuring-And-Managing-JMX-Management">JMX management
plugin</link>.</para>
+ the Shutdown MBean from the <link
linkend="Java-Broker-Management-Channel-JMX">JMX management
plugin</link>.</para>
</section>
<section role="h2" id="Java-Broker-Getting-Started-LogFile">
<title>Log file</title>
@@ -105,9 +105,9 @@
<para>The Java Broker understands a number of command line options which
may be used to customise the configuration.</para>
<para>
For additional details about the broker configuration and related
command line arguments see
- <xref
linkend="Java-Broker-Configuring-And-Managing-Configuration-Store"/>.
+ <xref linkend="Java-Broker-Initial-Configuration"/>.
The broker is fully configurable via its Web Management Console, for
details of this see
- <xref linkend="Java-Broker-Configuring-And-Managing-Web-Console"/>.
+ <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>
@@ -171,5 +171,4 @@
means do not check for changes.
]]></screen>
</section>
-
</chapter>
Modified:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml
(original)
+++ qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-High-Availability.xml
Mon Oct 6 06:56:59 2014
@@ -41,9 +41,8 @@
<section role="h3" id="Java-Broker-High-Availability-OfferingsOfJavaBroker">
<title>HA offerings of the Java Broker</title>
- <para>The Java Broker's HA offering became available at release <emphasis
role="bold">0.18</emphasis>. HA is provided by way of the HA
- features built into the <ulink url="&oracleBdbProductOverviewUrl;">Java
Edition of the Berkley Database (BDB JE)</ulink> and as such
- is currently only available to Java Broker users who use the optional
BDB JE based persistence store. This
+ <para>HA is provided by way of the HA features built into the <ulink
url="&oracleBdbProductOverviewUrl;">Java Edition of the Berkley Database
+ (BDB JE)</ulink> and as such is currently only available to Java Broker
users who use the optional BDB JE based persistence store. This
<emphasis role="bold">optional</emphasis> store requires the use of BDB
JE which is licensed under the Sleepycat Licence, which is
not compatible with the Apache Licence and thus BDB JE is not
distributed with Qpid. Users who elect to use this optional store for
the broker have to provide this dependency.</para>
@@ -286,96 +285,13 @@
<section role="h3" id="Java-Broker-High-Availability-MultiNodeCluster">
<title>Multi Node Cluster</title>
- <para>Multi node clusters, that is clusters where the number of nodes is
three or more, are not yet
- ready for use.</para>
+ <para>Multi node clusters are now supported. TODO expand</para>
</section>
- <section role="h3" id="Java-Broker-High-Availability-Configuration">
- <title>Configuring a Virtual Host to be a node</title>
- <para>To configure a virtualhost as a cluster node, configure the
virtualhost.xml in the following manner:</para>
- <para>
-
- <example>
- <title>Configuring a VirtualHost to use the BDBHAMessageStore</title>
- <programlisting language="xml"><![CDATA[
-<virtualhosts>
- <virtualhost>
- <name>vhostname</name>
- <vhostname>
- <store>
- <class>org.apache.qpid.server.store.berkeleydb.BDBHAMessageStore</class>
- <environment-path>${QPID_WORK}/bdbhastore/vhostname</environment-path>
- <highAvailability>
- <groupName>myclustername</groupName>
- <nodeName>mynode1</nodeName>
- <nodeHostPort>node1host:port</nodeHostPort>
- <helperHostPort>node1host:port</helperHostPort>
- <durability>NO_SYNC\,NO_SYNC\,SIMPLE_MAJORITY</durability>
- <coalescingSync>true|false</coalescingSync>
- <designatedPrimary>true|false</designatedPrimary>
- </highAvailability>
- </store>
- ...
- </vhostname>
- </virtualhost>
-</virtualhosts>]]></programlisting>
- </example>
- </para>
- <para>The <varname>groupName</varname> is the name of logical name of the
cluster. All nodes within the
- cluster must use the same <varname>groupName</varname> in order to be
considered part of the cluster.</para>
- <para>The <varname>nodeName</varname> is the logical name of the node.
All nodes within the cluster must have a
- unique name. It is recommended that the node name should be chosen from
a different nomenclature from that of
- the servers on which they are hosted, in case the need arises to move
node to a new server in the future.</para>
- <para>The <varname>nodeHostPort</varname> is the hostname and port number
used by this node to communicate with the
- the other nodes in the cluster. For the hostname, an IP address,
hostname or fully qualified hostname may be used.
- For the port number, any free port can be used. It is important that
this address is stable over time, as BDB
- records and uses this address internally.</para>
- <para>The <varname>helperHostPort</varname> is the hostname and port
number that new nodes use to discover other
- nodes within the cluster when they are newly introduced to the cluster.
When configuring the first node, set the
- <varname>helperHostPort</varname> to its own
<varname>nodeHostPort</varname>. For the second and subsequent nodes,
- set their <varname>helperHostPort</varname> to that of the first
node.</para>
- <para><varname>durability</varname> controls the <link
linkend="Java-Broker-High-Availability-DurabilityGuarantee">durability</link>
- guarantees made by the cluster. It is important that all nodes use the
same value for this property. The default value is
- NO_SYNC\,NO_SYNC\,SIMPLE_MAJORITY. Owing to the internal use of Apache
Commons Config, it is currently necessary
- to escape the commas within the durability string.</para>
- <para><varname>coalescingSync</varname> controls the <link
linkend="Java-Broker-High-Availability-DurabilityGuarantee_CoalescingSync">coalescing-sync</link>
- mode of Qpid. It is important that all nodes use the same value. If
omitted, it defaults to true.</para>
- <para>The <varname>designatedPrimary</varname> is applicable only to the
<link linkend="Java-Broker-High-Availability-TwoNodeCluster">two-node
- case.</link> It governs the behaviour of a node when the other node
fails or becomes uncontactable. If true,
- the node will be designated as primary at startup and will be able to
continue operating as a single node master.
- If false, the node will transition to an unavailable state until a
third-party manually designates the node as
- primary or the other node is restored. It is suggested that the node that
normally fulfils the role of master is
- set true in config file and the node that is normally replica is set
false. Be aware that setting both nodes to
- true will lead to a failure to start up, as both cannot be designated at
the point of contact. Designating both
- nodes as primary at runtime (using the JMX interface) will lead to a
<link
linkend="Java-Broker-High-Availability-TwoNodeSplitBrain">split-brain</link>
- in the case of network partition and must be avoided.</para>
- <note><para>Usage of domain names in <varname>helperHostPort</varname>
and <varname>nodeHostPort</varname> is more preferebale
- over IP addresses due to the tendency of more frequent changes of the
last over the former.
- If server IP address changes but domain name remains the same the HA
cluster can continue working as normal
- in case when domain names are used in cluster configuration. In case when
IP addresses are used and they are changed with the time
- than Qpid <link linkend="Java-Broker-High-Availability-JMXAPI">JMX API
for HA</link> can be used to change the addresses or remove the nodes from the
cluster.</para></note>
-
- <section role="h4"
id="Java-Broker-High-Availability-Configuration_BDBEnvVars">
- <title>Passing BDB environment and replication configuration
options</title>
- <para>It is possible to pass BDB <ulink
url="&oracleBdbJavaDocUrl;com/sleepycat/je/EnvironmentConfig.html">environment</ulink>
and
- <ulink
url="&oracleBdbJavaDocUrl;com/sleepycat/je/rep/ReplicationConfig.html">replication</ulink>
configuration options from the
- virtualhost.xml.</para>
- <para>Environment configuration options are passed as described in <xref
linkend="Java-Broker-Stores-BDB-Store-Configuration_BDBEnvVars"/></para>
- <para>Replication configuration option are passed using
<varname>repConfig</varname> elements with the <varname>store</varname>
element.</para>
- <para>For example, to override the BDB replication configuration option
<varname>je.rep.electionsPrimaryRetries</varname>.</para>
- <programlisting language="xml"><![CDATA[
- ...
- </highAvailability>
- ...
- <repConfig>
- <name>je.rep.electionsPrimaryRetries</name>
- <value>3</value>
- </repConfig>
- ...
- </store>]]></programlisting>
- </section>
+ <section role="h3" id="Java-Broker-High-Availability-Creating-A-Grouop">
+ <title>Creating a Group</title>
+ <para>TODO</para>
</section>
-
<section role="h3" id="Java-Broker-High-Availability-DurabilityGuarantee">
<title>Durability Guarantees</title>
<para>The term <ulink
url="http://en.wikipedia.org/wiki/ACID#Durability";>durability</ulink> is used
to mean that once a
@@ -482,9 +398,9 @@
the value greater than 1000 milliseconds. If it is desired that clients
re-connect automatically after a
master to replica failure, <varname>cyclecount</varname> should be tuned
so that the retry period is longer than
the expected length of time to perform the failover.</para>
- <example><title>Example of connection URL for the HA
Cluster</title><![CDATA[
+ <example><title>Example of connection URL for the HA
Cluster</title><para><![CDATA[
amqp://guest:guest@clientid/test?brokerlist='tcp://localhost:5672?connectdelay='2000'&retries='3';tcp://localhost:5671?connectdelay='2000'&retries='3';tcp://localhost:5673?connectdelay='2000'&retries='3''&failover='roundrobin?cyclecount='30''
- ]]></example>
+ ]]></para></example>
</section>
@@ -706,8 +622,7 @@ Current state of node: Node-5001 from gr
<para>In case when a Replica goes down (or falls behind the Master in 2
node cluster where the Master is designated primary)
and the Master continues running, the non-replicated store files are kept
on the Masters disk for the period of time
as specified in <emphasis>je.rep.repStreamTimeout</emphasis> JE setting in
order to replicate this data later
- when the Replica is back. This setting is set to 1 hour by default by the
broker. The setting can be overridden as described in
- <xref
linkend="Java-Broker-High-Availability-Configuration_BDBEnvVars"/>.</para>
+ when the Replica is back. This setting is set to 1 hour by default by the
broker.</para>
<para>Depending from the application publishing/consuming rates and
message sizes,
the disk space might become overfull during this period of time due to
preserved logs.
Please, make sure to allocate enough space on your disk to avoid this from
happening.
Added:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml?rev=1629579&view=auto
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml
(added)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml
Mon Oct 6 06:56:59 2014
@@ -0,0 +1,360 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<chapter id="Java-Broker-Initial-Configuration">
+ <title>Initial Configuration</title>
+
+
+ <section 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 perfomed 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 databadse or an in-memory store which does not.
The following
+ components configuration is stored there: <itemizedlist>
+ <listitem>
+ <para>Broker</para>
+ </listitem>
+ <listitem>
+ <para>Virtual Host</para>
+ </listitem>
+ <listitem>
+ <para>Port</para>
+ </listitem>
+ <listitem>
+ <para>Authentication Provider</para>
+ </listitem>
+ <listitem>
+ <para>Access Control Provider</para>
+ </listitem>
+ <listitem>
+ <para>Group Provider</para>
+ </listitem>
+ <listitem>
+ <para>Key store</para>
+ </listitem>
+ <listitem>
+ <para>Trust store</para>
+ </listitem>
+ <listitem>
+ <para>Plugin</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <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
+ 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">
+ <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
+ otherwise instructed. </para>
+ <para> The command line argument <emphasis>-sp</emphasis> (or
+ <emphasis>--store-path</emphasis>) can optionally be used to
specify a different
+ relative or absolute path to use for the broker configuration
store: </para>
+ <screen>
+$ ./qpid-server -sp ./my-broker-configuration.json
+ </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
+ Configuration'</link>. </para>
+ </section>
+
+ <section id="Java-Broker-Initial-Configuration-Initial-Config-Location">
+ <title>'Initial Configuration' Location</title>
+ <para> The 'Initial Configuration' JSON file is used when
initialiasing 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
+ 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
+ store</link>
+ </para>
+ </section>
+
+ <section 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'
+ file to disk using the command line argument
<emphasis>-cic</emphasis> (or
+ <emphasis>--create-initial-config</emphasis>). If the option
is used without
+ providing a path, a file called
<emphasis>initial-config.json</emphasis> will be created
+ in the current directory, or alternatively the file can be created
at a specified
+ location: </para>
+ <screen>
+$ ./qpid-server -cic ./initial-config.json
+ </screen>
+
+ <para> The 'Initial Configuration' JSON file shares a common format
with the brokers JSON
+ Configuration Store implementation, so it is possible to use a
brokers Configuration
+ 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
+ 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-Configuring-And-Managing-Configuration-Initial-Config-Example"
+ />
+ </para>
+
+ </section>
+
+ <section 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
+ 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
+ configuration store to be initialised from the current 'Initial
Configuration' even if
+ one exists: </para>
+ <screen>
+$ ./qpid-server -os -icp ./my-initial-configuration.json
+ </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
+ also be useful. </para>
+ </section>
+
+ <section id="Java-Broker-Initial-Configuration-Type">
+ <title>Configuration Store Type</title>
+ <para> There are currently two implementations of the pluggable Broker
Configuration Store,
+ the default one which persists content to disk in a JSON file, and
another which
+ 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
+ Configuration'</link> to provide the configuration to start
the broker with. </para>
+ <para> The command line argument <emphasis>-st</emphasis> (or
+ <emphasis>--store-type</emphasis>) can be used to override the
default
+ <emphasis>json</emphasis>)configuration store type and allow
choosing an alterative,
+ such as <emphasis>memory</emphasis>) </para>
+ <screen>
+$ ./qpid-server -st memory
+ </screen>
+ <para> This can be useful when running tests, or always wishing to
start the broker with the
+ same <link
linkend="Java-Broker-Initial-Configuration-Initial-Config-Location">'Initial
+ Configuration'</link>
+ </para>
+ </section>
+
+ <section id="Java-Broker-Initial-Configuration-Configuration-Properties">
+ <title>Customising Configuration using Configuration Properties</title>
+ <para> It is posible for 'Initial Configuration' (and Configuration
Store) files to contain
+ ${properties} that can be resolved to String values at startup,
allowing a degree of
+ customisation using a fixed file. Configuration Property values
can be set either via
+ Java System Properties, or by specifying ConfigurationPproperties
on the broker command
+ line. If both are defined, System Property values take precedence.
</para>
+
+ <para> The broker has the following set of core configuration
properties, with the indicated
+ default values if not otherwise configured by the user: <table>
+ <title>Base Configuration Properties</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry> Name </entry>
+ <entry> Description </entry>
+ <entry> Value </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry> qpid.amqp_port </entry>
+ <entry> Port number used for the brokers default
AMQP messaging port </entry>
+ <entry> "5672" </entry>
+ </row>
+ <row>
+ <entry> qpid.http_port </entry>
+ <entry> Port number used for the brokers default
HTTP management port </entry>
+ <entry> "8080" </entry>
+ </row>
+ <row>
+ <entry> qpid.rmi_port </entry>
+ <entry> Port number used for the brokers default
RMI Registry port, to
+ advertise the JMX ConnectorServer. </entry>
+ <entry> "8999" </entry>
+ </row>
+ <row>
+ <entry> qpid.jmx_port </entry>
+ <entry> Port number used for the brokers default
JMX port </entry>
+ <entry> "9099" </entry>
+ </row>
+ <row>
+ <entry> qpid.home_dir </entry>
+ <entry> Location of the broker installation
directory, which contains
+ the 'lib' directory and the 'etc' directory
often used to store
+ files such as group and ACL files. </entry>
+ <entry> Defaults to the value set into the
QPID_HOME system property if
+ it is set, or remains unset otherwise unless
configured by the user.
+ </entry>
+ </row>
+ <row>
+ <entry> qpid.work_dir </entry>
+ <entry> Location of the broker working directory,
which might contain
+ the persistent message store and broker
configuration store files. </entry>
+ <entry> Defaults to the value set into the
QPID_WORK system property if
+ it is set, or the 'work' subdirectory of the
JVMs current working
+ directory. </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+
+ <para> Use of these core properties can be seen in the <link
+
linkend="Java-Broker-Configuring-And-Managing-Configuration-Initial-Config-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>)
+ command line argument: </para>
+
+ <screen>
+$ ./qpid-server -prop "qpid.amqp_port=10000" -prop "qpid.http_port=10001"
+ </screen>
+ <para> In the example above, property used to set the port number of
the default AMQP port
+ is specified with the value 10000, overriding the default value of
5672, and similarly
+ the vlaue 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
+ 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-Configuring-And-Managing-Configuration-Initial-Config-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[
+{
+ "name": "${broker.name}",
+ "modelVersion": "2.0",
+ "defaultVirtualHost" : "default",
+ "authenticationproviders" : [ {
+ "name" : "passwordFile",
+ "type" : "PlainPasswordFile",
+ "path" : "${qpid.home_dir}${file.separator}etc${file.separator}passwd",
+ "preferencesproviders" : [{
+ "name": "fileSystemPreferences",
+ "type": "FileSystemPreferences",
+ "path" : "${qpid.work_dir}${file.separator}user.preferences.json"
+ }]
+ } ],
+ "ports" : [ {
+ "name" : "AMQP",
+ "port" : "${qpid.amqp_port}",
+ "authenticationProvider" : "passwordFile"
+ }, {
+ "name" : "HTTP",
+ "port" : "${qpid.http_port}",
+ "authenticationProvider" : "passwordFile",
+ "protocols" : [ "HTTP" ]
+ }, {
+ "name" : "RMI_REGISTRY",
+ "port" : "${qpid.rmi_port}",
+ "protocols" : [ "RMI" ]
+ }, {
+ "name" : "JMX_CONNECTOR",
+ "port" : "${qpid.jmx_port}",
+ "authenticationProvider" : "passwordFile",
+ "protocols" : [ "JMX_RMI" ]
+ }],
+ "virtualhostnodes" : [ {
+ "name" : "default",
+ "type" : "JSON",
+ "virtualHostInitialConfiguration" : "{ \"type\" : \"DERBY\" }"
+ } ],
+ "plugins" : [ {
+ "type" : "MANAGEMENT-HTTP",
+ "name" : "httpManagement"
+ }, {
+ "type" : "MANAGEMENT-JMX",
+ "name" : "jmxManagement"
+ } ]
+}
+]]></programlisting>
+ <para>In the configuration above the following entries are stored:
<itemizedlist>
+ <listitem>
+ <para> Authentication Provider of type
+ <emphasis>PlainPasswordFile</emphasis> with
name "passwordFile".
+ </para>
+ </listitem>
+ <listitem>
+ <para> Four Port entries: "AMQP", "HTTP",
"RMI_REGISTRY", "JMX_CONNECTOR".
+ </para>
+ </listitem>
+ <listitem>
+ <para> Virtualhost Node called default. On initial
startup, it
+ virtualHostInitialConfiguration will cause a
virtualhost to be created
+ with the same name. The confiuration will be
stored in a
+ <emphasis>JSON</emphasis> configuration store,
the message data will
+ be stored in a <emphasis>DERBY</emphasis> message
store.</para>
+ </listitem>
+ <listitem>
+ <para>Two management plugins: "jmxManagement" of type
"MANAGEMENT-JMX" and
+ "httpManagement" of type "MANAGEMENT-HTTP".</para>
+ </listitem>
+ <listitem>
+ <para>Broker attributes are stored as a root
entry.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </example>
+ </section>
+
+</chapter>
Modified: qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Installation.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Installation.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Installation.xml
(original)
+++ qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Installation.xml Mon
Oct 6 06:56:59 2014
@@ -35,43 +35,43 @@
<title>Prerequisites</title>
<section role="h3" 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.6 or higher. This includes Linux, Solaris,
Mac OS X, and Windows XP/Vista/7/8.</para>
- <para>
- The broker has been tested with Java implementations from both Oracle
and IBM. Whatever
- platform you chose, it is recommended that you ensure it is patched
with any critical updates made
- available from the vendor.
- </para>
- <para>
- Verify that your JVM is installed properly by following <link
linkend="Java-Broker-Miscellaneous-JVM-Verification">these instructions.</link>
+ <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. This includes Linux,
Solaris, Mac OS X, and
+ Windows XP/Vista/7/8.</para>
+ <para> The broker has been tested with Java implementations from both
Oracle and IBM. Whatever
+ platform you chose, it is recommended that you ensure it is patched
with any critical
+ updates made available from the vendor. </para>
+ <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">
<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 message store, that is, the area of the file-system used to record
persistent messages whilst they
- are passing through the Broker. The working directory is also used
for the default location of the log file.
- The size of the working directory will depend on the how the Broker is
used.</para>
- <para>The performance of the file system hosting the work directory is
key to the performance of Broker as
- a whole. For best performance, choose a device that has low latency
and one that is uncontended by other
- applications.</para>
- <para>Be aware that there are additional considerations if you are
considering hosting the working directory on NFS. See
- <xref linkend="Java-Broker-Stores"/> for further details.</para>
+ <para>The Java Broker also requires a working directory. The working
directory is used for the
+ message store, that is, the area of the file-system used to record
persistent messages
+ whilst they are passing through the Broker. The working directory is
also used for the
+ default location of the log file. The size of the working directory
will depend on the how
+ the Broker is used.</para>
+ <para>The performance of the file system hosting the work directory is
key to the performance
+ of Broker as a whole. For best performance, choose a device that has
low latency and one
+ that is uncontended by other applications.</para>
+ <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">
<title>Memory</title>
<para>Qpid caches messages on the heap for performance reasons, so in
general, the Broker will
- benefit from as much heap as possible. However, on a 32bit JVM, the
maximum addressable memory range
- for a process is 4GB, after leaving space for the JVM's own use this
will give a maximum heap size
- of approximately ~3.7GB.</para>
+ benefit from as much heap as possible. However, on a 32bit JVM, the
maximum addressable
+ memory range for a process is 4GB, after leaving space for the JVM's
own use this will give
+ a maximum heap size of approximately ~3.7GB.</para>
</section>
<section role="h3"
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
that you use an dedicated account
- (e.g. qpid) for the installation and operation of the Java Broker.</para>
+ <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
+ that you use an dedicated account (e.g. qpid) for the installation and
operation of the Java
+ Broker.</para>
</section>
</section>
@@ -79,33 +79,28 @@
<title>Download</title>
<section role="h3" 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> It is recommended that you confirm the integrity of the download
by verifying the PGP signature
- matches that available on the site. Instrutions are given on the
download page.
- </para>
- </section>
- <section role="h3"
id="Java-Broker-Installation-Download-OptionalDependencies">
- <title>Optional Dependencies</title>
- <para>The broker has an optional message store implementations backed by
Oracle BDB JE. If you wish to use these
- stores you will need to provide the optional Oracle BDB JE dependency.
For more details, see <xref linkend="Java-Broker-Stores-BDB-Store"></xref>
+ <para>You can download the latest Java broker package from the <ulink
url="&qpidDownloadUrl;"
+ >Download Page</ulink>. </para>
+ <para> It is recommended that you confirm the integrity of the download
by verifying the PGP
+ signature matches that available on the site. Instrutions are given on
the download page.
</para>
</section>
</section>
<section role="h2" 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 for the
persistent message store or the log file (you will choose this
- location later). For the remainder this example we will assume that
location c:\qpid has been chosen.</para>
- <para>Next extract the &windowsBrokerDownloadFileName; package into the
directory, using either the zip file handling offered
- by Windows (right click the file and select 'Extract All') or a third
party tool of your choice.</para>
- <para>The extraction of the broker package will have created a directory
&windowsExtractedBrokerDirName; within c:\qpid</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
+ for the persistent message store or the log file (you will choose this
location later). For
+ the remainder this example we will assume that location c:\qpid has been
chosen.</para>
+ <para>Next extract the &windowsBrokerDownloadFileName; package into the
directory, using either
+ the zip file handling offered by Windows (right click the file and
select 'Extract All') or a
+ third party tool of your choice.</para>
+ <para>The extraction of the broker package will have created a directory
+ &windowsExtractedBrokerDirName; within c:\qpid</para>
<screen>
Directory of c:\qpid\&windowsExtractedBrokerDirName;
@@ -120,36 +115,34 @@
</screen>
<section role="h3"
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 set on the
- command-line (for the lifetime of the command interpreter), but you
will normally want to set
- the environment variable permanently via the Advanced System Settings
in the Control Panel.</para>
+ <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 command interpreter),
but you will normally
+ 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 exist, the Java Broker will attempt to create it
- on start-up.</para>
- </section>
- <section role="h3"
id="Java-Broker-Installation-InstallationWindows-OptionalDependencies">
- <title>Optional Dependencies</title>
- <para>The broker has optional message store implementations backed by
Oracle BDB JE. If you wish to use these
- stores you will need to provide the optional Oracle BDB JE dependency.
For more details, see <xref linkend="Java-Broker-Stores-BDB-Store"></xref>
- </para>
+ <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">
<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 for the
persistent message store or the log file (you will choose this
- location later). For the remainder this example we will assume that
location /usr/local/qpid has been chosen.</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
+ for the persistent message store or the log file (you will choose this
location later). For
+ the remainder this example we will assume that location /usr/local/qpid
has been
+ chosen.</para>
<para>Next extract the &unixBrokerDownloadFileName; package into the
directory.</para>
<programlisting>mkdir /usr/local/qpid
cd /usr/local/qpid
tar xvzf &unixBrokerDownloadFileName;</programlisting>
- <para>The extraction of the broker package will have created a directory
&unixExtractedBrokerDirName; within /usr/local/qpid</para>
+ <para>The extraction of the broker package will have created a directory
+ &unixExtractedBrokerDirName; within /usr/local/qpid</para>
<screen>ls -la &unixExtractedBrokerDirName;/
total 152
drwxr-xr-x 8 qpid qpid 272 25 Jul 23:22 .
@@ -163,21 +156,23 @@ drwxr-xr-x 34 qpid qpid 1156 25 Jul
</screen>
<section role="h3"
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>
+ <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>
- <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 role="h3"
id="Java-Broker-Installation-InstallationUnix-OptionalDependencies">
- <title>Optional Dependencies</title>
- <para>The broker has an optional message store implementations backed by
Oracle BDB JE. If you wish to use these
- stores you will need to provide the optional Oracle BDB JE dependency.
For more details, see <xref linkend="Java-Broker-Stores-BDB-Store"></xref>
- </para>
+ <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">
+ <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
+ installing their dependencies.</para>
+ </section>
</chapter>
Modified: qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Introduction.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Introduction.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Introduction.xml
(original)
+++ qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Introduction.xml Mon
Oct 6 06:56:59 2014
@@ -67,11 +67,11 @@
External, and file-based authentication mechanisms.</para>
</listitem>
<listitem>
- <para>Pluggable message store architecture with implementations based on
<ulink
+ <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>Oracle BDB JE must be downloaded separately.</para>
- </footnote>, and Memory Store</para>
+ </footnote>, and External Database</para>
</listitem>
<listitem>
<para>Web based management interface and programmatic management
interfaces via REST and JMX
Added:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Channels.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Channels.xml?rev=1629579&view=auto
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Channels.xml
(added)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Channels.xml
Mon Oct 6 06:56:59 2014
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<chapter id="Java-Broker-Management-Channel">
+ <title>Management Channels</title>
+ <para>The Broker can be managed over a number of different channels.</para>
+ <itemizedlist>
+ <listitem>
+ <para>HTTP - The primary channel for management. The HTTP interace
comprises of a Web
+ Console and a REST API.</para>
+ </listitem>
+ <listitem>
+ <para>JMX - The Broker provides a JMX compilent management interface.
This is not currently
+ undergoing further development and is retained largely for backward
compatibility. It is
+ suggested the new users favour the Web Console/REST API.</para>
+ </listitem>
+ <listitem>
+ <para>AMQP - The AMQP protocols 0-8..0-10 allow for some management of
Exchanges, Queue and
+ Bindings. This will be superceded by AMQP 1.0 Management. It is
suggested that new users
+ favour the Management facilities provided by the Web Console/REST
API.</para>
+ </listitem>
+ </itemizedlist>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/channels/Java-Broker-Management-Channel-HTTP.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/channels/Java-Broker-Management-Channel-Web-Console.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/channels/Java-Broker-Management-Channel-REST-API.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/channels/Java-Broker-Management-Channel-JMX.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/channels/Java-Broker-Management-Channel-AMQP-Intrinsic.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="management/channels/Java-Broker-Management-Channel-QMF.xml"/>
+</chapter>
+
Added:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml?rev=1629579&view=auto
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
(added)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Management-Managing-Entities.xml
Mon Oct 6 06:56:59 2014
@@ -0,0 +1,114 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<chapter 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
+ with a general description that applies to all.</para>
+ <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">
+ <title>General Description</title>
+ <para>The following description applies to all entities within the Broker
regardless of their
+ type.</para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>All entities have a parent, and may have children. The parent
of the Broker is
+ called the System Context. It has no parent.</para>
+ </listitem>
+ <listitem>
+ <para>Entities have one or more attributes. For example a
<literal>name</literal>, an
+ <literal>id</literal> or a
<literal>maximumQueueDepth</literal></para>
+ </listitem>
+ <listitem>
+ <para>Entities can be durable or non-durable. Durable entities
survive a restart.
+ Non-durable entities will not.</para>
+ </listitem>
+ <listitem>
+ <para>Attributes may have a default value. If an attribute value is
not specified the
+ default value is used.</para>
+ </listitem>
+ <listitem>
+ <para>Attributes values can be expressed as a simple value (e.g.
<literal>myName</literal>
+ or <literal>1234</literal>), in terms of context variables
+ (e.g.<literal>${foo}</literal> or
<literal>/data/${foo}/</literal>).</para>
+ </listitem>
+ <listitem>
+ <para>Each entity has own zero or more context variables.</para>
+ </listitem>
+ <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>
+ environment variable.</para>
+ </listitem>
+ <listitem>
+ <para>When resolving an attribute's value, if the value contains a
variable
+ (e.g.<literal>${foo}</literal>), the variable is first resolved
using the entity's own
+ context variables. If the entity has no definition for the context
variable, the
+ entity's parent is tried, then its grandparent and so forth, all
the way until the
+ SystemContext is reached.</para>
+ </listitem>
+ <listitem>
+ <para>Some entities support state and have a lifecycle.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>What follows now is a section dedicated to each entity type. For
each entity type key
+ 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-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-Plugins-JMX.xml"/>
+</chapter>
Modified: qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml?rev=1629579&r1=1629578&r2=1629579&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml
(original)
+++ qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Miscellaneous.xml Mon
Oct 6 06:56:59 2014
@@ -31,50 +31,73 @@
<title>JVM Installation verification</title>
<section role="h2" id="Java-Broker-Miscellaneous-JVM-Verification-Windows">
<title>Verify JVM on Windows</title>
- <para>
- Firstly confirm that the JAVA_HOME environment variable is set
correctly by typing the
- following at the command prompt:
- </para>
+ <para> Firstly confirm that the JAVA_HOME environment variable is set
correctly by typing the
+ following at the command prompt: </para>
<programlisting><![CDATA[echo %JAVA_HOME%]]></programlisting>
- <para>
- If JAVA_HOME is set you will see something similar to the following:
- </para>
- <screen><![CDATA[c:"\PROGRA~1"\Java\jdk1.6.0_24\]]>
+ <para> If JAVA_HOME is set you will see something similar to the
following: </para>
+ <screen><![CDATA[c:"\PROGRA~1"\Java\jdk1.7.0_60\]]>
</screen>
- <para>
- Then confirm that a Java installation (1.6 or higher) is available:
- </para>
+ <para> Then confirm that a Java installation (1.7 or higher) is
available: </para>
<programlisting><![CDATA[java -version]]></programlisting>
- <para>
- If java is available on the path, output similar to the following will
be seen:
- </para>
- <screen><![CDATA[java version "1.6.0_24"
-Java(TM) SE Runtime Environment (build 1.6.0_24-b07)
-Java HotSpot(TM) 64-Bit Server VM (build 19.1-b02, mixed mode)]]></screen>
+ <para> If java is available on the path, output similar to the following
will be seen: </para>
+ <screen><![CDATA[java version "1.7.0_60"
+Java(TM) SE Runtime Environment (build 1.7.0_60-b19)
+Java HotSpot(TM) 64-Bit Server VM (build 24.60-b09, mixed mode)]]></screen>
</section>
<section role="h2" id="Java-Broker-Miscellaneous-JVM-Verification-Unix">
<title>Verify JVM on Unix</title>
- <para>
- Firstly confirm that the JAVA_HOME environment variable is set
correctly by typing the
- following at the command prompt:
- </para>
+ <para> Firstly confirm that the JAVA_HOME environment variable is set
correctly by typing the
+ following at the command prompt: </para>
<programlisting><![CDATA[echo $JAVA_HOME]]></programlisting>
- <para>
- If JAVA_HOME is set you will see something similar to the following:
- </para>
- <screen><![CDATA[/usr/java/jdk1.6.0_35]]>
+ <para> If JAVA_HOME is set you will see something similar to the
following: </para>
+ <screen><![CDATA[/usr/java/jdk1.7.0_60]]>
</screen>
- <para>
- Then confirm that a Java installation (1.6 or higher) is available:
- </para>
+ <para> Then confirm that a Java installation (1.7 or higher) is
available: </para>
<programlisting><![CDATA[java -version]]></programlisting>
- <para>
- If java is available on the path, output similar to the following will
be seen:
- </para>
- <screen><![CDATA[java version "1.6.0_35"
-Java(TM) SE Runtime Environment (build 1.6.0_35-b10-428-11M3811)
-Java HotSpot(TM) 64-Bit Server VM (build 20.10-b01-428, mixed mode)]]></screen>
+ <para> If java is available on the path, output similar to the following
will be seen: </para>
+ <screen><![CDATA[java version "1.7.0_60"
+Java(TM) SE Runtime Environment (build 1.7.0_60-b19)
+Java HotSpot(TM) 64-Bit Server VM (build 24.60-b09, mixed mode)]]></screen>
</section>
</section>
+ <section role="h2"
id="Java-Broker-Miscellaneous-Installing-External-JDBC-Driver">
+ <title>Installing External JDBC Driver</title>
+ <para>In order to use a JDBC Virtualhost Node or a JDBC Virtualhost, you
must make the
+ Database's JDBC 4.0 compatible drivers available on the Broker's
classpath. To do this copy
+ the driver's JAR file into the <literal>${QPID_HOME}/lib/opt</literal>
folder.</para>
+ <programlisting>Unix:
+cp <literal>driver</literal>.jar
qpid-broker-&qpidCurrentRelease;/lib/opt</programlisting>
+
+ <programlisting>Windows:
+copy <literal>driver</literal>.jar
qpid-broker-&qpidCurrentRelease;\lib\opt</programlisting>
+
+ </section>
+ <section role="h2" id="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE">
+ <title>Installing Oracle BDB JE</title>
+ <para> The Oracle BDB JE is not distributed with Apache Qpid owing to
license considerations.. </para>
+ <para>If you wish to use a BDB Virtualhost Node, BDB Virtualhost, or BDB
HA Virtualhost Node you
+ must make the BDB JE's JDBC 4.0 compatible drivers= available on the
Broker's classpath. </para>
+ <para> Download the Oracle BDB JE &oracleBdbProductVersion; release <ulink
+ url="&oracleJeDownloadUrl;">from the Oracle website.</ulink>
+ </para>
+ <para> The download has a name in the form
je-&oracleBdbProductVersion;.tar.gz. It is
+ recommended that you confirm the integrity of the download by verifying
the MD5. </para>
+ <para>Copy the je-&oracleBdbProductVersion;.jar from within the release
into
+ <literal>${QPID_HOME}/lib/opt</literal> folder.</para>
+
+ <programlisting>Unix:
+cp je-&oracleBdbProductVersion;.jar
qpid-broker-&qpidCurrentRelease;/lib/opt</programlisting>
+
+ <programlisting>Windows:
+copy je-&oracleBdbProductVersion;.jar
qpid-broker-&qpidCurrentRelease;\lib\opt</programlisting>
+
+ </section>
+
+
+
+
+
+
+
</chapter>
Copied:
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Background-Recovery.xml
(from r1629242,
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml)
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Background-Recovery.xml?p2=qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Background-Recovery.xml&p1=qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml&r1=1629242&r2=1629579&rev=1629579&view=diff
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-Other-Tooling.xml
(original)
+++
qpid/trunk/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Background-Recovery.xml
Mon Oct 6 06:56:59 2014
@@ -20,7 +20,7 @@
-->
-<section id="Java-Broker-Configuring-And-Managing-Other-Tooling">
-<title>Other Tooling</title>
-
+<section id="Java-Broker-Runtime-Background-Recovery">
+ <title>Background Recovery</title>
+ <para>TODO-QPID-5907</para>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org
For additional commands, e-mail: commits-h...@qpid.apache.org
