Add package.html files for more packages.

voldemort · Jan 6, 2009 · f177152 · f177152
1 parent fbd0f95
commit f177152
Show file tree

Hide file tree

Showing 20 changed files with 76 additions and 16 deletions.
diff --git a/lib/colt.jar → lib/colt-1.2.0.jar b/lib/colt.jar → lib/colt-1.2.0.jar
diff --git a/lib/src/hadoop-0.18.0-src.zip b/lib/src/hadoop-0.18.0-src.zip
diff --git a/lib/src/mina-core-1.1.5-sources.jar b/lib/src/mina-core-1.1.5-sources.jar
diff --git a/lib/src/stringtree-2.0.9-src.zip b/lib/src/stringtree-2.0.9-src.zip
diff --git a/src/java/voldemort/annotations/jmx/package.html b/src/java/voldemort/annotations/jmx/package.html
@@ -1,5 +1,6 @@
 <html>
   <body>
-    Annotations for exposing objects as JMX managed beans.
+    Annotations for exposing objects as JMX managed beans. The point of these is to be able to add declarative JMX management
+    without requiring java 1.6.
   </body>
 </html>
diff --git a/src/java/voldemort/client/VoldemortProtocol.java b/src/java/voldemort/client/VoldemortProtocol.java
@@ -2,6 +2,5 @@
 
 public enum VoldemortProtocol {
     HTTP,
-    TCP,
-    MINA
+    TCP
 }
