You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by or...@apache.org on 2015/11/26 15:07:51 UTC
svn commit: r1716666 - in /qpid/java/branches/6.0.x: ./
doc/book/src/java-broker/ doc/book/src/java-broker/concepts/
doc/book/src/java-broker/management/channels/
doc/book/src/java-broker/management/managing/
doc/book/src/java-broker/runtime/
Author: orudyy
Date: Thu Nov 26 14:07:51 2015
New Revision: 1716666
URL: http://svn.apache.org/viewvc?rev=1716666&view=rev
Log:
QPID-6805: [Java Broker Documentation] Updates to reflect changes during course of v6.0
------------------------------------------------------------------------
Merged from trunk with command:
svn merge -c r1716087 https://svn.apache.org/repos/asf/qpid/java/trunk
Modified:
qpid/java/branches/6.0.x/ (props changed)
qpid/java/branches/6.0.x/doc/book/src/java-broker/ (props changed)
qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Installation.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Introduction.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Broker.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Keystores.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Ports.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml
qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml
Propchange: qpid/java/branches/6.0.x/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Thu Nov 26 14:07:51 2015
@@ -9,5 +9,5 @@
/qpid/branches/java-broker-vhost-refactor/java:1493674-1494547
/qpid/branches/java-network-refactor/qpid/java:805429-821809
/qpid/branches/qpid-2935/qpid/java:1061302-1072333
-/qpid/java/trunk:1715445-1715447,1715586,1715940,1716086
+/qpid/java/trunk:1715445-1715447,1715586,1715940,1716086-1716087
/qpid/trunk/qpid:796646-796653
Propchange: qpid/java/branches/6.0.x/doc/book/src/java-broker/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Thu Nov 26 14:07:51 2015
@@ -7,4 +7,4 @@
/qpid/branches/mcpierce-QPID-4719/qpid/doc/book/src/java-broker:1477004-1477093
/qpid/branches/qpid-2935/qpid/doc/book/src/java-broker:1061302-1072333
/qpid/branches/qpid-3346/qpid/doc/book/src/java-broker:1144319-1179855
-/qpid/java/trunk/doc/book/src/java-broker:1716086
+/qpid/java/trunk/doc/book/src/java-broker:1716086-1716087
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml Thu Nov 26 14:07:51 2015
@@ -69,8 +69,8 @@
user id used by the client (myapp1), their IP, ephemeral port number and the name of the virtual
host. The message text itself gives us further details about the connection: the client id, the
protocol version in used, and details of the client's qpid library.</para>
- <screen>[con:8(myapp1@/127.0.0.1:52851/default)] CON-1001 : Open : Client ID : clientid :
- Protocol Version : 0-10 : Client Version : &qpidCurrentRelease; : Client Product : qpid</screen>
+ <screen>[con:8(myapp1@/127.0.0.1:52851/default)] CON-1001 : Open : Destination : AMQP(127.0.0.1:5672) :
+ Protocol Version : 0-10 : Client ID : myapp1 : Client Version : &qpidCurrentRelease; : Client Product : qpid</screen>
<para><literal><link linkend="Java-Broker-Appendix-Operation-Logging-Message-QUE-1001"
>QUE-1001</link></literal> is used when a queue is created. The connection actor
<literal>con</literal> tells us details of the connection performing the queue creation: the
@@ -78,7 +78,7 @@
host. The queue subject tells use the queue's name (myqueue) and the virtualhost. The message
itself tells us more information about the queue that is being created. </para>
- <screen>[con:8(myapp1@/127.0.0.1:52851/default)/ch:0] [vh(/default)/qu(myqueue)] QUE-1001 : Create : Owner: clientid Transient</screen>
+ <screen>[con:8(myapp1@/127.0.0.1:52851/default)/ch:0] [vh(/default)/qu(myqueue)] QUE-1001 : Create : Owner: myapp1 Transient</screen>
<para>The first two tables that follow describe the actor and subject entities, then the later
provide a complete catalogue of all supported messages.</para>
<table pgwide="1" id="Java-Broker-Appendix-Operation-Logging-Actor-Format">
@@ -314,16 +314,6 @@
<para>Indicates the name of the configuration store in use by the Broker.</para>
</entry>
</row>
- <row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1007">
- <entry morerows="1">BRK-1007</entry>
- <entry>Using logging configuration : <replaceable>file</replaceable>
- </entry>
- </row>
- <row>
- <entry>
- <para>Indicates the name of the log configuration file in use by the Broker.</para>
- </entry>
- </row>
<row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1008">
<entry morerows="1">BRK-1008</entry>
<entry><replaceable>delivered|received</replaceable> : <replaceable>size</replaceable>
@@ -344,6 +334,38 @@
<para>Statistic - messages delivered or received by the Broker.</para>
</entry>
</row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1010">
+ <entry morerows="1">BRK-1010</entry>
+ <entry>Platform : JVM : <replaceable>vendor</replaceable> version: <replaceable>version
+ </replaceable> OS : <replaceable>operating system vendor</replaceable> version:
+ <replaceable>operating system version</replaceable>} arch: <replaceable>processor
+ architecture</replaceable> cores: <replaceable>number of CPU cores</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Key information about the environment hosting the Broker</para>
+ </entry>
+ </row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1011">
+ <entry morerows="1">BRK-1011</entry>
+ <entry>Maximum Memory : Heap : <replaceable>size</replaceable> bytes Direct : <replaceable>
+ bytes</replaceable> size</entry></row>
+ <row>
+ <entry>
+ <para>Configured memory paramters for the Broker.</para>
+ </entry>
+ </row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1012">
+ <entry morerows="1">BRK-1012</entry>
+ <entry>Management Mode : User Details : <replaceable>management node user id</replaceable> /
+ <replaceable>management mode password</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Used when Broker is started in management mode to indicate the
+ management credentials that may be used connect to the Broker.</para>
+ </entry>
+ </row>
<row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1014">
<entry morerows="1">BRK-1014</entry>
<entry>Message flow to disk active : Message memory use <replaceable>size of all
@@ -352,11 +374,10 @@
</row>
<row>
<entry>
- <para>Indicates that the heap memory space occupied by messages has exceeded the
+ <para>Indicates that the memory space occupied by messages has exceeded the
threshold so the flow to disk feature has been activated.</para>
</entry>
</row>
-
<row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1015">
<entry morerows="1">BRK-1015</entry>
<entry>Message flow to disk inactive : Message memory use <replaceable>size of all
@@ -365,7 +386,7 @@
</row>
<row>
<entry>
- <para>Indicates that the heap memory space occupied by messages has fallen below the
+ <para>Indicates that the memory space occupied by messages has fallen below the
threshold so the flow to disk feature has been deactivated.</para>
</entry>
</row>
@@ -613,6 +634,30 @@
linkend="Qpid-Producer-Flow-Control"/> for details.</para>
</entry>
</row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1014">
+ <entry morerows="1">QUE-1014</entry>
+ <entry>Message flow to disk active : Message memory use <replaceable>size of all
+ messages</replaceable> exceeds threshold <replaceable>threshold
+ size</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that the memory space occupied by messages for this queue
+ has exceeded thevthreshold so the flow to disk feature has been activated.</para>
+ </entry>
+ </row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1015">
+ <entry morerows="1">QUE-1015</entry>
+ <entry>Message flow to disk inactive : Message memory use <replaceable>size of all
+ messages</replaceable> within threshold <replaceable>threshold
+ size</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that the memory space occupied by messages for this queue has fallen
+ below the threshold so the flow to disk feature has been deactivated.</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -707,10 +752,10 @@
<tbody>
<row id="Java-Broker-Appendix-Operation-Logging-Message-CON-1001">
<entry morerows="1">CON-1001</entry>
- <entry>Open : Client ID : <replaceable>clientid</replaceable> : Protocol Version :
- <replaceable>protocol version</replaceable> : Client Version : <replaceable>client
- version</replaceable> : Client Product :<replaceable>client
- product</replaceable></entry>
+ <entry>Open : Destination : <replaceable>target port</replaceable> : Protocol Version :
+ <replaceable>protocol version</replaceable> : Client ID : <replaceable>clientid</replaceable> :
+ Client Version : <replaceable>client version</replaceable> :
+ Client Product : <replaceable>client product</replaceable></entry>
</row>
<row>
<entry>
@@ -739,6 +784,47 @@
a heartbeat for too long and is therefore closed as being inactive. </para>
</entry>
</row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-CON-1004">
+ <entry morerows="1">CON-1004</entry>
+ <entry>Connection dropped</entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that a connection has been unexpectedly closed by the peer. This usually
+ occurs if a machine hosting an application fails or the application's process is
+ abruptly terminated.</para>
+ </entry>
+ </row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-CON-1005">
+ <entry morerows="1">CON-1005</entry>
+ <entry>Client version <replaceable>version</replaceable> logged by validation</entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that a connection has been received from client with a version number
+ that is configured to be logged. This feature may help teams manage software currency.</para>
+ </entry>
+ </row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-CON-1006">
+ <entry morerows="1">CON-1006</entry>
+ <entry>Client version <replaceable>version</replaceable> rejected by validation</entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that a connection attempt has been received from client with a version number
+ that is configured to be rejected. This feature may help manage software currency.</para>
+ </entry>
+ </row>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-CON-1007">
+ <entry morerows="1">CON-1007</entry>
+ <entry>Connection close initiated by operator</entry>
+ </row>
+ <row>
+ <entry>
+ <para>Indicates that a connection has been closed by the actions of an
+ Operator using manangement.</para>
+ </entry>
+ </row>
</tbody>
</tgroup>
</table>
@@ -938,7 +1024,7 @@
<para>Indicates that a subscription has been in a suspened state for an unusual length
of time. This may be indicative of an consuming application that has stopped taking
messages from the consumer (i.e. a JMS application is not calling receive() or its
- asynchronous message listener onMessage() is block in application code). It may also
+ asynchronous message listener onMessage() is blocked in application code). It may also
indicate a generally overloaded system.
</para>
</entry>
@@ -1401,14 +1487,24 @@
</row>
<row id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1005">
<entry morerows="1">PRT-1005</entry>
- <entry>Connection from <replaceable>host</replaceable> rejected</entry>
+ <entry>Connection from <replaceable>peer</replaceable> rejected. Maximum connection count (<replaceable>limit</replaceable>) for this port already reached.</entry>
</row>
<row>
<entry>
<para>Connection from given host is rejected because of reaching the maximum allowed limit</para>
</entry>
</row>
- </tbody>
+ <row id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1007">
+ <entry morerows="1">PRT-1007</entry>
+ <entry>Unsupported protocol header received, replying with <replaceable>AMQP version</replaceable></entry>
+ </row>
+ <row>
+ <entry>
+ <para>Ususualy indicates an attempt to make an non-AMQP connection on an AMQP port, for instance,
+ with a web browser.</para>
+ </entry>
+ </row>
+ </tbody>
</tgroup>
</table>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Appendix-System-Properties.xml Thu Nov 26 14:07:51 2015
@@ -64,17 +64,6 @@
linkend="Java-Broker-Runtime-Handling-Undeliverable-Messages-Dead-Letter-Queues"/>
feature. Governs the suffix used when generating a name for a Dead Letter Queue.</entry>
</row>
- <row>
- <entry>qpid.broker_msg_auth</entry>
- <entry>false</entry>
- <entry>
- <para>If set true, the Broker ensures that the user id of each received message matches
- the user id of the producing connection. If this check fails, the message is returned
- to the producer's connection with a 403 (Access Refused) error code.</para>
- <para>This is check is currently not enforced when using AMQP 0-10 and 1-0
- protocols.</para>
- </entry>
- </row>
<row id="Java-Broker-Appendix-System-Properties-Broker-Status-Updates">
<entry>qpid.broker_status_updates</entry>
<entry>true</entry>
@@ -82,15 +71,6 @@
<para>If set true, the Broker will produce operational logging messages.</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>
- <entry>
- <para>Used during protocol negotiation. If set, the Broker will offer this AMQP version
- to a client requesting an AMQP protocol that is not supported by the Broker. If not set, the
- Broker offers the highest protocol version it supports.</para>
- </entry>
- </row>
<row id="Java-Broker-Appendix-System-Properties-Broker-Disabled-Features">
<entry>qpid.broker_disabled_features</entry>
<entry>none</entry>
@@ -123,14 +103,6 @@
<para>It is not recommended to change this property from its default value.</para>
</entry>
</row>
- <row id="Java-Broker-Appendix-System-Properties-Broker-Log-Record-Buffer-Size">
- <entry>qpid.broker_log_records_buffer_size</entry>
- <entry>4096</entry>
- <entry>
- <para>Controls the number of recent Broker log entries that remain viewable online via
- the HTTP Management interface.</para>
- </entry>
- </row>
</tbody>
</tgroup>
</table>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Getting-Started.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Getting-Started.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Getting-Started.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Getting-Started.xml Thu Nov 26 14:07:51 2015
@@ -48,8 +48,8 @@
<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
-[Broker] BRK-1010 : Platform : JVM : Oracle Corporation version: 1.7.0_21-b11 OS : Windows 7 version: 6.1 arch: x86
-[Broker] BRK-1011 : Maximum Memory : 1,060,372,480 bytes
+[Broker] BRK-1010 : Platform : JVM : Oracle Corporation version: 1.7.0_79-b15 OS : Windows 7 version: 6.1 arch: x86 cores: 4
+[Broker] BRK-1011 : Maximum Memory : Heap : 518,979,584 bytes Direct : 1,610,612,736 bytes
[Broker] BRK-1002 : Starting : Listening on TCP port 5672
[Broker] MNG-1001 : JMX Management Startup
[Broker] MNG-1002 : Starting : RMI Registry : Listening on port 8999
@@ -59,7 +59,7 @@
[Broker] MNG-1002 : Starting : HTTP : Listening on port 8080
[Broker] MNG-1004 : Web Management Ready
[Broker] BRK-1004 : Qpid Broker Ready</screen>
- <para>The BRK-1004 message confirms that the Broker is ready for work. The MNG-1002 and BRK-1002 confirm the ports to
+ <para>The BRK-1004 message confirms that the Broker is ready for work. The MNG-1002 and BRK-1002 confirm the ports on
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-Management-Channel-JMX">JMX management plugin</link>.</para>
@@ -73,8 +73,8 @@
<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
-[Broker] BRK-1010 : Platform : JVM : Sun Microsystems Inc. version: 1.6.0_32-b05 OS : Linux version: 3.6.10-2.fc16.x86_64 arch: amd64
-[Broker] BRK-1011 : Maximum Memory : 1,065,025,536 bytes
+[Broker] BRK-1010 : Platform : JVM : Oracle Corporation version: 1.7.0_79-b15 OS : Mac OS X version: 10.10.5 arch: x86_64 cores: 4
+[Broker] BRK-1011 : Maximum Memory : Heap : 518,979,584 bytes Direct : 1,610,612,736 bytes
[Broker] BRK-1002 : Starting : Listening on TCP port 5672
[Broker] MNG-1001 : Web Management Startup
[Broker] MNG-1002 : Starting : HTTP : Listening on port 8080
@@ -84,7 +84,7 @@
[Broker] MNG-1002 : Starting : JMX RMIConnectorServer : Listening on port 9099
[Broker] MNG-1004 : JMX Management Ready
[Broker] BRK-1004 : Qpid Broker Ready</screen>
- <para>The BRK-1004 message confirms that the Broker is ready for work. The MNG-1002 and BRK-1002 confirm the ports to
+ <para>The BRK-1004 message confirms that the Broker is ready for work. The MNG-1002 and BRK-1002 confirm the ports on
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
@@ -109,59 +109,69 @@
</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>] [-l <file>] [-mm] [-mmhttp <port>]
- [-mmjmx <port>] [-mmpass <password>] [-mmqv] [-mmrmi <port>] [-os]
- [-sp <path>] [-st <type>] [-v] [-w <period>]
- -cic <path> Create a copy of the initial config
- --create-initial-config <path> file, either to an optionally specified
- file path, or as initial-config.json
- in the current directory
-
- -h, Print this message
- --help
-
- -icp <path> Set the location of initial JSON config
- --initial-config-path <path> to use when creating/overwriting a
- broker configuration store
-
- -mm Start broker in management mode,
- --management-mode disabling the AMQP ports
-
- -mmhttp <port> Override http management port in
- --management-mode-http-port <port> management mode
-
- -mmjmx Override jmx connector port in
- --management-mode-jmx-connector-port <port> management mode
-
- -mmpass <password> Set the password for the management
- --management-mode-password <password> mode user mm_admin
-
- -mmqv Make virtualhosts stay in the quiesced
- --management-mode-quiesce-virtualhosts state during management mode.
-
- -mmrmi <port> Override jmx rmi registry port in
- --management-mode-rmi-registry-port <port> management mode
-
- -os Overwrite the broker configuration store
- --overwrite-store with the current initial configuration
-
- -prop "<name=value>" Set a configuration property to use when
- --config-property "<name=value>" resolving variables in the broker
- configuration store, with format
- "name=value"
-
- -sp <path> Use given configuration store location
- --store-path <path>
-
- -st <type> Use given broker configuration store type
- --store-type <type>
-
- -v Print the version information and exit
- --version
-
- -w <period> Monitor the log file configuration file
- --logwatch <period> for changes. Units are seconds. Zero
- means do not check for changes.
+ <screen><![CDATA[usage: Qpid [-cic <path>] [-h] [-icp <path>] [-mm] [-mmhttp <port>]
+ [-mmjmx <port>] [-mmpass <password>] [-mmqv] [-mmrmi <port>] [-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
+ file path, or as
+ initial-config.json
+ in the current
+ directory
+ -h,--help print this message
+ -icp,--initial-config-path <path> set the location of
+ initial JSON config
+ to use when
+ creating/overwriting
+ a broker
+ configuration store
+ -mm,--management-mode start broker in
+ management mode,
+ disabling the AMQP
+ ports
+ -mmhttp,--management-mode-http-port <port> override http
+ management port in
+ management mode
+ -mmjmx,--management-mode-jmx-connector-port <port> override jmx
+ connector port in
+ management mode
+ -mmpass,--management-mode-password <password> Set the password for
+ the management mode
+ user mm_admin
+ -mmqv,--management-mode-quiesce-virtualhosts make virtualhosts
+ stay in the quiesced
+ state during
+ management mode.
+ -mmrmi,--management-mode-rmi-registry-port <port> override jmx rmi
+ registry port in
+ management mode
+ -os,--overwrite-store overwrite the broker
+ configuration store
+ with the current
+ initial
+ 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
+ initial properties
+ file to set
+ otherwise unset
+ system properties
+ -sp,--store-path <path> use given
+ configuration store
+ location
+ -st,--store-type <type> use given broker
+ configuration store
+ type
+ -v,--version print the version
+ information and exit
]]></screen>
</section>
</chapter>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Initial-Configuration.xml Thu Nov 26 14:07:51 2015
@@ -37,7 +37,10 @@
<para>Broker</para>
</listitem>
<listitem>
- <para>Virtual Host</para>
+ <para>Virtual Host Nodes</para>
+ </listitem>
+ <listitem>
+ <para>Loggers</para>
</listitem>
<listitem>
<para>Port</para>
@@ -129,7 +132,7 @@ $ ./qpid-server -cic ./initial-config.js
</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
+ Configuration Store implementation, so it is possible to use a Broker's 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
@@ -283,8 +286,7 @@ $ ./qpid-server -prop "qpid.amqp_port=10
<programlisting><![CDATA[
{
"name": "${broker.name}",
- "modelVersion": "2.0",
- "defaultVirtualHost" : "default",
+ "modelVersion": "6.0",
"authenticationproviders" : [ {
"name" : "passwordFile",
"type" : "PlainPasswordFile",
@@ -295,10 +297,60 @@ $ ./qpid-server -prop "qpid.amqp_port=10
"path" : "${qpid.work_dir}${file.separator}user.preferences.json"
}]
} ],
+ "brokerloggers" : [ {
+ "name" : "logfile",
+ "type" : "File",
+ "fileName" : "${qpid.work_dir}${file.separator}log${file.separator}qpid.log",
+ "brokerloginclusionrules" : [ {
+ "name" : "Root",
+ "type" : "NameAndLevel",
+ "level" : "WARN",
+ "loggerName" : "ROOT"
+ }, {
+ "name" : "Qpid",
+ "type" : "NameAndLevel",
+ "level" : "INFO",
+ "loggerName" : "org.apache.qpid.*"
+ }, {
+ "name" : "Operational",
+ "type" : "NameAndLevel",
+ "level" : "INFO",
+ "loggerName" : "qpid.message.*"
+ } ]
+ }, {
+ "name" : "memory",
+ "type" : "Memory",
+ "brokerloginclusionrules" : [ {
+ "name" : "Root",
+ "type" : "NameAndLevel",
+ "level" : "WARN",
+ "loggerName" : "ROOT"
+ }, {
+ "name" : "Qpid",
+ "type" : "NameAndLevel",
+ "level" : "INFO",
+ "loggerName" : "org.apache.qpid.*"
+ }, {
+ "name" : "Operational",
+ "type" : "NameAndLevel",
+ "level" : "INFO",
+ "loggerName" : "qpid.message.*"
+ } ]
+ } ],
"ports" : [ {
"name" : "AMQP",
"port" : "${qpid.amqp_port}",
- "authenticationProvider" : "passwordFile"
+ "authenticationProvider" : "passwordFile",
+ "virtualhostaliases" : [ {
+ "name" : "nameAlias",
+ "type" : "nameAlias"
+ }, {
+ "name" : "defaultAlias",
+ "type" : "defaultAlias"
+ }, {
+ "name" : "hostnameAlias",
+ "type" : "hostnameAlias"
+ } ]
}, {
"name" : "HTTP",
"port" : "${qpid.http_port}",
@@ -317,7 +369,8 @@ $ ./qpid-server -prop "qpid.amqp_port=10
"virtualhostnodes" : [ {
"name" : "default",
"type" : "JSON",
- "virtualHostInitialConfiguration" : "{ \"type\" : \"DERBY\" }"
+ "defaultVirtualHostNode" : "true",
+ "virtualHostInitialConfiguration" : "${qpid.initial_config_virtualhost_config}"
} ],
"plugins" : [ {
"type" : "MANAGEMENT-HTTP",
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Installation.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Installation.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Installation.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Installation.xml Thu Nov 26 14:07:51 2015
@@ -37,7 +37,7 @@
<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)
- Unlimited Strength required for some features</para></footnote>. This includes Linux, Solaris, Mac OS X, and
+ Unlimited Strength policy file are required for some features</para></footnote>. 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
@@ -50,7 +50,7 @@
<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
+ message store, that is, the area of the file-system used to record 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>
@@ -62,10 +62,12 @@
</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
+ <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
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>
+ a maximum usable size of approximately ~3.7GB.</para>
+ <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">
<title>Operating System Account</title>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Introduction.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Introduction.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Introduction.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/Java-Broker-Introduction.xml Thu Nov 26 14:07:51 2015
@@ -67,6 +67,12 @@
External, and file-based authentication mechanisms.</para>
</listitem>
<listitem>
+ <para>Support for message compression</para>
+ </listitem>
+ <listitem>
+ <para>Client support for end to end message encryption</para>
+ </listitem>
+ <listitem>
<para>Pluggable storage architecture with implementations including <ulink
url="http://db.apache.org/derby/">Apache Derby</ulink>, <ulink
url="&oracleBdbProductOverviewUrl;">Oracle BDB JE</ulink><footnote>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Overview.xml Thu Nov 26 14:07:51 2015
@@ -21,7 +21,7 @@
-->
<section id="Java-Broker-Concepts-Overview">
<title>Overview</title>
- <para>The Broker comprises of a number of entities. This section summaries the purpose of each of
+ <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
in the sub-sections that follow.</para>
<para>The most important entity is the <emphasis>Virtualhost</emphasis>. A virtualhost is an
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/concepts/Java-Broker-Concepts-Virtualhosts.xml Thu Nov 26 14:07:51 2015
@@ -30,7 +30,7 @@
<para>A virtualhost is identified by a name which must be unique broker-wide. Clients use the name
to identify the virtualhost to which they wish to connect when they connect.</para>
<para>A virtualhost exists in a container called a virtualhost node.</para>
- <para>The virtualhost comprises of a number of entities. This section summaries the purpose of
+ <para>The virtualhost comprises a number of entities. This section summaries the purpose of
each of the entities and describes the relationships between them. These details are developed
further in the sub-sections that follow.</para>
<para><emphasis>Exchanges</emphasis> is a named entity within the Virtual Host which receives
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/management/channels/Java-Broker-Management-Channel-REST-API.xml Thu Nov 26 14:07:51 2015
@@ -35,6 +35,7 @@
the URL is <literal>/api/<version></literal> where <version> is a major model version prefixed with "v", for example, v3.
For convenience the alias <literal>latest</literal> (<literal>/api/latest</literal>) signifies the latest supported version.
There are also some ancillary services under URI <literal>/service</literal>.</para>
+ <para>The remainder of this section will assume you are using the <literal>/api/latest</literal> form.</para>
</section>
<section id="Java-Broker-Management-Channel-REST-API-URI">
@@ -54,7 +55,6 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/broker</para></listitem>
- <listitem><para>/api/<version>/broker</para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -65,9 +65,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/virtualhostnode</para></listitem>
- <listitem><para>/api/<version>/virtualhostnode</para></listitem>
<listitem><para>/api/latest/virtualhostnode/<virtual host node name></para></listitem>
- <listitem><para>/api/<version>/virtualhostnode/<virtual host node name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -78,11 +76,8 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/virtualhost</para></listitem>
- <listitem><para>/api/<version>/virtualhost</para></listitem>
<listitem><para>/api/latest/virtualhost/<virtual host node name></para></listitem>
- <listitem><para>/api/<version>/virtualhost/<virtual host node name></para></listitem>
<listitem><para>/api/latest/virtualhost/<virtual host node name>/<virtual host name></para></listitem>
- <listitem><para>/api/<version>/virtualhost/<virtual host node name>/<virtual host name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -93,13 +88,9 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/queue</para></listitem>
- <listitem><para>/api/<version>/queue</para></listitem>
<listitem><para>/api/latest/queue/<virtual host node name></para></listitem>
- <listitem><para>/api/<version>/queue/<virtual host node name></para></listitem>
<listitem><para>/api/latest/queue/<virtual host node name>/<virtual host name></para></listitem>
- <listitem><para>/api/<version>/queue/<virtual host node name>/<virtual host name></para></listitem>
<listitem><para>/api/latest/queue/<virtual host node name>/<virtual host name>/<queue name></para></listitem>
- <listitem><para>/api/<version>/queue/<virtual host node name>/<virtual host name>/<queue name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -110,13 +101,9 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/exchange</para></listitem>
- <listitem><para>/api/<version>/exchange</para></listitem>
<listitem><para>/api/latest/exchange/<virtual host node name></para></listitem>
- <listitem><para>/api/<version>/exchange/<virtual host node name></para></listitem>
<listitem><para>/api/latest/exchange/<virtual host node name>/<virtual host name></para></listitem>
- <listitem><para>/api/<version>/exchange/<virtual host node name>/<virtual host name></para></listitem>
<listitem><para>/api/latest/exchange/<virtual host node name>/<virtual host name>/<exchange name></para></listitem>
- <listitem><para>/api/<version>/exchange/<virtual host node name>/<virtual host name>/<exchange name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -127,15 +114,10 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/binding</para></listitem>
- <listitem><para>/api/<version>/binding</para></listitem>
<listitem><para>/api/latest/binding/<virtual host node name></para></listitem>
- <listitem><para>/api/<version>/binding/<virtual host node name></para></listitem>
<listitem><para>/api/latest/binding/<virtual host node name>/<virtual host name></para></listitem>
- <listitem><para>/api/<version>/binding/<virtual host node name>/<virtual host name></para></listitem>
<listitem><para>/api/latest/binding/<virtual host node name>/<virtual host name>/<exchange name></para></listitem>
- <listitem><para>/api/<version>/binding/<virtual host node name>/<virtual host name>/<exchange name></para></listitem>
<listitem><para>/api/latest/binding/<virtual host node name>/<virtual host name>/<exchange name>/<queue name>/<binding name></para></listitem>
- <listitem><para>/api/<version>/binding/<virtual host node name>/<virtual host name>/<exchange name>/<queue name>/<binding name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -146,32 +128,19 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/connection</para></listitem>
- <listitem><para>/api/<version>/connection</para></listitem>
- <listitem><para>/api/latest/connection/<virtual host node name></para></listitem>
- <listitem><para>/api/<version>/connection/<virtual host node name></para></listitem>
- <listitem><para>/api/latest/connection/<virtual host node name>/<virtual host name></para></listitem>
- <listitem><para>/api/<version>/connection/<virtual host node name>/<virtual host node name></para></listitem>
- <listitem><para>/api/latest/connection/<virtual host node name>/<virtual host name>/<connection name></para></listitem>
- <listitem><para>/api/<version>/connection/<virtual host node name>/<virtual host node name>/<connection name></para></listitem>
+ <listitem><para>/api/latest/connection/<connection name></para></listitem>
</itemizedlist>
</entry>
<entry>
- <para>Manages (deletes) Connection(s) on VirtualHost and provides current values of Connection attributes and its Sessions</para>
+ <para>Manages (deletes) AMQP Connection(s) and provides current values of Connection attributes and its Sessions</para>
</entry>
</row>
<row>
<entry>
<itemizedlist>
<listitem><para>/api/latest/session</para></listitem>
- <listitem><para>/api/<version>/session</para></listitem>
- <listitem><para>/api/latest/session/<virtual host node name></para></listitem>
- <listitem><para>/api/<version>/session/<virtual host node name></para></listitem>
- <listitem><para>/api/latest/session/<virtual host node name>/<virtual host name></para></listitem>
- <listitem><para>/api/<version>/session/<virtual host node name>/<virtual host node name></para></listitem>
- <listitem><para>/api/latest/session/<virtual host node name>/<virtual host name>/<connection name></para></listitem>
- <listitem><para>/api/<version>/session/<virtual host node name>/<virtual host node name>/<connection name</para></listitem>
- <listitem><para>/api/latest/session/<virtual host node name>/<virtual host name>/<connection name>/<session name></para></listitem>
- <listitem><para>/api/<version>/session/<virtual host node name>/<virtual host node name>/<connection name>/<session name></para></listitem>
+ <listitem><para>/api/latest/session/<connection name></para></listitem>
+ <listitem><para>/api/latest/session/<connection name>/<session name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -182,9 +151,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/port</para></listitem>
- <listitem><para>/api/<version>/port</para></listitem>
<listitem><para>/api/latest/port/<port name></para></listitem>
- <listitem><para>/api/<version>/port/<port name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -195,9 +162,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/authenticationprovider</para></listitem>
- <listitem><para>/api/<version>/authenticationprovider</para></listitem>
<listitem><para>/api/latest/authenticationprovider/<authentication provider name></para></listitem>
- <listitem><para>/api/<version>/authenticationprovider/<authentication provider name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -208,11 +173,8 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/user</para></listitem>
- <listitem><para>/api/<version>/user</para></listitem>
<listitem><para>/api/latest/user/<authentication provider name>/<user name></para></listitem>
- <listitem><para>/api/<version>/user/<authentication provider name>/<user name></para></listitem>
<listitem><para>/api/latest/user/<authentication provider name>/<user name></para></listitem>
- <listitem><para>/api/<version>/user/<authentication provider name>/<user name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -223,9 +185,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/accesscontrolprovider</para></listitem>
- <listitem><para>/api/<version>/accesscontrolprovider</para></listitem>
<listitem><para>/api/latest/accesscontrolprovider/<access control provider name></para></listitem>
- <listitem><para>/api/<version>/accesscontrolprovider/<access control provider name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -236,9 +196,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/groupprovider</para></listitem>
- <listitem><para>/api/<version>/groupprovider</para></listitem>
<listitem><para>/api/latest/groupprovider/<group provider name></para></listitem>
- <listitem><para>/api/<version>/groupprovider/<group provider name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -249,11 +207,8 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/group</para></listitem>
- <listitem><para>/api/<version>/group</para></listitem>
<listitem><para>/api/latest/group/<group provider name></para></listitem>
- <listitem><para>/api/<version>/group/<group provider name></para></listitem>
<listitem><para>/api/latest/group/<group provider name>/<group name></para></listitem>
- <listitem><para>/api/<version>/group/<group provider name>/<group name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -264,13 +219,9 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/groupmember</para></listitem>
- <listitem><para>/api/<version>/groupmember</para></listitem>
<listitem><para>/api/latest/groupmember/<group provider name></para></listitem>
- <listitem><para>/api/<version>/groupmember/<group provider name></para></listitem>
<listitem><para>/api/latest/groupmember/<group provider name>/<group name></para></listitem>
- <listitem><para>/api/<version>/groupmember/<group provider name>/<group name></para></listitem>
<listitem><para>/api/latest/groupmember/<group provider name>/<group name>/<user name></para></listitem>
- <listitem><para>/api/<version>/groupmember/<group provider name>/<group name>/<user name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -281,9 +232,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/keystore</para></listitem>
- <listitem><para>/api/<version>/keystore</para></listitem>
<listitem><para>/api/latest/keystore/<key store name></para></listitem>
- <listitem><para>/api/<version>/keystore/<key store name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -294,9 +243,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/truststore</para></listitem>
- <listitem><para>/api/<version>/truststore</para></listitem>
<listitem><para>/api/latest/truststore/<trust store name></para></listitem>
- <listitem><para>/api/<version>/truststore/<trust store name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -307,11 +254,8 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/preferencesprovider</para></listitem>
- <listitem><para>/api/<version>/preferencesprovider</para></listitem>
- <listitem><para>/api/latest/preferencesprovider/<authentication provider name></para></listitem>
- <listitem><para>/api/<version>/preferencesprovider/<authentication provider name></para></listitem>
+= <listitem><para>/api/latest/preferencesprovider/<authentication provider name></para></listitem>
<listitem><para>/api/latest/preferencesprovider/<authentication provider name>/<preferences provider name></para></listitem>
- <listitem><para>/api/<version>/preferencesprovider/<authentication provider name>/<preferences provider name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -322,9 +266,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/plugin</para></listitem>
- <listitem><para>/api/<version>/plugin</para></listitem>
<listitem><para>/api/latest/plugin/<plugin name></para></listitem>
- <listitem><para>/api/<version>/plugin/<plugin name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -335,11 +277,8 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/remotereplicationnode</para></listitem>
- <listitem><para>/api/<version>/remotereplicationnode</para></listitem>
<listitem><para>/api/latest/remotereplicationnode/<virtual host node name></para></listitem>
- <listitem><para>/api/<version>/remotereplicationnode/<virtual host node name></para></listitem>
<listitem><para>/api/latest/remotereplicationnode/<virtual host node name>/<replication node name></para></listitem>
- <listitem><para>/api/<version>/remotereplicationnode/<virtual host node name>/<replication node name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -350,9 +289,7 @@
<entry>
<itemizedlist>
<listitem><para>/api/latest/(broker|virtualhost)logger</para></listitem>
- <listitem><para>/api/<version>/(broker|virtualhost)logger</para></listitem>
<listitem><para>/api/latest/(broker|virtualhost)logger/<logger name></para></listitem>
- <listitem><para>/api/<version>/(broker|virtualhost)logger/<logger name></para></listitem>
</itemizedlist>
</entry>
<entry>
@@ -491,6 +428,18 @@
</varlistentry>
</variablelist>
</section>
+ <section id="Java-Broker-Management-Channel-REST-API-Operations">
+ <title>Configured Object operations</title>
+ <para>Method POST is used to invoke Configured Objects operations. Some operations
+ support parameters. Pass parameters using a JSON request body containing a map with
+ a map entry for each parameter.
+ </para>
+ <example>
+ <title>Example of REST call to invoke the Queue clear queue operation</title>
+ <para>To clear the queue with name "my-queue" on a virtual host with name "vh".</para>
+ <screen><![CDATA[POST api/latest/queue/default/vhn/vh/my-queue/clearQueue HTTP/1.1]]></screen>
+ </example>
+ </section>
<section id="Java-Broker-Management-Channel-REST-API-Status-Codes">
<title>HTTP status codes returned by REST interfaces</title>
<table>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Broker.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Broker.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Broker.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Broker.xml Thu Nov 26 14:07:51 2015
@@ -39,9 +39,9 @@
Heartbeats help discover severed TCP/IP connections in a timely manner.</para>
</listitem>
<listitem>
- <para><emphasis>Confidential configuration encryption provider</emphasis>. The name of
- the provider used to encrypt passwords and other secrets within the configuration. See
- <xref linkend="Java-Broker-Security-Configuration-Encryption"/>.</para>
+ <para><emphasis>Confidential configuration encryption provider</emphasis>. The name of the
+ provider used to encrypt passwords and other secrets within the configuration. See <xref
+ linkend="Java-Broker-Security-Configuration-Encryption"/>.</para>
</listitem>
</itemizedlist>
</para>
@@ -58,6 +58,29 @@
<para><emphasis>broker.messageCompressionEnabled</emphasis> Controls the <link
linkend="Java-Broker-Runtime-Message-Compression">message compression</link> .</para>
</listitem>
+ <listitem id="Java-Broker-Management-Managing-Broker-Context-StoreFilesystemMaxUsagePercent">
+ <para><emphasis>store.filesystem.maxUsagePercent</emphasis> Maximum percentage of space
+ that may be utilised on a filesystem hosting a virtualhost's message store before
+ producer flow control is automatically imposed.</para>
+ <para>This defaults to 90%.</para>
+ </listitem>
+ <listitem
+ id="Java-Broker-Management-Managing-Broker-Context-BrokerDefaultSupportedProtocolVersionReply">
+ <para><emphasis>qpid.broker_default_supported_protocol_version_reply</emphasis> Used
+ during protocol negotiation. If set, the Broker will offer this AMQP version to a client
+ requesting an AMQP protocol that is not supported by the Broker. If not set, the Broker
+ offers the highest protocol version it supports. </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>qpid.broker_msg_auth</emphasis> If set true, the Broker ensures that the user
+ id of each received message matches the user id of the producing connection. If this
+ check fails, the message is returned to the producer's connection with a 403 (Access
+ Refused) error code.</para>
+ <para>This is check is currently not enforced when using AMQP 0-10 and 1-0
+ protocols.</para>
+ <para>Defaults to false.</para>
+ </listitem>
</itemizedlist>
</para>
</section>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Entities-Matrix.xml Thu Nov 26 14:07:51 2015
@@ -130,7 +130,12 @@
<entry>No</entry>
<entry>No</entry>
</row>
-
+ <row>
+ <entry>Loggers</entry>
+ <entry>C/U/D</entry>
+ <entry>Limited</entry>
+ <entry>No</entry>
+ </row>
</tbody>
</tgroup>
</table>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Keystores.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Keystores.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Keystores.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Keystores.xml Thu Nov 26 14:07:51 2015
@@ -26,17 +26,56 @@
<section id="Java-Broker-Management-Managing-Keystores">
<title>Keystores</title>
- <para>A <link linkend="Java-Broker-Concepts-Keystores">Keystore</link> is required by a Port
- in order to use SSL.</para>
+ <para>A <link linkend="Java-Broker-Concepts-Keystores">Keystore</link> is required by a Port in
+ order to use SSL for messaging and/or management.</para>
+ <para>The Broker supports a number of different keystore types. These are described
+ below.</para>
+ <para>The key material may be held by the Broker itself (held inline within the configuration)
+ or you may use references to files on the server's file system. Whichever mechanism is
+ chosen it is imperative to ensure that private key material remains confidential.</para>
+ <section id="Java-Broker-Management-Managing-Keystores-Types">
+ <title>Types</title>
+ <para>The following keystore types are supported. <itemizedlist>
+ <listitem>
+ <para><emphasis>File Key Store</emphasis>. This type accepts the standard JKS
+ keystore format undertood by Java and Java tools such as <ulink
+ url="&oracleKeytool;">keytool</ulink>.</para>
+ <para>If the keystore contains multiple keys, it is possible to indicate which
+ certificate is to be used by specifying an alias. If no alias is specified
+ the first certificate found in the keystore will be used.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Non Java Key Store</emphasis>. A Non Java Keystore accepts key
+ material in PEM and DER file formats. With this store type it is necessary
+ to provide the private key, which must not be protected by password,
+ certificate and optionally a file containing intermediate
+ certificates.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Auto Generated Self Signed</emphasis> has the ability to
+ generate a self signed certificate.</para>
+ <para>The use of self signed certficates is not recommended for production
+ use.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
<section id="Java-Broker-Management-Managing-Keystores-Attributes">
<title>Attributes</title>
- <para><itemizedlist>
+ <para>
+ <itemizedlist>
<listitem>
<para><emphasis>Name the keystore</emphasis>. Used to identify the
keystore.</para>
</listitem>
+ </itemizedlist>
+ </para>
+ <para>The following attributes apply to <emphasis>File Key Stores</emphasis> only.</para>
+ <para>
+ <itemizedlist>
<listitem>
- <para><emphasis>Path</emphasis>. Path to keystore file</para>
+ <para><emphasis>Keystore path</emphasis>. File Key Stores only. Path to keystore
+ file</para>
</listitem>
<listitem>
<para><emphasis>Keystore password</emphasis>. Password used to secure the keystore<important>
@@ -54,14 +93,55 @@
entries.</para>
</listitem>
<listitem>
- <para><emphasis>Manager Factory Algorithm</emphasis>. In keystores the have more
+ <para><emphasis>Manager Factory Algorithm</emphasis>.In keystores the have more
than one certificate, the alias identifies the certificate to be
used.</para>
</listitem>
<listitem>
<para><emphasis>Key Store Type</emphasis>. Type of Keystore.</para>
</listitem>
- </itemizedlist></para>
+ </itemizedlist>
+ </para>
+ <para>The following attributes apply to <emphasis>Non Java Key Stores</emphasis>
+ only.</para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>Private Key</emphasis>. The private key in DER or PEM format.
+ This file must not be password protected.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Certificate</emphasis>. The cerificate in DER or PEM
+ format.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Intermediates Certificates </emphasis>. Optional. Intermediate
+ cerificates in PEM or DER format.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>The following attributes apply to <emphasis>Auto Generated Self Signed</emphasis>
+ only.</para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>Algorithm</emphasis>. Optional. Algorithm used to generate the
+ self-signed certificate.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Signature Algorithm </emphasis>. Optional. The name of signature
+ algorithm.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Key Length</emphasis>. Optional. Length of the key in
+ bits.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Duration</emphasis>. Optional. Validility period in
+ months.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
</section>
<section id="Java-Broker-Management-Managing-Keystores-Children">
<title>Children</title>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Ports.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Ports.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Ports.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Ports.xml Thu Nov 26 14:07:51 2015
@@ -25,7 +25,7 @@
<para>Ports provide TCP/IP connectivity for messaging and management. A port is defined to use a
protocol. This can be an AMQP protocol for messaging or HTTP/JMX for management.</para>
<para>A port is defined to have one or more transports. A transport can either be plain (TCP) or
- SSL. When SSL is in use, the port can be configured to accept or require client
+ SSL (TLS). When SSL is in use, the port can be configured to accept or require client
authentication.</para>
<para>Any number of ports defined to use AMQP or HTTP protocols can be defined. JMX is limited
to a single port instance per JMX protocol type.</para>
@@ -51,7 +51,7 @@
<listitem>
<para><emphasis>Protocol(s)</emphasis>. A list of protocols to be supported by
the port. For messaging choose one or more AMQP protocols. For management
- choose HTTP or on one the two JMX protocols.</para>
+ choose HTTP or one the two JMX protocols.</para>
</listitem>
<listitem>
<para><emphasis>Transports</emphasis>. A list of transports supported by the
@@ -59,6 +59,13 @@
TCP/SSL combination is not supported.</para>
</listitem>
<listitem>
+ <para><emphasis>Enabled/Disabled Cipher Suites</emphasis>. Allows cipher
+ suites supported by the JVM to be enabled or disabled. The cipher
+ suite names are those understood by the JVM.
+ </para>
+ <para>SSLv3 is disabled by default.</para>
+ </listitem>
+ <listitem>
<para><emphasis>Keystore</emphasis>. <link
linkend="Java-Broker-Management-Managing-Keystores">Keystore</link>
containing the Broker's private key. Required if the SSL is in use.</para>
@@ -78,11 +85,31 @@
contain an issuer certificate or the public keys of the clients themselves
if peers only is desired.</para>
</listitem>
- </itemizedlist></para>
+ <listitem>
+ <para><emphasis>Maximum Open Connections</emphasis>. AMQP ports only. Limits
+ the number of connections that may be open at any one time.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Thread pool size</emphasis>. AMQP ports only. Number of worker threads
+ used to process AMQP connections during connection negotiation phase.</para>
+ <para>Defaults to 8.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Number of selectors</emphasis>. AMQP ports only. Number of worker threads
+ used from the thread pool to dispatch I/O activity to the worker threads.</para>
+ <para>Defaults to one eighth of the thread pool size. Minimum 1.</para>
+ </listitem>
+ </itemizedlist></para>
</section>
<section id="Java-Broker-Management-Managing-Ports-Children">
<title>Children</title>
- <para>None</para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>Connection</para>
+ </listitem>
+ </itemizedlist>
+ </para>
</section>
<section id="Java-Broker-Management-Managing-Ports-Lifecycle">
<title>Lifecycle</title>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Truststores.xml Thu Nov 26 14:07:51 2015
@@ -1,4 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE entities [
+<!ENTITY % entities SYSTEM "../../commonEntities.xml">
+%entities;
+]>
<!--
Licensed to the Apache Software Foundation (ASF) under one
@@ -26,13 +30,38 @@
Port in order to SSL client authentication. Some authentication provides also use a
truststore when connecting to authentication systems that are protected by a private issuer
SSL certificate.</para>
+ <section id="Java-Broker-Management-Managing-Truststores-Types">
+ <title>Types</title>
+ <para>The following truststore types are supported. <itemizedlist>
+ <listitem>
+ <para><emphasis>File Trust Store</emphasis>. This type accepts the standard JKS
+ truststore format undertood by Java and Java tools such as <ulink
+ url="&oracleKeytool;">keytool</ulink>.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Non Java Trust Store</emphasis>. A non java keystore accepts key
+ material in PEM and DER file formats. </para>
+ </listitem>
+ <listitem>
+ <para>TODO</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
<section id="Java-Broker-Management-Managing-Truststores-Attributes">
<title>Attributes</title>
- <para><itemizedlist>
+ <para>
+ <itemizedlist>
<listitem>
<para><emphasis>Name the truststore</emphasis>. Used to identify the
truststore.</para>
</listitem>
+ </itemizedlist>
+ </para>
+ <para>The following attributes apply to <emphasis>File Trust Stores</emphasis> only.</para>
+ <para>
+ <itemizedlist>
+
<listitem>
<para><emphasis>Path</emphasis>. Path to truststore file</para>
</listitem>
@@ -58,10 +87,22 @@
</listitem>
<listitem>
<para><emphasis>Peers only</emphasis>. When "Peers Only" option is selected for
- the Truststore it will allow authenticate only those clients that present a certificate
- exactly matching a certificate contained within the Truststore database.</para>
+ the Truststore it will allow authenticate only those clients that present a
+ certificate exactly matching a certificate contained within the Truststore
+ database.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>The following attributes apply to <emphasis>Non Java Trust Stores</emphasis>
+ only.</para>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>Certificates</emphasis>. The cerificate(s) in DER or PEM
+ format.</para>
</listitem>
- </itemizedlist></para>
+ </itemizedlist>
+ </para>
</section>
<section id="Java-Broker-Management-Managing-Truststores-Children">
<title>Children</title>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/management/managing/Java-Broker-Management-Managing-Virtualhosts.xml Thu Nov 26 14:07:51 2015
@@ -89,6 +89,17 @@
/>.</para>
</listitem>
<listitem>
+ <para><emphasis>Connection thread pool size</emphasis>. Number of worker threads
+ used to perform messaging with connected clients. </para>
+ <para>Defaults to 64 or double the maximum number of available processors, whichever
+ is the larger.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>Number of selectors</emphasis>. Number of worker threads
+ used from the thread pool to dispatch I/O activity to the worker threads.</para>
+ <para>Defaults to one eighth of the thread pool size. Minimum 1.</para>
+ </listitem>
+ <listitem>
<para><emphasis>Store transaction timeouts</emphasis>. Warns of long running producer
transactions. See <xref linkend="Java-Broker-Runtime-Producer-Transaction-Timeout"
/></para>
@@ -114,9 +125,6 @@
<link linkend="Java-Broker-Management-Managing-Queues">Queue</link>
</para>
</listitem>
- <listitem>
- <para>Connection</para>
- </listitem>
</itemizedlist>
</para>
</section>
Modified: qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml
URL: http://svn.apache.org/viewvc/qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml?rev=1716666&r1=1716665&r2=1716666&view=diff
==============================================================================
--- qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml (original)
+++ qpid/java/branches/6.0.x/doc/book/src/java-broker/runtime/Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control.xml Thu Nov 26 14:07:51 2015
@@ -27,7 +27,7 @@
<title>General Information</title>
<para>
The Java Broker supports a flow control mechanism to which can be used to prevent either a single queue
- or an entire virtualhost exceeding configured limits. These two mechanisms are described
+ or a virtualhost exceeding configured limits. These two mechanisms are described
next.
</para>
</section>
@@ -109,6 +109,13 @@ MESSAGE [con:2(guest@anonymous(713889609
to be exceeded, the broker may allow all of them to be committed.
</para>
+ <para>
+ The Broker will also impose flow control if the filesystem hosting a virtualhost
+ exceeds a <link
+ linkend="Java-Broker-Management-Managing-Broker-Context-StoreFilesystemMaxUsagePercent">
+ configured percentage.</link>.
+ </para>
+
<section role="h4">
<title>Broker Log Messages for quota flow control</title>
<para>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org