[jboss-cvs] JBossAS SVN: r57641 - projects/cluster/trunk/ha-client/src/main/java/org/jboss/ha/client

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

Author: bstansberry at jboss.com
Date: 2006-10-12 23:26:49 -0400 (Thu, 12 Oct 2006)
New Revision: 57641

Modified:
   projects/cluster/trunk/ha-client/src/main/java/org/jboss/ha/client/GenericClusteringException.java
Log:
Fix license and package; add javadoc

Modified: projects/cluster/trunk/ha-client/src/main/java/org/jboss/ha/client/GenericClusteringException.java
===================================================================
--- projects/cluster/trunk/ha-client/src/main/java/org/jboss/ha/client/GenericClusteringException.java	2006-10-13 03:26:14 UTC (rev 57640)
+++ projects/cluster/trunk/ha-client/src/main/java/org/jboss/ha/client/GenericClusteringException.java	2006-10-13 03:26:49 UTC (rev 57641)
@@ -19,53 +19,37 @@
   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
   */
-package org.jboss.ha.framework.interfaces;
+package org.jboss.ha.client;
 
-import org.jboss.util.NestedException;
-
 /**
- * Generic clustering exception that can be used to replace other exceptions
- * that occur on the server. Thus, only this class is needed on the client side
- * and some specific server side exceptions class are not needed on the client side
- * (such as JMX exceptions for example). 
- * Furhtermore, it has support for "COMPLETED" status flag a la IIOP.
- *
- * @author  <a href="mailto:sacha.labourey at cogito-info.ch">Sacha Labourey</a>.
- * @version $Revision$
- *
- * <p><b>Revisions:</b>
- *
- * <p><b>8 avril 2002 Sacha Labourey:</b>
- * <ul>
- * <li> First implementation </li>
- * </ul>
+ * Generic clustering exception that can be used to replace other exceptions that occur on the server. Thus, only this class is needed on the client side and some specific server side exceptions classes are not needed on the client side (such as JMX exceptions for example).  Furthermore, it has support for "COMPLETED" status flag a la IIOP.
+ * @author   <a href="mailto:sacha.labourey at cogito-info.ch">Sacha Labourey</a>.
+ * @author  brian.stansberry at jboss.com
+ * @version  $Revision$  <p><b>Revisions:</b>  <p><b>8 avril 2002 Sacha Labourey:</b>  <ul>  <li> First implementation </li>  </ul>
  */
 
 public class GenericClusteringException
-   extends NestedException
+   extends Exception
 {
-   // When an invocation reaches a node, it may be invoked on the actual
-   // target or not (or not completely). If COMPLETED_NO and working in 
-   // a clustered environment, the client proxy is allowed to invoke
-   // the same invocation on a different node. Otherwise, it will depend
-   // if the target method is idempotent: this is no more the problem of
-   // this class but rather the meta-data of the business environment
-   // that can give this information
-   //
+   /** The serialVersionUID */
+   private static final long serialVersionUID = 7008819559854309729L;
+   
+   /** Means the invocation that generated this exception was invoked on the server-side target */
    public final static int COMPLETED_YES = 0;
+   /** Means the invocation that generated this exception was *not* invoked on the server-side target */
    public final static int COMPLETED_NO = 1;
+   /** 
+    * Means it is unclear whether the invocation that generated this exception 
+    * was invoked on the server-side target 
+    */
    public final static int COMPLETED_MAYBE = 2;
    
-   public boolean isDefinitive = true;
+   private boolean isDefinitive = true;
+   private int completed;
    
-   // if yes, then the invocation may be retried against another node
-   // because the state has not been modified by the current invocation
-   //
-   public int completed;
-   
    public GenericClusteringException ()
    {
-      this.completed = this.COMPLETED_MAYBE;
+      this.completed = COMPLETED_MAYBE;
    }
    
    public GenericClusteringException (int CompletionStatus)
@@ -99,6 +83,22 @@
       this.completed = CompletionStatus;
    }
    
+   /** 
+    * Gets whether the invocation that generated this exception was completely
+    * invoked on the server side target.
+    * <p>
+    * When an invocation reaches a node, it may be invoked on the actual
+    * target or not (or not completely). If COMPLETED_NO and working in 
+    * a clustered environment, the client proxy is allowed to invoke
+    * the same invocation on a different node. Otherwise, it will depend
+    * if the target method is idempotent: this is not the problem of
+    * this class but rather the meta-data of the business environment
+    * that can give this information
+    * </p>
+    * 
+    * @return {@link #COMPLETED_YES}, {@link #COMPLETED_NO} or 
+    *         {@link #COMPLETED_MAYBE}.
+    */
    public int getCompletionStatus ()
    {
       return this.completed;
@@ -109,9 +109,10 @@
       this.completed = completionStatus;
    }
    
-   // Indicates if the exception will most probably be repetitive (definitive)
-   // or if it is just a temporary failure and new attempts should be tried
-   //
+   /**
+    * Indicates if the exception will most probably be repetitive (definitive) or if it is just a temporary failure and new attempts should be tried
+    * @uml.property  name="isDefinitive"
+    */
    public boolean isDefinitive ()
    {
       return this.isDefinitive;