1
|
/**
|
2
|
* '$RCSfile$'
|
3
|
* Copyright: 2000 Regents of the University of California and the
|
4
|
* National Center for Ecological Analysis and Synthesis
|
5
|
*
|
6
|
* '$Author: berkley $'
|
7
|
* '$Date: 2007-03-07 14:29:58 -0800 (Wed, 07 Mar 2007) $'
|
8
|
* '$Revision: 3196 $'
|
9
|
*
|
10
|
* This program is free software; you can redistribute it and/or modify
|
11
|
* it under the terms of the GNU General Public License as published by
|
12
|
* the Free Software Foundation; either version 2 of the License, or
|
13
|
* (at your option) any later version.
|
14
|
*
|
15
|
* This program is distributed in the hope that it will be useful,
|
16
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
17
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
18
|
* GNU General Public License for more details.
|
19
|
*
|
20
|
* You should have received a copy of the GNU General Public License
|
21
|
* along with this program; if not, write to the Free Software
|
22
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
23
|
*/
|
24
|
|
25
|
package edu.ucsb.nceas.metacat.client;
|
26
|
|
27
|
import java.io.BufferedReader;
|
28
|
import java.io.InputStream;
|
29
|
import java.io.InputStreamReader;
|
30
|
import java.io.PushbackReader;
|
31
|
import java.io.StringReader;
|
32
|
import java.io.IOException;
|
33
|
import java.io.StringWriter;
|
34
|
import java.io.Reader;
|
35
|
import java.net.URL;
|
36
|
import java.util.Properties;
|
37
|
import java.util.Vector;
|
38
|
|
39
|
import org.w3c.dom.Node;
|
40
|
import org.w3c.dom.NodeList;
|
41
|
|
42
|
import edu.ucsb.nceas.utilities.HttpMessage;
|
43
|
import edu.ucsb.nceas.utilities.IOUtil;
|
44
|
import edu.ucsb.nceas.utilities.XMLUtilities;
|
45
|
import java.io.File;
|
46
|
|
47
|
|
48
|
/**
|
49
|
* This interface provides methods for initializing and logging in to a
|
50
|
* Metacat server, and then querying, reading, transforming, inserting,
|
51
|
* updating and deleting documents from that server.
|
52
|
*/
|
53
|
public class MetacatClient implements Metacat
|
54
|
{
|
55
|
/** The URL string for the metacat server */
|
56
|
private String metacatUrl;
|
57
|
|
58
|
/** The session identifier for the session */
|
59
|
private String sessionId;
|
60
|
|
61
|
/**
|
62
|
* Constructor to create a new instance. Protected because instances
|
63
|
* should only be created by the factory MetacatFactory.
|
64
|
*/
|
65
|
protected MetacatClient()
|
66
|
{
|
67
|
this.metacatUrl = null;
|
68
|
this.sessionId = null;
|
69
|
}
|
70
|
|
71
|
/**
|
72
|
* Method used to log in to a metacat server. Implementations will need
|
73
|
* to cache a cookie value to make the session persistent. Each time a
|
74
|
* call is made to one of the other methods (e.g., read), the cookie will
|
75
|
* need to be passed back to the metacat server along with the request.
|
76
|
*
|
77
|
* @param username the username of the user, like an LDAP DN
|
78
|
* @param password the password for that user for authentication
|
79
|
* @return the response string from metacat in XML format
|
80
|
* @throws MetacatAuthException when the username/password could
|
81
|
* not be authenticated
|
82
|
*/
|
83
|
public String login(String username, String password)
|
84
|
throws MetacatAuthException, MetacatInaccessibleException
|
85
|
{
|
86
|
Properties prop = new Properties();
|
87
|
prop.put("action", "login");
|
88
|
prop.put("qformat", "xml");
|
89
|
prop.put("username", username);
|
90
|
prop.put("password", password);
|
91
|
|
92
|
String response = null;
|
93
|
try {
|
94
|
response = sendDataForString(prop, null, null, 0);
|
95
|
} catch (Exception e) {
|
96
|
throw new MetacatInaccessibleException(e.getMessage());
|
97
|
}
|
98
|
|
99
|
if (response.indexOf("<login>") == -1) {
|
100
|
setSessionId("");
|
101
|
throw new MetacatAuthException(response);
|
102
|
} else {
|
103
|
int start = response.indexOf("<sessionId>") + 11;
|
104
|
int end = response.indexOf("</sessionId>");
|
105
|
if ((start != -1) && (end != -1)) {
|
106
|
setSessionId(response.substring(start,end));
|
107
|
}
|
108
|
}
|
109
|
return response;
|
110
|
}
|
111
|
|
112
|
/**
|
113
|
* Method used to log in to a metacat server. Implementations will need
|
114
|
* to cache a cookie value to make the session persistent. Each time a
|
115
|
* call is made to one of the other methods (e.g., read), the cookie will
|
116
|
* need to be passed back to the metacat server along with the request.
|
117
|
*
|
118
|
* @param username the username of the user, like an LDAP DN
|
119
|
* @param password the password for that user for authentication
|
120
|
* @return the response string from metacat in XML format
|
121
|
* @throws MetacatAuthException when the username/password could
|
122
|
* not be authenticated
|
123
|
*/
|
124
|
public String getloggedinuserinfo() throws MetacatInaccessibleException
|
125
|
{
|
126
|
Properties prop = new Properties();
|
127
|
prop.put("action", "getloggedinuserinfo");
|
128
|
prop.put("qformat", "xml");
|
129
|
|
130
|
String response = null;
|
131
|
try {
|
132
|
response = sendDataForString(prop, null, null, 0);
|
133
|
} catch (Exception e) {
|
134
|
throw new MetacatInaccessibleException(e.getMessage());
|
135
|
}
|
136
|
|
137
|
return response;
|
138
|
}
|
139
|
|
140
|
/**
|
141
|
* Method used to log out a metacat server. The Metacat server will end
|
142
|
* the session when this call is invoked.
|
143
|
*
|
144
|
* @return the response string from metacat in XML format
|
145
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
146
|
* reached or does not respond
|
147
|
*/
|
148
|
public String logout() throws MetacatInaccessibleException, MetacatException
|
149
|
{
|
150
|
Properties prop = new Properties();
|
151
|
prop.put("action", "logout");
|
152
|
prop.put("qformat", "xml");
|
153
|
|
154
|
String response = null;
|
155
|
try {
|
156
|
response = sendDataForString(prop, null, null, 0);
|
157
|
} catch (Exception e) {
|
158
|
throw new MetacatInaccessibleException(e.getMessage());
|
159
|
}
|
160
|
|
161
|
if (response.indexOf("<logout>") == -1) {
|
162
|
throw new MetacatException(response);
|
163
|
}
|
164
|
setSessionId("");
|
165
|
return response;
|
166
|
}
|
167
|
|
168
|
/**
|
169
|
* Read an XML document from the metacat server session, accessed by docid,
|
170
|
* and returned as a Reader.
|
171
|
*
|
172
|
* @param docid the identifier of the document to be read
|
173
|
* @return a Reader for accessing the document
|
174
|
* @throws InsufficientKarmaException when the user has insufficent rights
|
175
|
* for the operation
|
176
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
177
|
* reached or does not respond
|
178
|
* @throws MetacatException when the metacat server generates another error
|
179
|
*/
|
180
|
public Reader read(String docid) throws InsufficientKarmaException,
|
181
|
MetacatInaccessibleException, MetacatException, DocumentNotFoundException
|
182
|
{
|
183
|
PushbackReader pbr = null;
|
184
|
|
185
|
Properties prop = new Properties();
|
186
|
prop.put("action", "read");
|
187
|
prop.put("qformat", "xml");
|
188
|
prop.put("docid", docid);
|
189
|
InputStream response = null;
|
190
|
try {
|
191
|
response = sendData(prop, null, null, 0);
|
192
|
} catch (Exception e) {
|
193
|
throw new MetacatInaccessibleException(e.getMessage());
|
194
|
}
|
195
|
pbr = new PushbackReader(new InputStreamReader(response), 512);
|
196
|
try {
|
197
|
char[] characters = new char[512];
|
198
|
int len = pbr.read(characters, 0, 512);
|
199
|
StringWriter sw = new StringWriter();
|
200
|
sw.write(characters, 0, len);
|
201
|
String message = sw.toString();
|
202
|
sw.close();
|
203
|
pbr.unread(characters, 0, len);
|
204
|
if (message.indexOf("<error>") != -1) {
|
205
|
if (message.indexOf("does not have permission") != -1) {
|
206
|
throw new InsufficientKarmaException(message);
|
207
|
} else if(message.indexOf("does not exist") != -1) {
|
208
|
throw new DocumentNotFoundException(message);
|
209
|
} else {
|
210
|
throw new MetacatException(message);
|
211
|
}
|
212
|
}
|
213
|
} catch (IOException ioe) {
|
214
|
throw new MetacatException(
|
215
|
"MetacatClient: Error converting Reader to String."
|
216
|
+ ioe.getMessage());
|
217
|
}
|
218
|
return pbr;
|
219
|
}
|
220
|
|
221
|
|
222
|
/**
|
223
|
* Read inline data from the metacat server session, accessed by
|
224
|
* inlinedataid and returned as a Reader.
|
225
|
*
|
226
|
* @param inlinedataid the identifier of the data to be read
|
227
|
* @return a Reader for accessing the document
|
228
|
* @throws InsufficientKarmaException when the user has insufficent rights
|
229
|
* for the operation
|
230
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
231
|
* reached or does not respond
|
232
|
* @throws MetacatException when the metacat server generates another error
|
233
|
*/
|
234
|
public Reader readInlineData(String inlinedataid)
|
235
|
throws InsufficientKarmaException,
|
236
|
MetacatInaccessibleException, MetacatException
|
237
|
{
|
238
|
PushbackReader pbr = null;
|
239
|
|
240
|
Properties prop = new Properties();
|
241
|
prop.put("action", "readinlinedata");
|
242
|
prop.put("inlinedataid", inlinedataid);
|
243
|
|
244
|
InputStream response = null;
|
245
|
try {
|
246
|
response = sendData(prop, null, null, 0);
|
247
|
} catch (Exception e) {
|
248
|
throw new MetacatInaccessibleException(e.getMessage());
|
249
|
}
|
250
|
|
251
|
pbr = new PushbackReader(new InputStreamReader(response), 512);
|
252
|
try {
|
253
|
char[] characters = new char[512];
|
254
|
int len = pbr.read(characters, 0, 512);
|
255
|
StringWriter sw = new StringWriter();
|
256
|
sw.write(characters, 0, len);
|
257
|
String message = sw.toString();
|
258
|
sw.close();
|
259
|
pbr.unread(characters, 0, len);
|
260
|
|
261
|
if (message.indexOf("<error>") != -1) {
|
262
|
if (message.indexOf("does not have permission") != -1) {
|
263
|
throw new InsufficientKarmaException(message);
|
264
|
} else {
|
265
|
throw new MetacatException(message);
|
266
|
}
|
267
|
}
|
268
|
} catch (IOException ioe) {
|
269
|
throw new MetacatException(
|
270
|
"MetacatClient: Error converting Reader to String."
|
271
|
+ ioe.getMessage());
|
272
|
}
|
273
|
|
274
|
return pbr;
|
275
|
}
|
276
|
|
277
|
/**
|
278
|
* Query the metacat document store with the given metacat-compatible
|
279
|
* query document, and return the result set as a Reader.
|
280
|
*
|
281
|
* @param xmlQuery a Reader for accessing the XML version of the query
|
282
|
* @return a Reader for accessing the result set
|
283
|
*/
|
284
|
public Reader query(Reader xmlQuery) throws MetacatInaccessibleException,
|
285
|
IOException
|
286
|
{
|
287
|
Reader reader = null;
|
288
|
String query = null;
|
289
|
try {
|
290
|
query = IOUtil.getAsString(xmlQuery, true);
|
291
|
} catch (IOException ioE) {
|
292
|
throw ioE;
|
293
|
}
|
294
|
|
295
|
//set up properties
|
296
|
Properties prop = new Properties();
|
297
|
prop.put("action", "squery");
|
298
|
prop.put("qformat", "xml");
|
299
|
prop.put("query", query);
|
300
|
|
301
|
InputStream response = null;
|
302
|
try {
|
303
|
response = sendData(prop, null, null, 0);
|
304
|
} catch (Exception e) {
|
305
|
throw new MetacatInaccessibleException(e.getMessage());
|
306
|
}
|
307
|
reader = new InputStreamReader(response);
|
308
|
return reader;
|
309
|
}
|
310
|
|
311
|
/**
|
312
|
* Insert an XML document into the repository.
|
313
|
*
|
314
|
* @param docid the docid to insert the document
|
315
|
* @param xmlDocument a Reader for accessing the XML document to be inserted
|
316
|
* @param schema a Reader for accessing the DTD or XML Schema for
|
317
|
* the document
|
318
|
* @return the metacat response message
|
319
|
* @throws InsufficientKarmaException when the user has insufficent rights
|
320
|
* for the operation
|
321
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
322
|
* reached or does not respond
|
323
|
* @throws MetacatException when the metacat server generates another error
|
324
|
* @throws IOException when there is an error reading the xml document
|
325
|
*/
|
326
|
public String insert(String docid, Reader xmlDocument, Reader schema)
|
327
|
throws InsufficientKarmaException, MetacatException, IOException,
|
328
|
MetacatInaccessibleException
|
329
|
{
|
330
|
Reader reader = null;
|
331
|
String doctext = null;
|
332
|
String schematext = null;
|
333
|
try {
|
334
|
doctext = IOUtil.getAsString(xmlDocument, true);
|
335
|
if (schema != null) {
|
336
|
schematext = IOUtil.getAsString(schema, true);
|
337
|
}
|
338
|
} catch (IOException ioE) {
|
339
|
throw ioE;
|
340
|
}
|
341
|
|
342
|
//set up properties
|
343
|
Properties prop = new Properties();
|
344
|
prop.put("action", "insert");
|
345
|
prop.put("docid", docid);
|
346
|
prop.put("doctext", doctext);
|
347
|
if (schematext != null) {
|
348
|
prop.put("dtdtext", schematext);
|
349
|
}
|
350
|
|
351
|
String response = null;
|
352
|
try {
|
353
|
response = sendDataForString(prop, null, null, 0);
|
354
|
} catch (Exception e) {
|
355
|
throw new MetacatInaccessibleException(e.getMessage());
|
356
|
}
|
357
|
|
358
|
// Check for an error condition
|
359
|
if (response.indexOf("<error>") != -1) {
|
360
|
if (response.indexOf("does not have permission") != -1) {
|
361
|
throw new InsufficientKarmaException(response);
|
362
|
} else {
|
363
|
throw new MetacatException(response);
|
364
|
}
|
365
|
}
|
366
|
|
367
|
return response;
|
368
|
}
|
369
|
|
370
|
/**
|
371
|
* Update an XML document in the repository.
|
372
|
*
|
373
|
* @param docid the docid to update
|
374
|
* @param xmlDocument a Reader for accessing the XML text to be updated
|
375
|
* @param schema a Reader for accessing the DTD or XML Schema for
|
376
|
* the document
|
377
|
* @return the metacat response message
|
378
|
* @throws InsufficientKarmaException when the user has insufficent rights
|
379
|
* for the operation
|
380
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
381
|
* reached or does not respond
|
382
|
* @throws MetacatException when the metacat server generates another error
|
383
|
* @throws IOException when there is an error reading the xml document
|
384
|
*/
|
385
|
public String update(String docid, Reader xmlDocument, Reader schema)
|
386
|
throws InsufficientKarmaException, MetacatException, IOException,
|
387
|
MetacatInaccessibleException
|
388
|
{
|
389
|
Reader reader = null;
|
390
|
String doctext = null;
|
391
|
String schematext = null;
|
392
|
try {
|
393
|
doctext = IOUtil.getAsString(xmlDocument, true);
|
394
|
if (schema != null) {
|
395
|
schematext = IOUtil.getAsString(schema, true);
|
396
|
}
|
397
|
} catch (IOException ioE) {
|
398
|
throw ioE;
|
399
|
}
|
400
|
|
401
|
//set up properties
|
402
|
Properties prop = new Properties();
|
403
|
prop.put("action", "update");
|
404
|
prop.put("docid", docid);
|
405
|
prop.put("doctext", doctext);
|
406
|
if (schematext != null) {
|
407
|
prop.put("dtdtext", schematext);
|
408
|
}
|
409
|
|
410
|
String response = null;
|
411
|
try {
|
412
|
response = sendDataForString(prop, null, null, 0);
|
413
|
} catch (Exception e) {
|
414
|
throw new MetacatInaccessibleException(e.getMessage());
|
415
|
}
|
416
|
|
417
|
// Check for an error condition
|
418
|
if (response.indexOf("<error>") != -1) {
|
419
|
if (response.indexOf("does not have permission") != -1) {
|
420
|
throw new InsufficientKarmaException(response);
|
421
|
} else {
|
422
|
throw new MetacatException(response);
|
423
|
}
|
424
|
}
|
425
|
|
426
|
return response;
|
427
|
}
|
428
|
|
429
|
/**
|
430
|
* Upload a data document into the repository.
|
431
|
*
|
432
|
* @param docid the docid to insert the document
|
433
|
* @param document a Reader for accessing the document to be uploaded
|
434
|
* @return the metacat response message
|
435
|
* @throws InsufficientKarmaException when the user has insufficent rights
|
436
|
* for the operation
|
437
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
438
|
* reached or does not respond
|
439
|
* @throws MetacatException when the metacat server generates another error
|
440
|
* @throws IOException when there is an error reading the xml document
|
441
|
*/
|
442
|
public String upload(String docid, File file)
|
443
|
throws InsufficientKarmaException, MetacatException, IOException,
|
444
|
MetacatInaccessibleException
|
445
|
{
|
446
|
|
447
|
URL url = new URL(metacatUrl.trim());
|
448
|
HttpMessage msg = new HttpMessage(url);
|
449
|
//set up properties
|
450
|
Properties arg = new Properties();
|
451
|
arg.put("action", "upload");
|
452
|
arg.put("docid", docid);
|
453
|
|
454
|
Properties filenames = new Properties();
|
455
|
String filename = file.getAbsolutePath();
|
456
|
filenames.put("datafile", filename);
|
457
|
|
458
|
String response = null;
|
459
|
try {
|
460
|
response = sendDataForString(arg, filenames, null, 0);
|
461
|
} catch (Exception e) {
|
462
|
throw new MetacatInaccessibleException(e.getMessage());
|
463
|
}
|
464
|
|
465
|
// Check for an error condition
|
466
|
if (response.indexOf("<error>") != -1) {
|
467
|
if (response.indexOf("does not have permission") != -1) {
|
468
|
throw new InsufficientKarmaException(response);
|
469
|
} else {
|
470
|
throw new MetacatException(response);
|
471
|
}
|
472
|
}
|
473
|
|
474
|
return response;
|
475
|
}
|
476
|
|
477
|
/**
|
478
|
* Upload a data document into the repository.
|
479
|
*
|
480
|
* @param docid the docid to insert the document
|
481
|
* @param document a Reader for accessing the document to be uploaded
|
482
|
* @return the metacat response message
|
483
|
* @throws InsufficientKarmaException when the user has insufficent rights
|
484
|
* for the operation
|
485
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
486
|
* reached or does not respond
|
487
|
* @throws MetacatException when the metacat server generates another error
|
488
|
* @throws IOException when there is an error reading the xml document
|
489
|
*/
|
490
|
|
491
|
|
492
|
public String upload(String docid, String filename, InputStream fileData,
|
493
|
int size)
|
494
|
throws InsufficientKarmaException, MetacatException, IOException,
|
495
|
MetacatInaccessibleException {
|
496
|
|
497
|
URL url = new URL(metacatUrl.trim());
|
498
|
HttpMessage msg = new HttpMessage(url);
|
499
|
//set up properties
|
500
|
Properties arg = new Properties();
|
501
|
arg.put("action", "upload");
|
502
|
arg.put("docid", docid);
|
503
|
|
504
|
Properties filenames = new Properties();
|
505
|
filenames.put("datafile", filename);
|
506
|
|
507
|
String response = null;
|
508
|
try {
|
509
|
response = sendDataForString(arg, filenames, fileData, size);
|
510
|
} catch (Exception e) {
|
511
|
throw new MetacatInaccessibleException(e.getMessage());
|
512
|
}
|
513
|
|
514
|
// Check for an error condition
|
515
|
if (response.indexOf("<error>") != -1) {
|
516
|
if (response.indexOf("does not have permission") != -1) {
|
517
|
throw new InsufficientKarmaException(response);
|
518
|
} else {
|
519
|
throw new MetacatException(response);
|
520
|
}
|
521
|
}
|
522
|
|
523
|
return response;
|
524
|
}
|
525
|
|
526
|
/**
|
527
|
* Delete an XML document in the repository.
|
528
|
*
|
529
|
* @param docid the docid to delete
|
530
|
* @return the metacat response message
|
531
|
* @throws InsufficientKarmaException when the user has insufficent rights
|
532
|
* for the operation
|
533
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
534
|
* reached or does not respond
|
535
|
* @throws MetacatException when the metacat server generates another error
|
536
|
*/
|
537
|
public String delete(String docid)
|
538
|
throws InsufficientKarmaException, MetacatException,
|
539
|
MetacatInaccessibleException
|
540
|
{
|
541
|
//set up properties
|
542
|
Properties prop = new Properties();
|
543
|
prop.put("action", "delete");
|
544
|
prop.put("docid", docid);
|
545
|
|
546
|
String response = null;
|
547
|
try {
|
548
|
response = sendDataForString(prop, null, null, 0);
|
549
|
} catch (Exception e) {
|
550
|
throw new MetacatInaccessibleException(e.getMessage());
|
551
|
}
|
552
|
|
553
|
// Check for an error condition
|
554
|
if (response.indexOf("<error>") != -1) {
|
555
|
if (response.indexOf("does not have permission") != -1) {
|
556
|
throw new InsufficientKarmaException(response);
|
557
|
} else {
|
558
|
throw new MetacatException(response);
|
559
|
}
|
560
|
}
|
561
|
return response;
|
562
|
}
|
563
|
|
564
|
|
565
|
/**
|
566
|
* set the access on an XML document in the repository.
|
567
|
*
|
568
|
* @param _docid the docid of the document for which the access should be applied.
|
569
|
*
|
570
|
* @param _principal the document's principal
|
571
|
*
|
572
|
* @param _permission the access permission to be applied to the docid
|
573
|
* {e.g. read,write,all}
|
574
|
*
|
575
|
* @param _permType the permission type to be applied to the document
|
576
|
* {e.g. allow or deny}
|
577
|
*
|
578
|
* @param _permOrder the order that the document's permissions should be
|
579
|
* processed {e.g. denyFirst or allowFirst}
|
580
|
*
|
581
|
*
|
582
|
* @return the metacat response message
|
583
|
*
|
584
|
* @throws InsufficientKarmaException when the user has insufficent rights
|
585
|
* for the operation
|
586
|
* @throws MetacatInaccessibleException when the metacat server can not be
|
587
|
* reached or does not respond
|
588
|
* @throws MetacatException when the metacat server generates another error
|
589
|
*/
|
590
|
public String setAccess(String _docid, String _principal, String
|
591
|
_permission, String _permType,
|
592
|
String _permOrder )
|
593
|
throws InsufficientKarmaException, MetacatException,
|
594
|
MetacatInaccessibleException
|
595
|
{
|
596
|
//set up properties
|
597
|
Properties prop = new Properties();
|
598
|
prop.put("action", "setaccess");
|
599
|
prop.put("docid", _docid);
|
600
|
prop.put("principal", _principal);
|
601
|
prop.put("permission", _permission);
|
602
|
prop.put("permType", _permType);
|
603
|
prop.put("permOrder", _permOrder);
|
604
|
|
605
|
String response = null;
|
606
|
try {
|
607
|
response = sendDataForString(prop, null, null, 0);
|
608
|
} catch (Exception e) {
|
609
|
throw new MetacatInaccessibleException(e.getMessage());
|
610
|
}
|
611
|
|
612
|
// Check for an error condition
|
613
|
if (response.indexOf("<error>") != -1) {
|
614
|
if (response.indexOf("does not have permission") != -1) {
|
615
|
throw new InsufficientKarmaException(response);
|
616
|
} else {
|
617
|
throw new MetacatException(response);
|
618
|
}
|
619
|
}
|
620
|
return response;
|
621
|
}
|
622
|
|
623
|
/**
|
624
|
* When the MetacatFactory creates an instance it needs to set the
|
625
|
* MetacatUrl to which connections should be made.
|
626
|
*
|
627
|
* @param metacatUrl the URL for the metacat server
|
628
|
*/
|
629
|
public void setMetacatUrl(String metacatUrl)
|
630
|
{
|
631
|
this.metacatUrl = metacatUrl;
|
632
|
}
|
633
|
|
634
|
/**
|
635
|
* Get the session identifier for this session. This is only valid if
|
636
|
* the login methods has been called successfully for this Metacat object
|
637
|
* beforehand.
|
638
|
*
|
639
|
* @returns the sessionId as a String, or null if the session is invalid
|
640
|
*/
|
641
|
public String getSessionId()
|
642
|
{
|
643
|
return this.sessionId;
|
644
|
}
|
645
|
|
646
|
/**
|
647
|
* Set the session identifier for this session. This identifier was
|
648
|
* previously established with a call to login. To continue to use the
|
649
|
* same session, set the session id before making a call to one of the
|
650
|
* metacat access methods (e.g., read, query, insert, etc.).
|
651
|
*
|
652
|
* @param String the sessionId from a previously established session
|
653
|
*/
|
654
|
public void setSessionId(String sessionId)
|
655
|
{
|
656
|
this.sessionId = sessionId;
|
657
|
}
|
658
|
|
659
|
/**
|
660
|
* The method will return the latest revision in metacat server
|
661
|
* for a given document id. If some error happens, this method will throw
|
662
|
* an exception.
|
663
|
* @param docId String the given docid you want to use. the docid it self
|
664
|
* can have or haven't revision number
|
665
|
* @throws MetacatException
|
666
|
*/
|
667
|
public int getNewestDocRevision(String docId) throws MetacatException
|
668
|
{
|
669
|
int rev = 0;
|
670
|
//set up properties
|
671
|
Properties prop = new Properties();
|
672
|
prop.put("action", "getrevisionanddoctype");
|
673
|
prop.put("docid", docId);
|
674
|
|
675
|
String response = null;
|
676
|
try {
|
677
|
response = sendDataForString(prop, null, null, 0);
|
678
|
//parseRevisionResponse will return null if there is an
|
679
|
//error that it can't handle
|
680
|
String revStr = parserRevisionResponse(response);
|
681
|
Integer revObj = new Integer(revStr);
|
682
|
rev = revObj.intValue();
|
683
|
// Check for an error condition
|
684
|
if (response.indexOf("<error>") != -1 && revStr == null) {
|
685
|
throw new MetacatException(response);
|
686
|
}
|
687
|
} catch (Exception e) {
|
688
|
throw new MetacatException(e.getMessage());
|
689
|
}
|
690
|
return rev;
|
691
|
}
|
692
|
|
693
|
/**
|
694
|
* Return the highest document id for a given scope. This is used by
|
695
|
* clients to make it easier to determine the next free identifier in a
|
696
|
* sequence for a given scope.
|
697
|
* @param scope String the scope to use for looking up the latest id
|
698
|
* @throws MetacatException when an error occurs
|
699
|
*/
|
700
|
public String getLastDocid(String scope) throws MetacatException {
|
701
|
String lastIdentifier = "";
|
702
|
//set up properties
|
703
|
Properties prop = new Properties();
|
704
|
prop.put("action", "getlastdocid");
|
705
|
prop.put("scope", scope);
|
706
|
|
707
|
String response = null;
|
708
|
try {
|
709
|
response = sendDataForString(prop, null, null, 0);
|
710
|
// Check for an error condition
|
711
|
if (response.indexOf("<error>") != -1) {
|
712
|
throw new MetacatException(response);
|
713
|
} else {
|
714
|
Reader responseReader = new StringReader(response);
|
715
|
Node root =
|
716
|
XMLUtilities.getXMLReaderAsDOMTreeRootNode(responseReader);
|
717
|
Node docidNode =
|
718
|
XMLUtilities.getNodeWithXPath(root, "/lastDocid/docid");
|
719
|
lastIdentifier = docidNode.getFirstChild().getNodeValue();
|
720
|
}
|
721
|
} catch (Exception e) {
|
722
|
throw new MetacatException(e.getMessage());
|
723
|
}
|
724
|
return lastIdentifier;
|
725
|
}
|
726
|
|
727
|
/**
|
728
|
* return a list of all docids that match a given scope. if scope is null
|
729
|
* return all docids registered in the system
|
730
|
* @param scope String the scope to use to limit the docid query
|
731
|
* @throws MetacatException when an error occurs
|
732
|
*/
|
733
|
public Vector getAllDocids(String scope) throws MetacatException {
|
734
|
Vector resultVec = new Vector();
|
735
|
//set up properties
|
736
|
Properties prop = new Properties();
|
737
|
prop.put("action", "getalldocids");
|
738
|
if(scope != null)
|
739
|
{
|
740
|
prop.put("scope", scope);
|
741
|
}
|
742
|
|
743
|
String response = null;
|
744
|
try {
|
745
|
response = sendDataForString(prop, null, null, 0);
|
746
|
// Check for an error condition
|
747
|
if (response.indexOf("<error>") != -1) {
|
748
|
throw new MetacatException(response);
|
749
|
} else {
|
750
|
Reader responseReader = new StringReader(response);
|
751
|
Node root =
|
752
|
XMLUtilities.getXMLReaderAsDOMTreeRootNode(responseReader);
|
753
|
NodeList nlist = root.getChildNodes();
|
754
|
for(int i=0; i<nlist.getLength(); i++)
|
755
|
{
|
756
|
Node n = nlist.item(i);
|
757
|
if(n.getNodeName().equals("docid"))
|
758
|
{
|
759
|
//add the content to the return vector
|
760
|
String nodeVal = n.getFirstChild().getNodeValue();
|
761
|
resultVec.addElement(nodeVal);
|
762
|
}
|
763
|
}
|
764
|
|
765
|
}
|
766
|
} catch (Exception e) {
|
767
|
throw new MetacatException(e.getMessage());
|
768
|
}
|
769
|
return resultVec;
|
770
|
}
|
771
|
|
772
|
/**
|
773
|
* return true of the given docid is registered, false if not
|
774
|
* @param scope String the scope to use to limit the docid query
|
775
|
* @throws MetacatException when an error occurs
|
776
|
*/
|
777
|
public boolean isRegistered(String docid) throws MetacatException {
|
778
|
Vector resultVec = new Vector();
|
779
|
//set up properties
|
780
|
Properties prop = new Properties();
|
781
|
prop.put("action", "isregistered");
|
782
|
if(docid == null)
|
783
|
{
|
784
|
throw new MetacatException("<error>Cannot check if a null docid " +
|
785
|
"is registered.</error>");
|
786
|
}
|
787
|
prop.put("docid", docid);
|
788
|
|
789
|
String response = null;
|
790
|
try {
|
791
|
response = sendDataForString(prop, null, null, 0);
|
792
|
// Check for an error condition
|
793
|
if (response.indexOf("<error>") != -1) {
|
794
|
throw new MetacatException(response);
|
795
|
} else {
|
796
|
Reader responseReader = new StringReader(response);
|
797
|
StringBuffer sb = new StringBuffer();
|
798
|
char[] c = new char[1024];
|
799
|
int numread = responseReader.read(c, 0, 1024);
|
800
|
while(numread != -1)
|
801
|
{
|
802
|
sb.append(new String(c, 0, numread));
|
803
|
numread = responseReader.read(c, 0, 1024);
|
804
|
}
|
805
|
|
806
|
String responseStr = sb.toString();
|
807
|
if(responseStr.indexOf("true") != -1)
|
808
|
{
|
809
|
return true;
|
810
|
}
|
811
|
return false;
|
812
|
}
|
813
|
} catch (Exception e) {
|
814
|
throw new MetacatException(e.getMessage());
|
815
|
}
|
816
|
}
|
817
|
|
818
|
/************************************************************************
|
819
|
* PRIVATE METHODS
|
820
|
************************************************************************/
|
821
|
|
822
|
/**
|
823
|
* Send a request to metacat.
|
824
|
*
|
825
|
* @param prop the properties to be URL encoded and sent
|
826
|
* @param filename the properties to be sent to Metacat
|
827
|
* in case of upload, otherwise null
|
828
|
* @param fileData the inputStream for the file data to be sent to Metacat
|
829
|
* in case of upload, otherwise null
|
830
|
* @param size the size of the data being sent to Metacat
|
831
|
* in case of upload, otherwise 0
|
832
|
*/
|
833
|
synchronized private InputStream sendDataOnce(Properties args,
|
834
|
Properties filename,
|
835
|
InputStream fileData,
|
836
|
int size)
|
837
|
throws Exception
|
838
|
{
|
839
|
InputStream returnStream = null;
|
840
|
URL url = new URL(metacatUrl);
|
841
|
HttpMessage msg = new HttpMessage(url);
|
842
|
msg.setCookie("JSESSIONID="+this.sessionId);
|
843
|
if (filename == null){
|
844
|
returnStream = msg.sendPostData(args);
|
845
|
} else if (fileData == null){
|
846
|
returnStream = msg.sendPostData(args, filename);
|
847
|
} else if (size > 0) {
|
848
|
returnStream = msg.sendPostData(args, filename, fileData, size);
|
849
|
} else {
|
850
|
throw new MetacatException("Invalid size specified for " +
|
851
|
"the input stream being passed");
|
852
|
}
|
853
|
return returnStream;
|
854
|
}
|
855
|
|
856
|
/**
|
857
|
* Send a request to Metacat
|
858
|
*
|
859
|
* @param args the properties to be sent to Metacat
|
860
|
* @param filename the properties to be sent to Metacat
|
861
|
* in case of upload, otherwise null
|
862
|
* @param fileData the inputStream for the file data to be sent to Metacat
|
863
|
* in case of upload, otherwise null
|
864
|
* @param size the size of the data being sent to Metacat
|
865
|
* in case of upload, otherwise 0
|
866
|
* @return InputStream as returned by Metacat
|
867
|
*/
|
868
|
synchronized private InputStream sendData(Properties args,
|
869
|
Properties filename,
|
870
|
InputStream fileData,
|
871
|
int size)
|
872
|
throws Exception
|
873
|
{
|
874
|
InputStream returnStream = null;
|
875
|
/*
|
876
|
Note: The reason that there are three try statements all executing
|
877
|
the same code is that there is a problem with the initial connection
|
878
|
using the HTTPClient protocol handler. These try statements make
|
879
|
sure that a connection is made because it gives each connection a
|
880
|
2nd and 3rd chance to work before throwing an error.
|
881
|
THIS IS A TOTAL HACK. THIS NEEDS TO BE LOOKED INTO AFTER THE BETA1
|
882
|
RELEASE OF MORPHO!!! cwb (7/24/01)
|
883
|
*/
|
884
|
try {
|
885
|
return sendDataOnce(args, filename, fileData, size);
|
886
|
} catch (Exception e) {
|
887
|
try {
|
888
|
return sendDataOnce(args, filename, fileData, size);
|
889
|
} catch (Exception e2) {
|
890
|
try {
|
891
|
return sendDataOnce(args, filename, fileData, size);
|
892
|
} catch (Exception e3) {
|
893
|
System.err.println(
|
894
|
"Failed to send data to metacat 3 times: " + e3.getMessage());
|
895
|
System.err.println("metacaturl: " + metacatUrl);
|
896
|
throw e3;
|
897
|
}
|
898
|
}
|
899
|
}
|
900
|
}
|
901
|
|
902
|
/**
|
903
|
* Send a request to Metacat
|
904
|
*
|
905
|
* @param args the properties to be sent to Metacat
|
906
|
* @param filename the properties to be sent to Metacat
|
907
|
* in case of upload, otherwise null
|
908
|
* @param fileData the inputStream for the file data to be sent to Metacat
|
909
|
* in case of upload, otherwise null
|
910
|
* @param size the size of the data being sent to Metacat
|
911
|
* in case of upload, otherwise 0
|
912
|
* @return a string as returned by Metacat
|
913
|
*/
|
914
|
synchronized private String sendDataForString(Properties args,
|
915
|
Properties filename,
|
916
|
InputStream fileData,
|
917
|
int size)
|
918
|
throws Exception
|
919
|
{
|
920
|
String response = null;
|
921
|
|
922
|
try {
|
923
|
InputStreamReader returnStream =
|
924
|
new InputStreamReader(sendData(args, filename,
|
925
|
fileData, size));
|
926
|
StringWriter sw = new StringWriter();
|
927
|
int len;
|
928
|
char[] characters = new char[512];
|
929
|
while ((len = returnStream.read(characters, 0, 512)) != -1) {
|
930
|
sw.write(characters, 0, len);
|
931
|
}
|
932
|
returnStream.close();
|
933
|
response = sw.toString();
|
934
|
sw.close();
|
935
|
} catch (Exception e) {
|
936
|
throw e;
|
937
|
}
|
938
|
return response;
|
939
|
}
|
940
|
|
941
|
/*
|
942
|
* "getversionanddoctype" action will return a string from metacat server.
|
943
|
* The string format is "revision;doctype"(This is bad idea, we should use xml)
|
944
|
* This method will get revision string from the response string
|
945
|
*/
|
946
|
private String parserRevisionResponse(String response) throws Exception
|
947
|
{
|
948
|
String revision = null;
|
949
|
if (response != null)
|
950
|
{
|
951
|
if(response.indexOf("<error>") != -1)
|
952
|
{
|
953
|
if(response.indexOf("There is not record") != -1)
|
954
|
{
|
955
|
return "0";
|
956
|
}
|
957
|
else
|
958
|
{
|
959
|
return null;
|
960
|
}
|
961
|
}
|
962
|
else
|
963
|
{
|
964
|
int firstSemiCol = response.indexOf(";");
|
965
|
revision = response.substring(0, firstSemiCol);
|
966
|
}
|
967
|
}
|
968
|
return revision;
|
969
|
}
|
970
|
}
|