You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by tr...@apache.org on 2016/04/05 19:01:11 UTC
svn commit: r1737854 [3/4] - in /qpid/site:
docs/releases/qpid-dispatch-master/ docs/releases/qpid-dispatch-master/book/
docs/releases/qpid-dispatch-master/man/ input/releases/qpid-dispatch-master/
input/releases/qpid-dispatch-master/book/ input/releas...
Added: qpid/site/input/releases/qpid-dispatch-master/book/auto_links.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/auto_links.html.in?rev=1737854&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/auto_links.html.in (added)
+++ qpid/site/input/releases/qpid-dispatch-master/book/auto_links.html.in Tue Apr 5 17:01:10 2016
@@ -0,0 +1,205 @@
+
+
+
+ <div class="section" id="indirect-waypoints-and-auto-links">
+<h1>2.5. Indirect Waypoints and Auto-Links<a class="headerlink" href="#indirect-waypoints-and-auto-links" title="Permalink to this headline">.</a></h1>
+<p>This feature was introduced in Qpid Dispatch 0.6. It is a significant
+improvement on an earlier somewhat experimental feature called
+Waypoints.</p>
+<p>Auto-link is a feature of Qpid Dispatch Router that enables a router
+to actively attach a link to a node on an external AMQP container.
+The obvious application for this feature is to route messages through
+a queue on a broker, but other applications are possible as well.</p>
+<p>An auto-link manages the lifecycle of one AMQP link. If messages are
+to be routed to and from a queue on a broker, then two auto-links are
+needed: one for sending messages to the queue and another for
+receiving messages from the queue. The container to which an
+auto-link attempts to attach may be identified in one of two ways:</p>
+<blockquote>
+<div><ul class="simple">
+<li>The name of the connector/listener that resulted in the connection
+of the container, or</li>
+<li>The AMQP container-id of the remote container.</li>
+</ul>
+</div></blockquote>
+<div class="section" id="queue-waypoint-example">
+<h2>2.5.1. Queue Waypoint Example<a class="headerlink" href="#queue-waypoint-example" title="Permalink to this headline">.</a></h2>
+<p>Here is an example configuration for routing messages deliveries
+through a pair of queues on a broker:</p>
+<div class="highlight-python"><pre>connector {
+ name: broker
+ role: route-container
+ addr: <hostname>
+ port: <port>
+ sasl-mechanisms: ANONYMOUS
+}
+
+address {
+ prefix: queue
+ waypoint: yes
+}
+
+autoLink {
+ addr: queue.first
+ dir: in
+ connection: broker
+}
+
+autoLink {
+ addr: queue.first
+ dir: out
+ connection: broker
+}
+
+autoLink {
+ addr: queue.second
+ dir: in
+ connection: broker
+}
+
+autoLink {
+ addr: queue.second
+ dir: out
+ connection: broker
+}</pre>
+</div>
+<p>The <em>address</em> entity identifies a namespace (queue.*) that will be
+used for routing messages through queues via autolinks. The four
+<em>autoLink</em> entities identify the head and tail of two queues on the
+broker that will be connected via auto-links.</p>
+<p>If there is no broker connected, the auto-links shall remain
+<em>inactive</em>. This can be observed by using the <em>qdstat</em> tool:</p>
+<div class="highlight-python"><pre>$ qdstat --autolinks
+AutoLinks
+ addr dir phase link status lastErr
+ ===================================================
+ queue.first in 1 inactive
+ queue.first out 0 inactive
+ queue.second in 1 inactive
+ queue.second out 0 inactive</pre>
+</div>
+<p>If a broker comes online with a queue called <em>queue.first</em>, the
+auto-links will attempt to activate:</p>
+<div class="highlight-python"><pre>$ qdstat --autolinks
+AutoLinks
+ addr dir phase link status lastErr
+ ======================================================================
+ queue.first in 1 6 active
+ queue.first out 0 7 active
+ queue.second in 1 failed Node not found: queue.second
+ queue.second out 0 failed Node not found: queue.second</pre>
+</div>
+<p>Note that two of the auto-links are in <em>failed</em> state because the
+queue does not exist on the broker.</p>
+<p>If we now use the Qpid Proton example application <em>simple_send</em> to
+send three messages to queue.first via the router:</p>
+<div class="highlight-python"><pre>$ python simple_send.py -a 127.0.0.1/queue.first -m3
+all messages confirmed</pre>
+</div>
+<p>and then look at the address statistics on the router:</p>
+<div class="highlight-python"><pre>$ qdstat -a
+Router Addresses
+ class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc
+ ========================================================================================================
+ mobile queue.first 1 balanced 0 0 0 0 0 0 0 0 0
+ mobile queue.first 0 balanced 0 1 0 0 3 3 0 0 0</pre>
+</div>
+<p>we see that <em>queue.first</em> appears twice in the list of addresses. The
+<em>phs</em>, or phase column shows that there are two phases for the
+address. Phase ‘0’ is for routing message deliveries from producers
+to the tail of the queue (the <em>out</em> auto-link associated with the
+queue). Phase ‘1’ is for routing deliveries from the head of the
+queue to subscribed consumers.</p>
+<p>Note that three deliveries have been counted in the “in” and “out”
+columns for phase ‘0’. The “in” column represents the three messages
+that arrived from simple_send and the “out” column represents the
+three deliveries to the queue on the broker.</p>
+<p>If we now use <em>simple_recv</em> to receive three messages from this
+address:</p>
+<div class="highlight-python"><pre>$ python simple_recv_noignore.py -a 127.0.0.1:5672/queue.first -m3
+{u'sequence': int32(1)}
+{u'sequence': int32(2)}
+{u'sequence': int32(3)}</pre>
+</div>
+<p>We receive the three queued messages. Looking at the addresses again,
+we see that phase ‘1’ was used to deliver those messages from the
+queue to the consumer.</p>
+<div class="highlight-python"><pre>$ qdstat -a
+Router Addresses
+ class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc
+ ========================================================================================================
+ mobile queue.first 1 balanced 0 0 0 0 3 3 0 0 0
+ mobile queue.first 0 balanced 0 1 0 0 3 3 0 0 0</pre>
+</div>
+<p>Note that even in a multi-router network, and with multiple producers
+and consumers for <em>queue.first</em>, all deliveries will be routed through
+the queue on the connected broker.</p>
+</div>
+<div class="section" id="sharded-queue-example">
+<h2>2.5.2. Sharded Queue Example<a class="headerlink" href="#sharded-queue-example" title="Permalink to this headline">.</a></h2>
+<p>Here is an extension of the above example to illustrate how Qpid
+Dispatch Router can be used to create a distributed queue in which
+multiple brokers share the message-queueing load.</p>
+<div class="highlight-python"><pre>connector {
+ name: broker1
+ role: route-container
+ addr: <hostname>
+ port: <port>
+ sasl-mechanisms: ANONYMOUS
+}
+
+connector {
+ name: broker2
+ role: route-container
+ addr: <hostname>
+ port: <port>
+ sasl-mechanisms: ANONYMOUS
+}
+
+address {
+ prefix: queue
+ waypoint: yes
+}
+
+autoLink {
+ addr: queue.first
+ dir: in
+ connection: broker1
+}
+
+autoLink {
+ addr: queue.first
+ dir: out
+ connection: broker1
+}
+
+autoLink {
+ addr: queue.first
+ dir: in
+ connection: broker2
+}
+
+autoLink {
+ addr: queue.first
+ dir: out
+ connection: broker2
+}</pre>
+</div>
+<p>In the above configuration, there are two instances of <em>queue.first</em>
+on brokers 1 and 2. Message traffic from producers to address
+<em>queue.first</em> shall be balanced between the two instance and messages
+from the queues shall be balanced across the collection of subscribers
+to the same address.</p>
+</div>
+<div class="section" id="dynamically-adding-shards">
+<h2>2.5.3. Dynamically Adding Shards<a class="headerlink" href="#dynamically-adding-shards" title="Permalink to this headline">.</a></h2>
+<p>Since configurable entities in the router can also be accessed via the
+management protocol, we can remotely add a shard to the above example
+using <em>qdmanage</em>:</p>
+<div class="highlight-python"><pre>qdmanage create --type org.apache.qpid.dispatch.connector addr=<host> port=<port> name=broker3
+qdmanage create --type org.apache.qpid.dispatch.router.config.autoLink addr=queue.first dir=in connection=broker3
+qdmanage create --type org.apache.qpid.dispatch.router.config.autoLink addr=queue.first dir=out connection=broker3</pre>
+</div>
+</div>
+</div>
+
Modified: qpid/site/input/releases/qpid-dispatch-master/book/basic_usage.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/basic_usage.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/basic_usage.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/basic_usage.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="basic-usage-and-examples">
<h1>2.3. Basic Usage and Examples<a class="headerlink" href="#basic-usage-and-examples" title="Permalink to this headline">.</a></h1>
@@ -11,32 +12,36 @@ with any other routers and only routes m
endpoints.</p>
<p>If your router is running in stand-alone mode, <em>qdstat -a</em> will look
like the following:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdstat -a
+<div class="highlight-python"><pre>$ qdstat -a
Router Addresses
- class address phase in-proc local remote in out thru to-proc from-proc
- ===========================================================================================
- local $management Y 0 0 0 0 0 0 0
- mobile $management 0 Y 0 0 1 0 0 1 0
- local temp.4Q3i01lWbs 1 0 0 0 0 0 0
-</pre></div>
+ class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc
+ ===============================================================================================================
+ local $_management_internal closest 1 0 0 0 0 0 0 0 0
+ local $displayname closest 1 0 0 0 0 0 0 0 0
+ mobile $management 0 closest 1 0 0 0 1 0 0 1 0
+ local $management closest 1 0 0 0 0 0 0 0 0
+ local temp.1GThUllfR7N+BDP closest 0 1 0 0 0 0 0 0 0</pre>
</div>
-<p>Note that there are two known addresses. <em>$management</em> is the address of
-the router’s embedded management agent. <em>temp.4Q3i01lWbs</em> is the temporary
+<p>Note that there are a number of known addresses. <em>$management</em> is the address of
+the router’s embedded management agent. <em>temp.1GThUllfR7N+BDP</em> is the temporary
reply-to address of the <em>qdstat</em> client making requests to the agent.</p>
<p>If you change the mode to interior and restart the processs, the same
command will yield additional addresses which are used for
inter-router communication:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdstat -a
+<div class="highlight-python"><pre>$ qdstat -a
Router Addresses
- class address phase in-proc local remote in out thru to-proc from-proc
- ===========================================================================================
- local $management Y 0 0 0 0 0 0 0
- mobile $management 0 Y 0 0 1 0 0 1 0
- local qdhello Y 0 0 0 0 0 0 3
- local qdrouter Y 0 0 0 0 0 0 1
- local qdrouter.ma Y 0 0 0 0 0 0 0
- local temp.2ot2AWsnYz 1 0 0 0 0 0 0
-</pre></div>
+ class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc
+ =================================================================================================================
+ local $_management_internal closest 1 0 0 0 0 0 0 0 0
+ local $displayname closest 1 0 0 0 0 0 0 0 0
+ mobile $management 0 closest 1 0 0 0 1 0 0 1 0
+ local $management closest 1 0 0 0 0 0 0 0 0
+ local qdhello flood 1 0 0 0 0 0 0 0 10
+ local qdrouter flood 1 0 0 0 0 0 0 0 0
+ topo qdrouter flood 1 0 0 0 0 0 0 0 1
+ local qdrouter.ma multicast 1 0 0 0 0 0 0 0 0
+ topo qdrouter.ma multicast 1 0 0 0 0 0 0 0 0
+ local temp.wfx54+zf+YWQF3T closest 0 1 0 0 0 0 0 0 0</pre>
</div>
</div>
<div class="section" id="mobile-subscribers">
@@ -48,25 +53,24 @@ attaches, the messages will be routed to
<p>To illustrate a subscription on a stand-alone router, you can use the
examples that are provided with Qpid Proton. Using the <em>simple_recv.py</em> example
receiver:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ python ./simple_recv.py -a 127.0.0.1/my-address
-</pre></div>
+<div class="highlight-python"><pre>$ python ./simple_recv.py -a 127.0.0.1/my-address</pre>
</div>
<p>This command creates a receiving link subscribed to the specified
address. To verify the subscription:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdstat -a
+<div class="highlight-python"><pre>$ qdstat -a
Router Addresses
- class address phase in-proc local remote in out thru to-proc from-proc
- ===========================================================================================
- local $management Y 0 0 0 0 0 0 0
- mobile $management 0 Y 0 0 1 0 0 1 0
- mobile my-address 0 1 0 0 0 0 0 0
- local temp.JAgKj1+iB8 1 0 0 0 0 0 0
-</pre></div>
+ class addr phs distrib in-proc local remote cntnr in out thru to-proc from-proc
+ ===============================================================================================================
+ local $_management_internal closest 1 0 0 0 0 0 0 0 0
+ local $displayname closest 1 0 0 0 0 0 0 0 0
+ mobile $management 0 closest 1 0 0 0 2 0 0 2 0
+ local $management closest 1 0 0 0 0 0 0 0 0
+ mobile my-address 0 closest 0 1 0 0 0 0 0 0 0
+ local temp.75_d2X23x_KOT51 closest 0 1 0 0 0 0 0 0 0</pre>
</div>
<p>You can then, in a separate command window, run a sender to produce
messages to that address:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ python ./simple_send.py -a 127.0.0.1/my-address
-</pre></div>
+<div class="highlight-python"><pre>$ python ./simple_send.py -a 127.0.0.1/my-address</pre>
</div>
</div>
<div class="section" id="dynamic-reply-to">
@@ -77,7 +81,7 @@ take to get there. To illustrate this fe
program (written in C++ against the qpid::messaging API) that queries
the management agent of the attached router for a list of other known
routers’ management addresses.</p>
-<div class="highlight-python"><div class="highlight"><pre>#include <qpid/messaging/Address.h>
+<div class="highlight-python"><pre>#include <qpid/messaging/Address.h>
#include <qpid/messaging/Connection.h>
#include <qpid/messaging/Message.h>
#include <qpid/messaging/Receiver.h>
@@ -91,33 +95,32 @@ using std::stringstream;
using std::string;
int main() {
- const char* url = "amqp:tcp:127.0.0.1:5672";
- std::string connectionOptions = "{protocol:amqp1.0}";
+ const char* url = "amqp:tcp:127.0.0.1:5672";
+ std::string connectionOptions = "{protocol:amqp1.0}";
Connection connection(url, connectionOptions);
connection.open();
Session session = connection.createSession();
- Sender sender = session.createSender("mgmt");
+ Sender sender = session.createSender("mgmt");
// create reply receiver and get the reply-to address
- Receiver receiver = session.createReceiver("#");
+ Receiver receiver = session.createReceiver("#");
Address responseAddress = receiver.getAddress();
Message request;
request.setReplyTo(responseAddress);
- request.setProperty("x-amqp-to", "amqp:/_local/$management");
- request.setProperty("operation", "DISCOVER-MGMT-NODES");
- request.setProperty("type", "org.amqp.management");
- request.setProperty("name, "self");
+ request.setProperty("x-amqp-to", "amqp:/_local/$management");
+ request.setProperty("operation", "DISCOVER-MGMT-NODES");
+ request.setProperty("type", "org.amqp.management");
+ request.setProperty("name, "self");
sender.send(request);
Message response = receiver.fetch();
Variant content(response.getContentObject());
- std::cout << "Response: " << content << std::endl << std::endl;
+ std::cout << "Response: " << content << std::endl << std::endl;
connection.close();
-}
-</pre></div>
+}</pre>
</div>
<p>The equivalent program written in Python against the Proton Messenger
API:</p>
Modified: qpid/site/input/releases/qpid-dispatch-master/book/book.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/book.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/book.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/book.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="qpid-dispatch-router-book">
<h1>Qpid Dispatch Router Book<a class="headerlink" href="#qpid-dispatch-router-book" title="Permalink to this headline">.</a></h1>
@@ -27,6 +28,12 @@
<li class="toctree-l3"><a class="reference internal" href="link_routing.html#configuration">2.4.1. Configuration</a></li>
</ul>
</li>
+<li class="toctree-l2"><a class="reference internal" href="auto_links.html">2.5. Indirect Waypoints and Auto-Links</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="auto_links.html#queue-waypoint-example">2.5.1. Queue Waypoint Example</a></li>
+<li class="toctree-l3"><a class="reference internal" href="auto_links.html#sharded-queue-example">2.5.2. Sharded Queue Example</a></li>
+<li class="toctree-l3"><a class="reference internal" href="auto_links.html#dynamically-adding-shards">2.5.3. Dynamically Adding Shards</a></li>
+</ul>
+</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="technical_details.html">3. Technical Details and Specifications</a><ul>
@@ -51,6 +58,24 @@
</ul>
</li>
</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="console.html">4. Console</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="console_overview.html">4.1. Console overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="console_installation.html">4.2. Console installation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="console_installation.html#prerequisites">4.2.1. Prerequisites</a></li>
+<li class="toctree-l3"><a class="reference internal" href="console_installation.html#the-console-files">4.2.2. The console files</a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="console_operation.html">4.3. Console operation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="console_operation.html#logging-in-to-a-router-network">4.3.1. Logging in to a router network</a></li>
+<li class="toctree-l3"><a class="reference internal" href="console_operation.html#overview-page">4.3.2. Overview page</a></li>
+<li class="toctree-l3"><a class="reference internal" href="console_operation.html#topology-page">4.3.3. Topology page</a></li>
+<li class="toctree-l3"><a class="reference internal" href="console_operation.html#router-entity-details-page">4.3.4. Router entity details page</a></li>
+<li class="toctree-l3"><a class="reference internal" href="console_operation.html#charts-page">4.3.5. Charts page</a></li>
+<li class="toctree-l3"><a class="reference internal" href="console_operation.html#schema-page">4.3.6. Schema page</a></li>
+</ul>
+</li>
+</ul>
</li>
</ul>
</div>
Modified: qpid/site/input/releases/qpid-dispatch-master/book/client_compatibility.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/client_compatibility.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/client_compatibility.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/client_compatibility.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="client-compatibility">
<h1>3.1. Client Compatibility<a class="headerlink" href="#client-compatibility" title="Permalink to this headline">.</a></h1>
Added: qpid/site/input/releases/qpid-dispatch-master/book/console.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/console.html.in?rev=1737854&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/console.html.in (added)
+++ qpid/site/input/releases/qpid-dispatch-master/book/console.html.in Tue Apr 5 17:01:10 2016
@@ -0,0 +1,26 @@
+
+
+
+ <div class="section" id="console">
+<h1>4. Console<a class="headerlink" href="#console" title="Permalink to this headline">.</a></h1>
+<div class="toctree-wrapper compound">
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="console_overview.html">4.1. Console overview</a></li>
+<li class="toctree-l1"><a class="reference internal" href="console_installation.html">4.2. Console installation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="console_installation.html#prerequisites">4.2.1. Prerequisites</a></li>
+<li class="toctree-l2"><a class="reference internal" href="console_installation.html#the-console-files">4.2.2. The console files</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="console_operation.html">4.3. Console operation</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="console_operation.html#logging-in-to-a-router-network">4.3.1. Logging in to a router network</a></li>
+<li class="toctree-l2"><a class="reference internal" href="console_operation.html#overview-page">4.3.2. Overview page</a></li>
+<li class="toctree-l2"><a class="reference internal" href="console_operation.html#topology-page">4.3.3. Topology page</a></li>
+<li class="toctree-l2"><a class="reference internal" href="console_operation.html#router-entity-details-page">4.3.4. Router entity details page</a></li>
+<li class="toctree-l2"><a class="reference internal" href="console_operation.html#charts-page">4.3.5. Charts page</a></li>
+<li class="toctree-l2"><a class="reference internal" href="console_operation.html#schema-page">4.3.6. Schema page</a></li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+
Added: qpid/site/input/releases/qpid-dispatch-master/book/console_installation.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/console_installation.html.in?rev=1737854&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/console_installation.html.in (added)
+++ qpid/site/input/releases/qpid-dispatch-master/book/console_installation.html.in Tue Apr 5 17:01:10 2016
@@ -0,0 +1,48 @@
+
+
+
+ <div class="section" id="console-installation">
+<h1>4.2. Console installation<a class="headerlink" href="#console-installation" title="Permalink to this headline">.</a></h1>
+<div class="section" id="prerequisites">
+<h2>4.2.1. Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">.</a></h2>
+<p>The following need to be installed before running a console:</p>
+<ul class="simple">
+<li>One or more dispatch routers. See the documentation for the dispatch router for help in starting a router network.</li>
+<li>node.js This is needed to provide a proxy between the console’s websocket traffic and tcp.</li>
+<li>A web server. This can be any server capable of serving static html/js/css/image files.</li>
+</ul>
+<p>A nodejs proxy is distributed with proton.
+To start the proton’s nodejs proxy:</p>
+<div class="highlight-python"><pre>cd ~/rh-qpid-proton/examples/javascript/messenger
+node proxy.js &</pre>
+</div>
+<p>This will start the proxy listening to ws traffic on port 5673 and translating it to tcp on port 5672.
+One of the routers in the network needs to have a listener configured on port 5672. That listener’s role should be ‘normal’. For example:</p>
+<div class="highlight-python"><pre>listener {
+ addr: 0.0.0.0
+ role: normal
+ port: amqp
+ saslMechanisms: ANONYMOUS
+}</pre>
+</div>
+</div>
+<div class="section" id="the-console-files">
+<h2>4.2.2. The console files<a class="headerlink" href="#the-console-files" title="Permalink to this headline">.</a></h2>
+<p>The files for the console are located under the console directory in
+the source tree.:</p>
+<div class="highlight-python"><pre>app/
+bower_components/
+css/
+img/
+index.html
+lib/
+plugin/
+vendor.js</pre>
+</div>
+<dl class="docutils">
+<dt>Copy these files to a directory under the the html or webapps directory of your web server. For example, for apache tomcat the files should be under webapps/dispatch. Then the console is available as::</dt>
+<dd><a class="reference external" href="http://localhost:8080/dispatch">http://localhost:8080/dispatch</a></dd>
+</dl>
+</div>
+</div>
+
Added: qpid/site/input/releases/qpid-dispatch-master/book/console_operation.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/console_operation.html.in?rev=1737854&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/console_operation.html.in (added)
+++ qpid/site/input/releases/qpid-dispatch-master/book/console_operation.html.in Tue Apr 5 17:01:10 2016
@@ -0,0 +1,41 @@
+
+
+
+ <div class="section" id="console-operation">
+<h1>4.3. Console operation<a class="headerlink" href="#console-operation" title="Permalink to this headline">.</a></h1>
+<div class="section" id="logging-in-to-a-router-network">
+<h2>4.3.1. Logging in to a router network<a class="headerlink" href="#logging-in-to-a-router-network" title="Permalink to this headline">.</a></h2>
+<p>The console communicates to the router network using the proton javascript bindings. When run from a web page, the proton bindings use web sockets to send and receive commands. However, the dispatch router requires tcp. Therefore a web-sockets to tcp proxy is used.</p>
+<img alt="console_login.png" src="console_login.png" />
+<p>Enter the address of a proxy that is connected to a router in the network.</p>
+<p>User name and password are not used at this time.</p>
+<p>The Autostart checkbox, when checked, will automatically log in with the previous host:port the next time you start the console.</p>
+</div>
+<div class="section" id="overview-page">
+<h2>4.3.2. Overview page<a class="headerlink" href="#overview-page" title="Permalink to this headline">.</a></h2>
+<p>On the overview page, aggregate information about routers, addresses, and connections is displayed.</p>
+<img alt="console_overview.png" src="console_overview.png" />
+</div>
+<div class="section" id="topology-page">
+<h2>4.3.3. Topology page<a class="headerlink" href="#topology-page" title="Permalink to this headline">.</a></h2>
+<p>This page displays the router network in a graphical form showing how the routers are connected and information about the individual routers and links.</p>
+<img alt="console_topology.png" src="console_topology.png" />
+</div>
+<div class="section" id="router-entity-details-page">
+<h2>4.3.4. Router entity details page<a class="headerlink" href="#router-entity-details-page" title="Permalink to this headline">.</a></h2>
+<img alt="console_entity.png" src="console_entity.png" />
+<p>Displays detailed information about entities such as routers, links, addresses, memory.</p>
+<p>Numeric attributes can be graphed by clicking on the graph icon.</p>
+</div>
+<div class="section" id="charts-page">
+<h2>4.3.5. Charts page<a class="headerlink" href="#charts-page" title="Permalink to this headline">.</a></h2>
+<img alt="console_charts.png" src="console_charts.png" />
+<p>This page displays graphs of numeric values that are on the entity details page.</p>
+</div>
+<div class="section" id="schema-page">
+<h2>4.3.6. Schema page<a class="headerlink" href="#schema-page" title="Permalink to this headline">.</a></h2>
+<img alt="console_schema.png" src="console_schema.png" />
+<p>This page displays the json schema that is used to manage the router network.</p>
+</div>
+</div>
+
Added: qpid/site/input/releases/qpid-dispatch-master/book/console_overview.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/console_overview.html.in?rev=1737854&view=auto
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/console_overview.html.in (added)
+++ qpid/site/input/releases/qpid-dispatch-master/book/console_overview.html.in Tue Apr 5 17:01:10 2016
@@ -0,0 +1,11 @@
+
+
+
+ <div class="section" id="console-overview">
+<h1>4.1. Console overview<a class="headerlink" href="#console-overview" title="Permalink to this headline">.</a></h1>
+<p>The console is an HTML based web site that displays information about a qpid dispatch router network.</p>
+<p>The console requires an HTML web server that can serve static html, javascript, style sheets, and images.</p>
+<p>The current version of the is read-only. The ability to call management methods that change the running of the router network is planned for a future version of console.</p>
+<p>The console only provides limited information about the clients that are attached to the router network and is therfore more appropriate for administrators needing to know the layout and health of the router network.</p>
+</div>
+
Modified: qpid/site/input/releases/qpid-dispatch-master/book/default_config.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/default_config.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/default_config.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/default_config.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="configuration">
<h1>2.1. Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">.</a></h1>
Modified: qpid/site/input/releases/qpid-dispatch-master/book/introduction.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/introduction.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/introduction.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/introduction.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="introduction">
<h1>1. Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">.</a></h1>
Modified: qpid/site/input/releases/qpid-dispatch-master/book/link_routing.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/link_routing.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/link_routing.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/link_routing.html.in Tue Apr 5 17:01:10 2016
@@ -1,8 +1,10 @@
+
<div class="section" id="link-routing">
<h1>2.4. Link Routing<a class="headerlink" href="#link-routing" title="Permalink to this headline">.</a></h1>
-<p>This feature was introduced in Qpid Dispatch 0.4.</p>
+<p>This feature was introduced in Qpid Dispatch 0.4.
+This feature was significantly updated in Qpid Dispatch 0.6.</p>
<p>Link-routing is an alternative strategy for routing messages across a
network of routers. With the existing message-routing strategy, each
router makes a routing decision on a per-message basis when the
@@ -16,10 +18,12 @@ dispositions is performed across the rou
protocol to interact with other endpoints in far-flung parts of the
network. For example, a client can establish a receiver across the
network to a queue on a remote broker and use link credit to control
-the flow of messages from the broker.</p>
+the flow of messages from the broker. Similarly, a receiver can
+establish a link to a topic on a remote broker using a server-side
+filter.</p>
<p>Why would one want to do this? One reason is to provide client
isolation. A network like the following can be deployed:</p>
-<div class="highlight-python"><div class="highlight"><pre> Public Network
+<div class="highlight-python"><pre> Public Network
+-----------------+
| +-----+ |
| B1 | Rp | |
@@ -37,8 +41,7 @@ isolation. A network like the following
| +-----+ | | +-----+ |
| | | |
| | | |
-+-----------------+ +-----------------+
-</pre></div>
++-----------------+ +-----------------+</pre>
</div>
<p>The clients in Private Net B can be constrained (by firewall policy)
to only connect to the Router in their own network. Using
@@ -61,50 +64,57 @@ message-router network between them.</p>
configured to support the example described above?</p>
<p>First, router Ra needs to be told how to make a connection to the
broker B2:</p>
-<div class="highlight-python"><div class="highlight"><pre>connector {
+<div class="highlight-python"><pre>connector {
name: broker
- role: on-demand
+ role: route-container
addr: <B2-url>
port: <B2-port>
sasl-mechanisms: ANONYMOUS
-}
-</pre></div>
+}</pre>
</div>
-<p>This <em>on-demand</em> connector tells the router how to connect to an
+<p>This <em>route-container</em> connector tells the router how to connect to an
external AMQP container when it is needed. The name “broker” will be
used later to refer to this connection.</p>
<p>Now, the router must be configured to route certain addresses to B2:</p>
-<div class="highlight-python"><div class="highlight"><pre>linkRoutePattern {
+<div class="highlight-python"><pre>linkRoute {
prefix: b2
- connector: broker
+ dir: in
+ connection: broker
}
-</pre></div>
+
+linkRoute {
+ prefix: b2
+ dir: out
+ connection: broker
+}</pre>
</div>
-<p>The linkRoutePattern tells router Ra that any sender or receiver that
+<p>The linkRoute tells router Ra that any sender or receiver that
is attached with a target or source (respectively) whos address begins
-with “b2”, should be routed to the broker B2 (via the on-demand
+with “b2”, should be routed to the broker B2 (via the route-container
connector).</p>
+<p>Note that receiving and sending links are configured and routed
+separately. This allows configuration of link routes for listeners
+only or senders only. A direction of “in” matches client senders
+(i.e. links that carry messages inbound to the router network).
+Direction “out” matches client receivers.</p>
<dl class="docutils">
<dt>Examples of addresses that “begin with ‘b2’” include:</dt>
<dd><ul class="first last simple">
<li>b2</li>
-<li>b2/queues</li>
-<li>b2/queues/app1</li>
+<li>b2.queues</li>
+<li>b2.queues.app1</li>
</ul>
</dd>
</dl>
-<p>When the on-demand connector is configured, router Ra establishes a
+<p>When the route-container connector is configured, router Ra establishes a
connection to the broker. Once the connection is open, Ra tells the
other routers (Rp and Rb) that it is a valid destination for
link-routes to the “b2” prefix. This means that sender or receiver
links attached to Rb or Rp will be routed via the shortest path to Ra
where they are then routed outbound to the broker B2.</p>
-<p>On Rp and Rb, it is advisable to add the following configuration:</p>
-<div class="highlight-python"><div class="highlight"><pre>linkRoutePattern {
- prefix: b2
-}
-</pre></div>
-</div>
+<p>On Rp and Rb, it is advisable to add the identical configuration. It
+is permissible for a linkRoute configuration to reference a connection
+that does not exist.</p>
<p>This configuration tells the routers that link-routing is intended to
be available for targets and sources starting with “b2”. This is
important because it is possible that B2 might be unavailable or shut
Modified: qpid/site/input/releases/qpid-dispatch-master/book/schema.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/schema.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/schema.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/schema.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="management-schema">
<h1>3.4. Management Schema<a class="headerlink" href="#management-schema" title="Permalink to this headline">.</a></h1>
@@ -60,8 +61,8 @@ be modified using the <cite>update</cite
<dl class="docutils">
<dt><em>routerId</em> (string, <cite>CREATE</cite>)</dt>
<dd>Router’s unique identity.</dd>
-<dt><em>mode</em> (One of [‘standalone’, ‘interior’, ‘edge’, ‘endpoint’], default=’standalone’, <cite>CREATE</cite>)</dt>
-<dd>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network. In edge mode, the router operates with an up link into an interior router network. Edge routers are typically used as connection concentrators or as security firewalls for access into the interior network.</dd>
+<dt><em>mode</em> (One of [‘standalone’, ‘interior’], default=’standalone’, <cite>CREATE</cite>)</dt>
+<dd>In standalone mode, the router operates as a single component. It does not participate in the routing protocol and therefore will not cooperate with other routers. In interior mode, the router operates in cooperation with other interior routers in an interconnected network.</dd>
<dt><em>area</em> (string)</dt>
<dd>Unused placeholder.</dd>
<dt><em>helloInterval</em> (integer, default=1, <cite>CREATE</cite>)</dt>
@@ -75,7 +76,7 @@ be modified using the <cite>update</cite
<dt><em>remoteLsMaxAge</em> (integer, default=60, <cite>CREATE</cite>)</dt>
<dd>Time in seconds after which link state is declared stale if no RA is received.</dd>
<dt><em>mobileAddrMaxAge</em> (integer, default=60, <cite>CREATE</cite>)</dt>
-<dd>Deprecated - This value is no longer used in the router.</dd>
+<dd>(DEPRECATED) This value is no longer used in the router.</dd>
<dt><em>addrCount</em> (integer)</dt>
<dd>Number of addresses known to the router.</dd>
<dt><em>linkCount</em> (integer)</dt>
@@ -87,13 +88,15 @@ be modified using the <cite>update</cite
<div class="section" id="listener">
<h3>3.4.1.3. listener<a class="headerlink" href="#listener" title="Permalink to this headline">.</a></h3>
<p>Listens for incoming connections to the router.</p>
-<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>addr</em> (string, default=‘127.0.0.1’, <cite>CREATE</cite>)</dt>
<dd>IP address: ipv4 or ipv6 literal or a host name.</dd>
<dt><em>port</em> (string, default=’amqp’, <cite>CREATE</cite>)</dt>
<dd>Port number or symbolic service name.</dd>
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’, <cite>CREATE</cite>)</dt>
+<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’], <cite>CREATE</cite>)</dt>
+<dd>[‘IPv4’, ‘IPv6’] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.</dd>
+<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘route-container’, ‘on-demand’], default=’normal’, <cite>CREATE</cite>)</dt>
<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</dd>
<dt><em>certDb</em> (path, <cite>CREATE</cite>)</dt>
<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
@@ -105,6 +108,12 @@ be modified using the <cite>update</cite
<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
<dt><em>password</em> (string, <cite>CREATE</cite>)</dt>
<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
+<dt><em>uidFormat</em> (string, <cite>CREATE</cite>)</dt>
+<dd>A list of x509 client certificate fields that will be used to build a string that will uniquely identify the client certificate owner. For e.g. a value of ‘cou’ indicates that the uid will consist of c - common name concatenated with o - organization-company name concatenated with u - organization unit; or a value of ‘oF’ indicates that the uid will consist of o (organization name) concatenated with F (the sha256 fingerprint of the entire certificate) . Allowed values can be any combination of comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
+<dt><em>displayNameFile</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The path to the file containing the unique id to dispay name mapping</dd>
+<dt><em>sslProfileName</em> (string)</dt>
+<dd>The name of the ssl profile</dd>
<dt><em>saslMechanisms</em> (string, <cite>CREATE</cite>)</dt>
<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>authenticatePeer</em> (boolean, <cite>CREATE</cite>)</dt>
@@ -120,25 +129,29 @@ be modified using the <cite>update</cite
<dt><em>idleTimeoutSeconds</em> (integer, default=16, <cite>CREATE</cite>)</dt>
<dd>The idle timeout, in seconds, for connections through this listener. If no frames are received on the connection for this time interval, the connection shall be closed.</dd>
<dt><em>requirePeerAuth</em> (boolean, <cite>CREATE</cite>)</dt>
-<dd>Deprecated - This attribute is now controlled by the authenticatePeer attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the authenticatePeer attribute.</dd>
<dt><em>allowUnsecured</em> (boolean, <cite>CREATE</cite>)</dt>
-<dd>Deprecated - This attribute is now controlled by the requireEncryption attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the requireEncryption attribute.</dd>
<dt><em>allowNoSasl</em> (boolean, <cite>CREATE</cite>)</dt>
-<dd>Deprecated - This attribute is now controlled by the authenticatePeer attribute.</dd>
+<dd>(DEPRECATED) This attribute is now controlled by the authenticatePeer attribute.</dd>
<dt><em>stripAnnotations</em> (One of [‘in’, ‘out’, ‘both’, ‘no’], default=’both’, <cite>CREATE</cite>)</dt>
<dd>[‘in’, ‘out’, ‘both’, ‘no’] in: Strip the dispatch router specific annotations only on ingress; out: Strip the dispatch router specific annotations only on egress; both: Strip the dispatch router specific annotations on both ingress and egress; no - do not strip dispatch router specific annotations</dd>
+<dt><em>linkCapacity</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>The capacity of links within this connection, in terms of message deliveries. The capacity is the number of messages that can be in-flight concurrently for each link.</dd>
</dl>
</div>
<div class="section" id="connector">
<h3>3.4.1.4. connector<a class="headerlink" href="#connector" title="Permalink to this headline">.</a></h3>
-<p>Establishes an outgoing connections from the router.</p>
-<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<p>Establishes an outgoing connection from the router.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>addr</em> (string, default=‘127.0.0.1’, <cite>CREATE</cite>)</dt>
<dd>IP address: ipv4 or ipv6 literal or a host name.</dd>
<dt><em>port</em> (string, default=’amqp’, <cite>CREATE</cite>)</dt>
<dd>Port number or symbolic service name.</dd>
-<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘on-demand’], default=’normal’, <cite>CREATE</cite>)</dt>
+<dt><em>protocolFamily</em> (One of [‘IPv4’, ‘IPv6’], <cite>CREATE</cite>)</dt>
+<dd>[‘IPv4’, ‘IPv6’] IPv4: Internet Protocol version 4; IPv6: Internet Protocol version 6. If not specified, the protocol family will be automatically determined from the address.</dd>
+<dt><em>role</em> (One of [‘normal’, ‘inter-router’, ‘route-container’, ‘on-demand’], default=’normal’, <cite>CREATE</cite>)</dt>
<dd>The role of an established connection. In the normal role, the connection is assumed to be used for AMQP clients that are doing normal message delivery over the connection. In the inter-router role, the connection is assumed to be to another router in the network. Inter-router discovery and routing protocols can only be used over inter-router connections.</dd>
<dt><em>certDb</em> (path, <cite>CREATE</cite>)</dt>
<dd>The path to the database that contains the public certificates of trusted certificate authorities (CA).</dd>
@@ -150,6 +163,12 @@ be modified using the <cite>update</cite
<dd>If the above private key is password protected, this is the path to a file containing the password that unlocks the certificate key.</dd>
<dt><em>password</em> (string, <cite>CREATE</cite>)</dt>
<dd>An alternative to storing the password in a file referenced by passwordFile is to supply the password right here in the configuration file. This option can be used by supplying the password in the ‘password’ option. Don’t use both password and passwordFile in the same profile.</dd>
+<dt><em>uidFormat</em> (string, <cite>CREATE</cite>)</dt>
+<dd>A list of x509 client certificate fields that will be used to build a string that will uniquely identify the client certificate owner. For e.g. a value of ‘cou’ indicates that the uid will consist of c - common name concatenated with o - organization-company name concatenated with u - organization unit; or a value of ‘oF’ indicates that the uid will consist of o (organization name) concatenated with F (the sha256 fingerprint of the entire certificate) . Allowed values can be any combination of comma separated ‘c’( ISO3166 two character country code), ‘s’(state or province), ‘l’(Locality; generally - city), ‘o’(Organization - Company Name), ‘u’(Organization Unit - typically certificate type or brand), ‘n’(CommonName - typically a user name for client certificates) and ‘1’(sha1 certificate fingerprint, as displayed in the fingerprints section when looking at a certificate wi
th say a web browser is the hash of the entire certificate) and 2 (sha256 certificate fingerprint) and 5 (sha512 certificate fingerprint).</dd>
+<dt><em>displayNameFile</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The path to the file containing the unique id to dispay name mapping</dd>
+<dt><em>sslProfileName</em> (string)</dt>
+<dd>The name of the ssl profile</dd>
<dt><em>saslMechanisms</em> (string, <cite>CREATE</cite>)</dt>
<dd>Comma separated list of accepted SASL authentication mechanisms.</dd>
<dt><em>allowRedirect</em> (boolean, default=True, <cite>CREATE</cite>)</dt>
@@ -160,6 +179,12 @@ be modified using the <cite>update</cite
<dd>The idle timeout, in seconds, for connections through this connector. If no frames are received on the connection for this time interval, the connection shall be closed.</dd>
<dt><em>stripAnnotations</em> (One of [‘in’, ‘out’, ‘both’, ‘no’], default=’both’, <cite>CREATE</cite>)</dt>
<dd>[‘in’, ‘out’, ‘both’, ‘no’] in: Strip the dispatch router specific annotations only on ingress; out: Strip the dispatch router specific annotations only on egress; both: Strip the dispatch router specific annotations on both ingress and egress; no - do not strip dispatch router specific annotations</dd>
+<dt><em>linkCapacity</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>The capacity of links within this connection, in terms of message deliveries. The capacity is the number of messages that can be in-flight concurrently for each link.</dd>
+<dt><em>saslUsername</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The user name that the connector is using to connect to a peer.</dd>
+<dt><em>saslPassword</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The password that the connector is using to connect to a peer.</dd>
</dl>
</div>
<div class="section" id="log">
@@ -167,7 +192,7 @@ be modified using the <cite>update</cite
<p>Configure logging for a particular module. You can use the <cite>UPDATE</cite> operation to change log settings while the router is running.</p>
<p>Operations allowed: <cite>UPDATE</cite>, <cite>READ</cite></p>
<dl class="docutils">
-<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘DEFAULT’], required)</dt>
+<dt><em>module</em> (One of [‘ROUTER’, ‘ROUTER_CORE’, ‘ROUTER_HELLO’, ‘ROUTER_LS’, ‘ROUTER_MA’, ‘MESSAGE’, ‘SERVER’, ‘AGENT’, ‘CONTAINER’, ‘CONFIG’, ‘ERROR’, ‘DISPATCH’, ‘POLICY’, ‘DEFAULT’], required)</dt>
<dd>Module to configure. The special module ‘DEFAULT’ specifies defaults for all modules.</dd>
<dt><em>enable</em> (string, default=’default’, required, <cite>UPDATE</cite>)</dt>
<dd>Levels are: trace, debug, info, notice, warning, error, critical. The enable string is a comma-separated list of levels. A level may have a trailing ‘+’ to enable that level and above. For example ‘trace,debug,warning+’ means enable trace, debug, warning, error and critical. The value ‘none’ means disable logging for the module. The value ‘default’ means use the value from the DEFAULT module.</dd>
@@ -181,7 +206,7 @@ be modified using the <cite>update</cite
</div>
<div class="section" id="fixedaddress">
<h3>3.4.1.6. fixedAddress<a class="headerlink" href="#fixedaddress" title="Permalink to this headline">.</a></h3>
-<p>Establishes semantics for addresses starting with a prefix.</p>
+<p>(DEPRECATED) Establishes treatment for addresses starting with a prefix.</p>
<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
@@ -196,8 +221,8 @@ be modified using the <cite>update</cite
</div>
<div class="section" id="waypoint">
<h3>3.4.1.7. waypoint<a class="headerlink" href="#waypoint" title="Permalink to this headline">.</a></h3>
-<p>A remote node that messages for an address pass through.</p>
-<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<p>(DEPRECATED) A remote node that messages for an address pass through.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>address</em> (string, required, <cite>CREATE</cite>)</dt>
<dd>The AMQP address of the waypoint.</dd>
@@ -211,19 +236,76 @@ be modified using the <cite>update</cite
</div>
<div class="section" id="linkroutepattern">
<h3>3.4.1.8. linkRoutePattern<a class="headerlink" href="#linkroutepattern" title="Permalink to this headline">.</a></h3>
-<p>An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node.</p>
+<p>(DEPRECATED) An address pattern to match against link sources and targets to cause the router to link-route the attach across the network to a remote node.</p>
<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
<dl class="docutils">
<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
-<dd>An address prefix to match against target and source addresses. From Dispatch 0.6 onwards, this pattern must be of the form ‘<text>/<text1>/...’ or just ‘<text>’ and matches any address that contains that prefix. For example, if the prefix is set to org/apache any address that has the prefix ‘org/apache’ like org/apache/dev will match. Note that a prefix must not start or end with a slash (/) and can contain zero or more slashes (/). Any characters between the slashes are simply treated as part of the address</dd>
+<dd>An address prefix to match against target and source addresses. This pattern must be of the form ‘<text>.<text1>.<textN>’ or ‘<text>’ or ‘<text>.’ and matches any address that contains that prefix. For example, if the prefix is set to org.apache (or org.apache.), any address that has the prefix ‘org.apache’ (like org.apache.dev) will match. Note that a prefix must not start with a (.), can end in a (.) and can contain zero or more dots (.). Any characters between the dots are simply treated as part of the address</dd>
<dt><em>dir</em> (One of [‘in’, ‘out’, ‘both’], default=’both’, <cite>CREATE</cite>)</dt>
<dd>Link direction for match: ‘in’ matches only links inbound to the client; ‘out’ matches only links outbound from the client; ‘both’ matches any link.</dd>
<dt><em>connector</em> (string, <cite>CREATE</cite>)</dt>
<dd>The name of the on-demand connector used to reach the target node’s container. If this value is not provided, it means that the target container is expected to be connected to a different router in the network. This prevents links to a link-routable address from being misinterpreted as message-routing links when there is no route to a valid destination available.</dd>
</dl>
</div>
+<div class="section" id="router-config-address">
+<h3>3.4.1.9. router.config.address<a class="headerlink" href="#router-config-address" title="Permalink to this headline">.</a></h3>
+<p>Entity type for address configuration. This is used to configure the treatment of message-routed deliveries within a particular address-space. The configuration controls distribution and address phasing.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The address prefix for the configured settings</dd>
+<dt><em>distribution</em> (One of [‘multicast’, ‘closest’, ‘balanced’], default=’balanced’, <cite>CREATE</cite>)</dt>
+<dd>Treatment of traffic associated with the address</dd>
+<dt><em>waypoint</em> (boolean, <cite>CREATE</cite>)</dt>
+<dd>Designates this address space as being used for waypoints. This will cause the proper address-phasing to be used.</dd>
+<dt><em>ingressPhase</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Advanced - Override the ingress phase for this address</dd>
+<dt><em>egressPhase</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Advanced - Override the egress phase for this address</dd>
+</dl>
+</div>
+<div class="section" id="router-config-linkroute">
+<h3>3.4.1.10. router.config.linkRoute<a class="headerlink" href="#router-config-linkroute" title="Permalink to this headline">.</a></h3>
+<p>Entity type for link-route configuration. This is used to identify remote containers that shall be destinations for routed link-attaches. The link-routing configuration applies to an addressing space defined by a prefix.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>prefix</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The address prefix for the configured settings</dd>
+<dt><em>containerId</em> (string, <cite>CREATE</cite>)</dt>
+<dd>ContainerID for the target container</dd>
+<dt><em>connection</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The name from a connector or listener</dd>
+<dt><em>distribution</em> (One of [‘linkBalanced’], default=’linkBalanced’, <cite>CREATE</cite>)</dt>
+<dd>Treatment of traffic associated with the address</dd>
+<dt><em>dir</em> (One of [‘in’, ‘out’], required, <cite>CREATE</cite>)</dt>
+<dd>The permitted direction of links: ‘in’ means client senders; ‘out’ means client receivers</dd>
+</dl>
+</div>
+<div class="section" id="router-config-autolink">
+<h3>3.4.1.11. router.config.autoLink<a class="headerlink" href="#router-config-autolink" title="Permalink to this headline">.</a></h3>
+<p>Entity type for configuring auto-links. Auto-links are links whose lifecycle is managed by the router. These are typically used to attach to waypoints on remote containers (brokers, etc.).</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>DELETE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>addr</em> (string, required, <cite>CREATE</cite>)</dt>
+<dd>The address of the provisioned object</dd>
+<dt><em>dir</em> (One of [‘in’, ‘out’], required, <cite>CREATE</cite>)</dt>
+<dd>The direction of the link to be created. In means into the router, out means out of the router.</dd>
+<dt><em>phase</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>The address phase for this link. Defaults to ‘0’ for ‘out’ links and ‘1’ for ‘in’ links.</dd>
+<dt><em>containerId</em> (string, <cite>CREATE</cite>)</dt>
+<dd>ContainerID for the target container</dd>
+<dt><em>connection</em> (string, <cite>CREATE</cite>)</dt>
+<dd>The name from a connector or listener</dd>
+<dt><em>linkRef</em> (string)</dt>
+<dd>Reference to the org.apache.qpid.dispatch.router.link if the link exists</dd>
+<dt><em>operStatus</em> (One of [‘inactive’, ‘attaching’, ‘failed’, ‘active’, ‘quiescing’, ‘idle’])</dt>
+<dd>The operational status of this autoLink: inactive - The remote container is not connected; attaching - the link is attaching to the remote node; failed - the link attach failed; active - the link is attached and operational; quiescing - the link is transitioning to idle state; idle - the link is attached but there are no deliveries flowing and no unsettled deliveries.</dd>
+<dt><em>lastError</em> (string)</dt>
+<dd>The error description from the last attach failure</dd>
+</dl>
+</div>
<div class="section" id="console">
-<h3>3.4.1.9. console<a class="headerlink" href="#console" title="Permalink to this headline">.</a></h3>
+<h3>3.4.1.12. console<a class="headerlink" href="#console" title="Permalink to this headline">.</a></h3>
<p>Start a websocket/tcp proxy and http file server to serve the web console</p>
<p>Operations allowed: <cite>READ</cite></p>
<dl class="docutils">
@@ -239,6 +321,47 @@ be modified using the <cite>update</cite
<dd>Optional args to pass the proxy program for logging, authentication, etc.</dd>
</dl>
</div>
+<div class="section" id="policy">
+<h3>3.4.1.13. policy<a class="headerlink" href="#policy" title="Permalink to this headline">.</a></h3>
+<p>Defines global connection limit</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>maximumConnections</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Global maximum number of concurrent client connections allowed. Zero implies no limit. This limit is always enforced even if no other policy settings have been defined.</dd>
+<dt><em>enableAccessRules</em> (boolean, <cite>CREATE</cite>)</dt>
+<dd>Enable user rule set processing and connection denial.</dd>
+<dt><em>policyFolder</em> (path, <cite>CREATE</cite>)</dt>
+<dd>The path to a folder that holds policyRuleset definition .json files. For a small system the rulesets may all be defined in this file. At a larger scale it is better to have the policy files in their own folder and to have none of the rulesets defined here. All rulesets in all .json files in this folder are processed.</dd>
+</dl>
+<p><em>connectionsProcessed</em> (integer)</p>
+<p><em>connectionsDenied</em> (integer)</p>
+<p><em>connectionsCurrent</em> (integer)</p>
+</div>
+<div class="section" id="policyruleset">
+<h3>3.4.1.14. policyRuleset<a class="headerlink" href="#policyruleset" title="Permalink to this headline">.</a></h3>
+<p>Per application definition of the locations from which users may connect and the groups to which users belong.</p>
+<p>Operations allowed: <cite>CREATE</cite>, <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>applicationName</em> (string, required)</dt>
+<dd>The application name.</dd>
+<dt><em>maxConnections</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Maximum number of concurrent client connections allowed. Zero implies no limit.</dd>
+<dt><em>maxConnPerUser</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Maximum number of concurrent client connections allowed for any single user. Zero implies no limit.</dd>
+<dt><em>maxConnPerHost</em> (integer, <cite>CREATE</cite>)</dt>
+<dd>Maximum number of concurrent client connections allowed for any remote host. Zero implies no limit.</dd>
+<dt><em>userGroups</em> (map, <cite>CREATE</cite>)</dt>
+<dd>A map where each key is a user group name and the corresponding value is a CSV string naming the users in that group. Users who are assigned to one or more groups are deemed ‘restricted’. Restricted users are subject to connection ingress policy and are assigned policy settings based on the assigned user groups. Unrestricted users may be allowed or denied. If unrestricted users are allowed to connect then they are assigned to user group default.</dd>
+<dt><em>ingressHostGroups</em> (map, <cite>CREATE</cite>)</dt>
+<dd>A map where each key is an ingress host group name and the corresponding value is a CSV string naming the IP addresses or address ranges in that group. IP addresses may be FQDN strings or numeric IPv4 or IPv6 host addresses. A host range is two host addresses of the same address family separated with a hyphen. The wildcard host address ‘*’ represents any host address.</dd>
+<dt><em>ingressPolicies</em> (map, <cite>CREATE</cite>)</dt>
+<dd>A map where each key is a user group name and the corresponding value is a CSV string naming the ingress host group names that restrict the ingress host for the user group. Users who are members of the user group are allowed to connect only from a host in one of the named ingress host groups.</dd>
+<dt><em>connectionAllowDefault</em> (boolean, <cite>CREATE</cite>)</dt>
+<dd>Unrestricted users, those who are not members of a defined user group, are allowed to connect to this application. Unrestricted users are assigned to the ‘default’ user group and receive ‘default’ settings.</dd>
+<dt><em>settings</em> (map, <cite>CREATE</cite>)</dt>
+<dd>A map where each key is a user group name and the value is a map of the corresponding settings for that group.</dd>
+</dl>
+</div>
</div>
<div class="section" id="operational-entities">
<h2>3.4.2. Operational Entities<a class="headerlink" href="#operational-entities" title="Permalink to this headline">.</a></h2>
@@ -374,30 +497,59 @@ operational attributes.</p>
<div class="section" id="router-link">
<h3>3.4.2.3. router.link<a class="headerlink" href="#router-link" title="Permalink to this headline">.</a></h3>
<p>Link to another AMQP endpoint: router node, client or other AMQP process.</p>
-<p>Operations allowed: <cite>READ</cite></p>
-<p><em>linkName</em> (string)</p>
-<p><em>linkType</em> (One of [‘endpoint’, ‘waypoint’, ‘inter-router’, ‘inter-area’])</p>
-<p><em>linkDir</em> (One of [‘in’, ‘out’])</p>
-<p><em>owningAddr</em> (string)</p>
-<p><em>eventFifoDepth</em> (integer)</p>
-<p><em>msgFifoDepth</em> (integer)</p>
-<p><em>remoteContainer</em> (string)</p>
+<p>Operations allowed: <cite>UPDATE</cite>, <cite>READ</cite></p>
+<p><em>adminStatus</em> (One of [‘enabled’, ‘disabled’], default=’enabled’, <cite>UPDATE</cite>)</p>
+<p><em>operStatus</em> (One of [‘up’, ‘down’, ‘quiescing’, ‘idle’])</p>
+<dl class="docutils">
+<dt><em>linkName</em> (string)</dt>
+<dd>Name assigned to the link in the Attach.</dd>
+<dt><em>linkType</em> (One of [‘endpoint’, ‘router-control’, ‘inter-router’])</dt>
+<dd>Type of link: endpoint: a link to a normally connected endpoint; inter-router: a link to another router in the network.</dd>
+<dt><em>linkDir</em> (One of [‘in’, ‘out’])</dt>
+<dd>Direction of delivery flow over the link, inbound or outbound to or from the router.</dd>
+<dt><em>owningAddr</em> (string)</dt>
+<dd>Address assigned to this link during attach: The target for inbound links or the source for outbound links.</dd>
+<dt><em>capacity</em> (integer)</dt>
+<dd>The capacity, in deliveries, for the link. The number of undelivered plus unsettled deliveries shall not exceed the capacity. This is enforced by link flow control.</dd>
+<dt><em>peer</em> (string)</dt>
+<dd>Identifier of the paired link if this is an attach-routed link.</dd>
+<dt><em>undeliveredCount</em> (integer)</dt>
+<dd>The number of undelivered messages pending for the link.</dd>
+<dt><em>unsettledCount</em> (integer)</dt>
+<dd>The number of unsettled deliveries awaiting settlement on the link</dd>
+<dt><em>deliveryCount</em> (integer)</dt>
+<dd>The total number of deliveries that have traversed this link.</dd>
+</dl>
</div>
<div class="section" id="router-address">
<h3>3.4.2.4. router.address<a class="headerlink" href="#router-address" title="Permalink to this headline">.</a></h3>
<p>AMQP address managed by the router.</p>
<p>Operations allowed: <cite>READ</cite></p>
-<p><em>inProcess</em> (boolean)</p>
-<p><em>subscriberCount</em> (integer)</p>
-<p><em>remoteCount</em> (integer)</p>
-<p><em>deliveriesIngress</em> (integer)</p>
-<p><em>deliveriesEgress</em> (integer)</p>
-<p><em>deliveriesTransit</em> (integer)</p>
-<p><em>deliveriesToContainer</em> (integer)</p>
-<p><em>deliveriesFromContainer</em> (integer)</p>
<dl class="docutils">
+<dt><em>distribution</em> (One of [‘flood’, ‘multicast’, ‘closest’, ‘balanced’, ‘linkBalanced’])</dt>
+<dd>Forwarding treatment for the address: flood - messages delivered to all subscribers along all available paths (this will cause duplicate deliveries if there are redundant paths); multi - one copy of each message delivered to all subscribers; anyClosest - messages delivered to only the closest subscriber; anyBalanced - messages delivered to one subscriber with load balanced across subscribers; linkBalanced - for link-routing, link attaches balanced across destinations.</dd>
+<dt><em>inProcess</em> (integer)</dt>
+<dd>The number of in-process subscribers for this address</dd>
+<dt><em>subscriberCount</em> (integer)</dt>
+<dd>The number of local subscribers for this address (i.e. attached to this router)</dd>
+<dt><em>remoteCount</em> (integer)</dt>
+<dd>The number of remote routers that have at least one subscriber to this address</dd>
+<dt><em>containerCount</em> (integer)</dt>
+<dd>The number of attached containers that serve this route address</dd>
+<dt><em>deliveriesIngress</em> (integer)</dt>
+<dd>The number of deliveries to this address that entered the router network on this router</dd>
+<dt><em>deliveriesEgress</em> (integer)</dt>
+<dd>The number of deliveries to this address that exited the router network on this router</dd>
+<dt><em>deliveriesTransit</em> (integer)</dt>
+<dd>The number of deliveries to this address that transited this router to another router</dd>
+<dt><em>deliveriesToContainer</em> (integer)</dt>
+<dd>The number of deliveries to this address that were given to an in-process subscriber</dd>
+<dt><em>deliveriesFromContainer</em> (integer)</dt>
+<dd>The number of deliveries to this address that were originated from an in-process entity</dd>
<dt><em>key</em> (string)</dt>
<dd>Internal unique (to this router) key to identify the address</dd>
+<dt><em>hostRouters</em> (list)</dt>
+<dd>List of remote routers on which there is a destination for this address.</dd>
</dl>
</div>
<div class="section" id="router-node">
@@ -472,6 +624,31 @@ operational attributes.</p>
<p><em>batchesRebalancedToThreads</em> (integer)</p>
<p><em>batchesRebalancedToGlobal</em> (integer)</p>
</div>
+<div class="section" id="policystats">
+<h3>3.4.2.8. policyStats<a class="headerlink" href="#policystats" title="Permalink to this headline">.</a></h3>
+<p>Per application connection and access statistics.</p>
+<p>Operations allowed: <cite>READ</cite></p>
+<dl class="docutils">
+<dt><em>applicationName</em> (string)</dt>
+<dd>The application name.</dd>
+</dl>
+<p><em>connectionsApproved</em> (integer)</p>
+<p><em>connectionsDenied</em> (integer)</p>
+<p><em>connectionsCurrent</em> (integer)</p>
+<dl class="docutils">
+<dt><em>perUserState</em> (map)</dt>
+<dd>A map where the key is the authenticated user name and the value is a list of the user’s connections.</dd>
+<dt><em>perHostState</em> (map)</dt>
+<dd>A map where the key is the host name and the value is a list of the host’s connections.</dd>
+</dl>
+<p><em>sessionDenied</em> (integer)</p>
+<p><em>senderDenied</em> (integer)</p>
+<p><em>receiverDenied</em> (integer)</p>
+<p><em>dynamicSrcDenied</em> (integer)</p>
+<p><em>anonymousSenderDenied</em> (integer)</p>
+<p><em>linkSourceDenied</em> (integer)</p>
+<p><em>linkTargetDenied</em> (integer)</p>
+</div>
</div>
<div class="section" id="management-operations">
<h2>3.4.3. Management Operations<a class="headerlink" href="#management-operations" title="Permalink to this headline">.</a></h2>
Modified: qpid/site/input/releases/qpid-dispatch-master/book/technical_details.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/technical_details.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/technical_details.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/technical_details.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="technical-details-and-specifications">
<h1>3. Technical Details and Specifications<a class="headerlink" href="#technical-details-and-specifications" title="Permalink to this headline">.</a></h1>
@@ -35,7 +36,12 @@
<li class="toctree-l3"><a class="reference internal" href="schema.html#fixedaddress">3.4.1.6. fixedAddress</a></li>
<li class="toctree-l3"><a class="reference internal" href="schema.html#waypoint">3.4.1.7. waypoint</a></li>
<li class="toctree-l3"><a class="reference internal" href="schema.html#linkroutepattern">3.4.1.8. linkRoutePattern</a></li>
-<li class="toctree-l3"><a class="reference internal" href="schema.html#console">3.4.1.9. console</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-config-address">3.4.1.9. router.config.address</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-config-linkroute">3.4.1.10. router.config.linkRoute</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#router-config-autolink">3.4.1.11. router.config.autoLink</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#console">3.4.1.12. console</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#policy">3.4.1.13. policy</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#policyruleset">3.4.1.14. policyRuleset</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="schema.html#operational-entities">3.4.2. Operational Entities</a><ul>
@@ -46,6 +52,7 @@
<li class="toctree-l3"><a class="reference internal" href="schema.html#router-node">3.4.2.5. router.node</a></li>
<li class="toctree-l3"><a class="reference internal" href="schema.html#connection">3.4.2.6. connection</a></li>
<li class="toctree-l3"><a class="reference internal" href="schema.html#allocator">3.4.2.7. allocator</a></li>
+<li class="toctree-l3"><a class="reference internal" href="schema.html#policystats">3.4.2.8. policyStats</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="schema.html#management-operations">3.4.3. Management Operations</a><ul>
Modified: qpid/site/input/releases/qpid-dispatch-master/book/tools.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/tools.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/tools.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/tools.html.in Tue Apr 5 17:01:10 2016
@@ -1,16 +1,17 @@
+
<div class="section" id="tools">
<h1>2.2. Tools<a class="headerlink" href="#tools" title="Permalink to this headline">.</a></h1>
<div class="section" id="qdstat">
<h2>2.2.1. qdstat<a class="headerlink" href="#qdstat" title="Permalink to this headline">.</a></h2>
<p><em>qdstat</em> is a command line tool that lets you view the status of a
-Dispatch Router. The following options are useful for seeing that the
+Dispatch Router. The following options are useful for seeing what the
router is doing:</p>
<table border="1" class="docutils">
<colgroup>
-<col width="11%" />
-<col width="89%" />
+<col width="15%" />
+<col width="85%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head"><em>Option</em></th>
@@ -34,6 +35,12 @@ are attached to other routers in a netwo
<tr class="row-odd"><td>-c</td>
<td>Print a list of connections to the router.</td>
</tr>
+<tr class="row-even"><td>–autolinks</td>
+<td>Print a list of configured auto-links.</td>
+</tr>
+<tr class="row-odd"><td>–linkroutes</td>
+<td>Print a list of configures link-routes.</td>
+</tr>
</tbody>
</table>
<p>For complete details see the <cite>qdstat(8)</cite> man page and the output of
@@ -45,22 +52,18 @@ are attached to other routers in a netwo
to not only view but modify the configuration of a running dispatch
router.</p>
<p>For example you can query all the connection entities in the router:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdmanage query --type connection
-</pre></div>
+<div class="highlight-python"><pre>$ qdmanage query --type connection</pre>
</div>
<p>To enable logging debug and higher level messages by default:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdmanage update log/DEFAULT enable=debug+
-</pre></div>
+<div class="highlight-python"><pre>$ qdmanage update log/DEFAULT enable=debug+</pre>
</div>
<p>In fact, everything that can be configured in the configuration file can
also be created in a running router via management. For example to
create a new listener in a running router:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdmanage create type=listener port=5555
-</pre></div>
+<div class="highlight-python"><pre>$ qdmanage create type=listener port=5555</pre>
</div>
<p>Now you can connect to port 5555, for exampple:</p>
-<div class="highlight-python"><div class="highlight"><pre>$ qdmanage query -b localhost:5555 --type listener
-</pre></div>
+<div class="highlight-python"><pre>$ qdmanage query -b localhost:5555 --type listener</pre>
</div>
<p>For complete details see the <cite>qdmanage(8)</cite> man page and the output of
<cite>qdmanage –help</cite>. Also for details of what can be configured see the
Modified: qpid/site/input/releases/qpid-dispatch-master/book/using.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/book/using.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/book/using.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/book/using.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="using-qpid-dispatch">
<h1>2. Using Qpid Dispatch<a class="headerlink" href="#using-qpid-dispatch" title="Permalink to this headline">.</a></h1>
@@ -20,6 +21,12 @@
<li class="toctree-l2"><a class="reference internal" href="link_routing.html#configuration">2.4.1. Configuration</a></li>
</ul>
</li>
+<li class="toctree-l1"><a class="reference internal" href="auto_links.html">2.5. Indirect Waypoints and Auto-Links</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="auto_links.html#queue-waypoint-example">2.5.1. Queue Waypoint Example</a></li>
+<li class="toctree-l2"><a class="reference internal" href="auto_links.html#sharded-queue-example">2.5.2. Sharded Queue Example</a></li>
+<li class="toctree-l2"><a class="reference internal" href="auto_links.html#dynamically-adding-shards">2.5.3. Dynamically Adding Shards</a></li>
+</ul>
+</li>
</ul>
</div>
</div>
Modified: qpid/site/input/releases/qpid-dispatch-master/index.md
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/index.md?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/index.md (original)
+++ qpid/site/input/releases/qpid-dispatch-master/index.md Tue Apr 5 17:01:10 2016
@@ -27,7 +27,7 @@ Code and documentation found here may be
incomplete. For a smoother experience, see the [current stable
release]({{current_dispatch_release_url}}/index.html).
-This content was generated at 16:25 on Tuesday, 29 September 2015.
+This content was generated at 12:55 on Tuesday, 05 April 2016.
</div>
Modified: qpid/site/input/releases/qpid-dispatch-master/man/qdmanage.html.in
URL: http://svn.apache.org/viewvc/qpid/site/input/releases/qpid-dispatch-master/man/qdmanage.html.in?rev=1737854&r1=1737853&r2=1737854&view=diff
==============================================================================
--- qpid/site/input/releases/qpid-dispatch-master/man/qdmanage.html.in (original)
+++ qpid/site/input/releases/qpid-dispatch-master/man/qdmanage.html.in Tue Apr 5 17:01:10 2016
@@ -1,4 +1,5 @@
+
<div class="section" id="qdmanage-manual-page">
<h1>qdmanage manual page<a class="headerlink" href="#qdmanage-manual-page" title="Permalink to this headline">.</a></h1>
@@ -61,41 +62,19 @@ formatted output.</dd>
</div>
<div class="section" id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">.</a></h2>
-<p>-h, –help
-: show this help message and exit</p>
-<p>–version
-: Print version and exit.</p>
-<p>–type=TYPE
-: Type of entity to operate on.</p>
-<p>–name=NAME
-: Name of entity to operate on.</p>
-<p>–identity=ID
-: Identity of entity to operate on.</p>
-<p>–indent=INDENT
-: Pretty-printing indent. -1 means don’t pretty-print (default 2)</p>
-<p>–stdin
-: Read attributes as JSON map or list of maps from stdin.</p>
-<p>–body=BODY
-: JSON value to use as body of a non-standard operation call.</p>
-<p>–properties=PROPERTIES
-: JSON map to use as properties for a non-standard operation call.</p>
-<div class="section" id="connection-options">
-<h3>Connection Options<a class="headerlink" href="#connection-options" title="Permalink to this headline">.</a></h3>
-<p>-b URL, –bus=URL
-: URL of the messaging bus to connect to (default 0.0.0.0)</p>
-<p>-r ROUTER-ID, –router=ROUTER-ID
-: Router to be queried</p>
-<p>-t SECS, –timeout=SECS
-: Maximum time to wait for connection in seconds (default 5)</p>
-<p>–ssl-certificate=CERT
-: Client SSL certificate (PEM Format)</p>
-<p>–ssl-key=KEY
-: Client SSL private key (PEM Format)</p>
-<p>–ssl-trustfile=TRUSTED-CA-DB
-: Trusted Certificate Authority Database file (PEM Format)</p>
-<p>–ssl-password=PASSWORD
-: Certificate password, will be prompted if not specifed.</p>
-</div>
+<p>Command ‘[‘/tmp/ross/transom/qpid-dispatch-master/tools/qdmanage’, ‘–help’]’ returned non-zero exit status 1</p>
+<dl class="docutils">
+<dt>Traceback (most recent call last):</dt>
+<dd><dl class="first last docutils">
+<dt>File “/tmp/ross/transom/qpid-dispatch-master/tools/qdmanage”, line 24, in <module></dt>
+<dd>from qpid_dispatch.management.client import Node, Url</dd>
+<dt>File “/tmp/ross/transom/qpid-dispatch-master/python/qpid_dispatch/management/client.py”, line 25, in <module></dt>
+<dd>import proton</dd>
+</dl>
+</dd>
+</dl>
+<p>ImportError: No module named proton</p>
+<p>Run python script ‘/tmp/ross/transom/qpid-dispatch-master/doc/man/help2rst.py’:CalledProcessError: Command ‘[‘/tmp/ross/transom/qpid-dispatch-master/tools/qdmanage’, ‘–help’]’ returned non-zero exit status 1</p>
</div>
<div class="section" id="files">
<h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">.</a></h2>
@@ -109,25 +88,20 @@ formatted output.</dd>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">.</a></h2>
<p>Show the logging configuration</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage query --type=log
-</pre></div>
+<div class="highlight-python"><pre>qdmanage query --type=log</pre>
</div>
<p>Enable debug and higher log messages by default:</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage udpdate name=log/DEFAULT enable=debug+
-</pre></div>
+<div class="highlight-python"><pre>qdmanage udpdate name=log/DEFAULT enable=debug+</pre>
</div>
<p>Enable trace log messages only for the MESSAGE moudle and direct MESSAGE
logs to the file “test.log”</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage udpdate name=log/MESSAGE enable=trace output=test.log
-</pre></div>
+<div class="highlight-python"><pre>qdmanage udpdate name=log/MESSAGE enable=trace output=test.log</pre>
</div>
<p>Set MESSAGE logging back to the default:</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage udpdate name=log/MESSAGE enable=default
-</pre></div>
+<div class="highlight-python"><pre>qdmanage udpdate name=log/MESSAGE enable=default</pre>
</div>
<p>Disable MESSAGE logging:</p>
-<div class="highlight-python"><div class="highlight"><pre>qdmanage udpdate name=log/MESSAGE enable=none
-</pre></div>
+<div class="highlight-python"><pre>qdmanage udpdate name=log/MESSAGE enable=none</pre>
</div>
</div>
<div class="section" id="see-also">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org