PubMan Sword
This page briefly describes the SWORD Server implementation in the PubMan solution. General Information about SWORD can be found here.
Implementation[edit]
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 seperate SWORD service for all eSciDoc solutions. PubMan implements 3 classes for the SWORD service:
- PubManSwordServer - Processing of requests
- PubManServiceDocumentServlet - Accepting requests for the Service Document (dependent on user credentials)
- PubManDepositServlet - Accepting requests for the deposits (dependent on user credentials)
Interface[edit]
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, note that sword functionality is not yet deployed on live server)
Service Document[edit]
http://pubman.mpdl.mpg.de/pubman/faces/sword/servicedocument
Request:
GET with user credentials
Response:
Code 200
A servicedocument containing all open collections a user may deposit to.
<service> <sword:level>0</sword:level> <sword:verbose>false</sword:verbose> <sword:noOp>true</sword:noOp> <workspace> <atom:title type="text">PubMan SWORD Workspace</atom:title> <collection href="collectionIdentifier"> <atom:title type="text">demo publications</atom:title> <accept>application/zip</accept> <sword:collectionPolicy>todo</sword:collectionPolicy> <dcterms:abstract>Description of the demo publication collection</dcterms:abstract> <sword:mediation>false</sword:mediation> <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:formatNamespace>http://www.loc.gov/METS/</sword:formatNamespace> </collection> </workspace> </service>
Deposit Service[edit]
http://pubman.mpdl.mpg.de/pubman/faces/sword/deposit?collection=collectionIdentifier
Request:
POST with user credentials and depositing item as zip
Response:
Code 201: Created
- - Item action: Save, Submit, Release
- - Item action: Save, Submit, Release
Code 202: Accepted
- - Item action: Save
- Item action: Save, Submit
- - Item action: Save
Code 203:
- - No user credentials were provided
- - User was not recognized
- - No user credentials were provided
Code 403:
- - No collection was provided
- No rights to deposit to the provided collection
- - No collection was provided
Code 415:
- - Media Type not supported in PubMan
- No metadata file was provided
- Metadata could not be transformed into publication format
- - Media Type not supported in PubMan
Code 400:
- - Internal Server Error
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 ,0808.1121.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:formatNamespace>http://www.loc.gov/METS/</sword:formatNamespace> <sword:noOp>false</sword:noOp> </atom:entry>
- The zip file may contain several file but must contain one metadata file (currently only escidoc publication format is supported, as soon as know the depositing format we can run a transformation). 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 (see action mapping)
Action Mapping[edit]
For start we should only allow actions of the owner of an item.
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 | If item is in state released | Not implemented |
Delete | Delete | If item is in state pending or In-Revision | Not implemented |
TODO: Check exact delete behaviour of PubMan items, SWORD delete should reflect this behaviour.
Default Values[edit]
- File visibility will be set to public
- File content category will be set to Any Fulltext
- Currently the sword deposit service only handles escidoc publication format.