Boltdb final

README.md

@@ -1,9 +1,13 @@
-Steps to run the membership service -
+-----------------------------------------------------------------------------------------------------------------
+Steps to run the BoltDB KeyValue Store Server -
+-----------------------------------------------------------------------------------------------------------------
 
-1) Copy the boltdb-0.0.1-SNAPSHOT.jar, gson-1.7.1.jar, log4j-1.2.17.jar, dgroupmembership and boltdb.prop
-   files into a folder.
+1) Copy the boltdb-0.0.1-SNAPSHOT.jar, gson-1.7.1.jar, log4j-1.2.17.jar, commons-collections-3.0.jar, boltdb-server, server.policy
+   BoltDBServer_Stub.class and boltdb.prop files into a folder.
 2) cd into the folder to which you copied the above files.
-3) Open the boltdb.prop file in a text editor and set the properties
+3) Open the server.policy file and change the path in the policy file to the path of the current folder( where
+   the jar resides)
+4) Open the boltdb.prop file in a text editor and set the properties
 	*	"groupmembership.contact" - This is the hostname/ipaddress of the contact machine.
 	*	"groupmembership.tfail" - The time out for marking a process as failed
 	*	"groupmembership.heartbeat.freq" - The frequency at which the local heartbeat should be
@@ -12,18 +16,50 @@ Steps to run the membership service -
 		membership list should be refreshed (mark failures and remove marked entries).
 	*	"groupmembership.gossip.freq" - The gossip frequency.
 	*	"groupmembership.lossrate" - The message loss rate to be simulated.
+	*   "groupmembership.rfactor" - The replication factor
 
-4) Run the command - "./dgroupmembership -contact true -id machine.1
+5) Run the command - "./boltdb-server -contact true -id machine.1
 	*	"-contact" option is for specifying whether or not this daemon is the contact machine 
 		daemon.(In this case, it is "true". For the other daemons, specify "-contact" as "false")
 	*	"-id" is a unique id for the daemon and this unique id will be used to name the log file 
 		on this machine.
-5) While running the service, if you wish to voluntarily leave the system, type "leave" and hit enter. If you
-   want to crash the process, press Ctrl+C.
+6) On the boltdb-server> prompt - 
+	*	If you wish to voluntarily leave the system, type "leave" and hit enter.
+	*	If you wish to print out the membership list type "shownodes" and hit enter
+	*   If you wish to print out the contents of the key value store type "showKV" and hit enter.
+	*   If you wish to print out 10 most recent reads and writes, type "show" and hit enter
+-----------------------------------------------------------------------------------------------------------------
 
+
+
+-----------------------------------------------------------------------------------------------------------------
+Steps to run the BoltDB KeyValue Store Client -
+-----------------------------------------------------------------------------------------------------------------
+
+1) Copy the boltdb-0.0.1-SNAPSHOT.jar, gson-1.7.1.jar, log4j-1.2.17.jar, commons-collections-3.0.jar, boltdb-server, server.policy
+   BoltDBServer_Stub.class and boltdb.prop files into a folder.
+2) cd into the folder to which you copied the above files.
+3) Open the client.policy file and change the path in the policy file to the path of the current folder( where
+   the jar resides)
+4) Open the boltdb.prop file in a text editor and set the properties
+	*	"boltdb.kvstore.server" - This is the hostname/ipaddress of the server to which the client talks.
+	*   "boltdb.kvstore.clevel" - This is the consistency level. Possible values - ONE, QUORUM, ALL
+5) Run the command - "./boltdb-client
+6) On the boltdb-client> prompt -
+	*	"insert <clevel> <key> <value>" - Inserts the key and value onto the Distributed Key Value Store with the given consistency level
+	*	"update <clevel> <key> <value>" - Updates the key and value onto the Distributed Key Value Store with the given consistency level
+	*	"lookup <clevel> <key>" - Looks Up the key in the Distributed Key Value Store with the given consistency level
+	*	"delete <clevel> <key>" - Deletes the key from the Distributed Key Value Store with the given consistency level
+-----------------------------------------------------------------------------------------------------------------
+
+
+
+-----------------------------------------------------------------------------------------------------------------
 Steps to run the Log Querier service -
+-----------------------------------------------------------------------------------------------------------------
 
 Start the LogQuerier server -
+
 1) Copy the boltdb-0.0.1-SNAPSHOT.jar, dgrep and boltdb.prop files into a folder. (If you have already 
    copied these files in the previous step - while running the GroupMembership daemon, you should be fine)
 2) cd into the folder to which you copied the above files.
@@ -34,6 +70,7 @@ Start the LogQuerier server -
 
 
 Query logs using the LogQuerier client -
+
 1) Copy the boltdb-0.0.1-SNAPSHOT.jar, dgrep and boltdb.prop files into a folder (If you have already 
    copied these files in the previous step - while running the GroupMembership daemon, you should be fine)
 2) cd into the folder to which you copied the above files.
