[jboss-cvs] JBossAS SVN: r60809 - in trunk/cluster/src/main/org/jboss: ha/framework/interfaces and 5 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Thu Feb 22 17:02:33 EST 2007
Author: jerrygauth
Date: 2007-02-22 17:02:33 -0500 (Thu, 22 Feb 2007)
New Revision: 60809
Modified:
trunk/cluster/src/main/org/jboss/cache/invalidation/bridges/JGCacheInvalidationBridgeMBean.java
trunk/cluster/src/main/org/jboss/ha/framework/interfaces/DistributedReplicantManager.java
trunk/cluster/src/main/org/jboss/ha/framework/interfaces/DistributedState.java
trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java
trunk/cluster/src/main/org/jboss/ha/framework/server/ClusterPartition.java
trunk/cluster/src/main/org/jboss/ha/framework/server/ClusterPartitionMBean.java
trunk/cluster/src/main/org/jboss/ha/framework/server/DistributedReplicantManagerImplMBean.java
trunk/cluster/src/main/org/jboss/ha/framework/server/DistributedStateImplMBean.java
trunk/cluster/src/main/org/jboss/ha/framework/server/FarmMemberServiceMBean.java
trunk/cluster/src/main/org/jboss/ha/framework/server/HARMIServerImpl.java
trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateServiceMBean.java
trunk/cluster/src/main/org/jboss/ha/jmx/HAServiceMBean.java
trunk/cluster/src/main/org/jboss/ha/jndi/DetachedHANamingServiceMBean.java
trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonElectionPolicyMBean.java
trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonSupport.java
Log:
javadoc cleanup
Modified: trunk/cluster/src/main/org/jboss/cache/invalidation/bridges/JGCacheInvalidationBridgeMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/cache/invalidation/bridges/JGCacheInvalidationBridgeMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/cache/invalidation/bridges/JGCacheInvalidationBridgeMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -56,7 +56,7 @@
*
* @return the name of the partition
*
- * @deprecate use {@link #getClusterPartition()}
+ * @deprecated use {@link #getClusterPartition()}
*/
String getPartitionName();
/**
@@ -66,7 +66,7 @@
*
* @param name the name of the partition
*
- * @deprecate use {@link #setClusterPartition()}
+ * @deprecated use {@link #setClusterPartition(ClusterPartitionMBean)}
*/
void setPartitionName(String name);
Modified: trunk/cluster/src/main/org/jboss/ha/framework/interfaces/DistributedReplicantManager.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/interfaces/DistributedReplicantManager.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/interfaces/DistributedReplicantManager.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -28,6 +28,12 @@
/**
*
+ * DistributedReplicantManager is a service on top of HAPartition that provides a
+ * cluster-wide distributed state which is node-specific. The DistributedReplicantManager (DRM)
+ * service provides a <String key, Serializable replicant> tuple map. Each node in the cluster
+ * stores its own data for a given key. This data is replicated so that reading values for a key
+ * is always performed locally.
+ *
* @author <a href="mailto:bill at burkecentral.com">Bill Burke</a>.
* @author <a href="mailto:sacha.labourey at cogito-info.ch">Sacha Labourey</a>.
* @version $Revision$
Modified: trunk/cluster/src/main/org/jboss/ha/framework/interfaces/DistributedState.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/interfaces/DistributedState.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/interfaces/DistributedState.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -27,7 +27,7 @@
/**
* DistributedState is a service on top of HAPartition that provides a
* cluster-wide distributed state. The DistributedState (DS) service
- * provides a <String category, Serializable key, Serializable value> tuple
+ * provides a <String category, Serializable key, Serializable value> tuple
* map. Thus, any service, application, container, ... can request its own DS
* "private space" by working* in its own category (a string name).
* You work in a category like a Dictionary: you set values by key within a
Modified: trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -26,7 +26,10 @@
import java.util.ArrayList;
/**
- *
+ * HAPartition is an abstraction of the communication framework, providing access
+ * to clustered services such as Distributed State, Distributed Replicant Manager
+ * and RPC.
+ *
* @author <a href="mailto:bill at burkecentral.com">Bill Burke</a>.
* @author <a href="mailto:sacha.labourey at cogito-info.ch">Sacha Labourey</a>.
* @version $Revision$
@@ -109,7 +112,7 @@
* @param excludeSelf indicates if the RPC must also be made on the current
* node of the partition or only on remote nodes
* @throws Exception Throws if a communication exception occurs
- * @return an array of answers from remote nodes
+ * @return an array of responses from remote nodes
*/
public ArrayList callMethodOnCluster(String serviceName, String methodName,
Object[] args, Class[] types, boolean excludeSelf) throws Exception;
@@ -121,7 +124,7 @@
* @param methodName
* @param args
* @param excludeSelf
- * @return
+ * @return an array of responses from remote nodes
* @throws Exception
* @deprecated Use {@link #callMethodOnCluster(String, String, Object[], Class[], boolean)} instead
*/
@@ -155,7 +158,7 @@
* @param excludeSelf indicates if the RPC will be made on the current node even if the current node
* is the coordinator
* @throws Exception Throws if a communication exception occurs
- * @return an array of answers from remote nodes
+ * @return an array of responses from remote nodes
*/
public ArrayList callMethodOnCoordinatorNode(String serviceName, String methodName,
Object[] args, Class[] types, boolean excludeSelf) throws Exception;
@@ -247,7 +250,9 @@
{
// Nothing new
}
-
+
+ /** Extends HAMembershipListener to receive notification when a network-partition merge occurs.
+ */
public interface HAMembershipExtendedListener extends HAPartition.HAMembershipListener
{
/** Extends HAMembershipListener to receive a specific callback when a
Modified: trunk/cluster/src/main/org/jboss/ha/framework/server/ClusterPartition.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/server/ClusterPartition.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/ClusterPartition.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -854,7 +854,7 @@
* @param methodName
* @param args
* @param excludeSelf
- * @return
+ * @return an array of responses from remote nodes
* @throws Exception
* @deprecated Use {@link #callMethodOnCluster(String,String,Object[],Class[], boolean)} instead
*/
@@ -947,7 +947,7 @@
* @param args
* @param types
* @param excludeSelf
- * @return
+ * @return an array of responses from remote nodes
* @throws Exception
*/
public ArrayList callMethodOnCoordinatorNode(String objName, String methodName,
@@ -966,7 +966,7 @@
* @param types
* @param excludeSelf
* @param methodTimeout
- * @return
+ * @return an array of responses from remote nodes
* @throws Exception
*/
public ArrayList callMethodOnCoordinatorNode(String objName, String methodName,
Modified: trunk/cluster/src/main/org/jboss/ha/framework/server/ClusterPartitionMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/server/ClusterPartitionMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/ClusterPartitionMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -33,7 +33,7 @@
import org.jgroups.jmx.JChannelFactoryMBean;
/**
- * Management Bean for Cluster HAPartitions. It will start a JGroups
+ * MBean interface for ClusterPartition. It will start a JGroups
* channel and initialize the ReplicantManager and DistributedStateService.
*
* @author <a href="mailto:bill at burkecentral.com">Bill Burke</a>.
Modified: trunk/cluster/src/main/org/jboss/ha/framework/server/DistributedReplicantManagerImplMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/server/DistributedReplicantManagerImplMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/DistributedReplicantManagerImplMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -22,7 +22,7 @@
package org.jboss.ha.framework.server;
/**
- * Used as a static MBean interface for the DRM service
+ * MBean interface for the Distributed Replicant Manager (DRM) service
*
* @author <a href="mailto:sacha.labourey at cogito-info.ch">Sacha Labourey</a>.
* @version $Revision$
Modified: trunk/cluster/src/main/org/jboss/ha/framework/server/DistributedStateImplMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/server/DistributedStateImplMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/DistributedStateImplMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -24,6 +24,8 @@
import org.jboss.cache.Cache;
/**
+ * MBean interface for the Distributed State (DS) service
+ *
* @author <a href="mailto:sacha.labourey at cogito-info.ch">Sacha Labourey</a>.
* @version $Revision$
*
Modified: trunk/cluster/src/main/org/jboss/ha/framework/server/FarmMemberServiceMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/server/FarmMemberServiceMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/FarmMemberServiceMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -48,14 +48,14 @@
*
* @return the name of the partition
*
- * @deprecate use {@link #getClusterPartition()}
+ * @deprecated use {@link #getClusterPartition()}
*/
String getPartitionName();
/**
* Backward compatibility, but ignored as it does nothing.
*
- * @deprecated use {@link #setClusterPartition()}
+ * @deprecated use {@link #setClusterPartition(ClusterPartitionMBean)}
*/
void setPartitionName(String name);
Modified: trunk/cluster/src/main/org/jboss/ha/framework/server/HARMIServerImpl.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/server/HARMIServerImpl.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/HARMIServerImpl.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -158,11 +158,11 @@
/**
* Once a HARMIServer implementation exists, it is possible to ask for a stub that can, for example,
- * be bound in JNDI for client use. Each client stub may incorpore a specific load-balancing
+ * be bound in JNDI for client use. Each client stub may incorporate a specific load-balancing
* policy.
*
* @param policy {@link org.jboss.ha.framework.interfaces.LoadBalancePolicy} implementation to ues on the client.
- * @return
+ * @return proxy instance object
*/
public Object createHAStub(LoadBalancePolicy policy)
{
Modified: trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateServiceMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateServiceMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateServiceMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -49,7 +49,7 @@
*
* @return the name of the partition
*
- * @deprecate use {@link #getClusterPartition()}
+ * @deprecated use {@link #getClusterPartition()}
*/
String getPartitionName();
/**
@@ -57,7 +57,7 @@
*
* @param name the name of the partition
*
- * @deprecate use {@link #setClusterPartition()}
+ * @deprecated use {@link #setClusterPartition()}
*/
void setPartitionName(String name);
Modified: trunk/cluster/src/main/org/jboss/ha/jmx/HAServiceMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/jmx/HAServiceMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/jmx/HAServiceMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -46,7 +46,7 @@
/**
* Name of the underlying partition that determine the cluster to use.
*
- * @deprecate use {@link #getClusterPartition()}
+ * @deprecated use {@link #getClusterPartition()}
*/
String getPartitionName();
@@ -54,7 +54,7 @@
* Set the name of the underlying partition that determine the cluster to use.
* Can be set only when the MBean is not in a STARTED or STARTING state.
*
- * @deprecate use {@link #setClusterPartition()}
+ * @deprecated use {@link #setClusterPartition()}
*/
void setPartitionName(String partitionName);
Modified: trunk/cluster/src/main/org/jboss/ha/jndi/DetachedHANamingServiceMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/jndi/DetachedHANamingServiceMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/jndi/DetachedHANamingServiceMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -44,7 +44,7 @@
*
* @return the name of the partition
*
- * @deprecate use {@link #getClusterPartition()}
+ * @deprecated use {@link #getClusterPartition()}
*/
String getPartitionName();
/**
@@ -52,7 +52,7 @@
*
* @param name the name of the partition
*
- * @deprecate use {@link #setClusterPartition()}
+ * @deprecated use {@link #setClusterPartition()}
*/
void setPartitionName(String name);
Modified: trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonElectionPolicyMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonElectionPolicyMBean.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonElectionPolicyMBean.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -78,5 +78,5 @@
* @param partition
* @return true only if the managed service is the master
*/
- public boolean isElectedMaster(HAPartition partiton);
+ public boolean isElectedMaster(HAPartition partition);
}
Modified: trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonSupport.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonSupport.java 2007-02-22 20:42:50 UTC (rev 60808)
+++ trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonSupport.java 2007-02-22 22:02:33 UTC (rev 60809)
@@ -127,7 +127,7 @@
* of the isDRMMasterReplica() call.
*
* @see HAServiceMBeanSupport#partitionTopologyChanged(List, int)
- * @see DistributedReplicantManager#isMasterReplica(String);
+ * @see DistributedReplicantManager#isMasterReplica(String)
*/
public void partitionTopologyChanged(List newReplicants, int newViewID)
{
More information about the jboss-cvs-commits
mailing list