/docs/user/metacatapi.html - Annotate - Metacat - Ecoinformatics Redmine

metacat/docs/user/metacatapi.html @ 4615

-            berkley
+<!--
   * Metacatapi.html
+  *
   *      Authors: Jivka Bojilova
   *    Copyright: 2000 Regents of the University of California and the
   *               National Center for Ecological Analysis and Synthesis
   *  For Details: http://www.nceas.ucsb.edu/
   *      Created: 2000 April 5
   *      Version: 0.01
   *    File Info: '$Id$'
+  *
   * October Meeting SDSC, 2000
 -->
 <HTML>
 <HEAD>
 <TITLE>Metacat</TITLE>
-            daigle
+<link rel="stylesheet" type="text/css" href="./default.css">
-            berkley
+</HEAD>
 <BODY>
   <table width="100%">
     <tr>
       <td class="tablehead" colspan="2"><p class="label">Metacat High Level API</p></td>
       <td class="tablehead" colspan="2" align="right">
         <a href="./metacatout.html">Back</a> | <a href="./metacattour.html">Home</a> |
         <a href="./packages.html">Next</a>
       </td>
     </tr>
   </table>
   <p>
       <b>Multiple client interface</b> <br>
       Since Metacat Servlet is a subclass of HttpServlet, this allows any client
       to communicate with Metacat by essentially passing a URL with embedded
       servlet parameters.
       Metacat Servlet provides an HTTP Interface and can handle GET and POST
       requests. HTTP requests are sent from the the Client application and contain
       a number of parameters. These parameters, in form of name/value pairs, provide
       input data for the Servlet and also provide the Servlet any extra information it
       needs to handle the request. </p>
   <P> <b>Extensions of HttpServlet</b> <br>
       Metacat Server adds the functionality for writing, quering, and reading of
       XML stored in the Metacat Database as well functions for validating and
       transforming XML documents. </p>
   <b>MetacatServlet Parameters</b>
   <table border="1">
     <tr>
       <td><b>Action</b></td>
       <td><b>Supplemental Parameters</b></td>
       <td><b>Description</b></td>
     </tr>
     <tr>
       <td>login</td>
       <td>
         <ul>
           <li>username - the user's login name</li>
           <li>password - the user's password</li>
         </ul>
       </td>
       <td>Log the user in.</td>
     </tr>
     <tr>
       <td>logout</td>
       <td>none</td>
       <td>Log the current user out and destroy the associated session.</td>
     </tr>
     <tr>
       <td>query</td>
       <td>
         <ul>
           <li>returndoctype - the doctype that you wish to use for your
           <a href="./packages.html">Package View</a></li>
           <li>qformat - the format that you wish to return the resultset in.
           Possible values are 'html' or 'xml'.</li>
           <li>querytitle - OPTIONAL - the title of the query</li>
           <li>doctype - OPTIONAL - if doctype is specified, the search is limited
           only to the doctype(s) specified.</li>
           <li>returnfield - a custom field to be returned by any hit document.
           This is explained in more detail in <a href="./metacatquery.html">
           Queries and Results</a>.</li>
           <li>operator - the boolean operator to apply to the query - Possible
           values are: UNION or INTERSECT</li>
           <li>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.</li>
           <li>anyfield - a freetext search variable.  A value placed in this
           parameter will be searched for in any document in any node.</li>
         </ul>
       </td>
       <td>Perform a free text query.</td>
     </tr>
     <tr>
       <td>squery</td>
       <td>
       <ul>
         <li>query - the text of the pathquery document that is being sent to the
         server</li>
       </ul>
       </td>
       <td>Perform a structured query.</td>
     </tr>
     <tr>
-            daigle
+      <td>spatial_query</td>
       <td>
       <ul>
         <li>xmax - max x spacial coordinate</li>
         <li>ymax - max y spacial coordinate</li>
         <li>xmin - min x spacial coordinate</li>
         <li>ymin - min y spacial coordinate</li>
       </ul>
       </td>
       <td>Perform a spatial query.  These queries may include any of the
           queries supported by the WFS / WMS standards.</td>
     </tr>
     <tr>
-            berkley
+      <td>read</td>
       <td>
       <ul>
         <li>docid - the docid of the document to read</li>
         <li>qformat - the format to return the document in.  Possible values
         are: html, xml</li>
       </ul>
       </td>
       <td>Get docid from the database and return it in qformat form.</td>
     </tr>
     <tr>
-            daigle
+      <td>readinlinedata</td>
       <td>
       <ul>
         <li>inlinedataid - the id of the inline data to read</li>
       </ul>
       </td>
       <td>Read inline data only.</td>
     </tr>
     <tr>
