[jboss-cvs] JBossAS SVN: r69148 - trunk/cluster/src/main/org/jboss/ha/framework/server.

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

Author: bstansberry at jboss.com
Date: 2008-01-20 14:05:37 -0500 (Sun, 20 Jan 2008)
New Revision: 69148

Modified:
   trunk/cluster/src/main/org/jboss/ha/framework/server/JChannelFactory.java
Log:
Javadoc

Modified: trunk/cluster/src/main/org/jboss/ha/framework/server/JChannelFactory.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/server/JChannelFactory.java	2008-01-20 18:10:49 UTC (rev 69147)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/JChannelFactory.java	2008-01-20 19:05:37 UTC (rev 69148)
@@ -61,13 +61,27 @@
 
    /**
     * Overrides the superclass version by generating a unique node id
-    * and passing it down the Channel as additional_data.
+    * and passing it down the Channel as additional_data and by suppressing the 
+    * <code>register_for_state_transfer</code> param.
+    * <p/>
+    * The additional data is the value of {@link #getNodeName()} which either
+    * can be injected as part of configuration or will be calculated 
+    * the first time a channel is created.
+    * <p/>
+    * Suppressing the <code>register_for_state_transfer</code> param is necessary
+    * to avoid issues that occur with JGroups when it is <code>true</code>.
+    * In JBoss AS there is little benefit to setting this to true, as the 
+    * single-threaded nature of deployments in the AS ensures that services 
+    * always connect channels and request state transfer in series, with no
+    * interleaving. 
+    * 
+    * @param register_for_state_transfer  ignored; always treated as <code>false</code>
     */
    @Override
    public Channel createMultiplexerChannel(String stack_name, String id, boolean register_for_state_transfer, String substate_id) throws Exception
    {
-      // Due to JBMESSAGING-1120, we suppress register_for_state_transfer usage.
-      // FIXME revert to normal when JBMESSAGING-1120 is fixed
+      // Due to problems with coordinated state transfer, we suppress register_for_state_transfer usage.
+      // TODO revert to normal if coordinated state transfer is fixed
 //      Channel channel = super.createMultiplexerChannel(stack_name, id, register_for_state_transfer, substate_id);
       Channel channel = super.createMultiplexerChannel(stack_name, id, false, null);