Project

General

Profile

« Previous | Next » 

Revision 4604

Added by daigle over 15 years ago

Update metacat api documentation

View differences:

MetaCatServlet.java
98 98 
 *
99 99 
 * <p>
100 100 
 * Valid parameters are: <br>
101 
 * action=query -- query the values of all elements and attributes and return a
102 
 * result set of nodes <br>
101 
 * action=query -- query the values of all elements and attributes and return a result set of nodes <br>
102 
 * action=spatial_query -- run a spatial query.  these queries may include any of the
103 
 *      queries supported by the WFS / WMS standards
103 104 
 * action=squery -- structured query (see pathquery.dtd) <br>
104 
 * action= -- export a zip format for data packadge <br>
105 
 * action=read -- read any metadata/data file from Metacat and from Internet
106 
 * <br>
105 
 * action=export -- export a zip format for data packadge <br>
106 
 * action=read -- read any metadata/data file from Metacat and from Internet<br>
107 
 * action=readinlinedata -- read inline data only<br>
107 108 
 * action=insert -- insert an XML document into the database store <br>
108 109 
 * action=insertmultipart -- insert an xml document into the database using multipart encoding<br>
109 110 
 * action=update -- update an XML document that is in the database store <br>
110 111 
 * action=delete -- delete an XML document from the database store <br>
112 
 * action=setaccess -- change access permissions for a user on a document. <br>
111 113 
 * action=validate -- vallidate the xml contained in valtext <br>
112 114 
 * doctype -- document type list returned by the query (publicID) <br>
113 115 
 * qformat=xml -- display resultset from query in XML <br>
......
117 119 
 * doctext -- XML text of the document to load into the database <br>
118 120 
 * acltext -- XML access text for a document to load into the database <br>
119 121 
 * dtdtext -- XML DTD text for a new DTD to load into Metacat XML Catalog <br>
120 
 * query -- actual query text (to go with 'action=query' or 'action=squery')
121 
 * <br>
122 
 * query -- actual query text (to go with 'action=query' or 'action=squery')<br>
122 123 
 * valtext -- XML text to be validated <br>
123 124 
 * action=getaccesscontrol -- retrieve acl info for Metacat document <br>
124 125 
 * action=getalldocids -- retrieves a list of all docids registered with the system<br>
125 126 
 * scope --can limit the query by the scope of the id
126 127 
 * action=isregistered -- checks to see if the provided docid is registered<br>
128 
 * action=getrevisionanddoctype -- get a document's revision and doctype from database
129 
 * action=getversion --
127 130 
 * docid --the docid to check
128 131 
 * action=getdoctypes -- retrieve all doctypes (publicID) <br>
129 132 
 * action=getdtdschema -- retrieve a DTD or Schema file <br>
130 133 
 * action=getdataguide -- retrieve a Data Guide <br>
131 
 * action=getprincipals -- retrieve a list of principals in XML <br>
134 
 * action=getprincipals -- retrieve a list of principals in XML <br>
132 135 
 * datadoc -- data document name (id) <br>
133 136 
 * action=getlog -- get a report of events that have occurred in the system<br>
137 
 * action=getloggedinuserinfo -- get user info for the currently logged in user<br>
134 138 
 * ipAddress --  filter on one or more IP addresses<br>
135 139 
 * principal -- filter on one or more principals (LDAP DN syntax)<br>
136 140 
 * docid -- filter on one or more document identifiers (with revision)<br>
......
2562 2566
2563 2567 
    }
2564 2568
2569 
    /**
2570 
     * Check if the document is registered in either the xml_documents or xml_revisions table
2571 
     * @param out the writer to write the xml results to
2572 
     * @param params request parameters
2573 
     * @param response the http servlet response
2574 
     */
2565 2575 
    private void handleIdIsRegisteredAction(PrintWriter out, Hashtable<String, String[]> params,
2566 2576 
            HttpServletResponse response) {
2567 2577 
        String id = null;

Also available in: Unified diff