Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
SlideShare a Scribd company logo

Sword Or2008 Julieallinson

•Download as PPT, PDF•
•
Julie Allinson
Julie Allinson

SWORD is a protocol for depositing content into repositories. It is a lightweight profile of the Atom Publishing Protocol that defines a set of mandatory and optional parameters for repository deposit. The SWORD protocol has been implemented in several repositories including DSpace, EPrints, IntraLibrary and Fedora. It also has several Java client implementations. SWORD aims to provide a standard way for content to be deposited into repositories from a variety of sources through a simple web service interface.

1 of 36
Julie Allinson Open Repositories 2008 Southampton 1st April 2008 Simple Web-service Offering Repository Deposit SWORD
Quick introduction SWORD?
SWORD Simple Web service Offering Repository Deposit JISC funded project 2007 To provide a standard mechanism for ‘doing deposit’ into repositories Small amount of continuation funding for SWORD II (pending)‏
SWORD : what it is A lightweight protocol for deposit A profile of the Atom Publishing Protocol Implementations of the SWORD deposit interface in IntraLibrary, Fedora, DSpace and EPrints Three java deposit clients – web-based, command-line and desktop NOT a solution to metadata/packaging decisions
Background Before SWORD there was deposit API
Deposit API Discussions at the JISC-CETIS Conference 2005 focussed on the lack of a deposit ‘standard’ Rachel Heery and Repositories Research Team at UKOLN facilitated a working group of repository developers to address this requirement for a standard interface for deposit
Motivations no standard interface for tagging, packaging or authoring tools to upload objects into a repository no standard interface for transferring digital objects between repositories no way to deposit into more than one repository with one ‘click’ no way of initiating a deposit workflow from outside a repository system no way of including deposit into a repository a part of service orientated architecture
Deposit API - achievements Common agreement Scope and definitions Requirements and parameters Scenarios Outline approach Draft XML serialisations
But Progress ground to a halt after July 2006 meeting Difficult to keep momentum without a formal project and without money! November 2006, JISC funding call explicitly mentioned ‘deposit’ as an area for funding proposals ...
JISC to the rescue Repositories and Preservation Programme, Tools and Innovations strand
The project, the funding Six months (plus slight extension) funded under the tools and innovations strand of the JISC Repositories and Preservation Programme, in March 2007 SWORD partners: UKOLN, University of Bath (Project management and dissemination) – Julie Allinson University of Southampton (EPrints) – Les Carr, Seb Francois University of Aberystwyth (DSpace, Fedora, reference client) – Stuart Lewis, Neil Taylor, Glen Robson, Richard Jones Intrallect (IntraLibrary) – Martin Morrey, Sarah Currier Plus some friendly advisors – Jim Downing, Richard Green
SWORD – the acronym Simple – lightweight, agile and fit-for-purpose Web service – independent of proprietary software, supports standard interfaces Offering – repository services Repository – or any system which wants to put or receive content Deposit – or put, or post, or register, or add – a little step in the ingest workflow
But why … ? slicing up the scenarios
Use cases Deposit from a Desktop/Online tool - more on next slide Multiple deposit - e.g. deposit to institutional and (mandated) funders’ repository with one action Machine deposit - e.g. automated deposit from a laboratory machine Migration/transfer - e.g. to a preservation service Mediated deposit - e.g. deposit by a nominated representative, to additional repositories
Desktop tools Desktop ‘smart’ deposit client reference client deposit through SWORD interface Feedforward personal information organiser http://legolas.cetis.ac.uk potential for a Flickr-style batch uploder Facebook plug-in? Deposit as ‘save as’ e.g. from within word processing software
Making scenarios happen the work
Parameters - mandatory Mandatory (level 0)‏ deposit any type of content repository or collection id identifier deposit status (accepted, rejected, error), error codes, error description treatment description
Parameters - optional Optional (level 1 mandatory)‏ mediated deposit repository / collection name collection policy, description accepted formats format namespace source repository checksum compliance level additional identifiers
Future proofing with layers layered approach two levels of compliance Level 0 compliance requires a set of mandatory elements and a set of optional elements Level 1 offers a set of additional elements for richer functionality mandatory at level 1
Offering Services Explain/Discover service can I deposit? to which collections? what can I deposit? what are the policies? Deposit service deposit accepted receipt returned to depositor
Existing standards WebDAV ( http://www.webdav.org /) JSR 170 ( http://www.jcp.org/en/jsr/detail?id=170 ) JSR 283 ( http://www.jcp.org/en/jsr/detail?id=283 ) SRW Update ( http://www.loc.gov/standards/sru/ ) Flickr Deposit API ( http://www.flickr.com/services/api/ ) Fedora Deposit API ( http://www.fedora.info/definitions/1/0/api/ ) OKI OSID ( http://www.okiproject.org /) ECL ( http://ecl.iat.sfu.ca /)‏ ATOM Publishing Protocol (http://www.ietf.org/html-charters/atompub-charter.html)‏
“ the Atom Publishing Protocol is an application-level protocol for publishing and editing Web resources” benefits supports many of our parameters and requirements, in particular file deposit it already exists and has growing support it is well-used in popular applications it has an extension mechanism Google have created their own profile (gdata)‏ good fit with the Web architecture drawbacks / risks too much of a retrofit? it is designed for a single package/file OR an atom document – this means that we need to package up metadata and files
SWORD profile of APP ‘ POST’ only - SWORD does not deal in update/delete ‘ POST’ binary files only - SWORD does not (currently) specify how to post ATOM documents Categories not used SWORD extensions HTTP Header extensions APP / ATOM extensions Recommendations for discovery accessed from /sword-app/ service document at /sword-app/servicedocument use of <link> header to point to sword implementation
How it works ... APP works by issuing HTTP requests (GET, POST)‏ GET Service Document (explain/discover)‏ POST ATOM document or file to collection URI HTTP response and ATOM document is returned HTTP basic authentication is required
Parameters - mandatory Mandatory (level 0)‏ deposit any type of content - APP yes repository or collection id - APP yes identifier - APP yes deposit status (accepted, rejected, error), error codes, error description - APP yes (and extension)‏ compliance level - extension treatment description
Parameters - optional Optional (level 1 mandatory)‏ mediated deposit - extension repository / collection name - APP yes collection policy, description - extension accepted formats - APP yes format namespace - extension source repository - APP yes checksum - extension compliance level - extension additional identifiers - APP yes
Examples - GET (explain)‏ GET /sword-app/servicedocument HTTP/1.1 Host: www.myrepository.ac.uk X-On-Behalf-Of: lcarr
Examples - POST (deposit)‏ POST /burning-collection HTTP/1.1 Host: www.myrepository.ac.uk/sword-app Content-Type: application/zip Authorization: Basic ZGFmZnk6c2VjZJldA== Content-length: nnn Content-MD5: md5-digest Content-Disposition: filename=mydeposit.zip X-On-Behalf-Of: lcarr X-Format-Namespace: METS
The Technical implementing the profile
Implementation Repository implementations DSpace EPrints IntraLibrary Fedora Client implementations Java client library command-line, desktop and web clients
 
User testing Four case studies, implementations in: SPECTRa tool arXiv White Rose Research Online SOURCE project
The future … where seamless deposit actually happens?
Is anybody using SWORD? In addition to the case study implementations: Feedforward has already implemented ICE project is looking at SWORD DSpace and EPrints installations already exist Microsoft eChemistry work OAI-ORE interest more are planned NISO activity around deposit - hopefully this will recognise SWORD
SWORD II and beyond Small amount of continuation funding What for? up for discussion/scoping additional APP support (update/delete)‏ more clients (.net / php etc)‏ more tools (for desktop and web-based deposit)‏ ORE testing (deposit of Resource Map as ATOM document, deposit of Resource Map as XML file)‏ ongoing support for code and test installations
Questions? Julie Allinson < [email_address] > www.ukoln.ac.uk/repositories/digirep/index/SWORD

More Related Content

Sword Or2008 Julieallinson

  • 1. Julie Allinson Open Repositories 2008 Southampton 1st April 2008 Simple Web-service Offering Repository Deposit SWORD
  • 3. SWORD Simple Web service Offering Repository Deposit JISC funded project 2007 To provide a standard mechanism for ‘doing deposit’ into repositories Small amount of continuation funding for SWORD II (pending)‏
  • 4. SWORD : what it is A lightweight protocol for deposit A profile of the Atom Publishing Protocol Implementations of the SWORD deposit interface in IntraLibrary, Fedora, DSpace and EPrints Three java deposit clients – web-based, command-line and desktop NOT a solution to metadata/packaging decisions
  • 5. Background Before SWORD there was deposit API
  • 6. Deposit API Discussions at the JISC-CETIS Conference 2005 focussed on the lack of a deposit ‘standard’ Rachel Heery and Repositories Research Team at UKOLN facilitated a working group of repository developers to address this requirement for a standard interface for deposit
  • 7. Motivations no standard interface for tagging, packaging or authoring tools to upload objects into a repository no standard interface for transferring digital objects between repositories no way to deposit into more than one repository with one ‘click’ no way of initiating a deposit workflow from outside a repository system no way of including deposit into a repository a part of service orientated architecture
  • 8. Deposit API - achievements Common agreement Scope and definitions Requirements and parameters Scenarios Outline approach Draft XML serialisations
  • 9. But Progress ground to a halt after July 2006 meeting Difficult to keep momentum without a formal project and without money! November 2006, JISC funding call explicitly mentioned ‘deposit’ as an area for funding proposals ...
  • 10. JISC to the rescue Repositories and Preservation Programme, Tools and Innovations strand
  • 11. The project, the funding Six months (plus slight extension) funded under the tools and innovations strand of the JISC Repositories and Preservation Programme, in March 2007 SWORD partners: UKOLN, University of Bath (Project management and dissemination) – Julie Allinson University of Southampton (EPrints) – Les Carr, Seb Francois University of Aberystwyth (DSpace, Fedora, reference client) – Stuart Lewis, Neil Taylor, Glen Robson, Richard Jones Intrallect (IntraLibrary) – Martin Morrey, Sarah Currier Plus some friendly advisors – Jim Downing, Richard Green
  • 12. SWORD – the acronym Simple – lightweight, agile and fit-for-purpose Web service – independent of proprietary software, supports standard interfaces Offering – repository services Repository – or any system which wants to put or receive content Deposit – or put, or post, or register, or add – a little step in the ingest workflow
  • 13. But why … ? slicing up the scenarios
  • 14. Use cases Deposit from a Desktop/Online tool - more on next slide Multiple deposit - e.g. deposit to institutional and (mandated) funders’ repository with one action Machine deposit - e.g. automated deposit from a laboratory machine Migration/transfer - e.g. to a preservation service Mediated deposit - e.g. deposit by a nominated representative, to additional repositories
  • 15. Desktop tools Desktop ‘smart’ deposit client reference client deposit through SWORD interface Feedforward personal information organiser http://legolas.cetis.ac.uk potential for a Flickr-style batch uploder Facebook plug-in? Deposit as ‘save as’ e.g. from within word processing software
  • 17. Parameters - mandatory Mandatory (level 0)‏ deposit any type of content repository or collection id identifier deposit status (accepted, rejected, error), error codes, error description treatment description
  • 18. Parameters - optional Optional (level 1 mandatory)‏ mediated deposit repository / collection name collection policy, description accepted formats format namespace source repository checksum compliance level additional identifiers
  • 19. Future proofing with layers layered approach two levels of compliance Level 0 compliance requires a set of mandatory elements and a set of optional elements Level 1 offers a set of additional elements for richer functionality mandatory at level 1
  • 20. Offering Services Explain/Discover service can I deposit? to which collections? what can I deposit? what are the policies? Deposit service deposit accepted receipt returned to depositor
  • 21. Existing standards WebDAV ( http://www.webdav.org /) JSR 170 ( http://www.jcp.org/en/jsr/detail?id=170 ) JSR 283 ( http://www.jcp.org/en/jsr/detail?id=283 ) SRW Update ( http://www.loc.gov/standards/sru/ ) Flickr Deposit API ( http://www.flickr.com/services/api/ ) Fedora Deposit API ( http://www.fedora.info/definitions/1/0/api/ ) OKI OSID ( http://www.okiproject.org /) ECL ( http://ecl.iat.sfu.ca /)‏ ATOM Publishing Protocol (http://www.ietf.org/html-charters/atompub-charter.html)‏
  • 22. “ the Atom Publishing Protocol is an application-level protocol for publishing and editing Web resources” benefits supports many of our parameters and requirements, in particular file deposit it already exists and has growing support it is well-used in popular applications it has an extension mechanism Google have created their own profile (gdata)‏ good fit with the Web architecture drawbacks / risks too much of a retrofit? it is designed for a single package/file OR an atom document – this means that we need to package up metadata and files
  • 23. SWORD profile of APP ‘ POST’ only - SWORD does not deal in update/delete ‘ POST’ binary files only - SWORD does not (currently) specify how to post ATOM documents Categories not used SWORD extensions HTTP Header extensions APP / ATOM extensions Recommendations for discovery accessed from /sword-app/ service document at /sword-app/servicedocument use of <link> header to point to sword implementation
  • 24. How it works ... APP works by issuing HTTP requests (GET, POST)‏ GET Service Document (explain/discover)‏ POST ATOM document or file to collection URI HTTP response and ATOM document is returned HTTP basic authentication is required
  • 25. Parameters - mandatory Mandatory (level 0)‏ deposit any type of content - APP yes repository or collection id - APP yes identifier - APP yes deposit status (accepted, rejected, error), error codes, error description - APP yes (and extension)‏ compliance level - extension treatment description
  • 26. Parameters - optional Optional (level 1 mandatory)‏ mediated deposit - extension repository / collection name - APP yes collection policy, description - extension accepted formats - APP yes format namespace - extension source repository - APP yes checksum - extension compliance level - extension additional identifiers - APP yes
  • 27. Examples - GET (explain)‏ GET /sword-app/servicedocument HTTP/1.1 Host: www.myrepository.ac.uk X-On-Behalf-Of: lcarr
  • 28. Examples - POST (deposit)‏ POST /burning-collection HTTP/1.1 Host: www.myrepository.ac.uk/sword-app Content-Type: application/zip Authorization: Basic ZGFmZnk6c2VjZJldA== Content-length: nnn Content-MD5: md5-digest Content-Disposition: filename=mydeposit.zip X-On-Behalf-Of: lcarr X-Format-Namespace: METS
  • 30. Implementation Repository implementations DSpace EPrints IntraLibrary Fedora Client implementations Java client library command-line, desktop and web clients
  • 31.  
  • 32. User testing Four case studies, implementations in: SPECTRa tool arXiv White Rose Research Online SOURCE project
  • 33. The future … where seamless deposit actually happens?
  • 34. Is anybody using SWORD? In addition to the case study implementations: Feedforward has already implemented ICE project is looking at SWORD DSpace and EPrints installations already exist Microsoft eChemistry work OAI-ORE interest more are planned NISO activity around deposit - hopefully this will recognise SWORD
  • 35. SWORD II and beyond Small amount of continuation funding What for? up for discussion/scoping additional APP support (update/delete)‏ more clients (.net / php etc)‏ more tools (for desktop and web-based deposit)‏ ORE testing (deposit of Resource Map as ATOM document, deposit of Resource Map as XML file)‏ ongoing support for code and test installations
  • 36. Questions? Julie Allinson < [email_address] > www.ukoln.ac.uk/repositories/digirep/index/SWORD