PubMan Sword

This page briefly describes the SWORD Server implementation in the PubMan solution. General Information about SWORD can be found here.

Implementation

For start the SWORD functionality is directly implemented in PubMan by exploiting and extending the sword api provided by JISC. In future we could have a separate SWORD service for all eSciDoc solutions.

PubMan implements 3 classes for the SWORD service:

1. PubManSwordServer - Processing of requests
2. PubManServiceDocumentServlet - Accepting requests for the Service Document (dependent on user credentials)
3. PubManDepositServlet - Accepting requests for the deposits (dependent on user credentials)

Interface

The PubMan SWORD interface is deployed within the PubMan ear, therefore one can access the above described servlets by the PubMan baseURL + the servlet path.

(Example with PubMan base url http://pubman.mpdl.mpg.de/pubman, note that sword functionality is not yet deployed on live server)

Service Document

http://pubman.mpdl.mpg.de/pubman/faces/sword-app/servicedocument

Request:

GET with user credentials

Response:

Code 200

A servicedocument describing all open collections a user may deposit to. A collection identifier which can be found in this document must be provided for deposit.

Deposit Service

http://pubman.mpdl.mpg.de/pubman/faces/sword-app/deposit?collection=collectionIdentifier

Request:

POST with user credentials and depositing item as zip

Response:

Code 201: Created

- Item action: Save, Submit, Release

Code 202: Accepted

- Item action: Save
- Item action: Save, Submit

Code 203:

- No user credentials were provided

- User was not recognized

Code 403:

- No collection was provided
- No rights to deposit to the provided collection

Code 415:

- Media Type not supported in PubMan
- No metadata file was provided
- Metadata could not be transformed into publication format

Code 400:

- Authentication Failure

- Validation Failure

Code 500:

- Internal Server Error

Code 413:

- Mediation not allowed

Plus an Atom Entry Document which contains information about the deposit:

<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:sword="http://purl.org/net/sword/">
  <atom:author>
     <atom:name>Friederike, Kleinfercher</atom:name>
  </atom:author>
  <atom:content src="http://pubman.mpdl.mpg.de/pubman/item/escidoc:142247"/>
  <atom:summary>item.xml ,123.pdf</atom:summary>
  <atom:title>First Sword item</atom:title>
  <atom:source>
     <atom:generator>http://pubman.mpdl.mpg.de/pubman</atom:generator>
  </atom:source>
  <atom:updated>2009-04-02T14:23:02Z</atom:updated>
  <sword:treatment>Zip archives recognised as content
     packages are opened and the individual files contained
     in them are stored. All other files are stored as
     is.</sword:treatment>
  <sword:acceptPackaging >http://www.tei-c.org/ns/1.0</sword:acceptPackaging >
  <sword:noOp>false</sword:noOp>
</atom:entry>

• The zip file may contain several files but must contain exactly one metadata file. All files not containing metadata are transformed to PubFiles and are added to the Publication item.
• The item is deposited to the collection: collectionIdentifier
• The validation of the item depends on the collection
• The action of deposit depends on the collection

Action Mapping

SWORD Action	PubMan Action	Comment	Status
Deposit	Save Save, Submit Save, Submit,Release	depending on the collection workflow and collection policies.	Implemented
Edit	Save Save, Submit Save, Submit,Release	depending on the collection workflow and collection policies.	Not implemented
Delete	Withdraw Delete	If item is in state released If item is in state pending or In-Revision	Not implemented

Useful information

• File visibility will be set to public
• File content category will be set to Publisher Version
• PubMan SWORD deposit interface can process the following metadata formats:
  • escidoc publication metadata (file ending .xml)
  • tei metadata (file ending .tei), the mapping is optimized for the use of the PEER Project
  • BibTex metadata (file ending .bib)
  • EndNote metadata (file ending .enl)

Simple Web-service Offering Repository Deposit

Publication Management

Joint Information Systems Committee UK

Enhanced Scientific Documentation

Enterprise Archive File Formate

Portable Document Format

Publishing and the Ecology of European Research

Reference Management Software for Lists of References