Implementation Guidelines for the Open Archives Initiative Protocol for Metadata Harvesting

- XML Schema for repositories to list confederate repositories

Protocol Version 2.0 of 2002-06-14
Document Version 2002/09/30T15:33:00Z
http://www.openarchives.org/OAI/2.0/guidelines-friends.htm

Editors

The OAI Executive:
Carl Lagoze <lagoze@cs.cornell.edu> -- Cornell University - Computer Science
Herbert Van de Sompel <herbertv@lanl.gov> -- Los Alamos National Laboratory - Research Library

From the OAI Technical Committee:
Michael Nelson <m.l.nelson@larc.nasa.gov> -- NASA - Langley Research Center
Simeon Warner <simeon@cs.cornell.edu> -- Cornell University - Computer Science

This document is one part of the Implementation Guidelines that accompany the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH).

XML Schema for repositories to list confederate repositories

The friends container is recommended for use by repositories to list confederate repositories. This provides an automatic way for harvesters to discover other repositories that may be of interest. Widespread use of this container would provide a decentralized mechanism by which harvesters can discover other repositories.

`friends` `description` container

<schema xmlns="http://www.w3.org/2001/XMLSchema"
  xmlns:friends="http://www.openarchives.org/OAI/2.0/friends/"
  targetNamespace="http://www.openarchives.org/OAI/2.0/friends/"
  elementFormDefault="qualified"
  attributeFormDefault="unqualified">

  <annotation>
    <documentation>
      Schema for description section of Identify reply, for repositories 
      that list "friends" (confederate data providers). 2002. 
      Validated at http://www.w3.org/2001/03/webdata/xsv on 03-24-2002.
    </documentation>
  </annotation>

  <element name="friends" type="friends:friendsType"/>

  <complexType name="friendsType">
    <sequence>
     <element name="baseURL" minOccurs="0" maxOccurs="unbounded" type="anyURI"/>
    </sequence>
  </complexType>

</schema>

This Schema is available at http://www.openarchives.org/OAI/2.0/friends.xsd

Example

The following example is an excerpt from an Identify response which may contain zero or more <description> containers.

<description>
  <friends xmlns="http://www.openarchives.org/OAI/2.0/friends/" 
    xmlns:xsi:="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/friends/
      http://www.openarchives.org/OAI/2.0/friends.xsd">
    <baseURL>http://oai.east.org/foo/</baseURL>
    <baseURL>http://oai.hq.org/bar/</baseURL>
    <baseURL>http://oai.south.org/repo.cgi</baseURL>
  </friends>
</description>

Acknowledgements

Support for the development of the OAI-PMH and for other Open Archives Initiative activities comes from the Digital Library Federation, the Coalition for Networked Information, and from the National Science Foundation through Grant No. IIS-9817416. Individuals who have played a significant role in the development of OAI-PMH version 2.0 are acknowledged in the protocol document.

Document History

2002-06-14: Release of this document, combined with the release of OAI-PMH version 2.0.
2002-09-30: Corrected namespace URI in the schema and example in this document to agree with the schema.