Project

General

Profile

metacat / docs / user / metacat.html @ 3067

1
<!--
2
  * metacat.html
3
  *
4
  *      Authors: Jivka Bojilova
5
  *    Copyright: 2000 Regents of the University of California and the
6
  *               National Center for Ecological Analysis and Synthesis
7
  *  For Details: http://www.nceas.ucsb.edu/
8
  *      Created: 2000 April 5
9
  *      Version: 0.01
10
  *    File Info: '$Id: metacat.html 2509 2005-06-08 18:13:42Z costa $'
11
  * 
12
  * October Meeting SDSC, 2000
13
-->
14
<HTML>
15
<HEAD>
16
<TITLE>Metacat</TITLE>
17
<link rel="stylesheet" type="text/css" href="@docrooturl@default.css">
18
</HEAD> 
19
<BODY>
20
  <table width="100%">
21
    <tr>
22
      <td class="tablehead" colspan="2"><p class="label">Metacat Server</p></td>
23
      <td class="tablehead" colspan="2" align="right">
24
        <a href="./domapi.html">Back</a> | <a href="./metacattour.html">Home</a> | 
25
        <a href="./metacatdb.html">Next</a>
26
      </td>
27
    </tr>
28
  </table>
29
  <P>The Metacat Server stores arbitrary XML 
30
  documents in a relational 
31
  database without foreknowledge of the document schema.  It does this by implementing
32
  the DOM within the table structure of the relational database.
33
  Metacat also performs optimized free-text 
34
  and structured 
35
  searches across the entire document collection. Metacat provides 
36
  standardized interfaces to client software for document processing, storing 
37
  and searching. 
38

    
39
  <P> <img alt="Structural diagram of Metacat architecture" src="metacat.gif">
40
  </p>
41
  <p>
42
        Metacat provides several means of access for communicating with the
43
        server to access and submit metadata and data.  First, users can
44
        access the flexible web user interface.  Second, the servlet can be
45
        queried using basic HTML forms.  Third, a 
46
        <a href="./clientapi.html">client API</a> exists for 
47
        writing software for accessing the server's contents.
48
  </p>
49
  <p>        
50
        When accessing the servlet interface either through 'GET' or 'POST'
51
        HTTP requests, the request is directed to the appropriate handler based
52
        on an 'action' parameter in the request.  For example, using the 
53
        parameter 'action=getversion' one could construct an HTTP GET
54
        request to retrive the Metacat version string:<br>
55
          <code>http://some.metacat.host/context/metacat?action=getversion</code>
56
  </p>
57
  <p>
58
        The complete list of "actions" which can be used in request to Metacat 
59
        along with the additional parameters associated with each action are
60
        as follows.
61
  </p>
62
  <p>        Primary actions for the most important features:<br>
63
  <ul>
64
      <li><code>action=login</code>
65
          <ul>
66
          <li><code>username</code></li>
67
          <li><code>password</code></li>
68
          </ul>
69
      </li>
70
      <li><code>action=logout</code>
71
      </li>
72
      <li><code>action=query</code>
73
          <ul>
74
          <li><code>meta_file_id</code></li>
75
          <li><code>returndoctype</code></li>
76
          <li><code>filterdoctype</code></li>
77
          <li><code>returnfield</code></li>
78
          <li><code>owner</code></li>
79
          <li><code>site</code></li>
80
          <li><code>operator</code></li>
81
          <li><code>casesensitive</code></li>
82
          <li><code>searchmode</code></li>
83
          <li><code>anyfield</code></li>
84
          <li><code>sessionid</code></li>
85
          <li>Any other parameter passed in will be interpreted as a query
86
              term unless it is listed in the 'query.ignored.params'
87
              property in metacat.properties</li>
88
          </ul>
89
      </li>
90
      <li><code>action=squery</code>
91
          <ul>
92
          <li><code>query</code></li>
93
          <li><code>qformat</code></li>
94
          </ul>
95
      </li>
96
      <li><code>action=read</code>
97
          <ul>
98
          <li><code>docid</code></li>
99
          <li><code>qformat</code></li>
100
          </ul>
101
      </li>
102
      <li><code>action=insert</code>
103
          <ul>
104
          <li><code>docid</code></li>
105
          <li><code>doctext</code></li>
106
          <li><code>dtdtext</code></li>
107
          </ul>
108
      </li>
109
      <li><code>action=update</code>
110
          <ul>
111
          <li><code>docid</code></li>
112
          <li><code>doctext</code></li>
113
          <li><code>dtdtext</code></li>
114
          </ul>
115
      </li>
116
      <li><code>action=delete</code>
117
          <ul>
118
          <li><code>docid</code></li>
119
          </ul>
120
      </li>
121
  </ul>
122
        Actions for less important features:<br>
123
  <ul>
124
      <li><code>action=export</code>
125
          <ul>
126
          <li><code>docid</code></li>
127
          </ul>
128
      </li>
129
      <li><code>action=readinlinedata</code>
130
          <ul>
131
          <li><code>inlinedataid</code></li>
132
          </ul>
133
      </li>
134
      <li><code>action=validate</code>
135
          <ul>
136
          <li><code>valtext</code></li>
137
          <li><code>docid</code></li>
138
          </ul>
139
      </li>
140
      <li><code>action=setaccess</code>
141
          <ul>
142
          <li><code>docid</code></li>
143
          <li><code>principal</code></li>
144
          <li><code>permission</code></li>
145
          <li><code>permType</code></li>
146
          <li><code>permOrder</code></li>
147
          <li><code>principal</code></li>
148
          </ul>
149
      </li>
150
      <li><code>action=getaccesscontrol</code>
151
          <ul>
152
          <li><code>docid</code></li>
153
          </ul>
154
      </li>
155
      <li><code>action=getprincipals</code>
156
      </li>
157
      <li><code>action=getdoctypes</code>
158
      </li>
159
      <li><code>action=getdtdschema</code>
160
          <ul>
161
          <li><code>doctype</code></li>
162
          </ul>
163
      </li>
164
      <li><code>action=getlastdocid</code>
165
          <ul>
166
          <li><code>scope</code></li>
167
          <li><code>username</code></li>
168
          </ul>
169
      </li>
170
      <li><code>action=getrevisionanddoctype</code>
171
          <ul>
172
          <li><code>docid</code></li>
173
          </ul>
174
      </li>
175
      <li><code>action=getversion</code>
176
      </li>
177
      <li><code>action=getlog</code>
178
          <ul>
179
          <li><code>ipaddress</code></li>
180
          <li><code>principal</code></li>
181
          <li><code>docid</code></li>
182
          <li><code>event</code></li>
183
          <li><code>start</code></li>
184
          <li><code>end</code></li>
185
          </ul>
186
      </li>
187
      <li><code>action=buildindex</code>
188
          <ul>
189
          <li><code>docid</code></li>
190
          </ul>
191
      </li>
192
      <li><code>action=shrink</code>
193
      </li>
194
  </ul>
195
  </p>
196

    
197
  <br>
198
  <a href="./domapi.html">Back</a> | <a href="./metacattour.html">Home</a> | 
199
  <a href="./metacatdb.html">Next</a>
200
</BODY>
201
</HTML>
202