Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Info
titleCurrent released version

OAI Provider Service 1.2.12 is the currently released version. See release notes

Info
titleCompatibility

Compatible with Fedora Version 3.0-3.4.5.

Warning
titleFCREPO-832

Due to an outstanding issue, the oaiprovider requires a default character encoding of UTF-8.

Supply the parameter -Dfile.encoding=utf-8 to the JVM, for instance by including this in your CATALINA_OPTS. This is only necessary if your default platform encoding is not UTF-8.

Table of contents:

Table of Contents

About This Service

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.

Major Features

  • Supports any metadata format available through your Fedora Repository via a Datastream or dissemination service
  • Supports sets that are expressed as RDF relationships in your digital objects' RELS-EXT Datastreams as exposed via the Resource Index
  • Runs as a Web application in any servlet container, acting as a Web service client to the Fedora Repository
  • Caches the content of Fedora Repository disseminations and Datastreams intended to be exposed as OAI records allowing for fast response times and ensuring that the OAI provider can continue to run even when the Fedora Repository is temporarily stopped.
  • Automatic schema validation - Incoming record XML can now be automatically validated and rejected if it doesn't conform to the XML schema it declares.
  • Support for Mulgara (formerly Kowari) and MPTStore - This service requires that Fedora's Resource Index is enabled, and can be used whether it is backed by Mulgara, Kowari (Fedora 2 and earlier), or MPTStore.

See the Configuration section for more detail on using these capabilities.

Installation

To install the service:

  1. Make sure you have a suitable database installed (MySQL, PostgreSQL, Oracle, or McKoi) and a database user account that can create tables in the database.

...

  1. Deploy the oaiprovider.war file into your servlet container.
  2. Configure the OAI Provider as described in the Configuration section below.
  3. Re-start the Web application (this is often done by restarting the servlet container itself).

Demonstration and Test Setup

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.

...

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.

Configuration
Anchor
configuration
configuration

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).

Release Notes

Version 1.2.1 - August 30th, 2010

This bugfix release addresses the following issues:

...

.

...