From 842e0d3bed5e3bbee62607a7c606aeaa233aa366 Mon Sep 17 00:00:00 2001
From: pgamba <pgamba@localhost>
Date: Fri, 04 Jan 2008 17:17:55 +0000
Subject: [PATCH] Fix comments

---
 opendj-sdk/opends/src/server/org/opends/server/replication/protocol/MonitorMessage.java |   53 +++++++++++++++++++++++++++++------------------------
 1 files changed, 29 insertions(+), 24 deletions(-)

diff --git a/opendj-sdk/opends/src/server/org/opends/server/replication/protocol/MonitorMessage.java b/opendj-sdk/opends/src/server/org/opends/server/replication/protocol/MonitorMessage.java
index 51863da..2e50e35 100644
--- a/opendj-sdk/opends/src/server/org/opends/server/replication/protocol/MonitorMessage.java
+++ b/opendj-sdk/opends/src/server/org/opends/server/replication/protocol/MonitorMessage.java
@@ -42,9 +42,10 @@
 
 /**
  * This message is part of the replication protocol.
- * This message is sent by a server to one or several other servers and
- * contain one entry to be sent over the protocol in the context of
- * an import/export over the protocol.
+ * RS1 sends a MonitorRequestMessage to RS2 to requests its monitoring
+ * informations.
+ * When RS2 receives a MonitorRequestMessage from RS1, RS2 responds with a
+ * MonitorMessage.
  */
 public class MonitorMessage extends RoutableMessage implements
     Serializable
@@ -53,8 +54,9 @@
   private static final long serialVersionUID = -1900670921496804942L;
 
   /**
-   * FIXME.
-   *
+   * Data structure to manage the state and the approximation
+   * of the data of the first missing change for each LDAP server
+   * connected to a Replication Server.
    */
   class ServerData
   {
@@ -63,7 +65,8 @@
   }
 
   /**
-   * FIXME.
+   * Data structure to manage the state of the replication server
+   * and the state informations for the LDAP servers connected.
    *
    */
   class SubTopoMonitorData
@@ -87,8 +90,8 @@
   }
 
   /**
-   * FIXME.
-   * @param state a.
+   * Sets the state of the replication server.
+   * @param state The state.
    */
   public void setReplServerState(ServerState state)
   {
@@ -96,14 +99,15 @@
   }
 
   /**
-   * FIXME.
-   * @param serverId a.
-   * @param state a.
-   * @param olderUpdateTime a.
+   * Sets the informations of an LDAP server.
+   * @param serverId The serverID.
+   * @param state The server state.
+   * @param approxFirstMissingDate  The approximation of the date
+   * of the older missing change.
    *
    */
   public void setLDAPServerState(short serverId, ServerState state,
-      Long olderUpdateTime)
+      Long approxFirstMissingDate)
   {
     if (data.ldapStates == null)
     {
@@ -111,14 +115,14 @@
     }
     ServerData sd = new ServerData();
     sd.state = state;
-    sd.approxFirstMissingDate = olderUpdateTime;
+    sd.approxFirstMissingDate = approxFirstMissingDate;
     data.ldapStates.put(serverId, sd);
   }
 
   /**
-   * FIXME.
-   * @param serverId a.
-   * @return a.
+   * Get the server state for the LDAP server with the provided serverId.
+   * @param serverId The provided serverId.
+   * @return The state.
    */
   public ServerState getLDAPServerState(short serverId)
   {
@@ -126,9 +130,10 @@
   }
 
   /**
-   * FIXME.
-   * @param serverId a.
-   * @return a.
+   * Get the approximation of the date of the older missing change for the
+   * LDAP Server with the provided server Id.
+   * @param serverId The provided serverId.
+   * @return The approximated state.
    */
   public Long getApproxFirstMissingDate(short serverId)
   {
@@ -353,8 +358,8 @@
   }
 
   /**
-   * FIXME.
-   * @return FIXME.
+   * Get the state of the replication server that sent this message.
+   * @return The state.
    */
   public ServerState getReplServerState()
   {
@@ -362,8 +367,8 @@
   }
 
   /**
-   * FIXME.
-   * @return a.
+   * Returns an iterator on the serverId of the connected LDAP servers.
+   * @return The iterator.
    */
   public Iterator<Short> iterator()
   {

--
Gitblit v1.10.0