-            berkley
+      <td>insert</td>
       <td>
         <ul>
-            tao
+          <li>docid - the user defined docid to assign to the new XML document.</li>
           <li>doctext - the text of the XML document to insert</li>
-            berkley
+        </ul>
       </td>
-            tao
+      <td>Insert an XML document into the database.</td>
-            berkley
+    </tr>
     <tr>
-            daigle
+      <td>insertmultipart</td>
       <td>
         <ul>
           <li>docid - the user defined docid to assign to the new XML document.</li>
           <li>doctext - the text of the XML document to insert</li>
         </ul>
       </td>
       <td>insert an xml document into the database using multipart encoding.</td>
     </tr>
     <tr>
-            berkley
+      <td>update</td>
       <td>
       <ul>
         <li>docid - the docid of the document to update</li>
-            tao
+        <li>doctext - the text with which to update the XML document</li>
-            berkley
+      </ul>
       </td>
-            tao
+      <td>Overwrite an XML document with a new one and give the new one
-            berkley
+          the same docid but with next revision number.</td>
     </tr>
     <tr>
-            tao
+      <td>upload</td>
       <td>
       <ul>
         <li>docid - the docid of the data document to upload</li>
         <li>datafile - the data document to upload</li>
       </ul>
       </td>
-            tao
+      <td>Upload (insert or update) a data document into metacat. Data files are stored on
-            tao
+               metacat and may be in any format (binary or text), but they are all
-            tao
+               treated as if they were binary.</td>
-            tao
+    </tr>
     <tr>
-            berkley
+      <td>delete</td>
       <td>
         <ul>
           <li>docid - the docid of the document to delete</li>
         </ul>
       </td>
       <td>Delete the specified docid from the database.</td>
     </tr>
     <tr>
-            daigle
+      <td>setaccess</td>
       <td>
         <ul>
           <li>docid - the docid of the document whose access we want to change</li>
           <li>principal - the user or group whose permissions want to change</li>
           <li>permission - the permission we want to set (read, write, all)</li>
           <li>permType - the type of permission to set (allow, deny)</li>
           <li>permOrder - the order to apply the permission (allowFirst, denyFirst)</li>
         </ul>
       </td>
       <td>Change access permissions for a user on a document.</td>
     </tr>
     <tr>
-            berkley
+      <td>validate</td>
       <td>
       <ul>
         <li>docid - the docid of the document to validate</li>
         <li>valtext - the DTD by which to validate this document</li>
       </ul>
       </td>
       <td>Validate docid against its DTD.</td>
     </tr>
     <tr>
       <td>getaccesscontrol</td>
       <td>
       <ul>
         <li>docid - the docid of the document to get the ACL for</li>
       </ul>
       </td>
       <td>Get ACL for document with that docid</td>
     </tr>
     <tr>
       <td>getprincipals</td>
       <td>none</td>
       <td>Get all users and groups in the current authentication schema</td>
     </tr>
     <tr>
       <td>getdoctypes</td>
       <td>none</td>
       <td>Get all doctypes currently available in Metacat Catalog System.</td>
     </tr>
     <tr>
       <td>getdtdschema</td>
       <td>
         <ul>
           <li>doctype - the doctype which DTD or XMLSchema file to read.</td>
         </ul>
       </td>
       <td>Read DTD or XMLSchema file for the specified doctype.</td>
     </tr>
     <tr>
       <td>getdataguide</td>
       <td>
         <ul>
           <li>doctype - the doctype for which to get the data guide</li> <br>
           <i><b> Deprecated. </b></i> Use getdtdschema action instead.
         </ul>
       </td>
       <td>Read a dataguide for doctype.</td>
     </tr>
     <tr>
       <td>getlastdocid</td>
       <td>
         <ul>
           <li>username - the user's login name which last docid to get.</td>
         </ul>
       </td>
       <td>Get the latest docid with rev number used by user.</td>
     </tr>
     <tr>
-            daigle
+      <td>getalldocids</td>
       <td>
         <ul>
           <li>scope - a string used to match a range of docids in a SQL LIKE statement.</td>
         </ul>
       </td>
       <td>retrieves a list of all docids registered with the system.</td>
     </tr>
     <tr>
       <td>isregistered</td>
       <td>
         <ul>
           <li>docid - the docid of the document to check for.</td>
         </ul>
       </td>
       <td>checks if an individual document exists in either the xml_documents
           or xml_revisions tables.</td>
     </tr>
     <tr>
       <td>getrevisionanddoctype</td>
       <td>
         <ul>
           <li>docid - the docid of the document to check for.</td>
         </ul>
       </td>
       <td>Return the revision and doctype of a document. The output is String
       that looks like "rev;doctype"</td>
     </tr>
     <tr>
       <td>getversion - get Metacat version.</td>
       <td>none</td>
       <td>Returns the current version of Metacat as XML.</td>
     </tr>
     <tr>
