[hornetq-commits] JBoss hornetq SVN: r9021 - in trunk/docs/user-manual/en: images and 1 other directory.

[do-not-reply at jboss.org]

Author: ataylor
Date: 2010-03-31 06:18:29 -0400 (Wed, 31 Mar 2010)
New Revision: 9021

Added:
   trunk/docs/user-manual/en/images/console1.png
Modified:
   trunk/docs/user-manual/en/management.xml
Log:
added doc section for admin console

Added: trunk/docs/user-manual/en/images/console1.png
===================================================================
(Binary files differ)


Property changes on: trunk/docs/user-manual/en/images/console1.png
___________________________________________________________________
Name: svn:mime-type
   + application/octet-stream

Modified: trunk/docs/user-manual/en/management.xml
===================================================================
--- trunk/docs/user-manual/en/management.xml	2010-03-31 10:08:45 UTC (rev 9020)
+++ trunk/docs/user-manual/en/management.xml	2010-03-31 10:18:29 UTC (rev 9021)
@@ -906,4 +906,55 @@
             message counters to retrieve information on a JMS <literal>Queue</literal>.</para>
       </section>
    </section>
+   <section>
+      <title>Administering HornetQ Resources Using The JBoss AS Admin Console</title>
+      <para>Its possible to create and configure HornetQ resources via the admin console within the JBoss Application Server.</para>
+      <para>The Admin Console will allow you to create destinations (JMS Topics and Queues) and JMS Connection Factories.</para>
+      <para>Once logged in to the admin console you will see a JMS Manager item in the left hand tree. All HornetQ resources
+      will be configured via this. This will have a child items for JMS Queues, Topics and Connection Factories, clicking
+         on each node will reveal which resources are currently available. The following sections explain how to create
+         and configure each resource in turn.</para>
+      <section>
+         <title>JMS Queues</title>
+         <para>To create a new JMS Queue click on the JMS Queues item to reveal the available queues. On the right hand
+            panel you will see an add a new resource button, click on this and then choose the default(JMS Queue) template
+         and click continue. The important things to fill in here are the name of the queue and the JNDI name of the
+            queue. The JNDI name is what you will use to look up the queue in JNDI from your client. For most queues this
+            will be the only info you will need to provide as sensible defaults are provided for the others. You will also
+            see a security roles section near the bottom. If you do not provide any roles for this queue then the servers
+         default security configuration will be used, after you have created the queue these will be shown in the configuration.
+         All configuration values, except the name and JNDI name, can be changed via the configuration tab after clicking
+            on the queue in the admin console. The following section explains these in more detail</para>
+         <para>After highlighting the configuration you will see the following screen</para>
+         <para>
+            <graphic fileref="images/console1.png" align="center"/>
+        </para>
+         <para>The name and JNDI name cant be changed, if you want to change these recreate the queue with the appropriate
+         settings. The rest of the configuration options, apart from security roles, relate to address settings for a particular
+         address. The default address settings are picked up from the servers configuration, if you change any of these
+         settings or create a queue via the console a new Address Settings enrty will be added. For a full explanation on
+         Address Settings see <xref linkend="queue-attributes.address-settings"/></para>
+         <para>To delete a queue simply click on the delete button beside the queue name in the main JMS Queues screen.
+         This will also delete any address settings or security settings previously created for the queues address</para>
+         <para>The last part of the configuration options are security roles. If non are provided on creation then the
+            servers default security settings will be shown. If these are changed or updated then new securty settings are
+         created for the address of this queue. For more information on securuty setting see <xref linkend="security"/> </para>
+         <para>It is also possible via the metrics tab to view statistics for this queue. This will show statistics such
+            as message count, consumer count etc.</para>
+         <para>Operations can be performed on a queue via the control tab. This will allow you to start and stop the queue,
+         list,move,expire and delete messages from the queue and other useful operations. To invoke an operation click on
+         the button for the operation you want, this will take you to a screen where you can parameters for the opertion can be set.
+         Once set clicking the ok button will invoke the operation, results appear at the bottom of the screen.</para>
+      </section>
+      <section>
+         <title>JMS Topics</title>
+         <para>Creating and configuring JMS Topics is almost identical to creating queues. The only difference is that the
+         configuration will be applied to the queue representing a subscription.</para>
+      </section>
+      <section>
+         <title>JMS Connection Factories</title>
+         <para>The format for creating connection factories is the same as for JMS Queues and topics apart frm the configuration
+         being different. For as list of all the connection factory settings see the configuration index </para>
+      </section>
+   </section>
 </chapter>