Backend Module implementing the OAI-PMH metadata harvesting protocol
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
descriptors
docker
ramls
src
.editorconfig
.gitignore
.gitmodules
CONTRIBUTING.md
Dockerfile
Jenkinsfile
LICENSE
NEWS.md
README.md
pom.xml

README.md

mod-oai-pmh

Copyright (C) 2018 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Portions of this software may use XML schemas Copyright © 2011 DCMI, the Dublin Core Metadata Initiative. These are licensed under the Creative Commons 3.0 Attribution license.

Introduction

Backend Module implementing the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH Version 2.0), but providing more RESTful API than described in the specification. Refer to oai-pmh.raml for the details.

The repository supports oai_dc and marc21 metadata formats. The OAI Identifier Format is used for resource identifiers with the following pattern: oai:<repositoryBaseUrl>:<tenantId>/<uuid of record> e.g. oai:demo.folio.org:tenant123/fb857902-3ab2-4c34-9772-14ad7acdfe76.

Additional information

Schemas

The following schemas used:

Configuration

Configuration properties are intended to be retrieved from mod-configuration module. System property values are used as a fallback. The default configuration system properties are defined in config.properties. The following configuration properties are used:

Module Config Code System Default Value Description
OAI-PMH repository.name FOLIO_OAI_Repository The name of the repository. The value is used to construct value for OAI-PMH/Identify/repositoryName element.
OAI-PMH repository.baseURL http://folio.org/oai The URL of the repository (basically the URL of the edge-oai-pmh). The value is used in OAI-PMH/Identify/baseURL element.
OAI-PMH repository.adminEmails oai-pmh@folio.org The e-mail address of an administrator(s) of the repository. Might contain several emails which should be separated by comma. The value is used in OAI-PMH/Identify/adminEmail element(s).
OAI-PMH repository.timeGranularity YYYY-MM-DDThh:mm:ssZ The finest harvesting granularity supported by the repository. The legitimate values are YYYY-MM-DD and YYYY-MM-DDThh:mm:ssZ with meanings as defined in ISO8601.
OAI-PMH repository.deletedRecords no The manner in which the repository supports the notion of deleted records. Legitimate values are no ; transient ; persistent with meanings defined in the section on deletion.
OAI-PMH repository.maxRecordsPerResponse 100 The maximum number of records returned in the List responses. The main intention is to implement Flow Control
OAI-PMH jaxb.marshaller.enableValidation false Boolean value which defines if the response content should be validated against xsd schemas.
OAI-PMH jaxb.marshaller.formattedOutput false Boolean value which is used to specify whether or not the marshalled XML data is formatted with linefeeds and indentation.

Notes:

  • The system default values can be overwritten by VM options e.g. -Drepository.name=Specific_FOLIO_OAI-PMH_Repository

  • Another configuration file can be specified via -DconfigPath=<path_to_configs> but the file should be accessible by ClassLoader

  • There is repository.storage system property defining which storage should be used to get records from. This configuration is not tenant specific but system wide therefore cannot be defined in mod-configuration module. There are 2 allowed values:

    Value Storage
    SRS mod-source-record-storage
    INVENTORY mod-inventory-storage

    The default value is SRS. To enable usage of the inventory storage, the -Drepository.storage=INVENTORY VM option should be specified.

Issue tracker

See project MODOAIPMH at the FOLIO issue tracker.

Other documentation

Other modules are described, with further FOLIO Developer documentation at dev.folio.org