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

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

Author: bstansberry at jboss.com
Date: 2009-06-12 17:09:45 -0400 (Fri, 12 Jun 2009)
New Revision: 90168

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

Modified: trunk/cluster/src/main/org/jboss/ha/framework/server/JChannelFactoryMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/server/JChannelFactoryMBean.java	2009-06-12 21:08:53 UTC (rev 90167)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/JChannelFactoryMBean.java	2009-06-12 21:09:45 UTC (rev 90168)
@@ -27,9 +27,7 @@
 import org.jgroups.ChannelException;
 
 /**
- * StandardMBean interface for {@link JChannelFactory}. Based on the 
- * <code>org.jgroups.jmx.JChannelFactoryMBean</code> interface, which
- * is scheduled to be removed.
+ * StandardMBean interface for {@link JChannelFactory}.
  * <p>
  * The plain-old-java-interface for the channel factory is 
  * <code>org.jgroups.ChannelFactory</code>; users are encouraged to dependency
@@ -130,7 +128,7 @@
    void setExposeProtocols(boolean f);
 
    /**
-    * Returns the stack configuration as a string (valid to be fed into new JChannel()). Throws an exception
+    * Returns the stack configuration as a string (valid to be fed into new JChannel(String)). Throws an exception
     * if the stack_name is not found. One of the setMultiplexerConfig() methods had to be called beforehand.
     * 
     * @return The protocol stack config as a plain string
@@ -151,12 +149,21 @@
 
    /**
     * Create a {@link Channel} using the specified stack. Channel will use a 
-    * shared transport if the <code>singleton-name</code> attribute is
-    * set on the stack's transport protocol.
+    * shared transport.
     * 
-    * @param stack_name the name of the stack
-    * @return the channel
+    * @param stack_name 
+    *            The name of the stack to be used. All stacks are defined in
+    *            the configuration with which the factory is configured (see
+    *            {@link #setMultiplexerConfig(Object)} for example. If
+    *            clients attempt to create a Channel for an undefined stack 
+    *            name an exception will be thrown.
     * 
+    * @return an implementation of Channel configured with a shared transport.
+    * 
+    * @throws IllegalArgumentException if <code>stack_name</code> is 
+    * <code>null</code> or {@link #getConfig(String)} returns <code>null</code>
+    * when <code>stack_name</code> is used.
+    * 
     * @throws Exception
     */
    Channel createChannel(String stack_name) throws Exception;