Revision 8265
Added by ben leinfelder over 10 years ago
| oaipmh.rst | ||
|---|---|---|
| 13 | 13 |
supported by an OAI-PMH compliant data provider (also referred to as a |
| 14 | 14 |
repository). These methods are: |
| 15 | 15 |
|
| 16 |
1. ``GetRecord`` – retrieves zero or one complete metadata record from a repository;
|
|
| 17 |
2. ``Identify`` – retrieves information about a repository;
|
|
| 18 |
3. ``ListIdentifiers`` – retrieves zero or more metadata record “headers” (not the complete metadata record) from a repository;
|
|
| 19 |
4. ``ListMetadataFormats`` – retrieves a list of available metadata record formats supported by a repository;
|
|
| 20 |
5. ``ListRecords`` – retrieves zero or more complete metadata records from a respository; and
|
|
| 21 |
6. ``ListSets`` – retrieves the set structure from a repository.
|
|
| 16 |
1. ``GetRecord`` - retrieves zero or one complete metadata record from a repository;
|
|
| 17 |
2. ``Identify`` - retrieves information about a repository;
|
|
| 18 |
3. ``ListIdentifiers`` - retrieves zero or more metadata record "headers" (not the complete metadata record) from a repository;
|
|
| 19 |
4. ``ListMetadataFormats`` - retrieves a list of available metadata record formats supported by a repository;
|
|
| 20 |
5. ``ListRecords`` - retrieves zero or more complete metadata records from a repository; and
|
|
| 21 |
6. ``ListSets`` - retrieves the set structure from a repository.
|
|
| 22 | 22 |
|
| 23 | 23 |
The OAI-PMH compliant data provider must accept requests from both HTTP GET |
| 24 | 24 |
and HTTP POST request methods. Responses from the data provider must be |
| ... | ... | |
| 105 | 105 |
|
| 106 | 106 |
Users of the Metacat OAI-PMH Data Provider should be aware of the following issues: |
| 107 | 107 |
|
| 108 |
* 'Deleted' Status – OAI-PMH repositories can optionally flag records with
|
|
| 108 |
* 'Deleted' Status - OAI-PMH repositories can optionally flag records with
|
|
| 109 | 109 |
a 'deleted' status, indicating that a record in the metadata format |
| 110 | 110 |
specified by the metadataPrefix is no longer available. Since Metacat does |
| 111 | 111 |
not provide a mechanism for retrieving a list of deleted documents, the use |
| 112 | 112 |
of the 'deleted' status is not supported in this implementation of the |
| 113 | 113 |
OAI-PMH Data Provider. This represents a possible future enhancement. |
| 114 |
* Sets – OAI-PMH repositories can optionally support set hierarchies. Since it
|
|
| 114 |
* Sets - OAI-PMH repositories can optionally support set hierarchies. Since it
|
|
| 115 | 115 |
has not been determined how set hierarchies should be structured in |
| 116 | 116 |
Metacat, this implementation of the OAI-PMH repository does not support |
| 117 | 117 |
set hierarchies. This represents a possible future enhancement. |
| 118 |
* Datestamp Granularity – When expressing datestamps for repository documents,
|
|
| 118 |
* Datestamp Granularity - When expressing datestamps for repository documents,
|
|
| 119 | 119 |
OAI-PMH allows two levels of granularity: day granularity and seconds |
| 120 | 120 |
granularity. Since the Metacat database stores the value of its |
| 121 | 121 |
``xml_documents.date_updated`` field in day granularity, it is the level |
| ... | ... | |
| 133 | 133 |
|
| 134 | 134 |
Users of the Metacat OAI-PMH Harvester should be aware of the following issues: |
| 135 | 135 |
|
| 136 |
* Handling of 'Deleted' status – The Metacat OAI-PMH Harvester program does
|
|
| 136 |
* Handling of 'Deleted' status - The Metacat OAI-PMH Harvester program does
|
|
| 137 | 137 |
check to see whether a 'deleted' status is flagged for a harvested document, |
| 138 | 138 |
and if it is, the document is correspondingly deleted from the Metacat repository. |
| 139 |
* Datestamp Granularity – When expressing datestamps for repository documents,
|
|
| 140 |
OAI-PMH allows two levels of granularity – day granularity and seconds
|
|
| 139 |
* Datestamp Granularity - When expressing datestamps for repository documents,
|
|
| 140 |
OAI-PMH allows two levels of granularity - day granularity and seconds
|
|
| 141 | 141 |
granularity. Since the Metacat database stores the value of its |
| 142 | 142 |
``xml_documents.last_updated`` field in day granularity, it is also the |
| 143 | 143 |
level that is supported by both the Metacat OAI-PMH Data Provider and the |
| ... | ... | |
| 175 | 175 |
|
| 176 | 176 |
:: |
| 177 | 177 |
|
| 178 |
``oaipmh.repositoryIdentifier`` – A string that identifies this repository
|
|
| 179 |
``Identify.adminEmail`` – The email address of the repository administrator
|
|
| 178 |
``oaipmh.repositoryIdentifier`` - A string that identifies this repository
|
|
| 179 |
``Identify.adminEmail`` - The email address of the repository administrator
|
|
| 180 | 180 |
|
| 181 | 181 |
3. Edit the deployment descriptor (``web.xml``) file, also in the WEB-INF |
| 182 | 182 |
directory. Uncomment the servlet-name and servlet-mapping entries for the |
| 183 |
DataProvider servlet by removing the surrounding “<!--“ and “-->” strings:
|
|
| 183 |
DataProvider servlet by removing the surroundin "<!--" and "-->" strings:
|
|
| 184 | 184 |
|
| 185 | 185 |
:: |
| 186 | 186 |
|
| ... | ... | |
| 213 | 213 |
+----------------------------------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 214 | 214 |
| AbstractCatalog.secondsToLive | 3600 | The lifetime, in seconds, of the resumptionToken. | |
| 215 | 215 |
+----------------------------------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 216 |
| AbstractCatalog.granularity | YYYY-MM-DD or | Granularity of datestamps. Either ‘days granularity’ or ‘seconds granularity’ values can be used. |
|
|
| 216 |
| AbstractCatalog.granularity | YYYY-MM-DD or | Granularity of datestamps. Either "days granularity" or "seconds granularity" values can be used. |
|
|
| 217 | 217 |
| | YYYY-MM-DDThh:mm:ssZ | | |
| 218 | 218 |
+----------------------------------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 219 | 219 |
| Identify.repositoryName | Metacat OAI-PMH Data Provider | A name for the repository. | |
| 220 | 220 |
+----------------------------------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 221 | 221 |
| Identify.earliestDatestamp | 2000-01-01T00:00:00Z | Earliest datestamp supported by this repository | |
| 222 | 222 |
+----------------------------------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 223 |
| Identify.deletedRecord | yes or no | Use ‘yes’ if the repository indicates the status of deleted records; use ‘no’ if it doesn’t. |
|
|
| 223 |
| Identify.deletedRecord | yes or no | Use "yes" if the repository indicates the status of deleted records; use "no" if it doesn't. |
|
|
| 224 | 224 |
+----------------------------------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ |
| 225 | 225 |
| Identify.adminEmail | mailto:tech_support@someplace.org | Email address of the repository administrator. | |
| 226 | 226 |
+----------------------------------------+----------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ |
| ... | ... | |
| 316 | 316 |
-dn uid=jdoe,o=myorg,dc=ecoinformatics,dc=org \ |
| 317 | 317 |
-password some_password \ |
| 318 | 318 |
-metadataPrefix oai_dc \ |
| 319 |
http://baseurl.repository.org/knb/dataProvider
|
|
| 319 |
http://baseurl.repository.org/metacat/dataProvider
|
|
| 320 | 320 |
|
| 321 | 321 |
On Linux/Unix: |
| 322 | 322 |
|
| ... | ... | |
| 326 | 326 |
-dn uid=jdoe,o=myorg,dc=ecoinformatics,dc=org \ |
| 327 | 327 |
-password some_password \ |
| 328 | 328 |
-metadataPrefix oai_dc \ |
| 329 |
http://baseurl.repository.org/knb/dataProvider
|
|
| 329 |
http://baseurl.repository.org/metacat/dataProvider
|
|
| 330 | 330 |
|
| 331 | 331 |
|
| 332 | 332 |
Command line options and parameters are described in the following table: |
| ... | ... | |
| 346 | 346 |
+-----------------------------+----------------------------------------------------+-----------------------------------------------------------------------------------------------------+ |
| 347 | 347 |
| -setSpec | ``-setSpec someSet`` | Harvest documents belonging to this set. (Optional) | |
| 348 | 348 |
+-----------------------------+----------------------------------------------------+-----------------------------------------------------------------------------------------------------+ |
| 349 |
| base_url | ``http://baseurl.repository.org/knb/dataProvider`` | Base URL of the remote repository |
|
|
| 349 |
| base_url | ``http://baseurl.repository.org/metacat/dataProvider`` | Base URL of the remote repository |
|
|
| 350 | 350 |
+-----------------------------+----------------------------------------------------+-----------------------------------------------------------------------------------------------------+ |
| 351 | 351 |
|
| 352 | 352 |
|
Also available in: Unified diff
Refer to metacat.war deployments since those are now the default. https://projects.ecoinformatics.org/ecoinfo/issues/6082