directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1415938 - /directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java
Date Sat, 01 Dec 2012 07:16:29 GMT
Author: elecharny
Date: Sat Dec  1 07:16:28 2012
New Revision: 1415938

URL: http://svn.apache.org/viewvc?rev=1415938&view=rev
Log:
Small javadoc improvements

Modified:
    directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java

Modified: directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java
URL: http://svn.apache.org/viewvc/directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java?rev=1415938&r1=1415937&r2=1415938&view=diff
==============================================================================
--- directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java
(original)
+++ directory/apacheds/trunk/protocol-ldap/src/main/java/org/apache/directory/server/ldap/replication/consumer/ReplicationConsumer.java
Sat Dec  1 07:16:28 2012
@@ -26,7 +26,7 @@ import org.apache.directory.server.ldap.
 
 
 /**
- * An interface for providers of a service which receives the ldap entries as and when a

+ * An interface for consumers of a service which receives the ldap entries as and when a

  * event happens in the server. The data received might vary based on the internal configuration
  * used by implementation.
  *
@@ -35,7 +35,7 @@ import org.apache.directory.server.ldap.
 public interface ReplicationConsumer
 {
     /**
-     * sets the configuration of the consumer
+     * Sets the configuration of the consumer
      * 
      * @param config the configuration of the consumer
      */
@@ -49,16 +49,16 @@ public interface ReplicationConsumer
 
 
     /**
-     * initializes the consumer
+     * Initializes the consumer
      * 
      * @param dirService the DirectoryService
-     * @throws Exception
+     * @throws Exception If the initialization failed
      */
     void init( DirectoryService dirService ) throws Exception;
 
 
     /**
-     * starts the consumer
+     * Starts the consumer, connection immediately or wait before reconnection
      * 
      * @param now A param that tells the consumer to connect immediately or not
      */
@@ -66,13 +66,12 @@ public interface ReplicationConsumer
 
 
     /**
-     * stops the consumer
+     * Stops the consumer
      */
     void stop();
 
 
     /**
-     * the identifier of this consumer instance
      * @return the identifier of the consumer instance
      */
     String getId();



Mime
View raw message