From 4765dc83906e14e33a2c97c64d9367bf508a28e6 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Mon, 18 Nov 2013 15:58:34 +0000
Subject: [PATCH] ReplicationDomainDB.java, JEChangelogDB.java: In publishUpdateMsg(), added correct javadoc. In replicaHeartbeat() and replicaOffline(), changed parameter names + their javadoc.

---
 opends/src/server/org/opends/server/replication/server/changelog/api/ReplicationDomainDB.java |   14 ++++++++------
 1 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/opends/src/server/org/opends/server/replication/server/changelog/api/ReplicationDomainDB.java b/opends/src/server/org/opends/server/replication/server/changelog/api/ReplicationDomainDB.java
index 7ed476e..39c637e 100644
--- a/opends/src/server/org/opends/server/replication/server/changelog/api/ReplicationDomainDB.java
+++ b/opends/src/server/org/opends/server/replication/server/changelog/api/ReplicationDomainDB.java
@@ -210,7 +210,9 @@
       ServerState startAfterServerState) throws ChangelogException;
 
   /**
-   * for the specified serverId and replication domain.
+   * Publishes the provided change to the changelog DB for the specified
+   * serverId and replication domain. After a change has been successfully
+   * published, it becomes available to be returned by the External ChangeLog.
    *
    * @param baseDN
    *          the replication domain baseDN
@@ -231,11 +233,11 @@
    *
    * @param baseDN
    *          the replication domain baseDN
-   * @param csn
+   * @param heartbeatCSN
    *          The CSN heartbeat sent by this replica (contains the serverId and
    *          timestamp of the heartbeat)
    */
-  void replicaHeartbeat(DN baseDN, CSN csn);
+  void replicaHeartbeat(DN baseDN, CSN heartbeatCSN);
 
   /**
    * Let the DB know this replica is going down.
@@ -249,8 +251,8 @@
    *
    * @param baseDN
    *          the replication domain baseDN
-   * @param serverId
-   *          The replica's serverId going offline
+   * @param offlineCSN
+   *          The CSN (serverId and timestamp) for the replica's going offline
    */
-  void replicaOffline(DN baseDN, int serverId);
+  void replicaOffline(DN baseDN, CSN offlineCSN);
 }

--
Gitblit v1.10.0