From a54fa3d78b427d7b8278442acbe86ebebcf6c2e7 Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 27 Jan 2015 11:31:59 +0000
Subject: [PATCH] OPENDJ-1716 Various PluggableBackend/Storage refactorings Code review: Nicolas Capponi

---
 opendj3-server-dev/src/server/org/opends/server/backends/persistit/PersistItStorage.java |   27 ++++++++++++++++++++++-----
 1 files changed, 22 insertions(+), 5 deletions(-)

diff --git a/opendj3-server-dev/src/server/org/opends/server/backends/persistit/PersistItStorage.java b/opendj3-server-dev/src/server/org/opends/server/backends/persistit/PersistItStorage.java
index c4d9dae..df2b606 100644
--- a/opendj3-server-dev/src/server/org/opends/server/backends/persistit/PersistItStorage.java
+++ b/opendj3-server-dev/src/server/org/opends/server/backends/persistit/PersistItStorage.java
@@ -39,6 +39,7 @@
 import org.forgerock.opendj.ldap.ByteSequence;
 import org.forgerock.opendj.ldap.ByteString;
 import org.opends.server.admin.std.server.PersistitBackendCfg;
+import org.opends.server.admin.std.server.PluggableBackendCfg;
 import org.opends.server.backends.pluggable.spi.Cursor;
 import org.opends.server.backends.pluggable.spi.Importer;
 import org.opends.server.backends.pluggable.spi.ReadOperation;
@@ -63,13 +64,14 @@
 import com.persistit.exception.PersistitException;
 import com.persistit.exception.RollbackException;
 
-@SuppressWarnings("javadoc")
+/** PersistIt database implementation of the {@link Storage} engine. */
 public final class PersistItStorage implements Storage
 {
   private static final String VOLUME_NAME = "dj";
   /** The buffer / page size used by the PersistIt storage. */
   private static final int BUFFER_SIZE = 16 * 1024;
 
+  /** PersistIt implementation of the {@link Cursor} interface. */
   private final class CursorImpl implements Cursor
   {
     private ByteString currentKey;
@@ -190,6 +192,7 @@
     }
   }
 
+  /** PersistIt implementation of the {@link Importer} interface. */
   private final class ImporterImpl implements Importer
   {
     private final TreeBuilder importer = new TreeBuilder(db);
@@ -245,6 +248,7 @@
     }
   }
 
+  /** PersistIt implementation of the {@link WriteableStorage} interface. */
   private final class StorageImpl implements WriteableStorage
   {
     private final Map<TreeName, Exchange> exchanges = new HashMap<TreeName, Exchange>();
@@ -484,6 +488,7 @@
   private Configuration dbCfg;
   private PersistitBackendCfg config;
 
+  /** {@inheritDoc} */
   @Override
   public void close()
   {
@@ -501,15 +506,18 @@
     }
   }
 
+  /** {@inheritDoc} */
   @Override
   public void closeTree(final TreeName treeName)
   {
     // nothing to do, in persistit you close the volume itself
   }
 
+  /** {@inheritDoc} */
   @Override
-  public void initialize(final PersistitBackendCfg cfg)
+  public void initialize(final PluggableBackendCfg configuration)
   {
+    final PersistitBackendCfg cfg = (PersistitBackendCfg) configuration;
     backendDirectory = new File(getFileForPath(cfg.getDBDirectory()), cfg.getBackendId());
     config = cfg;
     dbCfg = new Configuration();
@@ -520,7 +528,7 @@
         Long.MAX_VALUE / BUFFER_SIZE, 2048, true, false, false)));
     final BufferPoolConfiguration bufferPoolCfg = getBufferPoolCfg();
     bufferPoolCfg.setMaximumCount(Integer.MAX_VALUE);
-    if (cfg.getDBCacheSize() > 0l)
+    if (cfg.getDBCacheSize() > 0)
     {
       bufferPoolCfg.setMaximumMemory(cfg.getDBCacheSize());
     }
@@ -536,12 +544,14 @@
     return dbCfg.getBufferPoolMap().get(BUFFER_SIZE);
   }
 
+  /** {@inheritDoc} */
   @Override
   public boolean isValid()
   {
     return !db.isFatal();
   }
 
+  /** {@inheritDoc} */
   @Override
   public void open()
   {
@@ -563,6 +573,7 @@
     }
   }
 
+  /** {@inheritDoc} */
   @Override
   public <T> T read(final ReadOperation<T> operation) throws Exception
   {
@@ -604,6 +615,7 @@
     }
   }
 
+  /** {@inheritDoc} */
   @Override
   public Importer startImport()
   {
@@ -614,12 +626,17 @@
 
   /**
    * Replace persistit reserved comma character with an underscore character.
+   *
+   * @param suffix
+   *          the suffix name to convert
+   * @return a new String suitable for use as a suffix name
    */
-  public String toSuffixName(final String prefix)
+  public String toSuffixName(final String suffix)
   {
-    return prefix.replaceAll("[,=]", "_");
+    return suffix.replaceAll("[,=]", "_");
   }
 
+  /** {@inheritDoc} */
   @Override
   public void write(final WriteOperation operation) throws Exception
   {

--
Gitblit v1.10.0