[jboss-cvs] JBossAS SVN: r76267 - trunk/tomcat/src/main/org/jboss/web/tomcat/service/modcluster/ha.

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

Author: bstansberry at jboss.com
Date: 2008-07-27 17:40:54 -0400 (Sun, 27 Jul 2008)
New Revision: 76267

Modified:
   trunk/tomcat/src/main/org/jboss/web/tomcat/service/modcluster/ha/ModClusterServiceHASingletonElectionPolicy.java
Log:
[JBAS-5659] Javadoc

Modified: trunk/tomcat/src/main/org/jboss/web/tomcat/service/modcluster/ha/ModClusterServiceHASingletonElectionPolicy.java
===================================================================
--- trunk/tomcat/src/main/org/jboss/web/tomcat/service/modcluster/ha/ModClusterServiceHASingletonElectionPolicy.java	2008-07-27 21:31:07 UTC (rev 76266)
+++ trunk/tomcat/src/main/org/jboss/web/tomcat/service/modcluster/ha/ModClusterServiceHASingletonElectionPolicy.java	2008-07-27 21:40:54 UTC (rev 76267)
@@ -27,12 +27,15 @@
 import java.util.List;
 
 import org.jboss.ha.framework.interfaces.ClusterNode;
+import org.jboss.ha.singleton.HASingletonElectionPolicy;
 import org.jboss.ha.singleton.HASingletonElectionPolicyBase;
 import org.jboss.ha.singleton.HASingletonElector;
 
 /**
+ * {@link HASingletonElectionPolicy} that factors the ability to communicate
+ * with proxy servers in its election decision.
+ * 
  * @author Brian Stansberry
- *
  */
 public class ModClusterServiceHASingletonElectionPolicy extends HASingletonElectionPolicyBase
 {
@@ -63,7 +66,16 @@
       List<ModClusterServiceDRMEntry> candidates = getHAPartition().getDistributedReplicantManager().lookupReplicants(getSingletonName());
       return narrowCandidateList(candidates);
    }
-
+   
+   /**
+    * Processes the candidate list, discarding those who don't match the best
+    * candidate when it comes to the ability to communicate with proxies.
+    * 
+    * @param candidates the universe of possible candidates.
+    * @return a list of candidates with an equivalent ability to communicate 
+    *         with proxies, or <code>null</code> if <code>candidates</code>
+    *         is <code>null</code>.
+    */
    public List<ClusterNode> narrowCandidateList(Collection<ModClusterServiceDRMEntry> candidates)
    {
       if (candidates == null)