-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSWORD003.html
More file actions
506 lines (392 loc) · 16 KB
/
Copy pathSWORD003.html
File metadata and controls
506 lines (392 loc) · 16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
<html>
<head>
<title>SWORD 003: AtomPub Extensions for Scholarly Systems</title>
<style type="text/css">
body {
font-family: sans-serif;
font-size: 12pt;
}
.toc {
font-size: 10pt;
}
.code {
font-family: monospace;
background: #ffffaa;
padding-left: 15px;
padding-right: 15px;
padding-top: 5px;
padding-bottom: 5px;
margin-top: 5px;
margin-bottom: 5px;
font-size: 10pt;
}
.code_inline {
font-family: monospace;
background: #ffffaa;
padding-right: 5px;
padding-left: 5px;
padding-top: 3px;
padding-bottom: 3px;
font-size: 10pt;
}
</style>
</head>
<body>
<h1>AtomPub Extensions for Scholarly Systems</h1>
<h2>Credits</h2>
<p>
<strong>SWORD 2.0 Technical Lead</strong>: Richard Jones, Cottage Labs
</p>
<p>
<strong>SWORD 2.0 Community Manager</strong>: Stuart Lewis, University of Auckland
</p>
<p>
<strong>SWORD 2.0 Technical Advisory Group</strong><br/>
Julie Allinson, University of York<br/>
Tim Brody, University of Southampton<br/>
David Flanders, JISC<br/>
Graham Klyne, University of Oxford<br/>
Alister Miles, University of Oxford<br/>
Ben O'Steen, Cottage Labs<br/>
Mark MacGillivray, Cottage Labs<br/>
Rob Sanderson, LANL<br/>
Nick Sheppard, Leeds Metropolitan University<br/>
Eddie Shin, MediaShelf<br/>
Ian Stuart, University of Edinburgh<br/>
Ed Summers, Library of Congress<br/>
David Tarrant, University of Southampton<br/>
Graham Triggs, BioMed Central<br/>
Scott Wilson, University of Bolton<br/>
</p>
<p>
<strong>Further acknowledgements of input</strong><br/>
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)
</p>
<h2>Introduction</h2>
<p>
The Atom Publishing Protocol [<a href="#rfc5023">RFC5023</a>] defines how to create a Media
Resource by POSTing the media to a server. It deals exclusively with
the upload of a single file to the Media Entry, and does not make
explicit allowances for the possibility that the end point may be a
more complex publishing system.
</p>
<p>
This specification defines a set of extensions to the Atom Publishing
Protocol [<a href="#rfc5023">RFC5023</a>] 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.
</p>
<h3>1.1 Terminology</h3>
<p>
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 [<a href="#rfc2119">RFC2119</a>].
</p>
<h3>1.2 Namespaces</h3>
<p>All extensions are defined within the namespace:</p>
<div class="code">
http://purl.org/net/sword/
</div>
<p>This document uses the prefix <span class="code_inline">sword</span> for the namespace name.</p>
<p>The AtomPub namespace is:</p>
<div class="code">
http://www.w3.org/2007/app
</div>
<p>This document uses the prefix <span class="code_inline">app</span> for the namespace name.</p>
<p>The Atom Syndication Format namespace is:</p>
<div class="code">
http://www.w3.org/2005/Atom
</div>
<p>This document uses the prefix <span class="code_inline">atom</span> for the namespace name.</p>
<h2>2 Service Document Extensions</h2>
<p>
This section documents extensions to the Atom Service Document.
</p>
<h3>2.1 sword:version</h3>
<p>
The <span class="code_inline">sword:version</span> element MUST be used to specify the version number
of the SWORD server. This is to avoid confusion with servers which
support older versions of the standard in which it was not compulsory
to supply this information. It is a direct child of the <span class="code_inline">app:service</span>
element.
</p>
<p>
For example:
</p>
<div class="code">
<pre>
<service xmlns="http://www.w3.org/2007/app"
xmlns:sword="http://purl.org/net/sword/terms/"
xmlns:atom="http://www.w3.org/2005/Atom">
<sword:version>2.0</sword:version>
<workspace>
<atom:title>Main Site</atom:title>
<collection href="http://www.appserver.org/col1">
<atom:title>Collection 1</atom:title>
<accept>*/*</accept>
</collection>
</workspace>
</service>
</pre>
</div>
<h3>2.2 sword:maxUploadSize</h3>
<p>
The <span class="code_inline">sword:maxUploadSize</span> element MAY be used to indicate to the user
agent what the maximum content size deliverable in one request is,
and MUST contain an integer if it is used. It is a direct child of
the <span class="code_inline">app:service</span> element. If the server does not supply an element,
the client MUST assume that the server will support arbitrarily large
files, although due consideration should be taken of limitations in
other supporting technology.
</p>
<p>
For example:
</p>
<div class="code">
<pre>
<service xmlns="http://www.w3.org/2007/app"
xmlns:sword="http://purl.org/net/sword/terms/"
xmlns:atom="http://www.w3.org/2005/Atom">
<sword:version>2.0</sword:version>
<sword:maxUploadSize>1024</sword:maxUploadSize>
<workspace>
<atom:title>Main Site</atom:title>
<collection href="http://www.appserver.org/col1">
<atom:title>Collection 1</atom:title>
<accept>*/*</accept>
</collection>
</workspace>
</service>
</pre>
</div>
<h3>2.3 sword:collectionPolicy</h3>
<p>
The <span class="code_inline">sword:collectionPolicyM</span> MAY be included, as a child of the
<span class="code_inline">app:collection</span> element. It is to be used for a human-readable
description of collection policy. Include either a text description
or a URI.
</p>
<p>
For example:
</p>
<div class="code">
<pre>
<service xmlns="http://www.w3.org/2007/app"
xmlns:sword="http://purl.org/net/sword/terms/"
xmlns:atom="http://www.w3.org/2005/Atom">
<sword:version>2.0</sword:version>
<sword:maxUploadSize>1024</sword:maxUploadSize>
<workspace>
<atom:title>Main Site</atom:title>
<collection href="http://www.appserver.org/col1">
<atom:title>Collection 1</atom:title>
<accept>*/*</accept>
<sword:collectionPolicy>http://www.swordserver.ac.uk/policy</sword:collectionPolicy>
</collection>
</workspace>
</service>
</pre>
</div>
<h3>2.4 sword:treatment</h3>
<p>
The <span class="code_inline">sword:treatment</span> element MAY be included, as a child of the
<span class="code_inline">app:collection</span> element. Used for a human-readable statement about
what treatment the deposited resource will receive.
</p>
<p>
For example:
</p>
<div class="code">
<pre>
<service xmlns="http://www.w3.org/2007/app"
xmlns:sword="http://purl.org/net/sword/terms/"
xmlns:atom="http://www.w3.org/2005/Atom">
<sword:version>2.0</sword:version>
<sword:maxUploadSize>1024</sword:maxUploadSize>
<workspace>
<atom:title>Main Site</atom:title>
<collection href="http://www.appserver.org/col1">
<atom:title>Collection 1</atom:title>
<accept>*/*</accept>
<sword:collectionPolicy>http://www.swordserver.ac.uk/policy</sword:collectionPolicy>
<sword:treatment>treatment description</sword:treatment>
</collection>
</workspace>
</service>
</pre>
</div>
<h3>2.5 sword:service</h3>
<p>
Zero or more <span class="code_inline">sword:service</span> elements MAY be included, as children of
<span class="code_inline">app:collection</span>, to direct clients to nested service definitions. If
present, the value MUST be a URI that dereferences to another Service
Document.
</p>
<p>
For example:
</p>
<div class="code">
<pre>
<service xmlns="http://www.w3.org/2007/app"
xmlns:sword="http://purl.org/net/sword/terms/"
xmlns:atom="http://www.w3.org/2005/Atom">
<sword:version>2.0</sword:version>
<sword:maxUploadSize>1024</sword:maxUploadSize>
<workspace>
<atom:title>Main Site</atom:title>
<collection href="http://www.appserver.org/col1">
<atom:title>Collection 1</atom:title>
<accept>*/*</accept>
<sword:collectionPolicy>http://www.swordserver.ac.uk/policy</sword:collectionPolicy>
<sword:treatment>treatment description</sword:treatment>
<sword:service>http://www.swordserver.ac.uk/service/subservice</sword:service>
</collection>
</workspace>
</service>
</pre>
</div>
<h2>3 Media Entry Extensions</h2>
<p>
This section documents extensions to the Media Entry document which
can be retrieved from the server from the Media Entry URI.
</p>
<h3>3.1 sword:treatment</h3>
<p>
The <span class="code_inline">sword:treatment</span> element SHOULD be included, as a child of the
<span class="code_inline">atom:entry</span> element. Used for a human-readable statement about what
treatment the deposited resource received.
</p>
<p>
For example:
</p>
<div class="code">
<pre>
<entry xmlns="http://www.w3.org/2005/Atom"
xmlns:sword="http://purl.org/net/sword/">
<title>My Deposit</title>
<id>info:something:1</id>
<updated>2008-08-18T14:27:08Z</updated>
<summary type="text">A summary</summary>
<generator uri="http://www.swordserver.ac.uk/sword-plugin" version="1.0"/>
<sword:treatment>Unpacked. JPEG contents converted to JPEG2000.</sword:treatment>
<content type="application/zip" src="http://www.swordserver.ac.uk/col1/mydeposit"/>
<link rel="edit-media" href="http://www.swordserver.ac.uk/col1/mydeposit"/>
<link rel="edit" href="http://www.swordserver.ac.uk/col1/mydeposit.atom" />
</entry>
</pre>
</div>
<h3>3.2 sword:verboseDescription</h3>
<p>
The <span class="code_inline">sword:verboseDescription</span> element MAY be included, as a child of
the <span class="code_inline">atom:entry</span> element. Used for a detailed description of the
processes that the service has carried out while processing the
deposit. This differs from the <span class="code_inline">sword:treatment</span> element in that it is
specifically for developers to provide extensive logging and other
feedback to clients and client developers, and SHOULD NOT be used to
enhance the user experience at the client end.
</p>
<p>
For example:
</p>
<div class="code">
<pre>
<entry xmlns="http://www.w3.org/2005/Atom"
xmlns:sword="http://purl.org/net/sword/">
<title>My Deposit</title>
<id>info:something:1</id>
<updated>2008-08-18T14:27:08Z</updated>
<summary type="text">A summary</summary>
<generator uri="http://www.swordserver.ac.uk/sword-plugin" version="1.0"/>
<sword:verboseDescription>
Deposit Received 2011-01-14T04:45:32Z
Authenticated User: jbloggs ... success
Depositing Resource in Collection: col1
Created File: mypicture.jpg
Filtering files ...
JPEG file found: mypicture.jpg
Converting JPEG file mypicture.jpg to mypicture_jpg2000.jpg
Deposit Complete 2011-01-14T04:45:34Z
</sword:verboseDescription>
<sword:treatment>Unpacked. JPEG contents converted to JPEG2000.</sword:treatment>
<content type="application/zip" src="http://www.swordserver.ac.uk/col1/mydeposit"/>
<link rel="edit-media" href="http://www.swordserver.ac.uk/col1/mydeposit"/>
<link rel="edit" href="http://www.swordserver.ac.uk/col1/mydeposit.atom" />
</entry>
</pre>
</div>
<h2>4 Error Documents</h2>
<p>
This extension describes a new class of document in the AtomPub
protocol for error handling. These give service implementations the
ability to describe error conditions more fully than HTTP response
codes allow. If a server is reporting an error condition in response
to a resource POST, PUT or DELETE, it SHOULD also return a document
with a root element of sword:error. The <span class="code_inline">sword:error</span> element SHOULD
have an <span class="code_inline">href</span> attribute containing a URI that identifies the error.
</p>
<p>
The <span class="code_inline">sword:error</span> element MAY contain any of the elements normally used
in Atom Entry Documents, but all fields are OPTIONAL
</p>
<p>
For example:
</p>
<div class="code">
<pre>
HTTP 1.1 400 Bad Request
<?xml version="1.0" encoding="utf-8"?>
<sword:error xmlns="http://www.w3.org/2005/Atom"
xmlns:sword="http://purl.org/net/sword/"
href="http://example.org/errors/BadManifest">
<author>
<name>A.N. Other</name>
</author>
<title>ERROR</title>
<updated>2008-02-19T09:34:27Z</updated>
<generator uri="https://example.org/sword-app/"
version="0.9">sword@example.org</generator>
<summary>
The manifest could be parsed, but was not valid -
no technical metadata was provided.
</summary>
<sword:treatment>processing failed</sword:treatment>
</sword:error>
</pre>
</div>
<h2>5 References </h2>
<h3>5.1 Normative References</h3>
<p>[<a name="rfc2119">RFC2119</a>] <a href="http://www.ietf.org/rfc/rfc2119.txt">S. Bradner, "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.</a></p>
<p>[<a name="rfc5023">RFC5023</a>] Gregorio, J. and B. de hOra, "The Atom Publishing
Protocol", RFC 5023, October 2007.</p>
<h2>Copyright and License Notice</h2>
<p>
Copyright (C) SWORD (2011). All Rights Reserved.
</p>
<p>
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.
</p>
<p>
The limited permissions granted above are perpetual and will not be
revoked by SWORD or its successors or assigns.
</p>
This document and the information contained herein is provided on an
"AS IS" basis and SWORD DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
</p>
</body>
</html>