Module 6 - introducing sword v2

1,308 views

Published on

Published in: Education, Technology
  • Be the first to comment

  • Be the first to like this

Module 6 - introducing sword v2

  1. 1. The SWORD Course<br />Module6<br />IntroducingSWORD v2<br />
  2. 2. Module objectives<br />By the end of this module you will:<br />Appreciate the limitations of SWORD v1<br />Know about this history of SWORD v2<br />Understand how SWORD v2 works<br />Have a knowledge of the extra use cases supported by SWORD v2<br />
  3. 3. SWORD v1<br />SWORD v1 was designed to be a:<br />Simple<br />Web-service<br />Offering<br />Repository<br />Deposit<br />This was at the heart of its success, but the root of its limitations.<br />
  4. 4. SWORD v1<br />SWORD v1 supports<br />‘Fire and forget’<br />Perform a deposit, but no way to interact with it subsequently<br />Modify / Replace / Augment / Delete<br />No standardized packaging format<br />
  5. 5. The history of SWORD v2<br />SWORD project wrote a discussion paper proposing SWORD v2<br />Paper outlined what needed to be added<br />Paper circulated at OR10 in Madrid for comment via open commenting system<br />http://sword2depositlifecycle.jiscpress.org/<br />
  6. 6. The history of SWORD v2<br />Proposal for funding submitted to JISC<br />Employ a Technical Lead and Community Manager<br />Gather community requirements<br />Form a Technical Advisory Panel<br />Write SWORD v2 standard<br />Employ repository and client developers<br />Develop draft specification<br />Finalize specification<br />
  7. 7. SWORD v2 implementations<br />SWORD v2 project funded:<br />Repositories:<br />DSpace<br />EPrints<br />Fedora<br />Clients:<br />Java<br />PHP<br />Ruby (+ BibApp)<br />Python<br />
  8. 8. Who is involved<br />Consortium project<br />UKOLN (lead)<br />Cottage Labs<br />University of Southampton<br />MediaShelf<br />Freelance staff<br />
  9. 9. Why develop SWORD v2?<br />Overcome limitations<br />Fire and forget<br />Standardized package format<br />Enable new use cases<br />Support for the whole deposit lifecycle<br />
  10. 10. SWORD v2 – How does it work?<br />Service Documents<br />GET service documents<br />Very similar to v1<br />
  11. 11. SWORD v2 – How does it work?<br />Package Deposit<br />POST packages<br />Very similar to v1<br />
  12. 12. SWORD v2 – How does it work?<br />Two other methods of (standardized) deposit:<br />POST Atom Entry<br />Deposits metadata<br />POST Multipart deposit<br />Atom Entry + file<br />Same method as used for email + attachment<br />
  13. 13. SWORD v2 – How does it work?<br />The deposit receipt:<br />An Atom entry<br />Contains some further URLs:<br />EDIT-URI / EDIT-IRI<br />EDIT-MEDIA-URI / EM-IRI<br />STATEMENT-URI / STATE-IRI<br />CONTENT-URI / CONT-IRI<br />SWORD-EDIT-URI / SE-IRI<br />
  14. 14. SWORD v2 – How does it work?<br />What can we do with these extra URIs?<br />
  15. 15. SWORD v2 – How does it work?<br />What can we do with these extra URIs?<br />GET on the Edit-URI<br />Retrieve back a copy of the Deposit Receipt<br />GET on the Content-URI / Edit Media-URI<br />Retrieve a copy of the content as a package<br />Can request different packaging formats if supported<br />
  16. 16. SWORD v2 – How does it work?<br />What can we do with these extra URIs?<br />PUT on the Edit Media-URI<br />Replace the file content<br />PUT on the Edit-URI<br />Replace the file and metadata via a package<br />Or<br />Replace the metadata via an Atom entry<br />
  17. 17. SWORD v2 – How does it work?<br />What can we do with these extra URIs?<br />POST to the Edit Media-URI<br />Add an extra content file<br />POST to the SWORD Edit-URI<br />Add extra file and metadata via a package<br />Or<br />Add extra file an metadata via multipart deposit<br />Or<br />Add extra metadata via an Atom entry<br />
  18. 18. SWORD v2 – How does it work?<br />What can we do with these extra URIs?<br />DELETE on the Edit Media-URI<br />Delete the content of the item (not the item)<br />DELETE on the Edit-URI<br />Delete the container (the item)<br />
  19. 19. SWORD v2 – How does it work?<br />A few other bells and whistles:<br />In-Progress header:<br />Consider the deposit ‘in progress’, for completion later<br />Deposit statement<br />Describes the structure and the state of the deposit<br />Serialized as Atom or OAI-ORE documents<br />
  20. 20. Credits<br />This course has been produced by:<br />Stuart Lewis and Richard Jones<br />The SWORD project<br />http://swordapp.org/<br />Funded by JISC<br />http://www.jisc.ac.uk/<br />Licence<br />Creative commons<br />
  21. 21. Photo Credits<br />Lecture hall: http://www.flickr.com/photos/iamthebestartist/2008790/<br />

×