SWORD 004: Atom Multipart Extensions for Packaged Content

Credits

SWORD 2.0 Technical Lead: Richard Jones, Cottage Labs

SWORD 2.0 Community Manager: Stuart Lewis, University of Auckland

SWORD 2.0 Technical Advisory Group
Julie Allinson, University of York
Tim Brody, University of Southampton
David Flanders, JISC
Graham Klyne, University of Oxford
Alister Miles, University of Oxford
Ben O'Steen, Cottage Labs
Mark MacGillivray, Cottage Labs
Rob Sanderson, LANL
Nick Sheppard, Leeds Metropolitan University
Eddie Shin, MediaShelf
Ian Stuart, University of Edinburgh
Ed Summers, Library of Congress
David Tarrant, University of Southampton
Graham Triggs, BioMed Central
Scott Wilson, University of Bolton

Further acknowledgements of input
Aaron Birkland (Cornell University), Tim Donohue (DuraSpace), Jim Downing (University of Cambridge), Ross Gardler (OSS Watch), Steve Midgley (US Department of Education), Glen Robson (National Library of Wales), Peter Sefton (University Of Southern Queensland), Adrian Stevenson (UKOLN), Paul Walk (UKOLN), Nigel Ward (University of Queensland)

Introduction

The AtomPub Multipart Media Resource Creation Internet Draft [AtomMultipart] defines how an Atom Publishing Protocol collection may process multipart/related requests and how a service announces that it accepts multipart/relatedentities. This document adds a short additional extension to that draft for supporting the delivery of packaged content in the same way.

This specification defines a set of extensions to the Atom Publishing Protocol [RFC5023] to support the transfer and recovery of content in scholarly systems. We will refer to a service which complies to this extension to AtomPub as a SWORD "server" throughout the course of this document.

1.1 Terminology

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119].

1.2 Namespaces

All extensions are defined within the namespace:

This document uses the prefix sword for the namespace name.

The AtomPub namespace is:

This document uses the prefix app for the namespace name.

The Atom Syndication Format namespace is:

This document uses the prefix atom for the namespace name.

2 Multipart Representations Extensions

This section documents extensions to the Multipart Representations of the deposit.

Further to the requirements laid out in [AtomMultipart] the Entry Part MUST include a Content-Disposition header of type attachment and name parameter of atom:

   	Content-Disposition: attachment; name=atom

The Media Part MUST include a Content-Disposition header of type attachment and name parameter of payload. It MAY also include a filename parameter:

   	Content-Disposition: attachment; name=payload; filename=example.zip

The Media Part MAY supply a Packaging header [SWORD001] providing the URI of the packaging format used in the payload.

For example:

POST /collection HTTP/1.1
Host: example.org
Content-Length: nnnn
Content-Type: multipart/related;
      boundary="===============1605871705==";
      type="application/atom+xml"
MIME-Version: 1.0

Media Post
--===============1605871705==
Content-Type: application/atom+xml; charset="utf-8"
Content-Disposition: attachment; type=atom
MIME-Version: 1.0

<?xml version="1.0"?>
<entry xmlns="http://www.w3.org/2005/Atom">
    ...
</entry>
--===============1605871705==
Content-Type: application/zip
Content-Disposition: attachment; name=payload; filename=example.zip
Packaging: http://purl.org/net/terms/package/default
MIME-Version: 1.0
Content-ID: <99334422@example.com>

...binary package data...
--===============1605871705==--

3 References

3.1 Normative References

[RFC2119] S. Bradner, "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.

[AtomMultipart] Gregorio, J. "AtomPub Multipart Media Resource Creation", September 2008

[RFC5023] Gregorio, J. and B. de hOra, "The Atom Publishing Protocol", RFC 5023, October 2007.

[SWORD001] Jones, R. "Packaged Content Delivery over HTTP", January 2011

Copyright and License Notice

Copyright (C) SWORD (2011). All Rights Reserved.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to SWORD, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English.

The limited permissions granted above are perpetual and will not be revoked by SWORD or its successors or assigns.