SWORD

From EPrints Documentation
Revision as of 15:16, 11 October 2013 by Kiz (Talk | contribs)

Jump to: navigation, search

This page is about SWORD which is a lightweight protocol for remotely depositing content into repositories.

The SWORD project was funded by JISC and more information can be found on the official website.

SWORD made easy

SWORD is basically an http put (or POST) to a defined web URL, where the content of the posted request is the thing being deposited.

SWORD 1.3 uses an http header field to define how the thing has been wrapped up (packaged)

SWORD 2.0 uses the content-type to deduce how to understand thing

By default, sword is ENABLED in all SWORD 3.2 & 3.3 EPrints servers, and access is available to all registered users.

EPrints 3.2 uses SWORD 1.3

EPrints 3.3 uses SWORD 2.0

This document covers EPrints 3.2 & SWORD 1.3 For information on SWORD 2 see API:EPrints/Apache/CRUD.

Terminology

SWORD 1.3 uses some specific terms for specific meanings

  • collection The specific URL within the server for the data to go into. For EPrints this generally means inbox, review, archive, deleted - however for DSpace, there is a Collection concept; and Fedora has a similar RDF tag for defining collective groupings.
  • package The URI that identifies how a particular deposit has been wrapped up.
  • mediation This is where one user can deposit on behalf of another user.
  • servicedocument The document that the SWORD server can return to inform clients of what collections and what packages are understood by the service

Protocol implementation

verbose no-op

Configuring SWORD

The default location for SWORD configuration is

 archives/<your repo>/cfg/cfg.d/sword.pl

This is where you enable and disable access to various collections, and add/remove packages

servicedocument

The servicedocument is an XML listing of which "collections" are available, and what "packages" can be used with each one.

  • a "collection" in EPrints terms is inbox, review, archive - which correspond to the users workspace, the administration review buffer, and visible in the live repository
  • a "package" is an agreed method for wrapping up the data being sent over - as XML, as formatted text, in a zip file, etc...

The default location for the servicedocument is /sword-app/servicedocument

example

Below is an example framework of the servicedocument

  <service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:sword="http://purl.org/net/sword/"
   xmlns:dcterms="http://purl.org/dc/terms/">
  <workspace>
    <atom:title>OpenDepot.org</atom:title>
    <collection href="http://opendepot.org/sword-app/deposit/buffer">
    ....
    </collection>
    <collection href="http://opendepot.org/sword-app/deposit/inbox">
    .... 
    </collection>
  </workspace>

and in each collection is listed for package formats unsderstood:

  <collection href="http://opendepot.org/sword-app/deposit/buffer">
    <atom:title>Repository Review</atom:title>
    <accept>*/*</accept>
    <sword:acceptPackaging q="0.2">http://www.loc.gov/METS/</sword:acceptPackaging>
    <sword:acceptPackaging q="1.0">http://eprints.org/ep2/data/2.0</sword:acceptPackaging>
    <sword:acceptPackaging q="0.2">http://www.imsglobal.org/xsd/imscp_v1p1</sword:acceptPackaging>
    <sword:acceptPackaging q="0.2">http://purl.org/net/sword-types/METSDSpaceSIP</sword:acceptPackaging>
    <sword:collectionPolicy/>
    <sword:treatment>
      Deposited items will undergo the review process. Upon approval, items will appear in the live repository.
    </sword:treatment>
  <sword:mediation>true</sword:mediation>
  <dcterms:abstract>This is the repository review.</dcterms:abstract>
  </collection>

Supported packages

maybe how to write new importer plugins