4 package org.vamsas.test.simpleclient;
7 import java.io.IOException;
9 import java.util.Hashtable;
10 import java.util.Vector;
12 import org.apache.commons.logging.Log;
13 import org.apache.commons.logging.LogFactory;
14 import org.exolab.castor.xml.MarshalException;
15 import org.exolab.castor.xml.ValidationException;
16 import org.vamsas.client.ClientHandle;
17 import org.vamsas.client.IVorbaIdFactory;
18 import org.vamsas.client.SessionHandle;
19 import org.vamsas.client.UserHandle;
20 import org.vamsas.client.Vobject;
21 import org.vamsas.client.VorbaId;
22 import org.vamsas.client.simpleclient.AppDataOutputStream;
23 import org.vamsas.client.simpleclient.FileWatcher;
24 import org.vamsas.client.simpleclient.IdFactory;
25 import org.vamsas.client.simpleclient.SessionFile;
26 import org.vamsas.client.simpleclient.SimpleDocBinding;
27 import org.vamsas.client.simpleclient.SimpleDocument;
28 import org.vamsas.client.simpleclient.VamsasArchive;
29 import org.vamsas.client.simpleclient.VamsasArchiveReader;
30 import org.vamsas.client.simpleclient.VamsasFile;
31 import org.vamsas.objects.core.AppData;
32 import org.vamsas.objects.core.ApplicationData;
33 import org.vamsas.objects.core.User;
34 import org.vamsas.objects.core.VamsasDocument;
35 import org.vamsas.objects.utils.AppDataReference;
36 import org.vamsas.objects.utils.DocumentStuff;
37 import org.vamsas.objects.utils.ProvenanceStuff;
38 import org.vamsas.objects.utils.SeqSet;
39 import org.vamsas.objects.utils.document.VersionEntries;
40 import org.vamsas.test.objects.Core;
44 * test the VamsasFile routines for watching, reading and updating a vamsas document jar file.
45 * simple document access base class.
47 public class ArchiveClient extends IdFactory {
49 private Log log = LogFactory.getLog(ArchiveClient.class);
50 // protected UserHandle user=null;
51 // protected ClientHandle me = new ClientHandle("ArchiveClient","0.01");
58 public ArchiveClient(UserHandle user, VamsasFile vsess) {
59 super(new SessionHandle("vamsasfile://"+vsess.getVamsasFile()), new ClientHandle("ArchiveClient","0.01"), user);
63 private void _openVsess(File vsess) {
65 this.vsess = new VamsasFile(vsess);
68 log.error("Couldn't open session for file "+vsess,e);
72 public ArchiveClient(String username, String organization, File vsess) {
73 super(new SessionHandle("vamsasfile://"+vsess), new ClientHandle("ArchiveClient","0.01"), new UserHandle(username, organization));
77 public ArchiveClient(String username, String organization, String clientName, String clientVersion, File vsess) {
78 super(new SessionHandle("vamsasfile://"+vsess), new ClientHandle(clientName, clientVersion), new UserHandle(username, organization));
84 throw new Error("ArchiveClient instance is invalid!.");
86 public static int WATCH_SLEEP=300;
88 * watch the document file for updates.
89 * @param time - length of time to watch for.
90 * @return read only IO interface for session document.
92 public ClientDoc watch(long time) {
94 vsess.unLock(); // doh.
95 FileWatcher watcher = new FileWatcher(vsess.getVamsasFile());
96 long endtime=System.currentTimeMillis()+time;
98 org.vamsas.client.simpleclient.Lock doclock;
101 doclock=watcher.getChangedState();
103 Thread.sleep(WATCH_SLEEP);
104 } while (doclock==null && (time==0 || endtime>System.currentTimeMillis())); // tuning.
108 doclock = vsess.getLock(doclock);
109 VamsasArchiveReader varc = new VamsasArchiveReader(vsess.getVamsasFile());
110 return _getReadonly(varc);
112 } catch (Exception e) {
113 log.error("Whilst watching file "+vsess.getVamsasFile(), e);
118 // from ClientDocument.getClientAppdata
119 private AppData[] getAppData(VamsasDocument doc) {
121 log.debug("extractAppData called for null document object");
124 AppData appsGlobal=null, usersData=null;
125 Vector apldataset = AppDataReference.getUserandApplicationsData(
126 doc, this.getUserHandle(), this.getClientHandle());
127 if (apldataset!=null) {
128 if (apldataset.size()>0) {
129 AppData clientdat = (AppData) apldataset.get(0);
130 if (clientdat instanceof ApplicationData) {
131 appsGlobal = (ApplicationData) clientdat;
132 if (apldataset.size()>1) {
133 clientdat = (AppData) apldataset.get(1);
134 if (clientdat instanceof User) {
135 usersData = (User) clientdat;
137 if (apldataset.size()>2)
138 log.info("Ignoring additional ("+(apldataset.size()-2)+") AppDatas returned by document appdata query.");
141 log.warn("Unexpected entry in AppDataReference query: id="+clientdat.getVorbaId()+" type="+clientdat.getClass().getName());
143 apldataset.removeAllElements(); // destroy references.
146 return new AppData[] { appsGlobal, usersData};
149 protected ClientDoc _getReadonly(VamsasArchiveReader vreader) throws IOException, ValidationException, MarshalException {
152 SimpleDocBinding docb = new SimpleDocBinding();
155 d = docb.getVamsasDocument(vreader);
158 ClientDoc creader = new ClientDoc(d, null, vreader, getClientHandle().getClientUrn(), getProvenanceUser(), getVorbaIdHash());
166 * @return user field for a provenance entry
168 protected String getProvenanceUser() {
169 return new String(getUserHandle().getFullName()+" ["+getClientHandle().getClientUrn()+"]");
172 public ClientDoc getUpdateable() {
175 // patiently wait for a lock on the document.
177 org.vamsas.client.simpleclient.Lock lock;
178 while (((lock=vsess.getLock())==null || !lock.isLocked()) && --tries>0) {
180 log.debug("Trying to get a document lock for the "+tries+"'th time.");
182 VamsasArchive varc = new VamsasArchive(vsess, true, false); // read archive, write as vamsasDocument, don't erase original contents.
184 VamsasDocument d = varc.getVamsasDocument(getProvenanceUser(), "Created new document.", VersionEntries.latestVersion()); // VAMSAS: provenance user and client combined
187 log.warn("Backing out from opening a VamsasArchive writable IO session");
188 varc.cancelArchive();
191 ClientDoc cdoc = new ClientDoc(d, varc, varc.getOriginalArchiveReader(), getClientHandle().getClientUrn(), getProvenanceUser(), getVorbaIdHash());
194 } catch (Exception e) {
195 log.error("Failed to get Updateable version of "+vsess.getVamsasFile(), e);
200 * trust client to not do anything stupid to the document roots which will now be written to the archive.
202 * @return true if write was a success.
204 public boolean doUpdate(ClientDoc cdoc) {
207 log.warn("Invalid ClientDoc passed to org.vamsas.test.simpleclient.doUpdate()");
210 if (cdoc.iohandler==null) {
211 log.warn("Read only ClientDoc object passed to org.vamsas.test.simpleclient.doUpdate()");
214 if (cdoc.iohandler.getVorba()!=this) {
215 log.error("Mismatch between ClientDoc instances and ArchiveClient instances!");
219 // do any appDatas first.
220 if (cdoc.iohandler.transferRemainingAppDatas())
221 log.debug("Remaining appdatas were transfered.");
222 cdoc.updateDocumentRoots();
223 cdoc.iohandler.putVamsasDocument(cdoc.doc);
224 cdoc.iohandler.closeArchive();
228 } catch (Exception e) {
229 log.warn("While updating archive in "+vsess.getVamsasFile(),e);
237 public static void usage() {
238 throw new Error("Usage: Username Organization VamsasFile [command,args]*");
240 public static void main(String[] args) {
245 ArchiveClient client = new ArchiveClient(args[0],args[1], new File(args[2]));
249 cdoc = client.getUpdateable();
250 // ArchiveReports.reportDocument(cdoc.doc, cdoc.getReader(), true, System.out);
251 System.out.println("Report Roots :");
252 ArchiveReports.rootReport(cdoc.getVamsasRoots(), true, System.out);
253 cdoc.addVamsasRoot(Core.getDemoVamsas());
254 System.out.println("Doing update.");
255 client.doUpdate(cdoc);
260 System.out.println("Watch for more... ("+u+" left)");
261 ClientDoc ucdoc = client.watch(50000);
263 System.out.println("****\nUpdate detected at "+new Date());
264 ArchiveReports.reportDocument(ucdoc.doc, ucdoc.getReader(), true, System.out);
268 System.out.println("!!!! Null document update detected at "+new Date());
272 catch (Exception e) {
273 client.log.error("Broken!", e);
275 System.out.println("Finished at "+new Date());
277 public org.vamsas.client.Vobject getObject(VorbaId id) {
278 Hashtable idhash = this.getVorbaIdHash();
279 if (idhash!=null && idhash.containsKey(id))
280 return (Vobject) idhash.get(id);