introducing Lock File based locking (for portability) - part implemented.
[vamsas.git] / src / org / vamsas / client / simpleclient / ClientsFile.java
index 6cc2219..cab03cd 100644 (file)
@@ -20,73 +20,16 @@ import java.util.Vector;
  * Handler for the clientsFile within a vamsas session thread.
  * @author jim 
  */
-public class ClientsFile {
-  private File filelist;
-
+public class ClientsFile extends ListFile {
   /**
-   * number of my client in list (not known at start but used when known to make
-   * lock)
+   * number of my client in list - passed back when a client 
+   * is added to list, and used (if valid) for quickly 
+   * looking up presence of client handle in the list.
    */
   private int syncnum = 1;
 
   public ClientsFile(File filelist) throws IOException {
-    this.filelist = filelist;
-    if (!this.filelist.exists())
-      this.filelist.createNewFile();
-  }
-
-  private Lock listlock = null;
-
-  protected boolean lockList(Lock extantlock) {
-    if (listlock!=null && !listlock.isLocked()) {
-      listlock.release();// tidy up invalid lock
-    }
-    listlock=extantlock;
-    return lockList();
-  }
-  /**
-   * Get a lock for the ClientsFile
-   * 
-   * @return true if lock was made
-   */
-  protected boolean lockList() {
-    if (listlock != null)
-      if (listlock.isLocked())
-        return true;
-      else 
-        // lock failed for some reason.
-        listlock.release();
-    listlock = null;
-    if (filelist != null) {
-      if (filelist.exists()) {
-        // TODO: see if we need to loop-wait for locks or they just block until
-        // lock is made...
-        do {
-          if (listlock!=null)
-            listlock.release();
-          listlock = new Lock(filelist); // TODO: wait around if we can't get the lock.
-        } while (!listlock.isLocked());
-        // listlock = new Lock(filelist);
-        return listlock.isLocked();
-      }
-    } else
-      throw new Error(
-          "org.vamsas.client.simpleclient.ClientsFile.lockList called for non-initialised ClientsFile!");
-
-    // no lock possible
-    return false;
-  }
-
-  /**
-   * Explicitly release the ClientsFile lock.
-   * 
-   * @return true if lock was released.
-   */
-  protected void unlockList() {
-    if (listlock != null) {
-      listlock.release();    
-      listlock = null;
-    }
+    super(filelist);
   }
 
   /**
@@ -96,12 +39,12 @@ public class ClientsFile {
    * @return list of clients
    */
   private ClientHandle[] retrieveClientHandles() {
-    if (lockList()) {
+    if (lockFile()) {
       try {
         ClientHandle[] clients=null;
-        if (this.listlock.rafile.length()>0) {
-          ObjectInputStream is = new ObjectInputStream(new BufferedInputStream(
-              new java.io.FileInputStream(filelist)));
+        if (this.fileLock.rafile.length()>0) {
+          
+          ObjectInputStream is = new ObjectInputStream(fileLock.getBufferedInputStream(true));
           Object o;
           o=is.readObject();
           if (o!=null) {
@@ -109,7 +52,7 @@ public class ClientsFile {
               clients = (ClientHandle[]) o;
             }
             catch (Exception e) {
-              System.err.println("Garbage in the clientHandle list "+this.filelist);
+              System.err.println("Garbage in the clientHandle list "+this.sessionFile);
             }
           }
         }
@@ -128,9 +71,9 @@ public class ClientsFile {
    * @return clientList
    */
   public ClientHandle[] retrieveClientList() {
-    if (lockList()) {
+    if (lockFile()) {
       ClientHandle[] clients = retrieveClientHandles();
-      unlockList();
+      unlockFile();
       return clients;
     }
     return null;
@@ -141,9 +84,9 @@ public class ClientsFile {
    * @return clientList or null if lock failed (or file was empty)
    */
   public ClientHandle[] retrieveClientList(Lock extantlock) {
-    if (lockList(extantlock)) {
+    if (lockFile(extantlock)) {
       ClientHandle[] clients = retrieveClientHandles();
-      unlockList();
+      unlockFile();
       return clients;
     }
     return null;
@@ -167,9 +110,9 @@ public class ClientsFile {
    */
   
   public int addClient(ClientHandle me, boolean disambig, Lock extantLock) {
-    if (lockList(extantLock)) {
+    if (lockFile(extantLock)) {
       syncnum = addClient(me, disambig);
-      unlockList();
+      unlockFile();
       return syncnum;
     }
     return 0;
@@ -186,7 +129,7 @@ public class ClientsFile {
 
   public int addClient(ClientHandle me) {
     syncnum = addClient(me, true);
-    unlockList();
+    unlockFile();
     return syncnum;
   }
 
@@ -197,7 +140,7 @@ public class ClientsFile {
    */
   public void removeClient(ClientHandle me, Lock clientlock) {
     int mynum=-1;
-    if (lockList(clientlock)) {
+    if (lockFile(clientlock)) {
       ClientHandle[] clients = retrieveClientHandles();
       if (clients != null) {
         if ((syncnum<=0 || syncnum>clients.length) || clients[syncnum-1]!=me) {
@@ -218,9 +161,9 @@ public class ClientsFile {
             throw new Error("Failed to write new clientList!"); // failed to put the clientList to disk.
         }
       }
-      unlockList();
+      unlockFile();
     } else {
-      throw new Error("Couldn't get lock for "+((filelist==null) ? "Unitialised filelist in ClientsFile" : filelist.getAbsolutePath()));
+      throw new Error("Couldn't get lock for "+((sessionFile==null) ? "Unitialised sessionFile in ClientsFile" : sessionFile.getAbsolutePath()));
     }
   }
   /**
@@ -236,7 +179,10 @@ public class ClientsFile {
    */
   protected int addClient(ClientHandle me, boolean disambiguate) {
     int newclient = 0;
-    if (lockList()) {
+    int tries=5;
+    while (tries-->0 && !lockFile())
+      try { Thread.sleep(1); } catch (Exception e){};
+    if (lockFile()) {
       ClientHandle[] clients = retrieveClientHandles();
       if (me.getClientUrn()==null) {
         // TODO: move this into ClientUrn as a standard form method.
@@ -276,44 +222,33 @@ public class ClientsFile {
     }
     return newclient;
   }
-
+  
   /**
-   * safely writes clients array to the file referred to by filelist.
+   * safely writes clients array to the file referred to by sessionFile.
    * 
    * @param clients
    * @return true if successful write. Throws Errors otherwise.
    */
   protected boolean putClientList(ClientHandle[] clients) {
-    if (lockList()) {
-      File templist = null;
-      try {
-        templist = File.createTempFile(filelist.getName(),".old", filelist.getParentFile());
-        FileOutputStream tos = new FileOutputStream(templist);
-        tos.getChannel().transferFrom(listlock.rafile.getChannel(), 0,
-            listlock.rafile.length());
-        tos.close();
-      } catch (FileNotFoundException e1) {
-        System.err.println("Can't create temp file for clientlist");
-        e1.printStackTrace(System.err);
-      } catch (IOException e1) {
-        System.err
-            .println("Error when copying content to temp file for clientlist");
-        e1.printStackTrace(System.err);
-      }
+    if (lockFile()) {
+      File templist = backupSessionFile();
       if (templist != null) {
         try {
-          listlock.rafile.setLength(0);
-          ObjectOutputStream os = new ObjectOutputStream(
-              new BufferedOutputStream(new FileOutputStream(this.filelist)));
+          // fileLock.rafile.setLength(0);
+          ObjectOutputStream os = 
+            new ObjectOutputStream(fileLock.getBufferedOutputStream(true));
+          
+//              new BufferedOutputStream(new FileOutputStream(this.sessionFile)));
+          //    new BufferedOutputStream(new FileOutputStream(this.fileLock.rafile.getFD())));
           os.writeObject(clients);
-          os.close();
+          os.close(); // close destroys lock!
           // All done - remove the backup.
           templist.delete();
           templist = null;
         } catch (Exception e) {
           if (templist != null) {
             System.err
-                .println("Serious - problems writing to filelist. Backup in "
+                .println("Serious - problems writing to sessionFile. Backup in "
                     + templist.getAbsolutePath());
             e.printStackTrace(System.err);
           }
@@ -324,8 +259,8 @@ public class ClientsFile {
       }
     } else {
       throw new Error("Could not lock the clientList: "
-          + ((filelist == null) ? "Unitialized ClientsFile"
-              : " failed to get lock on " + filelist.getAbsolutePath()));
+          + ((sessionFile == null) ? "Unitialized ClientsFile"
+              : " failed to get lock on " + sessionFile.getAbsolutePath()));
     }
     // successful!
     return true;