@@ -44,3 +81,4 @@ Query logs using the LogQuerier client -
 	*	To look for joins, type the command "./dgrep -key JOINED"
 	*	To look for crashes, type the command "./dgrep -key CRASHED"
 	*	To look for leavs, type the command "./dgrep -key LEFT"
+-----------------------------------------------------------------------------------------------------------------

boltdb/.classpath

@@ -6,25 +6,25 @@
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/J2SE-1.5">
+	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
+	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/4"/>
+	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
 		<attributes>
+			<attribute name="optional" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/J2SE-1.5">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/4"/>
-	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
+	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
 		<attributes>
-			<attribute name="optional" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>

boltdb/boltdb.prop

@@ -0,0 +1,8 @@
+machines.address=192.17.11.8:6789,192.17.11.7:6789,192.17.11.18:6789,192.17.11.19:6789
+groupmembership.lossrate=0
+groupmembership.contact=siebl-0218-07.ews.illinois.edu
+groupmembership.tfail=3
+groupmembership.heartbeat.freq=600
+groupmembership.refreshMembershipList.freq=1000
+groupmembership.gossip.freq=1000
+boltdb.server=172.16.149.48

boltdb/pom.xml

@@ -13,7 +13,24 @@
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   </properties>
-
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>rmic-maven-plugin</artifactId>
+        <version>1.2.1</version>
+        <executions>
+          <execution>
+            <id>rmic-process-classes</id>
+            <goals>
+              <goal>rmic</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+    </build>
+
   <dependencies>
     <dependency>
       <groupId>junit</groupId>
@@ -45,6 +62,11 @@
 		<groupId>log4j</groupId>
 		<artifactId>log4j</artifactId>
 		<version>1.2.17</version>
+	</dependency>
+	<dependency>
+	<groupId>commons-collections</groupId>
+	<artifactId>commons-collections</artifactId>
+	<version>3.0</version>
 	</dependency>         
   </dependencies>
 </project>

boltdb/src/main/java/edu/uiuc/boltdb/BoltDBClient.java

