src/org/vamsas/client/simpleclient/IdFactory.java

   1 /**
   2  *
   3  */
   4 package org.vamsas.client.simpleclient;
   5
   6 import org.apache.commons.logging.Log;
   7 import org.apache.commons.logging.LogFactory;
   8 import org.vamsas.client.ClientHandle;
   9 import org.vamsas.client.SessionHandle;
  10 import org.vamsas.client.UserHandle;
  11 import org.vamsas.client.VorbaId;
  12 import org.vamsas.client.VorbaIdFactory;
  13 import org.vamsas.client.Vobject;
  14 import org.vamsas.objects.utils.document.VersionEntries;
  15
  16 import java.util.Hashtable;
  17 import java.util.zip.CRC32;
  18 /**
  19  * Simplest VorbaId constructor
  20  * @author jimp
  21  *
  22  */
  23 public class IdFactory extends VorbaIdFactory {
  24   static Log log = LogFactory.getLog(IdFactory.class);
  25   private SessionHandle session=null;
  26   private ClientHandle client;
  27   private UserHandle user;
  28   private CRC32 unique=new CRC32(); // used to attempt a unique but predictable stream for IDs
  29   private String idstring;
  30   int sequence=1; // incrementing value for next new ID
  31   /**
  32    *
  33    */
  34   public IdFactory() {
  35     super();
  36     // TODO Auto-generated constructor stub
  37   }
  38
  39   /**
  40    * @param session
  41    * @param client
  42    * @param user
  43    */
  44   protected IdFactory(SessionHandle session, ClientHandle client, UserHandle user) {
  45     super();
  46     this.session = session;
  47     this.client = client;
  48     this.user = user;
  49     unique.reset();
  50     unique.update(new Object[] { session, client, user}.toString().getBytes());
  51     // TODO: Ensure format of URNs and use standard composition methods.
  52     idstring = client.getClientUrn()+":"+unique.getValue()+"/";
  53     extantids=new Hashtable();
  54   }
  55   /**
  56    * values for keys in this hash can be used to reference the org.vamsas.client.Vobject instance for the VorbaId string.
  57    * @return the hash of all VorbaIds
  58    */
  59   protected Hashtable getVorbaIdHash() {
  60     return extantids;
  61   }
  62
  63   /* (non-Javadoc)
  64    * @see org.vamsas.client.VorbaIdFactory#makeVorbaId()
  65    */
  66   public VorbaId makeVorbaId(Vobject vobject) {
  67     if (session==null)
  68       throw new Error("makeVorbaId called on improperly initialised IdFactory Vobject!");
  69     String newidstring;
  70     do {
  71       if (sequence>0) {
  72         sequence++;
  73       } else {
  74         idstring+="1/";
  75         sequence=1;
  76       }
  77       newidstring=idstring+Integer.toString(sequence);
  78     } while (extantids.containsKey(newidstring));
  79     extantids.put(newidstring, vobject); // hash the Vobject by its new Id
  80     VorbaId id = newId(newidstring);
  81     return id;
  82   }
  83
  84   /* (non-Javadoc)
  85    * @see org.vamsas.client.VorbaIdFactory#setSession(org.vamsas.client.SessionHandle)
  86    */
  87   protected void setSession(SessionHandle sessionhandle) {
  88     if (sessionhandle!=null)
  89       session=sessionhandle;
  90     else
  91       log.warn("setSession(null) called.");
  92   }
  93
  94   /* (non-Javadoc)
  95    * @see org.vamsas.client.VorbaIdFactory#getSessionHandle()
  96    */
  97   public SessionHandle getSessionHandle() {
  98     return session;
  99   }
 100
 101   /* (non-Javadoc)
 102    * @see org.vamsas.client.VorbaIdFactory#setClient(org.vamsas.client.ClientHandle)
 103    */
 104   protected void setClient(ClientHandle appHandle) {
 105     if (appHandle!=null)
 106       client = appHandle;
 107     else
 108       log.warn("setClient(null) called.");
 109   }
 110
 111   /* (non-Javadoc)
 112    * @see org.vamsas.client.VorbaIdFactory#getClientHandle()
 113    */
 114   public ClientHandle getClientHandle() {
 115     return client;
 116   }
 117
 118   /* (non-Javadoc)
 119    * @see org.vamsas.client.VorbaIdFactory#setUser(org.vamsas.client.UserHandle)
 120    */
 121   protected void setUser(UserHandle userHandle) {
 122   if (userHandle!=null)
 123     user = userHandle;
 124   else
 125     log.warn("setUser(null) called.");
 126   }
 127
 128   /* (non-Javadoc)
 129    * @see org.vamsas.client.VorbaIdFactory#getUserHandle()
 130    */
 131   public UserHandle getUserHandle() {
 132     return user;
 133   }
 134   /**
 135    * Convenience method used for default behaviour in testing
 136    * and any anonymous internal vamsasDocument unmarshalling
 137    * @param clientname
 138    * @return
 139    */
 140   protected  static IdFactory getDummyFactory(String clientname) {
 141     if (clientname==null)
 142       clientname="org.vamsas.client.simpleclient.IdFactory";
 143     return new IdFactory(new SessionHandle("dummy.session"),
 144         new ClientHandle(clientname,VersionEntries.latestVersion()),
 145         new UserHandle(clientname, "Arnold User's Inc."));
 146   }
 147 }