[jboss-cvs] JBossAS SVN: r60841 - in trunk/cluster/src/main/org/jboss: ha/framework/interfaces and 11 other directories.
jboss-cvs-commits at lists.jboss.org
jboss-cvs-commits at lists.jboss.org
Fri Feb 23 10:41:07 EST 2007
Author: jerrygauth
Date: 2007-02-23 10:41:07 -0500 (Fri, 23 Feb 2007)
New Revision: 60841
Modified:
trunk/cluster/src/main/org/jboss/cache/invalidation/bridges/JGCacheInvalidationBridgeMBean.java
trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java
trunk/cluster/src/main/org/jboss/ha/framework/server/FarmMemberServiceMBean.java
trunk/cluster/src/main/org/jboss/ha/framework/test/ExplicitFailoverClientInterceptor.java
trunk/cluster/src/main/org/jboss/ha/framework/test/ExplicitFailoverServerInterceptor.java
trunk/cluster/src/main/org/jboss/ha/hasessionstate/interfaces/HASessionState.java
trunk/cluster/src/main/org/jboss/ha/hasessionstate/interfaces/PackagedSession.java
trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateServiceMBean.java
trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateTopologyComputer.java
trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/PackagedSessionImpl.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/HASingletonSupport.java
trunk/cluster/src/main/org/jboss/invocation/http/interfaces/ClientMethodInterceptorHA.java
trunk/cluster/src/main/org/jboss/invocation/http/server/HAInvokerWrapper.java
trunk/cluster/src/main/org/jboss/invocation/http/server/HttpProxyFactoryHA.java
trunk/cluster/src/main/org/jboss/invocation/unified/interfaces/UnifiedInvokerHAProxy.java
trunk/cluster/src/main/org/jboss/invocation/unified/server/UnifiedInvokerHA.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-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/cache/invalidation/bridges/JGCacheInvalidationBridgeMBean.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -25,13 +25,13 @@
import org.jboss.system.ServiceMBean;
/**
- * Cache Invalidation bridge working over JavaGroup.
+ * MBean interface for JGroups cache invalidation bridge.
* The partition to be used and the invalidation manager can be defined as part
* of the MBean interface.
- * The bridge automatically discovers which are the InvalidationGroup that are
- * managed by other node of the cluster and only send invalidation information
+ * The bridge automatically discovers the InvalidationGroups that are
+ * managed by other nodes of the cluster and only sends invalidation information
* for these groups over the network. This makes this bridge very easy to setup
- * while still being efficient with network resource and CPU serialization cost.
+ * while still being efficient with network resources and CPU serialization cost.
*
* @see JGCacheInvalidationBridge
* @see org.jboss.cache.invalidation.InvalidationManager
@@ -51,7 +51,7 @@
{
/**
* Gets the name of the Clustering partition to be used to exchange
- * invalidation messages and discover which caches (i.e. InvalidationGroup)
+ * invalidation messages and discover which caches (i.e., InvalidationGroup)
* are available
*
* @return the name of the partition
@@ -61,7 +61,7 @@
String getPartitionName();
/**
* Sets the name of the Clustering partition to be used to exchange
- * invalidation messages and discover which caches (i.e. InvalidationGroup)
+ * invalidation messages and discover which caches (i.e., InvalidationGroup)
* are available
*
* @param name the name of the partition
@@ -72,7 +72,7 @@
/**
* Get the underlying partition used by this service to exchange
- * invalidation messages and discover which caches (i.e. InvalidationGroup)
+ * invalidation messages and discover which caches (i.e., InvalidationGroup)
* are available
*
* @return the partition
@@ -81,7 +81,7 @@
/**
* Sets the underlying partition used by this service to exchange
- * invalidation messages and discover which caches (i.e. InvalidationGroup)
+ * invalidation messages and discover which caches (i.e., InvalidationGroup)
* are available
*
* @param clusterPartition the partition
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-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/framework/interfaces/HAPartition.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -120,10 +120,12 @@
/**
*
- * @param serviceName
- * @param methodName
- * @param args
- * @param excludeSelf
+ * @param serviceName Name of the target service name on which calls are de-multiplexed
+ * @param methodName name of the Java method to be called on remote services
+ * @param args array of Java Object representing the set of parameters to be
+ * given to the remote method
+ * @param excludeSelf indicates if the RPC must also be made on the current
+ * node of the partition or only on remote nodes
* @return an array of responses from remote nodes
* @throws Exception
* @deprecated Use {@link #callMethodOnCluster(String, String, Object[], Class[], boolean)} instead
@@ -166,10 +168,12 @@
/**
*
- * @param serviceName
- * @param methodName
- * @param args
- * @param excludeSelf
+ * @param serviceName Name of the target service name on which calls are de-multiplexed
+ * @param methodName name of the Java method to be called on remote services
+ * @param args array of Java Object representing the set of parameters to be
+ * given to the remote method
+ * @param excludeSelf indicates if the RPC must also be made on the current
+ * node of the partition or only on remote nodes
* @throws Exception
* @deprecated Use {@link #callAsynchMethodOnCluster(String, String, Object[], Class[], boolean)} instead
*/
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-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/framework/server/FarmMemberServiceMBean.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -29,6 +29,7 @@
import org.jboss.deployment.scanner.URLDeploymentScannerMBean;
/**
+ * MBean interface for FarmMemberService
*
* @author <a href="mailto:bill at jboss.org">Bill Burke</a>
* @version $Revision$
Modified: trunk/cluster/src/main/org/jboss/ha/framework/test/ExplicitFailoverClientInterceptor.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/test/ExplicitFailoverClientInterceptor.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/framework/test/ExplicitFailoverClientInterceptor.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -25,7 +25,7 @@
import org.jboss.invocation.PayloadKey;
/**
- * Used for testing clustering: allows to explicitely makes a call to node fail
+ * Used for testing clustering; allows an explicit call to make a node fail.
* This will mimic a dead server.
*
* @see org.jboss.ha.framework.test.ExplicitFailoverServerInterceptor
Modified: trunk/cluster/src/main/org/jboss/ha/framework/test/ExplicitFailoverServerInterceptor.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/framework/test/ExplicitFailoverServerInterceptor.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/framework/test/ExplicitFailoverServerInterceptor.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -25,7 +25,7 @@
import org.jboss.ha.framework.interfaces.GenericClusteringException;
/**
- * Used for testing clustering: allows to explicitely makes a call to node fail
+ * Used for testing clustering; allows an explicit call to make a node fail.
* This will mimic a dead server.
*
* @see org.jboss.ha.framework.test.ExplicitFailoverClientInterceptor
Modified: trunk/cluster/src/main/org/jboss/ha/hasessionstate/interfaces/HASessionState.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/hasessionstate/interfaces/HASessionState.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/hasessionstate/interfaces/HASessionState.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -42,8 +42,9 @@
public void start () throws Exception;
/**
+ * Listener used to indicate that a session's state has changed.
* Information that can be used to clean a cache for example. It indicates that
- * another node has touched a session that we were previously owning.
+ * another node has touched a session that we previously owned.
*
*/
public interface HASessionStateListener
Modified: trunk/cluster/src/main/org/jboss/ha/hasessionstate/interfaces/PackagedSession.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/hasessionstate/interfaces/PackagedSession.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/hasessionstate/interfaces/PackagedSession.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -25,9 +25,11 @@
import java.io.Serializable;
/**
- * Information about a session that is shared by nodes in a same sub-partition
+ * Information about a session that is shared by nodes in the same subpartition
*
- * @see HASessionState, PackagedSessionImpl
+ * @see HASessionState
+ * @see org.jboss.ha.hasessionstate.server.PackagedSessionImpl
+ *
* @author sacha.labourey at cogito-info.ch
* @version $Revision$
*
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-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateServiceMBean.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -57,7 +57,7 @@
*
* @param name the name of the partition
*
- * @deprecated use {@link #setClusterPartition()}
+ * @deprecated use {@link #setClusterPartition(ClusterPartitionMBean)}
*/
void setPartitionName(String name);
Modified: trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateTopologyComputer.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateTopologyComputer.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/HASessionStateTopologyComputer.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -29,7 +29,8 @@
/**
* Helper interface to which is delegated new HASessionState topology computation
*
- * @see org.jboss.ha.hasessionstate.interfaces.HASessionState, HASessionStateTopologyComputerImpl
+ * @see org.jboss.ha.hasessionstate.interfaces.HASessionState
+ * @see HASessionStateTopologyComputerImpl
* @author sacha.labourey at cogito-info.ch
* @version $Revision$
*
Modified: trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/PackagedSessionImpl.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/PackagedSessionImpl.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/hasessionstate/server/PackagedSessionImpl.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -29,7 +29,8 @@
/**
* Default implementation of PackagedSession
*
- * @see PackagedSession, HASessionStateImpl
+ * @see PackagedSession
+ * @see HASessionStateImpl
* @author sacha.labourey at cogito-info.ch
* @version $Revision$
*/
Modified: trunk/cluster/src/main/org/jboss/ha/jmx/HAServiceMBean.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/jmx/HAServiceMBean.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/jmx/HAServiceMBean.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -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.
*
- * @deprecated use {@link #setClusterPartition()}
+ * @deprecated use {@link #setClusterPartition(ClusterPartitionMBean)}
*/
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-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/jndi/DetachedHANamingServiceMBean.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -52,7 +52,7 @@
*
* @param name the name of the partition
*
- * @deprecated use {@link #setClusterPartition()}
+ * @deprecated use {@link #setClusterPartition(ClusterPartitionMBean)}
*/
void setPartitionName(String name);
Modified: trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonSupport.java
===================================================================
--- trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonSupport.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/ha/singleton/HASingletonSupport.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -127,7 +127,7 @@
* of the isDRMMasterReplica() call.
*
* @see HAServiceMBeanSupport#partitionTopologyChanged(List, int)
- * @see DistributedReplicantManager#isMasterReplica(String)
+ * @see org.jboss.ha.framework.interfaces.DistributedReplicantManager#isMasterReplica(String)
*/
public void partitionTopologyChanged(List newReplicants, int newViewID)
{
Modified: trunk/cluster/src/main/org/jboss/invocation/http/interfaces/ClientMethodInterceptorHA.java
===================================================================
--- trunk/cluster/src/main/org/jboss/invocation/http/interfaces/ClientMethodInterceptorHA.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/invocation/http/interfaces/ClientMethodInterceptorHA.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -43,7 +43,7 @@
/** Handle methods locally on the client
*
* @param mi
- * @return
+ * @return the invocation response
* @throws Throwable
*/
public Object invoke(Invocation mi) throws Throwable
Modified: trunk/cluster/src/main/org/jboss/invocation/http/server/HAInvokerWrapper.java
===================================================================
--- trunk/cluster/src/main/org/jboss/invocation/http/server/HAInvokerWrapper.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/invocation/http/server/HAInvokerWrapper.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -89,7 +89,7 @@
* @param actionName
* @param params
* @param signature
- * @return
+ * @return the invocation response
* @throws MBeanException
* @throws ReflectionException
*/
Modified: trunk/cluster/src/main/org/jboss/invocation/http/server/HttpProxyFactoryHA.java
===================================================================
--- trunk/cluster/src/main/org/jboss/invocation/http/server/HttpProxyFactoryHA.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/invocation/http/server/HttpProxyFactoryHA.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -127,7 +127,7 @@
}
/** Override the HttpProxyFactory method to create a HttpInvokerProxyHA.
- * @return
+ * @return an invoker proxy
* @throws Exception
*/
protected Invoker createInvoker() throws Exception
Modified: trunk/cluster/src/main/org/jboss/invocation/unified/interfaces/UnifiedInvokerHAProxy.java
===================================================================
--- trunk/cluster/src/main/org/jboss/invocation/unified/interfaces/UnifiedInvokerHAProxy.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/invocation/unified/interfaces/UnifiedInvokerHAProxy.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -131,7 +131,7 @@
* will be initialized.
*
* @param invocationBasedRouting
- * @return
+ * @return remoting client
* @throws MalformedURLException
*/
protected Client getClient(Invocation invocationBasedRouting) throws MalformedURLException
Modified: trunk/cluster/src/main/org/jboss/invocation/unified/server/UnifiedInvokerHA.java
===================================================================
--- trunk/cluster/src/main/org/jboss/invocation/unified/server/UnifiedInvokerHA.java 2007-02-23 15:06:44 UTC (rev 60840)
+++ trunk/cluster/src/main/org/jboss/invocation/unified/server/UnifiedInvokerHA.java 2007-02-23 15:41:07 UTC (rev 60841)
@@ -107,7 +107,7 @@
* and invoke down the interceptor chain.
*
* @param invocationReq
- * @return
+ * @return response of the invocation
* @throws Throwable
*/
public Object invoke(InvocationRequest invocationReq) throws Throwable
More information about the jboss-cvs-commits
mailing list