Difference between revisions of "SWORD"

From EPrints Documentation
Jump to: navigation, search
m (Removed ", which will become standard when EPrints v3.2 is released")
Line 4: Line 4:
 
The SWORD project was funded by [http://www.jisc.ac.uk/ JISC] and more information can be found on the [http://swordapp.org official website].
 
The SWORD project was funded by [http://www.jisc.ac.uk/ JISC] and more information can be found on the [http://swordapp.org official website].
  
The current version of the protocol is 1.3 and this page is only about this version.
+
== 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 ==
 
== Protocol implementation ==
  
v1.3
 
 
verbose
 
verbose
 
no-op
 
no-op
  
For information on SWORD 2 see [[API:EPrints/Apache/CRUD]].
+
== Configuring SWORD ==
  
  
== Configuring SWORD ==
 
  
configuring sword.pl
+
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''
  
archives/<your repo>/cfg/cfg.d/sword.pl
+
== servicedocument ==
  
 +
The default
 
== Supported packages ==
 
== Supported packages ==
  
which features of the protocol are supported
 
  
 
maybe how to write new importer plugins
 
maybe how to write new importer plugins

Revision as of 16:35, 12 March 2013

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 default

Supported packages

maybe how to write new importer plugins