Difference between revisions of "PubMan Sword"

From MPDLMediaWiki
Jump to navigation Jump to search
(added action mapping)
Line 21: Line 21:


Request:
Request:
...


Response:
Response:
<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="collection Identifier">
        <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===
===Deposit Service===

Revision as of 11:56, 1 April 2009

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:

  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)

Deposit[edit]

  • The result of a deposit depends on the workflow of the collection an item is deposited to. Check the deposit action mapping.

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:

...

Response:

<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="collection Identifier">
       <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=1234

Request:

Response:

Action Mapping[edit]

SWORD Action PubMan Action Comment
Deposit Submit - Release {Save}, {Save, Submit} or {Save, Submit,Release}, depending on the collection workflow and collection policies.
Edit Release same as above
Delete Withdraw Provide also delete for 'not submitted' items?--Friederike 08:51, 11 March 2009 (UTC)


 :) Have not thought of it. Actually, maybe we should only provide delete for "pending" and "in-revision" items, and not withdraw automatically. --Natasa 09:15, 11 March 2009 (UTC)