Fedora™ OAI Provider Interface User Documentation

Software Release 1.2.1

Fedora™ Development Team

$Id: oaiprovider.dbx,v 1.15 2004/04/16 12:57:45 rlw Exp $


Table of Contents

Introduction
Interface Syntax

Introduction

The OAI Protocol for Metadata Harvesting (OAI-PMH) is a standard for sharing metadata across repositories. Every Fedora digital object has a primary Dublin Core record that conforms to the schema at: http://www.openarchives.org/OAI/2.0/oai_dc.xsd. This metadata is accessible using Fedora's OAI-PMH2.0 Provider Interface. Currently, only the Dublin Core metatdata for each object may be disseminated via this interface.

The Fedora OAI Provider Interface uses the standard OAI PMH syntax which can be found on the OAI web site (http://www.openarchives.org). Fedora will accept any valid OAI-PMH2.0 request.

Interface Syntax

The Fedora OAI-PMH Provider Interface is implemented as a java servlet and can be accessed using the following syntax:

http://hostname:port/fedora/oai?verb=oai-pmh2.0-verb

  • hostname - required hostname of the Fedora server.

  • port - required port number on which the Fedora server is running.

  • fedora - a required part of the Fedora servlet path.

  • oai - a required part of the Fedora servlet path.

  • verb - required keyword of the OAI-PMH2.0 syntax.

  • oai-pmh2.0-verb - required valid OAI-PMH2.0 verb.

For example, to request an OAI Identify verb request, use a URL similar to the following:

http://localhost:8080/fedora/oai?verb=Identify

and the Fedora repository will respond with an XML-encoded mime-typed stream providing identification information about the Fedora OAI provider.