OAI Provider Service 1.2.2 is the currently released version. See release notes
Compatible with Fedora Version 3.0-3.5.
Due to an outstanding issue, the oaiprovider requires a default character encoding of UTF-8.
Supply the parameter
Table of contents:
The Fedora OAI Provider Service is part of the Fedora Service Framework and offers a vast improvement over the previous, simple OAI provider that the Fedora Repository used in previous versions. The new provider is based on PROAI, an open source caching, polling OAI provider.
RELS-EXTDatastreams as exposed via the Resource Index
See the Configuration section for more detail on using these capabilities.
To install the service:
Make sure your Fedora Repository is running with the Resource Index turned ON. This is necessary because the OAI provider periodically queries the resource index to discover which records of interest have changed.
The source distribution of the OAI Provider service includes several test Fedora digital objects. You can use these objects and the default
proai.properties configuration file to quickly understand how the service works.
proai.propertiesconfiguration file and ensure the following properties are set according to your own Fedora Repository installation:
Upon starting, the Fedora OAI Provider service will poll the repository for objects that provide OAI record content and have changed since its last update. It will find the demonstration objects you just ingested, request appropriate disseminations of each, and save them in its cache. Once it has successfully completed a cache update cycle, you should be able call the
oaiprovider client service interface with OAI-PMH verbs. Here are some examples (note that you may have to substitute the name of your host for
fedora-admincommand line application to edit a Datastream in one of the demonstration objects you just ingested. The next time the OAI Provider service polls the repository for modified objects, it should pick up this change and make it available via the
oaiproviderclient service interface.
Note that the poll frequency is ten minutes by default - this can be configured to be more or less frequent by changing the
proai.driverPollSeconds property in the proai.properties file.
Please consult the Configuration Reference for a complete list of proai.properties configuration options and what they do.
You should also take a look at the
log4j.xml that resides alongside the
proai.properties file in the Web application's
WEB-INF/classes directory. This file controls where log messages will be sent and how much detail they will contain. When first setting up the Fedora OAI Provider service, it is recommended that you keep the log level high (DEBUG for most categories).