diff --git a/src/java/voldemort/server/storage/StorageService.java b/src/java/voldemort/server/storage/StorageService.java
@@ -61,7 +61,7 @@ public class StorageService extends AbstractService {
     private static final Logger logger = Logger.getLogger(StorageService.class.getName());
 
     private final VoldemortConfig voldemortConfig;
-    private final ConcurrentMap<String, Store<byte[], byte[]>> storeMap;
+    private final ConcurrentMap<String, Store<byte[], byte[]>> localStoreMap;
     private final Map<String, StorageEngine<byte[], byte[]>> rawEngines;
     private final ConcurrentMap<StorageEngineType, StorageConfiguration> storageConfigurations;
     private final StoreDefinitionsMapper storeMapper;
@@ -76,7 +76,7 @@ public StorageService(String name,
         super(name);
         this.voldemortConfig = config;
         this.storeMapper = new StoreDefinitionsMapper();
-        this.storeMap = storeMap;
+        this.localStoreMap = storeMap;
         this.rawEngines = new ConcurrentHashMap<String, StorageEngine<byte[], byte[]>>();
         this.scheduler = scheduler;
         this.storageConfigurations = initStorageConfigurations(config);
@@ -104,8 +104,8 @@ private ConcurrentMap<StorageEngineType, StorageConfiguration> initStorageConfig
 
     @Override
     protected void startInner() {
-        this.storeMap.clear();
-        this.storeMap.put(MetadataStore.METADATA_STORE_NAME, metadataStore);
+        this.localStoreMap.clear();
+        this.localStoreMap.put(MetadataStore.METADATA_STORE_NAME, metadataStore);
         Store<byte[], byte[]> slopStorage = getStore("slop", voldemortConfig.getSlopStoreType());
         this.slopStore = new SerializingStore<byte[], Slop>(slopStorage,
                                                             new IdentitySerializer(),
@@ -134,7 +134,7 @@ protected void startInner() {
                     store = new LoggingStore<byte[], byte[]>(store);
                 if(voldemortConfig.isStatTrackingEnabled())
                     store = new StatTrackingStore<byte[], byte[]>(store);
-                this.storeMap.put(def.getName(), store);
+                this.localStoreMap.put(def.getName(), store);
             }
         }
         logger.info("All stores initialized.");
@@ -194,7 +194,7 @@ protected void stopInner() {
         }
         VoldemortException exception = null;
         logger.info("Closing stores:");
-        for(Store<byte[], byte[]> s: this.storeMap.values()) {
+        for(Store<byte[], byte[]> s: this.localStoreMap.values()) {
             try {
                 logger.info("Closing " + s.getName() + ".");
                 s.close();
@@ -204,7 +204,7 @@ protected void stopInner() {
                 exception = e;
             }
         }
-        this.storeMap.clear();
+        this.localStoreMap.clear();
 
         logger.info("Closing storage configurations:");
         for(StorageConfiguration config: storageConfigurations.values()) {
@@ -222,13 +222,13 @@ protected void stopInner() {
         logger.info("All stores closed.");
     }
 
-    public ConcurrentMap<String, Store<byte[], byte[]>> getStoreMap() {
-        return storeMap;
+    public ConcurrentMap<String, Store<byte[], byte[]>> getLocalStoreMap() {
+        return localStoreMap;
     }
 
     @JmxGetter(name = "storeNames", description = "Get the names of all open stores.")
     public Set<String> getStoreNames() {
-        return new HashSet<String>(storeMap.keySet());
+        return new HashSet<String>(localStoreMap.keySet());
     }
 
     @JmxOperation(impact = MBeanOperationInfo.ACTION, description = "Push all keys that do not belong to this store out to the correct store.")

diff --git a/src/java/voldemort/store/bdb/package.html b/src/java/voldemort/store/bdb/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    A storage engine that persists data in BDB JE.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/filesystem/package.html b/src/java/voldemort/store/filesystem/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    A storage engine that provides access to data stored in files.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/memory/package.html b/src/java/voldemort/store/memory/package.html
@@ -0,0 +1,6 @@
+<html>
+  <body>
+    An in-memory storage engine that serves data out of a non-persistent map. This can be a soft reference map in order to allow this to
+    act as a cache.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/mysql/package.html b/src/java/voldemort/store/mysql/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    A storage engine that persists data in a mysql instance.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/package.html b/src/java/voldemort/store/package.html
@@ -0,0 +1,7 @@
+<html>
+  <body>
+    The Store interface is the primary interface for Voldemort. Stores provide functionality by implementing put, get, and delete from scratch
+    or by decorating existing stores with additional capabilities. Implementations of this interface provide the network i/o layer,
+    the various persistence layers, layers that deal with version conflicts, layers for logging and performance monitoring, etc.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/readonly/ExternalSorter.java b/src/java/voldemort/store/readonly/ExternalSorter.java
@@ -67,11 +67,9 @@ public int compare(V o1, V o2) {
      * Use natural ordering, system temp dir, and reasonable buffer size
      * 
      * @param serializer The serializer used to write data to disk
-     * @param internalSortSize The number of objects in the internal sort buffer
      * @param comparator The comparator used to order the objects
      * @param internalSortSize The number of objects to keep in the internal
      *        memory
-     * @param bufferSize The IO buffer size
      */
     public ExternalSorter(Serializer<V> serializer, Comparator<V> comparator, int internalSortSize) {
         this(serializer,
@@ -88,7 +86,6 @@ public ExternalSorter(Serializer<V> serializer, Comparator<V> comparator, int in
      * Use natural ordering, system temp dir, and reasonable buffer size
      * 
      * @param serializer The serializer used to write data to disk
-     * @param internalSortSize The number of objects in the internal sort buffer
      * @param comparator The comparator used to order the objects
      * @param internalSortSize The number of objects to keep in the internal
      *        memory

diff --git a/src/java/voldemort/store/readonly/package.html b/src/java/voldemort/store/readonly/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    A storage engine that provides very efficient read-only access to large sorted files of data.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/routed/package.html b/src/java/voldemort/store/routed/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    A store implmentation that handles routing to nodes, and repairing obsolete values detected on those nodes.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/serialized/package.html b/src/java/voldemort/store/serialized/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    A store implementation that handles serialization to bytes from rich objects.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/slop/package.html b/src/java/voldemort/store/slop/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    A store implementation that falls back on storing values in additional nodes not in the preference list when nodes are unavailable.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/socket/package.html b/src/java/voldemort/store/socket/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    A store implementation that works remotely over a tcp/ip socket interacting with a SocketServer on the the other side.
+  </body>
+</html>
diff --git a/src/java/voldemort/store/versioned/package.html b/src/java/voldemort/store/versioned/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    Store decorators that interact with versions.
+  </body>
+</html>
diff --git a/src/java/voldemort/versioning/package.html b/src/java/voldemort/versioning/package.html
@@ -0,0 +1,5 @@
+<html>
+  <body>
+    Classes for operating on vector clocks and dealing with distributed state.
+  </body>
+</html>