Author: ritchiem
Date: Tue Jul 6 17:32:16 2010
New Revision: 960953
URL: http://svn.apache.org/viewvc?rev=960953&view=rev
Log:
QPID-2681 : Add documentation for Topic Configuration
Added:
qpid/trunk/qpid/doc/book/src/Broker-Configuration-Guide.xml
qpid/trunk/qpid/doc/book/src/java/
qpid/trunk/qpid/doc/book/src/java/broker/
qpid/trunk/qpid/doc/book/src/java/broker/configuration/
qpid/trunk/qpid/doc/book/src/java/broker/configuration/Topic-Configuration.xml
Modified:
qpid/trunk/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml
Modified: qpid/trunk/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml?rev=960953&r1=960952&r2=960953&view=diff
==============================================================================
--- qpid/trunk/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml (original)
+++ qpid/trunk/qpid/doc/book/src/AMQP-Messaging-Broker-Java.xml Tue Jul 6
17:32:16 2010
@@ -42,6 +42,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Qpid-Java-FAQ.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Java-Environment-Variables.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Qpid-Troubleshooting-Guide.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
href="Broker-Configuration-Guide.xml"/>
</chapter>
<chapter id="Qpid-Java-Broker-HowTos">
Added: qpid/trunk/qpid/doc/book/src/Broker-Configuration-Guide.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/Broker-Configuration-Guide.xml?rev=960953&view=auto
==============================================================================
--- qpid/trunk/qpid/doc/book/src/Broker-Configuration-Guide.xml (added)
+++ qpid/trunk/qpid/doc/book/src/Broker-Configuration-Guide.xml Tue Jul 6
17:32:16 2010
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<section>
+ <title>Broker Configuration Guide </title>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude";
+ href="java/broker/configuration/Topic-Configuration.xml"/>
+</section>
Added:
qpid/trunk/qpid/doc/book/src/java/broker/configuration/Topic-Configuration.xml
URL:
http://svn.apache.org/viewvc/qpid/trunk/qpid/doc/book/src/java/broker/configuration/Topic-Configuration.xml?rev=960953&view=auto
==============================================================================
---
qpid/trunk/qpid/doc/book/src/java/broker/configuration/Topic-Configuration.xml
(added)
+++
qpid/trunk/qpid/doc/book/src/java/broker/configuration/Topic-Configuration.xml
Tue Jul 6 17:32:16 2010
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+<section>
+ <title>Topic Configuration on Java Broker</title>
+
+ <para>New in 0.7 is the ability to define configuration for topics.
Currently this is limited to
+ configuration for slow consumer detection. This configuration is based
on the work
+ designed on the <ulink
+
url="http://cwiki.apache.org/confluence/display/qpid/Topic+Configuration+Design";>design
+ wiki</ulink>.</para>
+
+ <section id="Topic Identification">
+ <title>Topic Identification</title>
+ <para>A configuration section has two entries that can be used to
identify how the
+ configuration will be applied: 'name' and 'subscriptionName'.
+
+ <programlisting>
+ <topic>
+ <name>stocks.us</name>
+ </programlisting>
+ <programlisting>
+ <topic>
+
<subscriptionName>clientid:mysubscription</subscriptionName>
+ </programlisting>
+
+ It is also possible to combine these two identifiers to specify a
unique subscription to
+ a given topic.
+
+ <programlisting>
+ <topic>
+ <name>stocks.us</name>
+
<subscriptionName>clientid:mysubscription</subscriptionName>
+ </programlisting>
+ </para>
+ </section>
+
+ <section>
+ <title>Configuration Items</title>
+ <para> Currently only one element of the designed configuration is
processed, that of the
+ slow consumer detection. This is setup as below using the
'slow-consumer-detection'
+ element. There are two required types of tag, first the trigger,
which is one of
+ 'depth', 'messageAge' or 'messageCount' and secondly the 'policy'.
</para>
+ <programlisting>
+ <slow-consumer-detection>
+ <!-- The maximum depth before which the policy will be
applied-->
+ <depth>4235264</depth>
+
+ <!-- The maximum message age before which the policy will
be applied-->
+ <messageAge>600000</messageAge>
+
+ <!-- The maximum number of message before which the policy
will be applied-->
+ <messageCount>50</messageCount>
+
+ <!-- Policy Selection -->
+ <policy name="TopicDelete"/>
+ </slow-consumer-detection>
+ </programlisting>
+
+ <para> The trigger is used to determine when the policy should be
applied. Currently we have
+ a simple policy 'topicdelete', this will disconnect consumers of
topics where their
+ consumption rate falls sufficiently to hit one of the trigger
values. </para>
+ </section>
+
+
+ <section id="Limitiations">
+ <title>Limitiations</title>
+ <para> As of 0.7 the topic configuration is limited to straight string
matching. This means
+ that given the following two topic configuring sections for
'stocks.us' and 'stocks.*' a
+ subscription for 'stocks.uk' will not match the expected
'stocks.*'. Nor will any
+ additional configuration listed in 'stocks.*' affect any
'stocks.us' subscriptions. </para>
+ <programlisting>
+ <topics>
+ <topic>
+ <name>stocks.us</name>
+ ...
+ </topic>
+ <topic>
+ <name>stocks.*</name>
+ ...
+ </topic>
+ </topics>
+ </programlisting>
+ <para> A subscription for 'stocks.us' will only receive configuration
settings that are
+ defined in the 'stocks.us' section. </para>
+ </section>
+
+</section>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:[email protected]
