[jboss-cvs] JBoss Messaging SVN: r7010 - trunk/docs/user-manual/en.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Tue May 26 04:37:49 EDT 2009
Author: ataylor
Date: 2009-05-26 04:37:49 -0400 (Tue, 26 May 2009)
New Revision: 7010
Modified:
trunk/docs/user-manual/en/clusters.xml
trunk/docs/user-manual/en/configuration-index.xml
trunk/docs/user-manual/en/message-expiry.xml
trunk/docs/user-manual/en/message-grouping.xml
trunk/docs/user-manual/en/queue-attributes.xml
trunk/docs/user-manual/en/undelivered-messages.xml
Log:
more doc updates
Modified: trunk/docs/user-manual/en/clusters.xml
===================================================================
--- trunk/docs/user-manual/en/clusters.xml 2009-05-26 06:47:08 UTC (rev 7009)
+++ trunk/docs/user-manual/en/clusters.xml 2009-05-26 08:37:49 UTC (rev 7010)
@@ -591,7 +591,7 @@
information on connectors please see chapter [LINK].</para>
</section>
</section>
- <section>
+ <section id="clusters.message-redistribution">
<title>Message Redistribution</title>
<para>Another important part of clustering is message redistribution. Earlier we learned how
server side message load balancing round robins messages across the cluster. If <literal
Modified: trunk/docs/user-manual/en/configuration-index.xml
===================================================================
--- trunk/docs/user-manual/en/configuration-index.xml 2009-05-26 06:47:08 UTC (rev 7009)
+++ trunk/docs/user-manual/en/configuration-index.xml 2009-05-26 08:37:49 UTC (rev 7010)
@@ -382,43 +382,44 @@
<entry/>
</row>
<row>
- <entry>divert.name (attribute)</entry>
+ <entry><link linkend="diverts">divert.name (attribute)</link></entry>
<entry>String</entry>
<entry>A unique name for the divert - mandatory</entry>
<entry/>
</row>
<row>
- <entry>divert.routing-name</entry>
+ <entry><link linkend="diverts">divert.routing-name</link></entry>
<entry>String</entry>
<entry>The routing name for the divert - mandatory</entry>
<entry/>
</row>
<row>
- <entry>divert.address</entry>
+ <entry><link linkend="diverts">divert.address</link></entry>
<entry>String</entry>
<entry>The address this divert will divert from - mandatory</entry>
<entry/>
</row>
<row>
- <entry>divert.forwarding-address</entry>
+ <entry><link linkend="diverts">divert.forwarding-address</link></entry>
<entry>String</entry>
<entry>The forwarding address for the divert - mandatory</entry>
<entry/>
</row>
<row>
- <entry>divert.exclusive</entry>
+ <entry><link linkend="diverts">divert.exclusive</link></entry>
<entry>Booleab</entry>
<entry>Is this divert exclusive?</entry>
<entry>false</entry>
</row>
<row>
- <entry>divert.filter</entry>
+ <entry><link linkend="diverts">divert.filter</link></entry>
<entry>String</entry>
<entry>An optional core filter expression</entry>
<entry>null</entry>
</row>
<row>
- <entry>divert.transformer-class-name</entry>
+ <entry><link linkend="diverts"
+ >divert.transformer-class-name</link></entry>
<entry>String</entry>
<entry>An optional class name of a transformer</entry>
<entry/>
@@ -430,25 +431,26 @@
<entry/>
</row>
<row>
- <entry>queues.name (attribute)</entry>
+ <entry><link linkend="predefined.queues">queues.name
+ (attribute)</link></entry>
<entry>String</entry>
<entry>Unique name of this queue</entry>
<entry/>
</row>
<row>
- <entry>queues.address</entry>
+ <entry><link linkend="predefined.queues">queues.address</link></entry>
<entry>String</entry>
<entry>Address for this queue - mandatory</entry>
<entry/>
</row>
<row>
- <entry>queues.filter</entry>
+ <entry><link linkend="predefined.queues">queues.filter</link></entry>
<entry>String</entry>
<entry>Optional core filter expression for this queue</entry>
<entry>null</entry>
</row>
<row>
- <entry>queues.durable</entry>
+ <entry><link linkend="predefined.queues">queues.durable</link></entry>
<entry>Boolean</entry>
<entry>Is this queue durable?</entry>
<entry>true</entry>
@@ -460,82 +462,94 @@
<entry/>
</row>
<row>
- <entry>bridges.name (attribute)</entry>
+ <entry><link linkend="core-bridges">bridges.name
+ (attribute)</link></entry>
<entry>String</entry>
<entry>Unique name for this bridge</entry>
<entry/>
</row>
<row>
- <entry>bridges.queue-name</entry>
+ <entry><link linkend="core-bridges">bridges.queue-name</link></entry>
<entry>String</entry>
<entry>Name of queue that this bridge consumes from - mandatory</entry>
<entry/>
</row>
<row>
- <entry>bridges.forwarding-address</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.forwarding-address</link></entry>
<entry>String</entry>
<entry>Address to forward to. If ommitted original destination is
used.</entry>
<entry>null</entry>
</row>
<row>
- <entry>bridges.filter</entry>
+ <entry><link linkend="core-bridges">bridges.filter</link></entry>
<entry>String</entry>
<entry>Optional core filter expression</entry>
<entry>null</entry>
</row>
<row>
- <entry>bridges.transformer-class-name</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.transformer-class-name</link></entry>
<entry>String</entry>
<entry>Optional name of transformer class</entry>
<entry>null</entry>
</row>
<row>
- <entry>bridges.retry-interval</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.retry-interval</link></entry>
<entry>Long</entry>
<entry>Period in ms between successive retries</entry>
<entry>2000 ms</entry>
</row>
<row>
- <entry>bridges.retry-interval-multiplier</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.retry-interval-multiplier</link></entry>
<entry>Double</entry>
<entry>Multiplier to apply to successive retry intervals</entry>
<entry>1.0</entry>
</row>
<row>
- <entry>bridges.reconnect-attempts</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.reconnect-attempts</link></entry>
<entry>Integer</entry>
<entry>Max. number of retry attempts, -1 signifies infinite</entry>
<entry>-1</entry>
</row>
<row>
- <entry>bridges.failover-on-server-shutdown</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.failover-on-server-shutdown</link></entry>
<entry>Boolean</entry>
<entry>Should failover be prompted if target server is cleanly
shutdown?</entry>
<entry>false</entry>
</row>
<row>
- <entry>bridges.use-duplicate-detection</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.use-duplicate-detection</link></entry>
<entry>Boolean</entry>
<entry>Should duplicate detection headers be inserted in forwarded
messages?</entry>
<entry>true</entry>
</row>
<row>
- <entry>bridges.discovery-group-ref</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.discovery-group-ref</link></entry>
<entry>String</entry>
<entry>Name of discovery group used by this bridge</entry>
<entry>null</entry>
</row>
<row>
- <entry>bridges.connector-ref.connector-name (attribute)</entry>
+ <entry><link linkend="core-bridges">bridges.connector-ref.connector-name
+ (attribute)</link></entry>
<entry>String</entry>
<entry>Name of connector to use for live connection</entry>
<entry/>
</row>
<row>
- <entry>bridges.connector-ref.backup-connector-name (attribute)</entry>
+ <entry><link linkend="core-bridges"
+ >bridges.connector-ref.backup-connector-name
+ (attribute)</link></entry>
<entry>String</entry>
<entry>Optional name of connector to use for backup connection</entry>
<entry>null</entry>
@@ -548,59 +562,68 @@
<entry/>
</row>
<row>
- <entry>cluster-connections.name (attribute)</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.name (attribute)</link></entry>
<entry>String</entry>
<entry>Unique name for this cluster connection</entry>
<entry/>
</row>
<row>
- <entry>cluster-connections.address</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.address</link></entry>
<entry>String</entry>
<entry>Name of address this cluster connection applies to</entry>
<entry/>
</row>
<row>
- <entry>cluster-connections.forward-when-no-consumers</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.forward-when-no-consumers</link></entry>
<entry>Boolean</entry>
<entry>Should messages be load balanced if there are no matching
consumers on target?</entry>
<entry>false</entry>
</row>
<row>
- <entry>cluster-connections.max-hops</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.max-hops</link></entry>
<entry>Integer</entry>
<entry>Max number of hops cluster topology is propagated</entry>
<entry>1</entry>
</row>
<row>
- <entry>cluster-connections.retry-interval</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.retry-interval</link></entry>
<entry>Long</entry>
<entry>Period in ms between successive retries</entry>
<entry>2000 ms</entry>
</row>
<row>
- <entry>cluster-connections.use-duplicate-detection</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.use-duplicate-detection</link></entry>
<entry>Boolean</entry>
<entry>Should duplicate detection headers be inserted in forwarded
messages?</entry>
<entry>true</entry>
</row>
<row>
- <entry>cluster-connections.discovery-group-ref</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.discovery-group-ref</link></entry>
<entry>String</entry>
<entry>Name of discovery group used by this bridge</entry>
<entry>null</entry>
</row>
<row>
- <entry>cluster-connections.connector-ref.connector-name
- (attribute)</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.connector-ref.connector-name
+ (attribute)</link></entry>
<entry>String</entry>
<entry>Name of connector to use for live connection</entry>
<entry/>
</row>
<row>
- <entry>cluster-connections.connector-ref.backup-connector-name
- (attribute)</entry>
+ <entry><link linkend="clusters.cluster-connections"
+ >cluster-connections.connector-ref.backup-connector-name
+ (attribute)</link></entry>
<entry>String</entry>
<entry>Optional name of connector to use for backup connection</entry>
<entry>null</entry>
@@ -613,11 +636,108 @@
<entry/>
</row>
<row>
- <entry>address-settings</entry>
+ <entry><link linkend="security.settings.roles">security-settings.match
+ (attribute)</link></entry>
+ <entry>String</entry>
+ <entry>The string to use for matching security against an
+ address.</entry>
+ <entry/>
+ </row>
+ <row>
+ <entry><link linkend="security.settings.roles"
+ >security-settings.permission</link></entry>
+ <entry>Security Permission</entry>
+ <entry>a permision to add to the address</entry>
+ <entry/>
+ </row>
+ <row>
+ <entry><link linkend="security.settings.roles"
+ >security-settings.permission.type (attribute)</link></entry>
+ <entry>Permission Type</entry>
+ <entry>The type of permission</entry>
+ <entry/>
+ </row>
+ <row>
+ <entry><link linkend="security.settings.roles"
+ >security-settings.permission.roles (attribute)</link></entry>
+ <entry>Roles</entry>
+ <entry>A comma separated list of roles to apply the permission
+ to</entry>
+ <entry/>
+ </row>
+ <row>
+ <entry><link linkend="queue-attributes.address-settings"
+ >address-settings</link></entry>
<entry>AddressSetting</entry>
<entry>A list of address settings</entry>
<entry/>
</row>
+ <row>
+ <entry><link linkend="undelivered-messages.configuring"
+ >address-settings.dead-letter-address</link></entry>
+ <entry>String</entry>
+ <entry>The address to send dead messages too</entry>
+ <entry/>
+ </row>
+ <row>
+ <entry><link linkend="undelivered-messages.configuring"
+ >address-settings.max-delivery-attempts</link></entry>
+ <entry>Integer</entry>
+ <entry>How many times to attempt to deliver a message before sending to
+ dead letter address</entry>
+ <entry>10</entry>
+ </row>
+ <row>
+ <entry><link linkend="message-expiry.configuring"
+ >address-settings.expiry-address</link></entry>
+ <entry>String</entry>
+ <entry>The address to send expired messages too</entry>
+ <entry/>
+ </row>
+ <row>
+ <entry><link linkend="undelivered-messages.delay"
+ >address-settings.redelivery-delay</link></entry>
+ <entry>Long</entry>
+ <entry>The time, in milliseconds, to wait before redelivering a
+ cancelled message.</entry>
+ <entry>0</entry>
+ </row>
+ <row>
+ <entry><link linkend="last-value-queues"
+ >address-settings.last-value-queue</link></entry>
+ <entry>boolean</entry>
+ <entry>Whether to treat the queueas a last value queue</entry>
+ <entry>false</entry>
+ </row>
+ <row>
+ <entry><link linkend="queue-attributes.address-settings"
+ >address-settings.distribution-policy-class</link></entry>
+ <entry>String</entry>
+ <entry>The class to use for distributing messages to a consumer</entry>
+ <entry>RoundRobinDistributor</entry>
+ </row>
+ <row>
+ <entry><link linkend="paging"
+ >address-settings.page-size-bytes</link></entry>
+ <entry>Long</entry>
+ <entry>The page size to use for an address</entry>
+ <entry>10 * 1024 * 1024</entry>
+ </row>
+ <row>
+ <entry><link linkend="paging"
+ >address-settings.max-size-bytes</link></entry>
+ <entry>Long</entry>
+ <entry>The max size to use in paging for an address</entry>
+ <entry>-1</entry>
+ </row>
+ <row>
+ <entry><link linkend="clusters.message-redistribution"
+ >address-settings.redistribution-delay</link></entry>
+ <entry>Long</entry>
+ <entry>Howlongto wait after the last consumer is closed on a queue
+ before redistributing messages.</entry>
+ <entry>-1</entry>
+ </row>
</tbody>
</tgroup>
</table>
Modified: trunk/docs/user-manual/en/message-expiry.xml
===================================================================
--- trunk/docs/user-manual/en/message-expiry.xml 2009-05-26 06:47:08 UTC (rev 7009)
+++ trunk/docs/user-manual/en/message-expiry.xml 2009-05-26 08:37:49 UTC (rev 7010)
@@ -36,7 +36,7 @@
</listitem>
</itemizedlist>
</section>
- <section>
+ <section id="message-expiry.configuring">
<title>Configuring Expiry Addresses</title>
<para>Expiry address are defined in the address-setting configuration:</para>
<programlisting>
Modified: trunk/docs/user-manual/en/message-grouping.xml
===================================================================
--- trunk/docs/user-manual/en/message-grouping.xml 2009-05-26 06:47:08 UTC (rev 7009)
+++ trunk/docs/user-manual/en/message-grouping.xml 2009-05-26 08:37:49 UTC (rev 7010)
@@ -15,7 +15,7 @@
messages with the same group id.</para>
</listitem>
</itemizedlist>
- <section>
+ <section id="message-grouping.configuring">
<title>Configuring Message Grouping</title>
<para>Message grouping must be enabled in the address-setting configuration by using a
specific <literal>distribution-policy-class</literal>:</para>
Modified: trunk/docs/user-manual/en/queue-attributes.xml
===================================================================
--- trunk/docs/user-manual/en/queue-attributes.xml 2009-05-26 06:47:08 UTC (rev 7009)
+++ trunk/docs/user-manual/en/queue-attributes.xml 2009-05-26 08:37:49 UTC (rev 7010)
@@ -66,4 +66,44 @@
<para>Take a look at the <xref linkend="management">management section</xref> for the API
for creating queues.</para>
</section>
+ <section id="queue-attributes.address-settings">
+ <title>Configuring Queues Via Address Settings</title>
+ <para>There are some attributes that are defined against a queue rather than a specific
+ queue. Here an example of an <literal>address-setting</literal> entry that would be
+ found in the <literal>jbm-configuration.xml</literal> file.</para>
+ <programlisting><address-settings>
+ <address-setting match="jms.queue.exampleQueue">
+ <dead-letter-address>jms.queue.deadLetterQueue</dead-letter-address>
+ <max-delivery-attempts>3</max-delivery-attempts>
+ <redelivery-delay>5000</redelivery-delay>
+ <expiry-address>jms.queue.expiryQueue</expiry-address>
+ <last-value-queue>true</last-value-queue>
+ <distribution-policy-class>org.jboss.messaging.core.server.impl.GroupingRoundRobinDistributor</distribution-policy-class>
+ <max-size-bytes>100000</max-size-bytes>
+ <page-size-bytes>20000</page-size-bytes>
+ <redistribution-delay>0</redistribution-delay>
+ </address-setting>
+</address-settings></programlisting>
+ <para>These are explained fully throughout the user manual, howvere here is a breif
+ description with a link to the appropriate chapter if available. </para>
+ <para><literal>max-delivery-attempts</literal> defines how many time a cancelled message can
+ be redelivered before sending to the <literal>dead-letter-address</literal>. A full
+ explanation can be found <link linkend="undelivered-messages.configuring"
+ >here</link>.</para>
+ <para><literal>redelivery-delay</literal> defines how long to wait before attempting
+ redelivery of a cancelled message. see <link linkend="undelivered-messages.delay"
+ >here</link>.</para>
+ <para><literal>expiry-address</literal> defines where to send a message that has expired.
+ see <link linkend="message-expiry.configuring">here</link>.</para>
+ <para><literal>last-value-queue</literal> defines whether a queue only uses last values or
+ not. see <link linkend="last-value-queues">here</link>.</para>
+ <para><literal>distribution-policy-class</literal> define the class to use for distribution
+ of messages by a queue to consumers. By default this is <literal
+ >org.jboss.messaging.core.server.impl.RoundRobinDistributor</literal>.</para>
+ <para><literal>max-size-bytes</literal> and <literal>page-size-bytes</literal> are used to
+ set paging on an address. This is explained <link linkend="paging">here</link>.</para>
+ <para><literal>redistribution-delay</literal> defines how long to wait when the last
+ consumer is closed on a queue before redistributing any messages. see <link
+ linkend="clusters.message-redistribution">here</link>.</para>
+ </section>
</chapter>
Modified: trunk/docs/user-manual/en/undelivered-messages.xml
===================================================================
--- trunk/docs/user-manual/en/undelivered-messages.xml 2009-05-26 06:47:08 UTC (rev 7009)
+++ trunk/docs/user-manual/en/undelivered-messages.xml 2009-05-26 08:37:49 UTC (rev 7010)
@@ -26,7 +26,7 @@
rollback. Without a delayed redelivery, the system can get into a "thrashing" state, with
delivery being attempted, the client rolling back, and delivery being re-attempted ad
infinitum in quick succession, consuming valuable CPU and network resources.</para>
- <section>
+ <section id="undelivered-messages.delay">
<title>Configuring Delayed Redelivery</title>
<para>Delayed redelivery is defined in the address-setting configuration:</para>
<programlisting>
@@ -61,7 +61,7 @@
have be unsuccessfully delivered for a given number of attempts, they are removed from the
queue and sent to the dead letter address. These <emphasis>dead letter</emphasis> messages
can later be consumed for further inspection.</para>
- <section>
+ <section id="undelivered-messages.configuring">
<title>Configuring Dead Letter Addresses</title>
<para>Dead letter address is defined in the address-setting configuration:</para>
<programlisting>
More information about the jboss-cvs-commits
mailing list