Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 4.09 KB

README.md

File metadata and controls

109 lines (77 loc) · 4.09 KB
Raw

OAI Provider for Fedora 4

Implements Open Archives Protocol Version 2.0 using Fedora 4 as the backend.

Installation

1.Checkout the sources and build the fcrepo-oaiprovider Jar:

#> git clone https://github.com/fasseg/fcrepo-oaiprovider.git
#> maven clean install

2.Drop the jar into Fedora's lib directory

#> cp target/fcrepo-oaiprovider-{VERSION}.jar /path/to/webapp/WEB-INF/lib/

3.Edit Fedora's web.xml (or classes/spring/master.xml)

#> vim /path/to/webapp/WEB-INF/web.xml

or

#> vim /path/to/webapp/WEB-INF/classes/spring/master.xml

4.Add oaiprovider.xml context configuration in the web.xml

<param-name>contextConfigLocation</param-name>
<param-value>WEB-INF/classes/spring/master.xml, classpath:oaiprovider.xml</param-value>

or, in master.xml

<import resource="classpath:oaiprovider.xml"/>

5.Restart Tomcat/Jetty, if necessary

Technoblabber

The OAI Provider exposes an endpoint at /oai which accepts OAI conforming HTTP requests. A Fedora object containing the set information is created at /oai/setspec. For Set creation an endpoint at /oai/sets is exposed which accepts HTTP POST requests containing serialized Set information adhering to the OAI schema. (see src/test/test-data/set.xml).

The provider depends on links to Datastreams and OAI Set objects to generate OAI responses. A graph linking a Fedora Object to it's OAI DC Datastream should look like this:

                                            +----------+
                                            | MyObject | 
                                            +----------+
                                            /          \
                                           /            \
                                   hasOaiDCRecord   isPartOfOaiSet
                                         /                \
                                        /                  \
                           +-------------------+      +----------+
                           | MyOaiDCDatastream |      |   MySet  |
                           +-------------------+      +----------+

Additional Metadata record types

The oaiprovider supports oai_dc out if the box, but users are able to add their own metadata format definitions to oaiprovider.xml.

Example

Create a Fedora Object MyObject and add an OAI DC Datastream MyOAIDCDatastream which is contained in the OAI Set MyOAISet

1.Create a new Datastream containing an XML representation of an oai_dc record:

#> curl -X POST http://localhost:8080/fcrepo/rest -H "Slug:MyOAIDCDatastream" -H "Content-Type:application/octet-stream" --data @src/test/resources/test-data/oaidc.xml

2.Create a new OAI Set:

#> curl -X POST http://localhost:8080/fcrepo/rest/oai/sets -H "Content-Type:text/xml" --data @src/test/resources/test-data/set.xml

3.Create a new Fedora Object and link the oai_dc Datastream and the OAI Set created in the previous step to it:

#> curl -X POST http://localhost:8080/fcrepo/rest -H "Slug:MyObject" -H "Content-Type:application/sparql-update"  --data "INSERT {<> <http://fedora.info/definitions/v4/config#hasOaiDCRecord> <http://localhost:8080/fcrepo/rest/MyOAIDCDatastream> . <> <http://fedora.info/definitions/v4/config#isPartOfOAISet> \"MyOAISet\"} WHERE {}"

4.Try the various responses from the oai provider

#> curl http://localhost:8080/fcrepo/rest/oai?verb=ListMetadataFormats
#> curl "http://localhost:8080/fcrepo/rest/oai?verb=GetRecord&identifier=MyObject&metadataPrefix=oai_dc"
#> curl "http://localhost:8080/fcrepo/rest/oai?verb=ListRecords&metadataPrefix=oai_dc"
#> curl "http://localhost:8080/fcrepo/rest/oai?verb=ListIdentifiers&metadataPrefix=oai_dc"
#> curl "http://localhost:8080/fcrepo/rest/oai?verb=ListSets"
#> curl "http://localhost:8080/fcrepo/rest/oai?verb=ListIdentifiers&metadataPrefix=oai_dc&set=MyOAISet"