Project

General

Profile

metacat / docs / user / metacat / source / submitting.rst @ 8272

1
Accessing and Submitting Metadata and Data
2
==========================================
3

    
4
.. contents::
5

    
6
The Metacat repository can be accessed and updated using a number of tools, 
7
including: 
8

    
9
* the Registry, Metacat's optional Web interface
10
* user-created HTML forms 
11
* Metacat's EarthGrid API
12
* existing clients, such as KNB's Morpho application, designed to help 
13
  scientists create, edit, and manage metadata
14
* user-created desktop clients that take advantage of Metacat's Java API.
15

    
16
In this section, we will look at how to take advantage of these tools to 
17
customize Metacat for your user-base.
18

    
19
A Brief Note about How Information is Stored
20
--------------------------------------------
21
Metacat stores XML files as a hierarchy of nodes, where each node is stored as 
22
records in database tables. Because many XML data schemas are broken up into 
23
multiple DTDs requiring multiple XML files that are related but stored 
24
separately in the system, the system uses "packages" to link related but 
25
separate documents. Packaged documents contain information that shows how they 
26
are related to eachother, essentially stating that file A has a relationship 
27
to file B, etc. A package file also allows users to link metadata files to the 
28
data files they describe. For more information about the structure of data 
29
packages and how XML documents and data are stored in Metacat, please see the 
30
developer's documentation.
31

    
32
Using the Registry
33
------------------
34
Metacat's optional Registry provides a simple Web-based interface for creating, 
35
editing, and submitting metadata to the Metacat repository (screenshot below). The 
36
interface includes help documentation, and can be customized using Metacat's 
37
configuration settings. The Registry also includes an administrative interface 
38
for managing LDAP user accounts, which is useful if you are using LDAP as your 
39
Metacat authentication system. Note that you must be running your own LDAP 
40
server if you wish to use the LDAP Web interface. If you do not have your own 
41
LDAP server, you can create and manage new accounts on the KNB website 
42
(http://knb.ecoinformatics.org/). Please note that at this time, the Registry 
43
interface has only been tested on Linux systems.
44

    
45
.. figure:: images/screenshots/image033.jpg
46
   :align: center
47

    
48
   An example installation of the Register's web interface. Customize the 
49
   displayed and required modules with the Skins Configuration settings.
50
   
51
You can customize which modules (e.g., "Name of Submitter" or "Temporal 
52
Coverage of Data") are displayed and which are required using the Skins 
53
Configuration settings
54

    
55
Installing the Registry
56
~~~~~~~~~~~~~~~~~~~~~~~
57
In order to install and run the Registry, you must have Metacat installed and 
58
Tomcat must be running behind an Apache Web server (see previous sections for 
59
information about installing and configuring Apache to run with Tomcat).
60

    
61
To install and run the Registry:
62

    
63
1. Build the Metacat Perl client library:
64

    
65
  ::
66

    
67
    cd $METACAT/src/perl/Metacat
68
    perl Makefile.PL
69
    sudo make
70
    sudo make install
71

    
72
.. sidebar:: Instructions for Red Hat (Alternate Step 2)
73

    
74
  * Install the libraries
75

    
76
    ::
77
    
78
      sudo yum install gcc libxml2-devel libxslt-devel ant -y
79

    
80
  * Install CPAN, which allows us to install the Perl dependencies for the 
81
    registry and account management parts of Metacat. If asked to manually 
82
    configure cpan, type 'no' and CPAN will be setup with its default values.
83

    
84
    ::
85
    
86
      sudo yum install perl-CPAN
87
      sudo cpan
88

    
89
  * You should now see a prompt which looks like:
90

    
91
    ::
92
    
93
      cpan>
94

    
95
  * The rest of the commands assume you're inside of CPAN. Let's get the most 
96
    recent version of the CPAN software. Just press return after any prompts 
97
    you receive during this process.
98
    
99
    ::
100
    
101
      install Bundle::CPAN
102
      reload cpan
103

    
104
  * Install the required modules. Here we're installing an old LibXSLT, as the 
105
    current one requires a newer libxslt than is available on Redhat 4 & 5. 
106
    Again, just answer 'yes' to any questions.
107

    
108
    ::
109

    
110
      install AutoLoader
111
      install CGI
112
      install CGI::SEssion
113
      install LWP::UserAgent
114
      install Net::LDAP
115
      install Template 
116
      install URI
117
      install MSERGEANT/XML-LibXSLT-1.58.tar.gz
118
      install Captcha:reCAPTCHA
119

    
120
2. Install the required system libraries using Ubuntu/Debian (instructions 
121
   Red Hat in sidebar)
122
         
123
  * Install the libraries
124

    
125
    ::
126

    
127
      sudo apt-get install ant libappconfig-perl libxml-libxml-perl \
128
      libxml-libxslt-perl libtemplate-perl libcgi-session-perl \
129
      libdigest-sha1-perl libnet-ldap-perl libterm-readkey-perl \
130
      libxml-dom-perl libsoap-lite-perl -y
131

    
132
  * Install two more package using cpan 
133

    
134
    ::
135
    
136
      sudo cpan -i Config::Properties
137
      sudo cpan -i Scalar::Util
138
      sudo cpan -i Captcha:reCAPTCHA
139

    
140

    
141
3. Double-check that Metacat's temporary folder, application.tempDir, is 
142
   writable by the apache user, usually www-data or apache. 
143

    
144
4. Make sure that the following scripts (found in ``<tomcat-home>/webapps/metacat/cgi-bin``) 
145
   are executable: register-dataset.cgi and ldapweb.cgi.
146

    
147
  ::
148
  
149
    sudo chmod +x <tomcat-home>/webapps/metacat/cgi-bin/*.cgi
150

    
151
5. Restart Apache.
152

    
153
  ::
154
  
155
    sudo /etc/init.d/apache2 restart
156

    
157
6. Visit the resulting URL: 
158
   http://<your_context_url>/cgi-bin/register-dataset.cgi?cfg=default
159
   Where ``<your_context_url>`` is the URL of the server hosting the Metacat 
160
   followed by the name of the WAR file (i.e., the application context) that 
161
   you installed. For instance, the context URL for the KNB Metacat is: 
162
   http://knb.ecoinformatics.org/knb.
163

    
164
If everything worked correctly, the registry home page will open (see figure).
165

    
166
.. figure:: images/screenshots/image035.jpg
167
   :align: center
168

    
169
   An example of the Registry home page (with the default skin).
170
   
171
Customizing the Registry
172
~~~~~~~~~~~~~~~~~~~~~~~~
173
Before using the registry, you may wish to customize the interface using the 
174
Skins Configuration settings. If you are using the default skin, you must 
175
disable the 'show site list' setting before you can submit the form without 
176
errors. You may also wish to remove (or modify) the list of NCEAS-specific 
177
projects that appear in the default registry. To remove these form fields, 
178
open Metacat's administrative interface (http://<your.context.url>/metacat/admin) 
179
and select the Skins Specific Properties Configuration option. On the skins 
180
configuration page, uncheck the boxes beside any form elements that you do not 
181
wish to appear in the registry.
182

    
183
Once you have saved your changes, you must restart Tomcat for them to come 
184
into effect. To restart Tomcat, type: ``sudo /etc/init.d/tomcat6 restart`` or an 
185
equivalent command appropriate to your operating system. 
186

    
187
.. figure:: images/screenshots/image037.jpg
188
   :align: center
189

    
190
   Uncheck the box beside any setting to remove it from the Registry form. In 
191
   the example, the "Show Site List" and "Show Work Group" form fields, 
192
   corresponding to the "Station Name" and "NCEAS Project" drop-down lists in 
193
   the registry form, have been removed.
194
   
195
LDAP account management
196
~~~~~~~~~~~~~~~~~~~~~~~~
197
If you intend to use Metacat's built-in LDAP account management feature, 
198
you will need public and private keys for the reCaptcha widget.
199

    
200
1. Get private and public recaptcha keys from Google using your Google account:
201
https://www.google.com/recaptcha/admin/create
202

    
203
2. Configure Metacat to use those keys in the metacat.properties file:
204

    
205
  ::
206
  
207
	ldap.recaptcha.publickey=<your public key>
208
	ldap.recaptcha.privatekey=<your private key>
209

    
210
3. Restart Tomcat
211

    
212
   
213
Using HTML Forms (the HTTP Interface)
214
-------------------------------------
215
Metacat's HTTP interface supports Get and Post requests and a variety of actions (Table 4.1) that facilitate information retrieval and storage. HTTP requests can be sent from any client application that communicates using the Web's HTTP protocol. 
216

    
217
* Supported Actions (API)
218
* Logging in
219
* Inserting, Updating, and Deleting XML and Data Documents
220
* Searching Metacat
221
* Paged Query Return
222
* Reading Data and Metadata
223

    
224
Supported Actions
225
~~~~~~~~~~~~~~~~~
226
Metacat supports get and post requests as well as actions for writing, querying, 
227
and reading stored XML. In addition, the HTTP interface includes functions for 
228
validating and transforming XML documents (see table). 
229

    
230
Note that if Replication is enabled, Metacat recognizes several additional 
231
actions, included in Table 4.2. For more information about replication, 
232
please see :doc:`replication`.
233

    
234
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
235
| Action                   | Description and Parameters                                                                                                                                                                                                                                         |
236
+==========================+====================================================================================================================================================================================================================================================================+
237
| delete                   | Delete the specified document from the database. For an                                                                                                                                                                                                            |
238
|                          | example, please see Inserting, Updating, and                                                                                                                                                                                                                       |
239
|                          | Deleting XML and Data Documents.                                                                                                                                                                                                                                   |
240
|                          |                                                                                                                                                                                                                                                                    |
241
|                          | ``docid`` - the docid of the document to delete                                                                                                                                                                                                                    |
242
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
243
| export                   | Export a data package in a zip file.                                                                                                                                                                                                                               |
244
|                          |                                                                                                                                                                                                                                                                    |
245
|                          | ``docid`` - the docid of the document to delete                                                                                                                                                                                                                    |
246
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
247
| getaccesscontrol         | Get the access control list (ACL) for the                                                                                                                                                                                                                          |
248
|                          | specified document.                                                                                                                                                                                                                                                |
249
|                          |                                                                                                                                                                                                                                                                    |
250
|                          | ``docid`` - the docid of the document to delete                                                                                                                                                                                                                    |
251
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
252
| getalldocids             | Retrieve a list of all docids registered with the system.                                                                                                                                                                                                          |
253
|                          |                                                                                                                                                                                                                                                                    |
254
|                          | ``scope`` - a string used to match a range of docids in a SQL LIKE statement                                                                                                                                                                                       |
255
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
256
| getdataguide             | Read a data guide for the specified document type                                                                                                                                                                                                                  |
257
| DEPRECATED               |                                                                                                                                                                                                                                                                    |
258
| Use getdtdschema instead | ``doctype`` - the doctype for which to get the data guide                                                                                                                                                                                                          |
259
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
260
| getdoctypes              | Get all doctypes currently available in the Metacat Catalog System. No parameters.                                                                                                                                                                                 |
261
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
262
| getdtdschema             | Read the DTD or XMLSchema file for the specified doctype.                                                                                                                                                                                                          |
263
|                          |                                                                                                                                                                                                                                                                    |
264
|                          | ``doctype`` - the doctype for which DTD or XMLSchema files to read                                                                                                                                                                                                 |
265
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
266
| getlastdocid             | Get the latest docid with revision number used by scope.                                                                                                                                                                                                           |
267
|                          |                                                                                                                                                                                                                                                                    |
268
|                          | ``scope`` - the scope to be queried                                                                                                                                                                                                                                |
269
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
270
| getlog                   | Get the latest docid with revision number used by user.                                                                                                                                                                                                            |
271
|                          |                                                                                                                                                                                                                                                                    |
272
|                          | ``ipaddress`` - the internet protocol address for the event                                                                                                                                                                                                        |
273
|                          | ``principal`` - the principal for the event (a username, etc)                                                                                                                                                                                                      |
274
|                          | ``docid`` - the identifier of the document to which the event applies                                                                                                                                                                                              |
275
|                          | ``event`` - the string code for the event                                                                                                                                                                                                                          |
276
|                          | ``start`` - beginning of date-range for query                                                                                                                                                                                                                      |
277
|                          | ``end`` - end of date-range for query                                                                                                                                                                                                                              |
278
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
279
| getloggedinuserinfo      | Get user info for the currently logged in user. No parameters.                                                                                                                                                                                                     |
280
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
281
| getpricipals             | Get all users and groups in the current authentication schema. No parameters.                                                                                                                                                                                      |
282
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
283
| getrevisionanddoctype    | Return the revision and doctype of a document.                                                                                                                                                                                                                     |
284
|                          | The output is String that looks like "rev;doctype"                                                                                                                                                                                                                 |
285
|                          |                                                                                                                                                                                                                                                                    |
286
|                          | ``docid`` - the docid of the document                                                                                                                                                                                                                              |
287
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
288
| getversion               | Get Metacat version.   Return the current version of Metacat as XML. No parameters.                                                                                                                                                                                |
289
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
290
| insert                   | Insert an XML document into the database. For an example, please see                                                                                                                                                                                               |
291
|                          | Inserting, Updating, and Deleting XML and Data Documents                                                                                                                                                                                                           |
292
|                          |                                                                                                                                                                                                                                                                    |
293
|                          | ``docid`` - the user-defined docid to assign to the new XML document                                                                                                                                                                                               |
294
|                          | ``doctext`` - the text of the XML document to insert                                                                                                                                                                                                               |
295
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
296
| insertmultipart          | Insert an XML document using multipart encoding into the database.                                                                                                                                                                                                 |
297
|                          |                                                                                                                                                                                                                                                                    |
298
|                          | ``docid`` - the user-defined docid to assign to the new XML document                                                                                                                                                                                               |
299
|                          | ``doctext`` - the text of the XML document to insert                                                                                                                                                                                                               |
300
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
301
| isregistered             | Check if an individual document exists in either the xml_documents or xml_revisions tables.                                                                                                                                                                        |
302
|                          | For more information about Metacat's database schema, please see the developer documentation.                                                                                                                                                                      |
303
|                          |                                                                                                                                                                                                                                                                    |
304
|                          | ``docid`` - the docid of the document                                                                                                                                                                                                                              |
305
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
306
| login                    | Log the user in. You must log in using this action before you can perform                                                                                                                                                                                          |
307
|                          | many of the actions. For an example of the login action, see Logging In.                                                                                                                                                                                           |
308
|                          |                                                                                                                                                                                                                                                                    |
309
|                          | ``username`` - the user's login name                                                                                                                                                                                                                               |
310
|                          | ``password`` - the user's password                                                                                                                                                                                                                                 |
311
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
312
| logout                   | Log the current user out and destroy the associated session. No parameters.                                                                                                                                                                                        |
313
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
314
| query                    | Perform a free text query. For an example, please see Searching Metacat.                                                                                                                                                                                           |
315
|                          |                                                                                                                                                                                                                                                                    |
316
|                          | ``returndoctype`` - the doctype to use for your Package View. For more information about packages, see http://knb.ecoinformatics.org/software/metacat/packages.html                                                                                                |
317
|                          | ``qformat`` - the format of the returned result set. Possible values are html or xml or the name of your servlet's Metacat skin.                                                                                                                                   |
318
|                          | ``querytitle`` - OPTIONAL - the title of the query                                                                                                                                                                                                                 |
319
|                          | ``doctype`` - OPTIONAL - if doctype is specified, the search is limited only to the specified doctype(s). (e.g., eml://ecoinformatics.org/eml-2.0.1 and/or eml://ecoinformatics.org/eml-2.0.0) If no doctype element is specified, all document types are returned |
320
|                          | ``returnfield`` - a custom field to be returned by any hit document.                                                                                                                                                                                               |
321
|                          | ``operator`` - the Boolean operator to apply to the query. Possible values are: union or intersect                                                                                                                                                                 |
322
|                          | ``searchmode`` - the type of search to be performed. Possible values are: contains, starts-with, ends-with, equals, isnot-equal, greater-than, less-than, greater-than-equals, less-than-equals.                                                                   |
323
|                          | ``anyfield`` - a free-text search variable. The value placed in this parameter will be searched for in any document in any node.                                                                                                                                   |
324
|                          | ``pagesize`` – the number of search results to display on each search results page (e.g., 10). Used with pagestart. See section 4.3.4 for an example.                                                                                                              |
325
|                          | ``pagestart`` – the displayed search results page (e.g, 1). Used with pagesize. See section 4.3.4 for an example.                                                                                                                                                  |
326
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
327
| read                     | Get a document from the database and return it in the specified format. See Searching Metacat for an example.                                                                                                                                                      |
328
|                          |                                                                                                                                                                                                                                                                    |
329
|                          | ``docid`` - the docid of the document to return                                                                                                                                                                                                                    |
330
|                          | ``qformat`` - the format to return the document in. Possible values are: ``html``, ``xml``,or, if your Metacat uses a skin, the name of the skin.                                                                                                                  |
331
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
332
| readinlinedata           | Read inline data only.                                                                                                                                                                                                                                             |
333
|                          |                                                                                                                                                                                                                                                                    |
334
|                          | ``inlinedataid`` - the id of the inline data to read                                                                                                                                                                                                               |
335
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
336
| setaccess                | Change access permissions for a user on a specified document.                                                                                                                                                                                                      |
337
|                          |                                                                                                                                                                                                                                                                    |
338
|                          | ``docid`` - the docid of the document to be modified.                                                                                                                                                                                                              |
339
|                          | ``principal`` - the user or group whose permissions will be modified                                                                                                                                                                                               |
340
|                          | ``permission`` - the permission  to set (read, write, all)                                                                                                                                                                                                         |
341
|                          | ``permType`` - the type of permission to set (allow, deny)                                                                                                                                                                                                         |
342
|                          | ``permOrder`` - the order in which to apply the permission (allowFirst, denyFirst)                                                                                                                                                                                 |
343
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
344
| spatial_query            | Perform a spatial query. These queries may include any of the queries supported by the                                                                                                                                                                             |
345
|                          | WFS / WMS standards. For more information, see Spatial Queries.                                                                                                                                                                                                    |
346
|                          |                                                                                                                                                                                                                                                                    |
347
|                          | ``xmax`` - max x spatial coordinate                                                                                                                                                                                                                                |
348
|                          | ``ymax`` - max y spatial coordinate                                                                                                                                                                                                                                |
349
|                          | ``xmin`` - min x spatial coordinate                                                                                                                                                                                                                                |
350
|                          | ``ymin`` - min y spatial coordinate                                                                                                                                                                                                                                |
351
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
352
| squery                   | Perform a structured query. For an example, please see Searching Metacat.                                                                                                                                                                                          |
353
|                          |                                                                                                                                                                                                                                                                    |
354
|                          | ``query`` - the text of the pathquery document sent to the server  																																																|
355
|                          | ``qformat`` - the format to return the results in. Possible values are:  ``xml``, or the name of the a skin.                                                                                                                                                       |
356
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
357
| update                   | Overwrite an XML document with a new one and give the new one the same docid but with                                                                                                                                                                              |
358
|                          | the next revision number. For an example, please see Inserting, Updating, and                                                                                                                                                                                      |
359
|                          | Deleting XML and Data Documents.                                                                                                                                                                                                                                   |
360
|                          |                                                                                                                                                                                                                                                                    |
361
|                          | ``docid`` - the docid of the document to update                                                                                                                                                                                                                    |
362
|                          | ``doctext`` - the text with which to update the XML document                                                                                                                                                                                                       |
363
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
364
| upload                   | Upload (insert or update) a data file into Metacat. Data files are stored on Metacat and may be in any                                                                                                                                                             |
365
|                          | format (binary or text), but they are all treated as if they were binary.                                                                                                                                                                                          |
366
|                          |                                                                                                                                                                                                                                                                    |
367
|                          | ``docid`` - the docid of the data file to upload                                                                                                                                                                                                                   |
368
|                          | ``datafile`` - the data file to upload                                                                                                                                                                                                                             |
369
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
370
| validate                 | Validate a specified document against its DTD.                                                                                                                                                                                                                     |
371
|                          |                                                                                                                                                                                                                                                                    |
372
|                          | ``docid`` - the docid of the document to validate                                                                                                                                                                                                                  |
373
|                          | ``valtext`` - the DTD by which to validate this document                                                                                                                                                                                                           |
374
+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
375

    
376

    
377
Metacat Replication Parameters
378

    
379
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
380
| Action         | Description and Parameters                                                                                                                                      |
381
+================+=================================================================================================================================================================+
382
| forcereplicate | Force the local server to get the specified document from the remote host.                                                                                      |
383
|                |                                                                                                                                                                 |
384
|                | ``server`` - The server to which this document is being sent                                                                                                    |
385
|                | ``docid`` - The docid of the document to send                                                                                                                   |
386
|                | ``dbaction`` - The action to perform on the document: insert or update (the default)                                                                            |
387
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
388
| getall         | Force the local server to check all known servers for updated documents. No parameters.                                                                         |
389
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
390
| getcatalog     | Send the contents of the xml_catalog table encoded in XML. No parameters.                                                                                       |
391
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
392
| getlock        | Request a lock on the specified document.                                                                                                                       |
393
|                |                                                                                                                                                                 |
394
|                | ``docid`` - the docid of the document                                                                                                                           |
395
|                | ``updaterev`` - the revision number of docid                                                                                                                    |
396
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
397
| gettime        | Return the local time on this server. No parameters.                                                                                                            |
398
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
399
| servercontrol  | Perform the specified replication control on the Replication daemon.                                                                                            |
400
|                |                                                                                                                                                                 |
401
|                | ``add`` - add a new server to the replication list                                                                                                              |
402
|                | ``delete`` - remove a server from the replication list                                                                                                          |
403
|                | ``list`` - list all of the servers currently in the server list                                                                                                 |
404
|                | ``replicate`` - a Boolean flag (1 or 0) which determines if this server should copy files from the newly added server.                                          |
405
|                | ``server`` - the server to add/delete                                                                                                                           |
406
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
407
| read           | Sends docid to the remote host.                                                                                                                                 |
408
|                |                                                                                                                                                                 |
409
|                | ``docid`` - the docid of the document to read                                                                                                                   |
410
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
411
| start          | Start the Replication daemon with a time interval of deltaT.                                                                                                    |
412
|                |                                                                                                                                                                 |
413
|                | ``rate`` - The rate (in seconds) at which you want the replication daemon to check for updated documents. The value cannot be less than 30. The default is 1000 |
414
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
415
| stop           | Stop the Replication daemon. No parameters.                                                                                                                     |
416
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
417
| update         | Send a list of all documents on the local server along with their revision numbers. No parameters.                                                              |
418
+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+
419

    
420
Logging In
421
~~~~~~~~~~
422
To log in to Metacat, use the ``login`` action.
423

    
424
The following is an example of a Web form (see figure) that logs a user into 
425
Metact. Example HTML code is included below the screenshot.
426

    
427
.. figure:: images/screenshots/image039.jpg
428
   :align: center
429
   
430
   Logging into Metacat using an HTML form.
431

    
432
::
433

    
434
  <html>
435
  <body>
436
  <form name="loginform" method="post"action="http://yourserver.com/yourcontext/servlet/metacat" 
437
  target="_top" onsubmit="return submitform(this);" id="loginform">
438
    <input type="hidden" name="action" value="login"> <input type=
439
    "hidden" name="username" value=""> <input type="hidden" name=
440
    "qformat" value="xml"> <input type="hidden" name=
441
    "enableediting" value="false">
442

    
443
    <table>
444
      <tr valign="middle">
445
        <td align="left" valign="middle" class="text_plain">
446
        username:</td>
447

    
448
        <td width="173" align="left" class="text_plain" style=
449
        "padding-top: 2px; padding-bottom: 2px;"><input name="uid"
450
        type="text" style="width: 140px;" value=""></td>
451
      </tr>
452

    
453
      <tr valign="middle">
454
        <td height="28" align="left" valign="middle" class=
455
        "text_plain">organization:</td>
456

    
457
        <td align="left" class="text_plain" style=
458
        "padding-top: 2px; padding-bottom: 2px;"><select name=
459
        "organization" style="width:140px;">
460
          <option value=""    selected>&#8212; choose one &#8212;</option>
461
          <option value="NCEAS">NCEAS</option>
462
          <option value="LTER">LTER</option>
463
          <option value="UCNRS">UCNRS</option>
464
          <option value="PISCO">PISCO</option>
465
          <option value="OBFS">OBFS</option>
466
          <option value="OSUBS">OSUBS</option>
467
          <option value="SAEON">SAEON</option>
468
          <option value="SANParks">SANParks</option>
469
          <option value="SDSC">SDSC</option>
470
          <option value="KU">KU</option>
471
          <option value="unaffiliated">unaffiliated</option>
472
        </select></td>
473
      </tr>
474

    
475
      <tr valign="middle">
476
        <td width="85" align="left" valign="middle" class=
477
        "text_plain">password:</td>
478

    
479
        <td colspan="2" align="left" class="text_plain" style=
480
        "padding-top: 2px; padding-bottom: 2px;">
481
          <table width="100%" border="0" cellpadding="0"
482
          cellspacing="0">
483
            <tr>
484
              <td width="150" align="left"><input name="password"
485
              type="password" maxlength="50" style="width:140px;"
486
              value=""></td>
487

    
488
              <td align="center" class="buttonBG_login">
489
              <input type="submit" name="loginAction" value="Login"
490
              class="button_login"></td>
491

    
492
              <td align="left">&nbsp;</td>
493
            </tr>
494
          </table>
495
        </td>
496
      </tr>
497
    </table>
498
  </form>
499
  </body>
500
  </html>
501

    
502
Inserting, Updating, and Deleting XML and Data Documents
503
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
504
Adding, editing, and deleting XML documents in Metacat can be accomplished 
505
using the insert, update, and delete actions, respectively. Before you can 
506
insert, delete, or update documents, you must log in to Metacat using the 
507
login action. See Logging in for an example.
508

    
509
``insert``
510
   Insert a new XML or data document into Metacat. You must specify a document ID.
511
   
512
``update``
513
   Update an existing Metacat document. The original document is archived, 
514
   then overwritten.
515

    
516
``delete``
517
   Archive a document and move the pointer in xml_documents to xml_revisions, 
518
   effectively "deleting" the document from public view, but preserving the 
519
   revision for the revision history. No further updates will be allowed for
520
   the Metacat document that was "deleted". All revisions of this identifier are no longer 
521
   public. 
522

    
523
.. warning::
524
   It is not possible to "delete" one revision without "deleting" all 
525
   revisions of a given identifier.
526

    
527
The following is an example of a Web form (see figure) that can perform all 
528
three tasks. Example HTML code is included in the sidebar.
529

    
530
.. figure:: images/screenshots/image041.jpg
531
   :align: center
532
   
533
   An example of a Web form used to insert, delete, or update XML documents in Metacat.
534

    
535
::
536

    
537
  <html>
538
    <head>
539
    <title>MetaCat</title>
540
    </head>
541
    <body class="emlbody">
542
    <b>MetaCat XML Loader</b>
543
    <p>
544
    Upload, Change, or Delete an XML document using this form.
545
    </p>
546
    <form action="http://yourserver.com/yourcontext/servlet/metacat" method="POST">
547
      <strong>1. Choose an action: </strong>
548
      <input type="radio" name="action" value="insert" checked> Insert
549
      <input type="radio" name="action" value="update"> Update
550
      <input type="radio" name="action" value="delete"> Delete
551
      <input type="submit" value="Process Action">
552
      <br />
553
      <strong>2. Provide a Document ID </strong>
554
      <input type="text" name="docid"> (optional for Insert)
555
         <input type="checkbox" name="public" value="yes" checked><strong>Public Document</strong>
556
      <br />
557
      <strong>3. Provide XML text </strong> (not needed for Delete)<br/>
558
      <textarea name="doctext" cols="65" rows="15"></textarea><br/>
559
      <strong>4. Provide DTD text for upload </strong> (optional; not needed for Delete)
560
      <textarea name="dtdtext" cols="65" rows="15"></textarea>
561
    </form>
562
    </body>
563
  </html>
564

    
565
Searching Metacat
566
~~~~~~~~~~~~~~~~~
567
To search Metacat use the ``query`` or ``squery`` actions. 
568

    
569
``query``:   
570
   Perform a free text query. Specify the returndoctype, qformat, returnfield, 
571
   operator, searchmode, anyfield, and (optionally) a querytitle and doctype. 
572

    
573
``squery``:
574
   Perform a structured query by submitting an XML pathquery document to the 
575
   Metacat server.
576
 
577

    
578
When Metacat receives a query via HTTP (screenshot below), the server creates a 
579
"pathquery" document, which is an XML document populated with the specified 
580
search criteria. The pathquery document is then translated into 
581
SQL statements that are executed against the database. Results are translated 
582
into an XML "resultset" document, which can be returned as XML or transformed 
583
into HTML and returned (specify which you would prefer with the returnfield 
584
parameter). You can also opt to submit a pathquery document directly, 
585
using an squery action.
586

    
587
.. figure:: images/screenshots/image043.jpg
588
   :align: center
589
   
590
   Example of a basic search form using a query action. The HTML code used to create the form is displayed below.
591

    
592
::
593

    
594
  <html>
595
  <head>
596
  <title>Search</title>
597
  </head>
598
  <body>
599
  <form method="POST" action="http://panucci.nceas.ucsb.edu/metacat/metacat">
600

    
601
  Search for:
602

    
603
  <input name="action" value="query" type="hidden">
604
  <input name="operator" value="INTERSECT" type="hidden">
605
  <input name="anyfield" type="text" value=" " size="40">
606
  <input name="qformat" value="html" type="hidden">
607
  
608
  <input name="returnfield" value="creator/individualName/surName" type="hidden">
609
  <input name="returnfield" value="creator/individualName/givenName" type="hidden">
610
  <input name="returnfield" value="creator/organizationName" type="hidden">
611
  <input name="returnfield" value="dataset/title" type="hidden">
612
  <input name="returnfield" value="keyword" type="hidden">
613

    
614
  <input name="returndoctype" value="eml://ecoinformatics.org/eml-2.0.1" type="hidden">
615

    
616
  <input value="Start Search" type="submit">
617

    
618
  </form>
619
  </body>
620
  </html>
621
  
622
Metacat's pathquery document can query specific fields of any XML document. 
623
The pathquery can also be used to specify which fields from each hit are 
624
returned and displayed in the search result set.
625

    
626
::
627

    
628
  <pathquery version="1.0">
629
      <meta_file_id>unspecified</meta_file_id>
630
      <querytitle>unspecified</querytitle>
631
      <returnfield>dataset/title</returnfield>
632
      <returnfield>keyword</returnfield>
633
      <returnfield>dataset/creator/individualName/surName</returnfield>
634
      <returndoctype>eml://ecoinformatics.org/eml-2.1.0</returndoctype>      
635
      <returndoctype>eml://ecoinformatics.org/eml-2.0.1</returndoctype>
636
      <returndoctype>eml://ecoinformatics.org/eml-2.0.0</returndoctype>
637
      <querygroup operator="UNION">
638
        <queryterm casesensitive="true" searchmode="contains">
639
          <value>Charismatic megafauna</value>
640
           <pathexpr>dataset/title</pathexpr>
641
         </queryterm>
642
        <queryterm casesensitive="false" searchmode="starts-with">
643
           <value>sea otter</value>
644
           <pathexpr>keyword</pathexpr>
645
        </queryterm>
646
        <queryterm casesensitive="false" searchmode="contains">
647
          <value>Enhydra</value>
648
          <pathexpr>abstract/para</pathexpr>
649
        </queryterm>
650
       </querygroup>
651
   </pathquery>
652
  </pathquery>
653
  
654
Each ``<returnfield>`` parameter specifies a field that the database will 
655
return (in addition to the fields Metacat returns by default) for each search 
656
result. 
657

    
658
The ``<returndoctype>`` field limits the type of returned documents 
659
(eg, eml://ecoinformatics.org/eml-2.0.1 and/or eml://ecoinformatics.org/eml-2.0.0). 
660
If no returndoctype element is specified, all document types are returned. 
661

    
662
A ``<querygroup>`` creates an AND or an OR statement that applies to the 
663
nested ``<queryterm>`` tags. The querygroup operator can be UNION or INTERSECT. 
664
A ``<queryterm>`` defines the actual field (contained in ``<pathexpr>`` tags) 
665
against which the query (contained in the ``<value>`` tags) is being performed. 
666

    
667
The ``<pathexpr>`` can also contain a document type keyword contained in 
668
``<returndoc>`` tags. The specified document type applies only to documents 
669
that are packaged together (e.g., a data set and its corresponding metadata file). 
670
If Metacat identifies the search term in a packaged document, the servlet will 
671
check to see if that document's type matches the specified one. If not, 
672
Metacat will check if one of the other documents in the package matches. If so, 
673
Metacat will return the matching document. For more information about packages, 
674
please see the developer documentation.
675

    
676
After Metacat has processed a Pathquery document, it returns a resultset document.
677

    
678
::
679

    
680
  <resultset>
681
        <query>
682
          <pathquery version="1.0">
683
             <meta_file_id>unspecified</meta_file_id>
684
             <querytitle>unspecified</querytitle>
685
             <returnfield>dataset/title</returnfield>
686
             <returnfield>keyword</returnfield>
687
             <returnfield>dataset/creator/individualName/surName</returnfield>
688
             <returndoctype>eml://ecoinformatics.org/eml-2.1.0</returndoctype>
689
             <returndoctype>eml://ecoinformatics.org/eml-2.0.1</returndoctype>
690
             <returndoctype>eml://ecoinformatics.org/eml-2.0.0</returndoctype>
691
             <querygroup operator="UNION">
692
                  <queryterm casesensitive="true" searchmode="contains">
693
                       <value>Charismatic megafauna</value>
694
                       <pathexpr>dataset/title</pathexpr>
695
                   </queryterm>
696
                   <queryterm casesensitive="false" searchmode="starts-with">
697
                      <value>sea otter</value>
698
                      <pathexpr>keyword</pathexpr>
699
                   </queryterm>
700
                   <queryterm casesensitive="false" searchmode="contains">
701
                      <value>Enhydra</value>
702
                      <pathexpr>abstract/para</pathexpr>
703
                   </queryterm>
704
            </querygroup>
705
          </pathquery>
706
         </query>  
707
       
708
         <document>
709
           <docid>nrs.569.3</docid>
710
           <docname>eml</docname>
711
           <doctype>eml://ecoinformatics.org/eml-2.0.0</doctype>
712
           <createdate>2012-06-06</createdate>
713
           <updatedate>2012-06-06</updatedate>
714
           <param name="dataset/title">Marine Mammal slides</param>
715
           <param name="creator/individualName/surName">Bancroft</param>
716
         </document>
717
 
718
         <document>
719
           <docid>knb-lter-sbc.61.1</docid>
720
           <docname>eml</docname>
721
           <doctype>eml://ecoinformatics.org/eml-2.1.0</doctype>
722
           <createdate>2012-06-06</createdate>
723
           <updatedate>2012-06-06</updatedate>
724
           <param name="dataset/creator/individualName/surName">Nelson</param>
725
           <param name="dataset/creator/individualName/surName">Harrer</param>
726
           <param name="dataset/creator/individualName/surName">Reed</param>
727
           <param name="dataset/title">SBC LTER: Reef: Sightings of Sea Otters (Enhydra lutris) near Santa Barbara and Channel Islands, ongoing since 2007</param>
728
         </document>
729
      .....  
730
  </resultset>
731

    
732
When Metacat returns a resultset document, the servlet always includes the 
733
pathquery used to create it. The pathquery XML is contained in the <query> tag, 
734
the first element in the resultset.
735

    
736
Each XML document returned by the query is represented by a ``<document>`` tag. By 
737
default, Metacat will return the docid, docname, doctype, doctitle, createdate 
738
and updatedate for each search result. If the user specified additional return 
739
fields in the pathquery using ``<returnfield>`` tags (e.g., dataset/title to return 
740
the document title), the additional fields are returned in ``<param>`` tags. 
741

    
742
Metacat can return the XML resultset to your client as either XML or HTML.
743

    
744
Paged Query Returns
745
~~~~~~~~~~~~~~~~~~~
746
Dividing large search result sets over a number of pages speeds load-time and 
747
makes the result sets more readable to users (Figure 4.12). To break your search 
748
results into pages, use the query action's optional pagestart and pagesize 
749
parameters. The pagesize parameter indicates how many results should be 
750
returned for a given page. The pagestart parameter indicates which page you 
751
are currently viewing.
752

    
753
.. figure:: images/screenshots/image045.jpg
754
   :align: center
755
   
756
   An example of paged search results. 
757

    
758
When a paged query is performed, the query's resultset contains four extra 
759
fields: pagestart, pagesize, nextpage, and previouspage (Figure 4.13).  The 
760
nextpage and previouspage fields help Metacat generate navigational links in 
761
the rendered resultset using XSLT to transform the XML to HTML. 
762

    
763
:: 
764

    
765
  <!-- An example of an XML resultset that include support for page breaks. 
766
       The pagestart parameter will always indicate the page you are currently viewing.
767
  -->
768
  <resultset>
769
      <pagestart>1</pagestart>
770
      <pagesize>10</pagesize>
771
      <nextpage>2</nextpage>
772
      <previouspage>0</previouspage>
773
      <query> ...</query>
774
      <document>...</document>
775
      <document>...</document>
776
    </resultset>
777

    
778
The HTML search results displayed in the figure were rendered using Kepler's XSLT, 
779
which can be found in lib/style/skins/kepler. Kepler's XSLT uses the four extra 
780
resultset fields to render the "Next" and "Previous" links.
781

    
782
::
783
  
784
  <a href="metacat?action=query&operator=INTERSECT&enableediting=false&anyfield=actor&qformat=kepler&pagestart=0&pagesize=10">Previous Page</a>
785
  <a href="metacat?action=query&operator=INTERSECT&enableediting=false&anyfield=actor&qformat=kepler&pagestart=2&pagesize=10">Next Page</a>
786
  
787
In the example above, the current page is 1, and the previous page (page 0) and next page (page 2) pages are indicated by the values of the pagestart parameters.
788

    
789
Reading Data and Metadata
790
~~~~~~~~~~~~~~~~~~~~~~~~~
791
To read data or metadata from Metacat, use the ``read`` action. The ``read`` action 
792
takes two parameters: ``docid``, which specifies the document ID of the document 
793
to return, and ``qformat``, which specifies the return format for the document 
794
(``html`` or ``xml`` or the name of a configured style-set, e.g., ``default``). If ``qformat`` 
795
is set to ``xml``, Metacat will return the XML document untransformed. If the 
796
return format is set to ``html``, Metacat will transform the XML document into 
797
HTML using the default XSLT style sheet (specified in the Metacat 
798
configuration). If the name of a style-set is specified, Metacat will use the 
799
XSLT styles specified in the set to transform the XML.
800

    
801
.. figure:: images/screenshots/image047.jpg
802
   :align: center
803
   
804
   The same document displayed using different qformat parameters (from left 
805
   to right: the default style-set, XML, and HTML). 
806

    
807
Note that the ``read`` action can be used to read both data files and metadata files. 
808
To read a data file, you could use the following request::
809

    
810
  http://yourserver.com/yourcontext/metacat?action=read&docid=nceas.55&qformat=default
811

    
812
Where ``nceas.55`` is the docid of the data file stored in the Metacat and 
813
``default`` is the name of the style (you could also use "html" or "xml" or the 
814
name of a customized skin).
815

    
816
::
817
  
818
  <html>
819
  <head>
820
    <title>Read Document</title>
821
  </head>
822
  <body>
823
    <form method="POST" action="http://your.server/your.context/servlet/metacat">
824
      <input name="action" value="read" type="hidden">
825
      <input name="docid" type="text" value="" size="40">
826
      <input name="qformat" value="default" type="hidden">
827
      <input value="Read" type="submit">
828
    </form>
829
  </body>
830
  </html>
831
  
832
Using the EarthGrid API (aka EcoGrid)
833
-------------------------------------
834

    
835
.. Note::
836

    
837
  The EarthGrid/EcoGrid web service API is *deprecated* as of Metacat 2.0.0 and 
838
  will be removed from a future version of Metacat.  Its functionality is being 
839
  replaced by the standardized DataONE REST service interface. The EarthGrid API
840
  will be completely removed by the end of 2013.
841
   
842
The EarthGrid (aka EcoGrid) provides access to disparate data on different 
843
networks (e.g., KNB, GBIF, GEON) and storage systems (e.g., Metacat and SRB), 
844
allowing scientists access to a wide variety of data and analytic resources 
845
(e.g., data, metadata, analytic workflows and processors) networked at different 
846
sites and at different organizations via the internet. 
847

    
848
Because Metacat supports the EarthGrid API (see table), it can query the 
849
distributed EarthGrid, retrieve metadata and data results, and write new and 
850
updated metadata and data back to the grid nodes.
851

    
852
For more information about each EarthGrid service and its WSDL file, navigate 
853
to the "services" page on your Metacat server 
854
(e.g., http://knb.ecoinformatics.org/metacat/services). 
855
Note that the AdminService and Version service that appear on this page are 
856
not part of EarthGrid.
857

    
858
EarthGrid/EcoGrid API Summary
859

    
860
+----------------------------+-----------------------------------------------------------------------------------------------------+
861
| Service                    | Description                                                                                         |
862
+============================+=====================================================================================================+
863
| AuthenticationQueryService | Search for and retrieve protected metadata and data from the EarthGrid as an authenticated user.    |
864
|                            |                                                                                                     |
865
|                            | Methods: ``query``, ``get``                                                                         |
866
+----------------------------+-----------------------------------------------------------------------------------------------------+
867
| AuthenticationService      | Log in and out of the EarthGrid                                                                     |
868
|                            |                                                                                                     |
869
|                            | Methods: ``login``, ``logout``                                                                      |
870
+----------------------------+-----------------------------------------------------------------------------------------------------+
871
| IdentifierService          | List, lookup, validate, and add Life Science Identifiers (LSIDs) to the EarthGrid                   |
872
|                            |                                                                                                     |
873
|                            | Methods: ``isRegistered``, ``addLSID``, ``getNextRevision``, ``getNextObject``, ``getAllIds``       |
874
+----------------------------+-----------------------------------------------------------------------------------------------------+
875
| PutService                 | Write metadata to the EarthGrid                                                                     |
876
|                            |                                                                                                     |
877
|                            | Methods: ``put``                                                                                    |
878
+----------------------------+-----------------------------------------------------------------------------------------------------+
879
| QueryService               | Search for and retrieve metadata from the EarthGrid                                                 |
880
|                            |                                                                                                     |
881
|                            | Methods: ``query``, ``get``                                                                         |
882
+----------------------------+-----------------------------------------------------------------------------------------------------+
883
| RegistryService            | Add, update, remove, and search for registered EarthGrid services.                                  |
884
|                            | Note: The WSDL for this  service is found under http://ecogrid.ecoinformatics.org/registry/services |
885
|                            |                                                                                                     |
886
|                            | Methods: ``add``, ``update``, ``remove``, ``list``, ``query``                                       |
887
+----------------------------+-----------------------------------------------------------------------------------------------------+
888

    
889
Using Morpho
890
------------
891
Morpho is a desktop tool created to facilitate the creation, storage, and 
892
retrieval of metadata. Morpho interfaces with any Metacat server, allowing 
893
users to upload, download, store, query and view relevant metadata and data 
894
using the network. Users can authorize the public or only selected colleagues 
895
to view their data files. 
896

    
897
Morpho is part of the Knowledge Network for Biocomplexity (KNB), a national 
898
network intended to facilitate ecological and environmental research on 
899
biocomplexity. To use Morpho with your Metacat, set the Metacat URL in the 
900
Morpho Preferences to point to your Metacat server.
901

    
902
.. figure:: images/screenshots/image049.png
903
   :align: center
904
   
905
   Set the Metacat URL in the Morpho preferences to point to your Metacat.
906

    
907
For more information about Morpho, please see: http://knb.ecoinformatics.org/
908

    
909
Creating Your Own Client
910
------------------------
911

    
912
.. Note::
913

    
914
  NOTE: The Client API (and underlying servlet implementation) has been 
915
  deprecated as of Metacat 2.0.0. Future development should utilize the DataONE 
916
  REST service methods. The Client API will be completely removed by the end of 2013.
917
  
918
Metacat's client API is available in Java and Perl (the Java interface is 
919
described in this section and further detailed in the appendix). Some of the 
920
API is also available in Python and Ruby. The API allows client applications 
921
to easily authenticate users and perform basic Metacat operations such as 
922
reading metadata and data files; inserting, updating, and deleting files; and 
923
searching for packages based on metadata matches. 
924

    
925
The Client API is defined by the interface edu.ucsb.nceas.metacat.client.Metacat, 
926
and all operations are fully defined in the javadoc_ documentation. To use the 
927
client API, include the ``metacat-client.jar``, ``utilities.jar``, ``commons-io-2.0.jar``, and 
928
``httpclient.jar`` in your classpath. After including these classes, you can 
929
begin using the API methods (see the next table). 
930

    
931
.. _javadoc: http://knb.ecoinformatics.org/software/metacat/dev/api/index.html
932

    
933
The following code block displays a typical session for reading a document 
934
from Metacat using the Java client API.
935

    
936
::
937
  
938
  String metacatUrl = "http://foo.com/context/metacat";
939
  String username = "uid=jones,o=NCEAS,dc=ecoinformatics,dc=org";
940
  String password = "neverHarcodeAPasswordInCode";
941
  try {
942
      Metacat m = MetacatFactory.createMetacatConnection(metacatUrl);
943
      m.login(username, password);
944
      Reader r = m.read("testdocument.1.1");
945
      // Do whatever you want with Reader r
946
  } catch (MetacatAuthException mae) {
947
      handleError("Authorization failed:\n" + mae.getMessage());
948
  } catch (MetacatInaccessibleException mie) {
949
      handleError("Metacat Inaccessible:\n" + mie.getMessage());
950
  } catch (Exception e) {
951
      handleError("General exception:\n" + e.getMessage());
952
  }
953
  
954
  Operations provided by Client API  (Metacat.java class)
955
  
956
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
957
| Method               | Parameters and Throws                                                                                                                                                                                       | Description                                                                                                                               |
958
+======================+=============================================================================================================================================================================================================+===========================================================================================================================================+
959
| delete               | ``public String delete(String docid) throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;``                                                                                   | Delete an XML document in the repository.                                                                                                 |
960
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
961
| getAllDocids         | ``public Vector getAllDocids(String scope) throws MetacatException;``                                                                                                                                       | Return a list of all docids that match a given scope. If scope is null, return all docids registered in the system.                       |
962
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
963
| getLastDocid         | ``public String getLastDocid(String scope) throws MetacatException;``                                                                                                                                       | Return the highest document ID for a given scope.  Used by clients to determine the next free identifier in a sequence for a given scope. |
964
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
965
| getloggedinuserinfo  | ``public String getloggedinuserinfo() throws MetacatInaccessibleException;``                                                                                                                                | Return the logged in user for this session.                                                                                               |
966
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
967
| getNewestDocRevision | ``public int getNewestDocRevision(String docId) throws MetacatException;``                                                                                                                                  | Return the latest revision of specified the document from Metacat                                                                         |
968
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
969
| getSessonId          | ``public String getSessionId();``                                                                                                                                                                           | Return the session identifier for this session.                                                                                           |
970
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
971
| insert               | ``public String insert(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``                                   | Insert an XML document into the repository.                                                                                               |
972
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
973
| isRegistered         | ``public boolean isRegistered(String docid) throws MetacatException;``                                                                                                                                      | Return true if given docid is registered; false if not.                                                                                   |
974
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
975
| login                | ``public String login(String username, String password) throws MetacatAuthException, MetacatInaccessibleException;``                                                                                        | Log in to a Metacat server.                                                                                                               |
976
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
977
| logout               | ``public String logout() throws MetacatInaccessibleException, MetacatException;``                                                                                                                           | Log out of a Metacat server.                                                                                                              |
978
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
979
| query                | ``public Reader query(Reader xmlQuery) throws MetacatInaccessibleException, IOException;``                                                                                                                  | Query the Metacat repository and return the result set as a Reader.                                                                       |
980
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
981
| query                | ``public Reader query(Reader xmlQuery, String qformat) throws MetacatInaccessibleException, IOException;``                                                                                                  | Query the Metacat repository with the given metacat-compatible query format and return the result set as a Reader.                        |
982
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
983
| read                 | ``public Reader read(String docid) throws InsufficientKarmaException, MetacatInaccessibleException, DocumentNotFoundException, MetacatException;``                                                          | Read an XML document from the Metacat server.                                                                                             |
984
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
985
| readInlineData       | ``public Reader readInlineData(String inlinedataid) throws InsufficientKarmaException, MetacatInaccessibleException, MetacatException;``                                                                    | Read inline data from the Metacat server session.                                                                                         |
986
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
987
| setAccess            | ``public String setAccess(String _docid, String _principal, String _permission, String _permType, String _permOrder ); throws InsufficientKarmaException, MetacatException, MetacatInaccessibleException;`` | Set permissions for an XML document in the Metacat repository.                                                                            |
988
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
989
| setMetacatUrl        | ``public void setMetacatUrl(String metacatUrl);``                                                                                                                                                           | Set the MetacatUrl to which connections should be made.                                                                                   |
990
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
991
| setSessionId         | ``public void setSessionId(String sessionId);``                                                                                                                                                             | Set the session identifier for this session.                                                                                              |
992
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
993
| update               | ``public String update(String docid, Reader xmlDocument, Reader schema) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``                                   | Update an XML document in the repository by providing a new version of the XML document.                                                  |
994
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
995
| upload               | ``public String upload(String docid, File file) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``                                                           | Upload a data document into the repository.                                                                                               |
996
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
997
| upload               | ``public String publicupload(String docid, String fileName, InputStream fileData, int size) throws InsufficientKarmaException, MetacatException, IOException, MetacatInaccessibleException;``               | Upload a data document into the repository.                                                                                               |
998
+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
999