@@ -0,0 +1,223 @@
+package edu.uiuc.boltdb;
+
+import java.io.BufferedReader;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.net.MalformedURLException;
+import java.rmi.Naming;
+import java.rmi.NotBoundException;
+import java.rmi.RemoteException;
+import java.util.Properties;
+import java.util.StringTokenizer;
+
+/**
+ * This class represents the client component of the distributed key value store. On start up it creates 
+ * a boltdb-client> shell where the user can type in the insert, update, lookup and delete queries. 
+ * The BoltDBClient class creates a reference to a remote BoltDBServer object in the member variable boltDBServer.
+ * All the operations (insert, lookup, update and delete) are performed on this remote object reference.  
+ * 
+ * @author Adarsh
+ *
+ */
+
+public class BoltDBClient {
+
+	private BoltDBProtocol boltDBServer = null;
+
+	public BoltDBClient(String rmiString) throws MalformedURLException, RemoteException, NotBoundException {
+		if(System.getSecurityManager() == null) {
+			System.setSecurityManager(new SecurityManager());
+		}
+		boltDBServer = (BoltDBProtocol) Naming.lookup("rmi://" + rmiString + "/KVStore");
+	}
+
+	/**
+	 * @param args
+	 * @throws IOException 
+	 * @throws NotBoundException 
+	 */
+	public static void main(String[] args) {
+		try {
+			Properties prop = new Properties();
+			FileInputStream fis = new FileInputStream("./boltdb.prop");
+			prop.load(fis);
+			fis.close();
+			String rmiString = prop.getProperty("boltdb.kvstore.server");
+			BoltDBClient boltDBClient = new BoltDBClient(rmiString);
+			boltDBClient.runClientShell();
+		} catch(Exception e) {
+			e.printStackTrace();
+		}
+	}
+
+	// Method to simulate a boltdb-client shell
+	private void runClientShell() throws IOException {
+		// Simulate a unix shell
+		 String commandString = "";
+		 BufferedReader console = new BufferedReader(new InputStreamReader(System.in));
+
+		 // Break out with Ctrl+C
+		while (true) {
+		  // Read user's input
+		  System.out.print("boltdb-client>");
+		  commandString = console.readLine();
+
+		  // If the user entered a return, just loop again
+		  if (commandString.equals(""))
+			continue;
+		  handleCommand(commandString);
+		}
+	}
+
+	private BoltDBProtocol.CONSISTENCY_LEVEL getConsistency(String clevel) {
+		if(clevel.equals("ONE")) return BoltDBProtocol.CONSISTENCY_LEVEL.ONE;
+		else if (clevel.equals("QUORUM")) return BoltDBProtocol.CONSISTENCY_LEVEL.QUORUM;
+		else if (clevel.equals("ALL")) return BoltDBProtocol.CONSISTENCY_LEVEL.ALL;
+
+		return null;
+	}
+	// This method handles the commands entered by the user in the boltdb-client shell
+	private void handleCommand(String commandString) {
+		try {
+			StringTokenizer stk = new StringTokenizer(commandString);
+			if(stk.countTokens() < 3) {
+				printUsage(0);
+				return;
+			}
+
+			// The Command Type
+			String commandType = stk.nextToken();
+
+			if(commandType.equals("insert")) {
+				String clevel = stk.nextToken();
+				if (!clevel.equals("ONE") && !clevel.equals("QUORUM") && !clevel.equals("ALL")) {
+					printUsage(1);
+					return;
+				}
+				BoltDBProtocol.CONSISTENCY_LEVEL consistencyLevel = getConsistency(clevel);
+
+				String keyStr = stk.nextToken();
+				long key = parseKey(keyStr);
+				if(key == -1) return;
+				String value = "";
+				if(stk.hasMoreTokens()) {
+					while(stk.hasMoreTokens())
+						value += stk.nextToken() + " ";
+				}
+				else {
+					printUsage(1);
+					return;
+				}
+				value = value.trim();
+				// Perform Insert Operation on the remote server object
+				if(!boltDBServer.insert(key, new ValueTimeStamp(value, 0), true,consistencyLevel))
+					System.out.println("Key already present");
+			} else if(commandType.equals("update")) {
+				String clevel = stk.nextToken();
+				if (!clevel.equals("ONE") && !clevel.equals("QUORUM") && !clevel.equals("ALL")) {
+					printUsage(2);
+					return;
+				}
+				BoltDBProtocol.CONSISTENCY_LEVEL consistencyLevel = getConsistency(clevel);
+
+				String keyStr = stk.nextToken();
+				long key = parseKey(keyStr);
+				if(key == -1) return;
+				String value = "";
+				if(stk.hasMoreTokens()) {
+					while(stk.hasMoreTokens())
+						value += stk.nextToken() + " ";
+				}
+				else {
+					printUsage(2);
+					return;
+				}
+				value = value.trim();
+				// Perform Update Operation on the remote server object
+				if(!boltDBServer.update(key, new ValueTimeStamp(value, 0), true, consistencyLevel))
+					System.out.println("Key not present");
+			} else if(commandType.equals("lookup")) {
+				String clevel = stk.nextToken();
+				if (!clevel.equals("ONE") && !clevel.equals("QUORUM") && !clevel.equals("ALL")) {
+					printUsage(3);
+					return;
+				}
+				BoltDBProtocol.CONSISTENCY_LEVEL consistencyLevel = getConsistency(clevel);
+
+				String keyStr = stk.nextToken();
+				long key = parseKey(keyStr);
+				if(key == -1) return;
+				// Perform LookUp Operation on the remote server object
+				ValueTimeStamp value = boltDBServer.lookup(key, true, consistencyLevel);
+				if(value == null) {
+					System.out.println("Key not present");
+					return;
+				}
+				System.out.println("Look Up Result : " + value.value);
+			} else if(commandType.equals("delete")) {
+				String clevel = stk.nextToken();
+				if (!clevel.equals("ONE") && !clevel.equals("QUORUM") && !clevel.equals("ALL")) {
+					printUsage(4);
+					return;
+				}
+				BoltDBProtocol.CONSISTENCY_LEVEL consistencyLevel = getConsistency(clevel);
+				String keyStr = stk.nextToken();
+				long key = parseKey(keyStr);
+				if(key == -1) return;
+				// Perform Delete Operation on the remote server object
+				if(boltDBServer.delete(key, true, consistencyLevel))
+					System.out.println("Key Value Pair Deleted");
+				else
+					System.out.println("Delete Failed");
+			} else {
+				printUsage(0);
+				return;
+			}
+		} catch(RemoteException re) {
+			if(re.getCause().getCause() != null)
+				System.out.println(re.getCause().getCause().getMessage());
+			else
+				System.out.println(re.getCause().getMessage());
+		}
+	}
+
+	// Method to parse the key entered by the user to long, and to validate the key 
+	private long parseKey(String keyStr) {
+		long key;
+		try {
+			key = Long.parseLong(keyStr);
+			if(key < 0L || key > 1000000L) {
+				System.out.println("Invalid Key Range. Key should be in the Range 0 - 1000000");
+				return -1L;
+			}
+			return key;
+		} catch(NumberFormatException nfe) {
+			System.out.println("Invalid Key : Please enter an Integer value for key");
+			return -1L;
+		}
+	}
+
+	// Method to print the usage of BoltDBClient
+	private void printUsage(int type) {
+		System.out.println("Invalid Command");
+		System.out.println("Usage : ");
+		switch(type) {
+		case 1: System.out.println("insert <clevel> <key> <value>");
+				break;
+		case 2: System.out.println("update <clevel> <key> <value>");
+				break;
+		case 3: System.out.println("lookukp <clevel> <key>");
+				break;
+		case 4: System.out.println("delete <clevel> <key>");
+				break;
+		default:System.out.println("insert <clevel> <key> <value>");
+				System.out.println("update <clevel> <key> <value>");
+				System.out.println("lookup <clevel> <key>");
+				System.out.println("delete <clevel> <key>");
+				break;
+		}
+		System.out.println("<key> is an integer value in the range 0 - 1000000");
+		System.out.println();
+	}
+}