[jboss-cvs] JBoss Messaging SVN: r6783 - trunk/docs/user-manual/en/modules.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu May 14 05:04:42 EDT 2009
Author: ataylor
Date: 2009-05-14 05:04:41 -0400 (Thu, 14 May 2009)
New Revision: 6783
Modified:
trunk/docs/user-manual/en/modules/queue-attributes.xml
Log:
queue attribute docs
Modified: trunk/docs/user-manual/en/modules/queue-attributes.xml
===================================================================
--- trunk/docs/user-manual/en/modules/queue-attributes.xml 2009-05-14 08:59:29 UTC (rev 6782)
+++ trunk/docs/user-manual/en/modules/queue-attributes.xml 2009-05-14 09:04:41 UTC (rev 6783)
@@ -1,8 +1,64 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="queue-attributes">
<title>Queue Attributes</title>
- <para></para>
-
-
-
+ <para>Queue attributes can be set in one of 2 ways. Either by configuring them via the
+ configuration file or when using the core API. This chapter will explain how to configure
+ each attribute and what effect the attribute has.</para>
+ <section>
+ <title>Predefined Queues</title>
+ <para>Queues can be predefined via configuration at a core level or at a JMS level. Firstly
+ lets look at a JMS level.</para>
+ <para>The following shows a queue predefined in the <literal>jbm-jms.xml</literal>
+ configuration file.</para>
+ <programlisting><queue name="selectorQueue">
+ <entry name="/queue/selectorQueue"/>
+ <filter string="color='red'"/>
+ <durable>true</durable>
+</queue></programlisting>
+ <para>This name attribute of queue defines the name of the queue. When we do this at a jms
+ level we follow a naming convention so the actual name of the queue will be <literal
+ >jms.queue.selectorQueue</literal>.</para>
+ <para>The entry element configures the name that will be used to bind the queue to JNDI.
+ This is a mandatory element and the queue can contain multiple of these to bind the same
+ queue to different names.</para>
+ <para>The filter element defines what filter or message selector the predefined queue will
+ have. This is an optional element with a default of null when ommitted.</para>
+ <para>The durable element specifies whether the queue will be persisted. This again is
+ optional and defaults to true if ommited.</para>
+ <para>Secondly a queue can be predefined at a core level in the <literal
+ >jbm-configuration.xml</literal> file. The following is an example.</para>
+ <programlisting><queues>
+ <queue name="jms.queue.selectorQueue">
+ <address>jms.queue.selectorQueue</address>
+ <filter string="color='red'"/>
+ <durable>true</durable>
+ </queue>
+</queues></programlisting>
+ <para>This is very similar to the jms configuration, with 3 real differences which
+ are.</para>
+ <orderedlist>
+ <listitem>
+ <para>The name attribute of queue is the actual name used for the queue with no
+ naming convention as in JMS.</para>
+ </listitem>
+ <listitem>
+ <para>The address element defines what address is used for routing messages.</para>
+ </listitem>
+ <listitem>
+ <para>There is no entry element.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>Using the API</title>
+ <para>Queues can also be created using the core API or the JMS management API.</para>
+ <para>For the core API queues can be created via the <literal
+ >org.jboss.messaging.core.client.ClientSession</literal> interface. There are
+ multiple <literal>createQueue</literal> methods that support setting all of the afore
+ mentioned attributes. There is one extra atrribute that can be set via this API which is
+ <literal>temporary</literal>. setting this to true means that the queue will be
+ deleted once the session is disconnected.</para>
+ <para>Take a look at the <xref linkend="management">management section</xref> for the API
+ for creating queues.</para>
+ </section>
</chapter>
More information about the jboss-cvs-commits
mailing list