Interoperability Fundamentals: SWORD 2

1
Interoperability Fundamentals SWORD 2 8th
December 2008SUETr Interoperability Workshop,
London School of Economics Adrian
Stevenson SWORD 2 Project Manager
UKOLN is supported by
2
SWORD Quick Introduction

• Simple Web service Offering Repository Deposit
• JISC funded project 2007
• To provide a standard mechanism for doing
  deposit into repositories
• Continuation funding for SWORD 2 from June 2008

3
What is it?

• A lightweight protocol for deposit
• A pro?le of the Atom Publishing Protocol
• Implementations of the SWORD deposit interface in
  IntraLibrary, Fedora, DSpace and Eprints
• A number of deposit clients web-based,
  command-line, desktop, Facebook

4
Background

• Before SWORD there was 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

5
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

6
The Project Partners

• SWORD partners
• UKOLN, University of Bath and University of York
  (Project Management) Adrian Stevenson Julie
  Allinson
• University of Aberystwyth (DSpace, Fedora,
  clients)
• Stuart Lewis, Neil Taylor, Glen Robson, Richard
  Jones
• University of Southampton (EPrints) Les Carr
• Intrallect (IntraLibrary) Sarah Currier
• Plus some friendly advisors
• Jim Downing, Richard Green

7
The Acronym

• Simple lightweight, agile and fit-for-purpose
• Web service independent of proprietary
  software, supports standard interfaces
• Offering
• 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

8
Use Cases

• Deposit from a Desktop/Online tool
• 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

9
Scenario 1 Author deposits using a desktop
authoring system to a mediated multiple deposit
service
A lightweight deposit web service can facilitate
this transfer of object(s)
10
Scenario 3 Deposit in multiple repositories
A lightweight deposit web service can facilitate
this transfer of object(s)
11
SWORD AtomPub Profile
12
Standards

• WebDAV (http//www.webdav.org/)
• JSR 170 (http//www.jcp.org/en/jsr/detail?id170)
  
• JSR 283 (http//www.jcp.org/en/jsr/detail?id283)
  
• SRW Update (http//www.loc.gov/standards/sru/)
• Flickr Deposit API (http//www.flickr.com/services
  /api/)
• Fedora Deposit API (http//www.fedora.info/definit
  ions/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)

13
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
• 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

14
SWORD AtomPub Profile

• SWORD profile builds on AtomPub
• Provides set of extensions, constraint
  relaxations and enforcements when
• Clients post compound resources (zip,tar)
• Mediated deposit required
• Workflows involved
• SWORD compliance does not preclude AtomPub
  compliance

15
SWORD APP Package Support

• AtomPub uses MIME to describe resources
• Inadequate for compound types e.g.
• Zip, tar
• METS, SCORM, MPEG21, DIDL packages
• SWORD extends AtomPub
• swordacceptPackaging element
• Value taken from SWORD package types

16
SWORD APP Mediated Deposit

• SWORD deposit client user may not be owner of
  resource
• SWORD allows clients to set a HTTP header
• X-On-Behalf-Of
• Assumes trust between owner and mediating user

17
SWORD APP Developer Features

• No-Op (Dry Run)
• Verbose Output
• Client and Server Identity
• Auto-Discovery
• Error Documents
• Nested Service Desription

18
SWORD APP Error Documents

• SWORD adds new class of doc to AtomPub to allow
  better error description
• ErrorContent
• ErrorChecksumMismatch
• ErrorBadRequest
• TargetOwnerUnknown
• MediationNotAllowed

19
SWORD Profile of AtomPub

• Part B follows AtomPub specification highlighting
  where SWORD profile diverges
• Part B covers
• Protocol Operations
• Retrieving Service Document
• Listing Collections
• Creating a Resource
• Editing a Resource - Not currently implemented
• Category Documents MUST NOT be required
• Service Documents
• new elements version, verbose, noOp,
  maxUploadSize

20
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

21
Examples Get (explain)
GET /sword-app/servicedocument HTTP/1.1 Host
www.myrepository.ac.uk X-On-Behalf-Of lcarr
22
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
filenamemydeposit.zip X-On-Behalf-Of
lcarr X-Format-Namespace METS
23
SWORD 2 Profile Updates

• SWORD Profile Version 1.3 includes
• Revised deviations from AtomPub and Atom
• increasing requirement for persistent Atom Entry
  Documents
• Includes description of SWORD specific extensions
• Removed notion of levels of compliance
• Added sworduserAgent, sworderror,
  swordservice, swordversion and
  swordmaxUploadSize elements

24
SWORD In Use
25
Implementations

• Repository implementations
• DSpace
• EPrints
• IntraLibrary
• Fedora
• Client implementations
• Java PHP libraries
• command-line, desktop and web clients
• Facebook Client
• Deposit from within MS Word Powerpoint
• Feedforward / FOREsite and others at
  http//www.swordapp.org/sword/implementations

26
(No Transcript)
27
(No Transcript)
28
Facebook Client
29
OfficeSWORD Add-on

• http//www.codeplex.com/OfficeSWORD

30
SWORD in use

• 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 - FOREsite work
• more are planned
• NISO activity around deposit - hopefully this
  will recognise
• Collaberation with Nature Publishing Group

31
More Info and Contact

• SWORD Website
• http//www.swordapp.org
• General queries
• Adrian Stevensona.stevenson_at_ukoln.ac.uk
• Technical queries
• Sword sourceforge listsword-app-tech_at_lists.source
  forge.net

32
Questions

• SWORD Website
• http//www.swordapp.org
• Adrian Stevenson, UKOLN
• a.stevenson_at_ukoln.ac.uk