svn commit: r485983 - in /directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service: ReplicationLogCleanJob.java ReplicationService.java

[tr...@apache.org]

Author: trustin
Date: Mon Dec 11 18:26:30 2006
New Revision: 485983

URL: http://svn.apache.org/viewvc?view=rev&rev=485983
Log:
Added JavaDoc for ReplicationService.purgeAgedData() and ReplicationLogCleanJob

Modified:
    directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationLogCleanJob.java
    directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationService.java

Modified: directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationLogCleanJob.java
URL: http://svn.apache.org/viewvc/directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationLogCleanJob.java?view=diff&rev=485983&r1=485982&r2=485983
==============================================================================
--- directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationLogCleanJob.java (original)
+++ directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationLogCleanJob.java Mon Dec 11 18:26:30 2006
@@ -24,13 +24,22 @@
 
 import javax.naming.NamingException;
 
+import org.apache.directory.mitosis.common.Constants;
 import org.apache.directory.server.core.DirectoryService;
 import org.apache.directory.server.core.interceptor.Interceptor;
 import org.quartz.Job;
 import org.quartz.JobExecutionContext;
 import org.quartz.JobExecutionException;
 
-
+/**
+ * A <a href="http://www.opensymphony.com/quartz/">OpenSymphony Quartz</a>
+ * {@link Job} that purges old replication logs and the old entries marked as
+ * 'deleted' (i.e. {@link Constants#ENTRY_DELETED} is <tt>true</tt>).  This
+ * {@link Job} just calls {@link ReplicationService#purgeAgedData()} to
+ * purge old data. 
+ * 
+ * @author The Apache Directory Project Team
+ */
 public class ReplicationLogCleanJob implements Job
 {
     public static final String INSTANCE_ID = "instanceId";

Modified: directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationService.java
URL: http://svn.apache.org/viewvc/directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationService.java?view=diff&rev=485983&r1=485982&r2=485983
==============================================================================
--- directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationService.java (original)
+++ directory/trunks/apacheds/mitosis/src/main/java/org/apache/directory/mitosis/service/ReplicationService.java Mon Dec 11 18:26:30 2006
@@ -256,6 +256,15 @@
     }
 
 
+    /**
+     * Purges old replication logs and the old entries marked as 'deleted'
+     * (i.e. {@link Constants#ENTRY_DELETED} is <tt>true</tt>).  This method
+     * should be called periodically to make sure the size of the DIT and
+     * {@link ReplicationStore} increase limitlessly.
+     * 
+     * @see ReplicationConfiguration#setLogMaxAge(int)
+     * @see ReplicationLogCleanJob
+     */
     public void purgeAgedData() throws NamingException
     {
         Attributes rootDSE = nexus.getRootDSE();