[jboss-cvs] JBoss Messaging SVN: r8423 - branches/Branch_1_4/docs/userguide/en/modules.

[jboss-cvs-commits at lists.jboss.org]

Author: gaohoward
Date: 2011-08-16 20:58:55 -0400 (Tue, 16 Aug 2011)
New Revision: 8423

Modified:
   branches/Branch_1_4/docs/userguide/en/modules/recovery_config.xml
Log:
JBMESSAGING-1890
doc


Modified: branches/Branch_1_4/docs/userguide/en/modules/recovery_config.xml
===================================================================
--- branches/Branch_1_4/docs/userguide/en/modules/recovery_config.xml	2011-08-17 00:15:07 UTC (rev 8422)
+++ branches/Branch_1_4/docs/userguide/en/modules/recovery_config.xml	2011-08-17 00:58:55 UTC (rev 8423)
@@ -59,4 +59,47 @@
   <para>Please note that to configure the recovery manager to recovery
   transactions from any node of the cluster it will be necessary to specify a
   line in the configuration for every node of the cluster</para>
-</chapter>
\ No newline at end of file
+
+  <section id="recovery.conf.cluster">
+    <title>New XA Recovery Configuration for a Cluster</title>
+    <para>
+      To be able to correctly recover the transactions across a cluster, one way is to configure a MessagingXAReseourceRecovery for each node as mentioned above.
+      However this method is burdensome with a large cluster. Whenever a node is added to/removed from the cluster, each XA recovery configuration file will have to be updated.
+    </para>
+    <para>
+      This version of JBoss Messaging provides a new way to do so. It introduces a new recovery module called ClusteredMessagingXAResourceRecovery. With this new
+      module, XA recovery configuration for a cluster is as easy as that for a single node.
+    </para>
+
+    <para>Here's an example:</para>
+
+  <programlisting>
+     &lt;properties depends="arjuna" name="jta"&gt;
+        &lt;!--
+        Support subtransactions in the JTA layer?
+        Default is NO.
+        --&gt;
+        &lt;property name="com.arjuna.ats.jta.supportSubtransactions" value="NO"/&gt;
+        &lt;property name="com.arjuna.ats.jta.jtaTMImplementation"
+           value="com.arjuna.ats.internal.jta.transaction.arjunacore.TransactionManagerImple"/&gt;
+        &lt;property name="com.arjuna.ats.jta.jtaUTImplementation"
+           value="com.arjuna.ats.internal.jta.transaction.arjunacore.UserTransactionImple"/&gt;      
+        &lt;!--
+           *** Add this line to enable recovery for JMS resources using DefaultJMSProvider ***
+        --&gt;
+        &lt;property name="com.arjuna.ats.jta.recovery.XAResourceRecovery.JBMESSAGING1"
+           value="org.jboss.jms.server.recovery.ClusteredMessagingXAResourceRecovery;java:/DefaultJMSProvider"/&gt;
+
+    &lt;/properties&gt;
+     
+  </programlisting>
+
+   <para>Using the new configuration, it needs only one line for the whole cluster's XA recovery. On each scan, it will return the XAResource for each node in the cluster.
+         If a node is removed from or added to the cluster, it can get automatically update so there is no need to change this configuration.</para>
+
+   <para><note>
+      ClusteredMessagingXAResourceRecovery works only with JBoss Messaging and requires the JMS provider to provide a 'clustered connection factory' for its "FactoryRef" attribute. 
+   </note></para>
+
+  </section>
+</chapter>