-            berkley
+      <td>protocoltest</td>
       <td>
         <ul>
           <li>url - the url to test against the protocol handler</li>
         </ul>
       </td>
       <td>Test the protocol handlers installed for metacat:// URLs.</td>
     </tr>
-            berkley
+    <tr>
       <td>export</td>
       <td>
-            daigle
+        <ul>
           <li>docid - the docid of the package you wish to export</li>
         </ul>
-            berkley
+      </td>
       <td>
         Exports a data package in a zip file.
       </td>
     </tr>
-            daigle
+    <tr>
       <td>getlog</td>
       <td>
         <ul>
             <li>ipaddress - the internet protocol address for the event</li>
             <li>principal - the principal for the event (a username, etc)</li>
             <li>docid - the identifier of the document to which the event applies</li>
             <li>event - the string code for the event</li>
             <li>start - beginning of date range for query</li>
             <li>end - end of date range for query</li>
         </ul>
       </td>
       <td>Print a report from the Metacat event log.</td>
     </tr>
     <tr>
       <td>getloggedinuserinfo</td>
       <td>none</td>
       <td>Get user info for the currently logged in user.</td>
     </tr>
-            berkley
+  </table>
   <br>
   <b><a href="./replication.html">MetacatReplication</a> Parameters</b>
     <table border="1">
     <tr>
       <td><b>Action</b></td>
       <td><b>Supplemental Parameters</b></td>
       <td><b>Description</b></td>
     </tr>
     <tr>
       <td>forcereplicate</td>
       <td>
         <ul>
           <li>server - The server to which this document is being sent</li>
           <li>docid - The docid of the document to send</li>
           <li>dbaction - DEFAULTS TO UPDATE - The action to perform on the
           document.  INSERT or UPDATE.</li>
         </ul>
       </td>
       <td>Force this server to get docid from the remote host.</td>
     </tr>
     <tr>
       <td>getall</td>
       <td>none</td>
       <td>Forces the local server to check all known servers for updated
       documents.</td>
     </tr>
     <tr>
       <td>getcatalog</td>
       <td>none</td>
       <td>Sends the contents of the xml_catalog table encoded in XML.</td>
     </tr>
     <tr>
       <td>getlock</td>
       <td>
         <ul>
           <li>docid - the docid to get the lock for</li>
           <li>updaterev - the revision number of docid</li>
         </ul>
       </td>
       <td>Request a lock on docid.</td>
     </tr>
     <tr>
       <td>gettime</td>
       <td>none</td>
       <td>Return the local time on this server.</td>
     </tr>
     <tr>
       <td>servercontrol</td>
       <td>
         <ul>
           <li>subaction - The replication control to be performed.  Possible
           values:
             <ul>
               <li>add - add a new server to the replication list</li>
               <li>delete - remove a server from the replication list</li>
               <li>list - list all of the servers currently in the server list</li>
             </ul>
           <li>replicate - a boolean flag (1 or 0) which determines if this
           server is to copy files from the newly added server.</li>
           <li>server - the server to add/delete</li>
         </ul>
       </td>
       <td>Perform subaction on the Replication daemon.</td>
     </tr>
     <tr>
       <td>read</td>
       <td>
         <ul>
           <li>docid - the docid to read</li>
         </ul>
       </td>
       <td>Sends docid to the remote host.</td>
     </tr>
     <tr>
       <td>start</td>
       <td>
         <ul>
           <li>rate - DEFAULTS TO 1000 - The rate (in seconds) at which you want
           the replication daemon to check for updated documents.  The value
           cannot be less than 30.</li>
         </ul>
       </td>
       <td>Start the Replication daemon with a time interval of deltaT.</td>
     </tr>
     <tr>
       <td>stop</td>
       <td>none</td>
       <td>Stop the Replication daemon.</td>
     </tr>
     <tr>
       <td>update</td>
       <td>none</td>
       <td>Send a list of all documents on the local server along with their
       revision numbers.</td>
     </tr>
   </table>
   <br>
   <a href="./metacatout.html">Back</a> | <a href="./metacattour.html">Home</a> |
   <a href="./packages.html">Next</a>
 </BODY>
 </HTML>

Project

General

Profile

Metacat