svn commit: r657453 - in /webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering: configuration/ConfigurationManagerListener.java context/ContextManagerListener.java

[az...@apache.org]

Author: azeez
Date: Sat May 17 12:59:49 2008
New Revision: 657453

URL: http://svn.apache.org/viewvc?rev=657453&view=rev
Log:
Added documentation


Modified:
    webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/configuration/ConfigurationManagerListener.java
    webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/context/ContextManagerListener.java

Modified: webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/configuration/ConfigurationManagerListener.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/configuration/ConfigurationManagerListener.java?rev=657453&r1=657452&r2=657453&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/configuration/ConfigurationManagerListener.java (original)
+++ webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/configuration/ConfigurationManagerListener.java Sat May 17 12:59:49 2008
@@ -22,25 +22,69 @@
 import org.apache.axis2.context.ConfigurationContext;
 
 /**
- * This is the counterpart of {@link ConfigurationManager}
+ * This is the counterpart of {@link ConfigurationManager}. On the message sending side,
+ * the ConfigurationManager will send a context replication message, which on the receiving
+ * side will be handed over to the implementer of this interface. So when a node sends a message
+ * through using its ConfigurationManager, all receivers will be notified through their respective
+ * ConfigurationManagerListeners.
  */
 public interface ConfigurationManagerListener {
 
+    /**
+     * Notification that a load service groups message has been received.
+     *
+     * @param command The message
+     */
     void serviceGroupsLoaded(ConfigurationClusteringCommand command);
 
+    /**
+     * Notification that an unload seervice groups message has been received.
+     *
+     * @param command  The message
+     */
     void serviceGroupsUnloaded(ConfigurationClusteringCommand command);
 
+    /**
+     * Notification that an apply policy to service message has been received.
+     *
+     * @param command The message
+     */
     void policyApplied(ConfigurationClusteringCommand command);
 
+    /**
+     * Notification that a reload configuration message has been received.
+     *
+     * @param command The message
+     */
     void configurationReloaded(ConfigurationClusteringCommand command);
 
+    /**
+     * Prepare to commit cpmfiguration changes
+     */
     void prepareCalled();
 
+    /**
+     * Rollback configuration changes
+     */
     void rollbackCalled();
 
+    /**
+     * Commit configuration changes
+     */
     void commitCalled();
 
+    /**
+     * An exception has occurred on a remote node while processing a configuration change command
+     *
+     * @param throwable The exception that occurred on the remote node
+     */
     void handleException(Throwable throwable);
 
+    /**
+     * Set the system's configuration context. This will be used by the clustering implementations
+     * to get information about the Axis2 environment and to correspond with the Axis2 environment
+     *
+     * @param configurationContext The configuration context
+     */
     void setConfigurationContext(ConfigurationContext configurationContext);
 }

Modified: webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/context/ContextManagerListener.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/context/ContextManagerListener.java?rev=657453&r1=657452&r2=657453&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/context/ContextManagerListener.java (original)
+++ webservices/axis2/trunk/java/modules/kernel/src/org/apache/axis2/clustering/context/ContextManagerListener.java Sat May 17 12:59:49 2008
@@ -22,9 +22,29 @@
 import org.apache.axis2.clustering.ClusteringFault;
 import org.apache.axis2.context.ConfigurationContext;
 
+/**
+ * This is the countepart of the {@link ContextManager} implementation. On the message sending side,
+ * the ContextManager will send a context replication message, which on the receiving
+ * side will be handed over to the implementer of this interface. So when a node sends a message
+ * through using its ContextManager, all receivers will be notified through their respective
+ * ContextManagerListeners.
+ */
 public interface ContextManagerListener {
-    
+
+    /**
+     * Notification that a context replication message has been received. The receiver will have to
+     * take appropriate action to process this message
+     *
+     * @param message The context replication message
+     * @throws ClusteringFault If an error occurs while processing the received message
+     */
     public void contextUpdated(ContextClusteringCommand message) throws ClusteringFault;
 
+    /**
+     * Set the system's configuration context. This will be used by the clustering implementations
+     * to get information about the Axis2 environment and to correspond with the Axis2 environment
+     *
+     * @param configurationContext The configuration context
+     */
     public void setConfigurationContext(ConfigurationContext configurationContext);
 }