Debian Codegraph @

rfc2639.html

raw
1 <pre>Network Working Group T. Hastings
2 Request for Comments: 2639 C. Manros
3 Category: Informational Xerox Corporation
4 July 1999
5
6
7 <span class="h1">Internet Printing Protocol/1.0: Implementer's Guide</span>
8
9 Status of this Memo
10
11 This memo provides information for the Internet community. It does
12 not specify an Internet standard of any kind. Distribution of this
13 memo is unlimited.
14
15 Copyright Notice
16
17 Copyright (C) The Internet Society (1999). All Rights Reserved.
18
19 Abstract
20
21 This document is one of a set of documents, which together describe
22 all aspects of a new Internet Printing Protocol (IPP). IPP is an
23 application level protocol that can be used for distributed printing
24 using Internet tools and technologies. This document contains
25 information that supplements the IPP Model and Semantics [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>]
26 and the IPP Transport and Encoding [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] documents. It is
27 intended to help implementers understand IPP/1.0 and some of the
28 considerations that may assist them in the design of their client
29 and/or IPP object implementations. For example, a typical order of
30 processing requests is given, including error checking. Motivation
31 for some of the specification decisions is also included.
32
33 The full set of IPP documents includes:
34
35 Design Goals for an Internet Printing Protocol [<a href="./rfc2567" title="&quot;Design Goals for an Internet Printing Protocol&quot;">RFC2567</a>]
36 Rationale for the Structure and Model and Protocol for the Internet
37 Printing Protocol [<a href="./rfc2568" title="&quot;Rationale for the Structure and Model and Protocol for the Internet Printing Protocol&quot;">RFC2568</a>]
38 Internet Printing Protocol/1.0: Model and Semantics [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>]
39 Internet Printing Protocol/1.0: Encoding and Transport [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]
40 Mapping between LPD and IPP Protocols [<a href="./rfc2569" title="&quot;Mapping between LPD and IPP Protocols&quot;">RFC2569</a>]
41
42 The document, "Design Goals for an Internet Printing Protocol", takes
43 a broad look at distributed printing functionality, and it enumerates
44 real-life scenarios that help to clarify the features that need to be
45 included in a printing protocol for the Internet. It identifies
46 requirements for three types of users: end users, operators, and
47
48
49
50
51
52 <span class="grey">Hastings &amp; Manros Informational [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
55
56
57 administrators. The design goals document calls out a subset of end
58 user requirements that are satisfied in IPP/1.0. Operator and
59 administrator requirements are out of scope for version 1.0.
60
61 The document, "Rationale for the Structure and Model and Protocol for
62 the Internet Printing Protocol", describes IPP from a high level
63 view, defines a roadmap for the various documents that form the suite
64 of IPP specifications, and gives background and rationale for the
65 IETF working group's major decisions.
66
67 The document, "Internet Printing Protocol/1.0: Model and Semantics",
68 describes a simplified model with abstract objects, their attributes,
69 and their operations. The model introduces a Printer and a Job. The
70 Job supports multiple documents per Job. The model document also
71 addresses how security, internationalization, and directory issues
72 are addressed.
73
74 The document, "Internet Printing Protocol/1.0: Encoding and
75 Transport", is a formal mapping of the abstract operations and
76 attributes defined in the model document onto HTTP/1.1. It also
77 defines the encoding rules for a new Internet media type called
78 "application/ipp".
79
80 The document, "Mapping between LPD and IPP Protocols", gives some
81 advice to implementers of gateways between IPP and LPD (Line Printer
82 Daemon) implementations.
83
84 Table of Contents
85
86 <a href="#section-1">1</a> Introduction......................................................<a href="#page-4">4</a>
87 <a href="#section-1.1">1.1</a> Conformance language............................................<a href="#page-4">4</a>
88 <a href="#section-1.2">1.2</a> Other terminology...............................................<a href="#page-5">5</a>
89 <a href="#section-2">2</a> Model and Semantics...............................................<a href="#page-5">5</a>
90 <a href="#section-2.1">2.1</a> Summary of Operation Attributes.................................<a href="#page-5">5</a>
91 <a href="#section-2.2">2.2</a> Suggested Operation Processing Steps for IPP Objects ..........<a href="#page-10">10</a>
92 <a href="#section-2.2.1">2.2.1</a> Suggested Operation Processing Steps for all Operations..11
93 <a href="#section-2.2.1.1">2.2.1.1</a> Validate version number...............................<a href="#page-11">11</a>
94 <a href="#section-2.2.1.2">2.2.1.2</a> Validate operation identifier.........................<a href="#page-11">11</a>
95 <a href="#section-2.2.1.3">2.2.1.3</a> Validate the request identifier.......................<a href="#page-11">11</a>
96 2.2.1.4 Validate attribute group and attribute presence and
97 order.................................................<a href="#page-12">12</a>
98 2.2.1.5 Validate the values of the REQUIRED Operation
99 attributes............................................<a href="#page-19">19</a>
100 2.2.1.6 Validate the values of the OPTIONAL Operation
101 attributes............................................<a href="#page-23">23</a>
102 2.2.2 Suggested Additional Processing Steps for Operations that
103 Create/Validate Jobs and Add Documents.....................<a href="#page-26">26</a>
104 <a href="#section-2.2.2.1">2.2.2.1</a> Default "ipp-attribute-fidelity" if not supplied......<a href="#page-26">26</a>
105
106
107
108 <span class="grey">Hastings &amp; Manros Informational [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
111
112
113 <a href="#section-2.2.2.2">2.2.2.2</a> Check that the Printer object is accepting jobs.......<a href="#page-26">26</a>
114 <a href="#section-2.2.2.3">2.2.2.3</a> Validate the values of the Job Template attributes....<a href="#page-26">26</a>
115 <a href="#section-2.2.3">2.2.3</a> Algorithm for job validation...............................<a href="#page-27">27</a>
116 <a href="#section-2.2.3.1">2.2.3.1</a> Check for conflicting Job Template attributes values..33
117 <a href="#section-2.2.3.2">2.2.3.2</a> Decide whether to REJECT the request..................<a href="#page-33">33</a>
118 2.2.3.3 For the Validate-Job operation, RETURN one of the
119 success status codes..................................<a href="#page-34">34</a>
120 <a href="#section-2.2.3.4">2.2.3.4</a> Create the Job object with attributes to support......<a href="#page-34">34</a>
121 <a href="#section-2.2.3.5">2.2.3.5</a> Return one of the success status codes................<a href="#page-36">36</a>
122 <a href="#section-2.2.3.6">2.2.3.6</a> Accept appended Document Content......................<a href="#page-36">36</a>
123 <a href="#section-2.2.3.7">2.2.3.7</a> Scheduling and Starting to Process the Job............<a href="#page-36">36</a>
124 <a href="#section-2.2.3.8">2.2.3.8</a> Completing the Job....................................<a href="#page-37">37</a>
125 <a href="#section-2.2.3.9">2.2.3.9</a> Destroying the Job after completion...................<a href="#page-37">37</a>
126 <a href="#section-2.2.3.10">2.2.3.10</a> Interaction with "ipp-attribute-fidelity".............<a href="#page-37">37</a>
127 <a href="#section-2.3">2.3</a> Status codes returned by operation ............................<a href="#page-37">37</a>
128 <a href="#section-2.3.1">2.3.1</a> Printer Operations.........................................<a href="#page-38">38</a>
129 <a href="#section-2.3.1.1">2.3.1.1</a> Print-Job.............................................<a href="#page-38">38</a>
130 <a href="#section-2.3.1.2">2.3.1.2</a> Print-URI.............................................<a href="#page-40">40</a>
131 <a href="#section-2.3.1.3">2.3.1.3</a> Validate-Job..........................................<a href="#page-40">40</a>
132 <a href="#section-2.3.1.4">2.3.1.4</a> Create-Job............................................<a href="#page-41">41</a>
133 <a href="#section-2.3.1.5">2.3.1.5</a> Get-Printer-Attributes................................<a href="#page-41">41</a>
134 <a href="#section-2.3.1.6">2.3.1.6</a> Get-Jobs..............................................<a href="#page-42">42</a>
135 <a href="#section-2.3.2">2.3.2</a> Job Operations.............................................<a href="#page-43">43</a>
136 <a href="#section-2.3.2.1">2.3.2.1</a> Send-Document.........................................<a href="#page-43">43</a>
137 <a href="#section-2.3.2.2">2.3.2.2</a> Send-URI..............................................<a href="#page-44">44</a>
138 <a href="#section-2.3.2.3">2.3.2.3</a> Cancel-Job............................................<a href="#page-44">44</a>
139 <a href="#section-2.3.2.4">2.3.2.4</a> Get-Job-Attributes....................................<a href="#page-45">45</a>
140 <a href="#section-2.4">2.4</a> Validate-Job...................................................<a href="#page-46">46</a>
141 <a href="#section-2.5">2.5</a> Case Sensitivity in URIs ......................................<a href="#page-46">46</a>
142 <a href="#section-2.6">2.6</a> Character Sets, natural languages, and internationalization....<a href="#page-46">46</a>
143 <a href="#section-2.6.1">2.6.1</a> Character set code conversion support .....................<a href="#page-46">46</a>
144 2.6.2 What charset to return when an unsupported charset is
145 requested?.................................................<a href="#page-48">48</a>
146 <a href="#section-2.6.3">2.6.3</a> Natural Language Override (NLO) ...........................<a href="#page-48">48</a>
147 <a href="#section-2.7">2.7</a> The "queued-job-count" Printer Description attribute...........<a href="#page-50">50</a>
148 <a href="#section-2.7.1">2.7.1</a> Why is "queued-job-count" RECOMMENDED?.....................<a href="#page-50">50</a>
149 2.7.2 Is "queued-job-count" a good measure of how busy a printer
150 is?........................................................<a href="#page-50">50</a>
151 <a href="#section-2.8">2.8</a> Sending empty attribute groups ................................<a href="#page-50">50</a>
152 <a href="#section-2.9">2.9</a> Returning unsupported attributes in Get-Xxxx responses ........<a href="#page-51">51</a>
153 <a href="#section-2.10">2.10</a> Returning job-state in Print-Job response ....................<a href="#page-51">51</a>
154 <a href="#section-2.11">2.11</a> Flow controlling the data portion of a Print-Job request .....<a href="#page-52">52</a>
155 <a href="#section-2.12">2.12</a> Multi-valued attributes ......................................<a href="#page-53">53</a>
156 2.13 Querying jobs with IPP that were submitted using other job
157 submission protocols .........................................<a href="#page-53">53</a>
158 <a href="#section-2.14">2.14</a> The 'none' value for empty sets ..............................<a href="#page-54">54</a>
159 <a href="#section-2.15">2.15</a> Get-Jobs, my-jobs='true', and 'requesting-user-name'?.........<a href="#page-54">54</a>
160
161
162
163
164 <span class="grey">Hastings &amp; Manros Informational [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
167
168
169 2.16 The "multiple-document-handling" Job Template attribute and
170 support of multiple document jobs.............................<a href="#page-54">54</a>
171 <a href="#section-3">3</a> Encoding and Transport...........................................<a href="#page-55">55</a>
172 <a href="#section-3.1">3.1</a> General Headers................................................<a href="#page-56">56</a>
173 <a href="#section-3.2">3.2</a> Request Headers...............................................<a href="#page-57">57</a>
174 <a href="#section-3.3">3.3</a> Response Headers...............................................<a href="#page-58">58</a>
175 <a href="#section-3.4">3.4</a> Entity Headers................................................<a href="#page-59">59</a>
176 <a href="#section-3.5">3.5</a> Optional support for HTTP/1.0..................................<a href="#page-60">60</a>
177 <a href="#section-3.6">3.6</a> HTTP/1.1 Chunking..............................................<a href="#page-60">60</a>
178 <a href="#section-3.6.1">3.6.1</a> Disabling IPP Server Response Chunking.....................<a href="#page-60">60</a>
179 <a href="#section-3.6.2">3.6.2</a> Warning About the Support of Chunked Requests..............<a href="#page-60">60</a>
180 <a href="#section-4">4</a> References.......................................................<a href="#page-61">61</a>
181 <a href="#section-4.1">4.1</a> Authors' Addresses.............................................<a href="#page-62">62</a>
182 <a href="#section-5">5</a> Security Considerations..........................................<a href="#page-62">62</a>
183 <a href="#section-6">6</a> Notices..........................................................<a href="#page-62">62</a>
184 Full Copyright Statement............................................<a href="#page-65">65</a>
185
186 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a> Introduction</span>
187
188 This document contains information that supplements the IPP Model and
189 Semantics [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] and the IPP Transport and Encoding [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]
190 documents. As such this information is not part of the formal
191 specifications. Instead information is presented to help implementers
192 understand the specification, including some of the motivation for
193 decisions taken by the committee in developing the specification.
194 Some of the implementation considerations are intended to help
195 implementers design their client and/or IPP object implementations.
196 If there are any contradictions between this document and [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] or
197 [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>], those documents take precedence over this document.
198
199 <span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a> Conformance language</span>
200
201 Usually, this document does not contain the terminology MUST, MUST
202 NOT, MAY, NEED NOT, SHOULD, SHOULD NOT, REQUIRED, and OPTIONAL.
203 However, when those terms do appear in this document, their intent is
204 to repeat what the [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] and [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] documents require and
205 allow, rather than specifying additional conformance requirements.
206 These terms are defined in <a href="#section-13">section 13</a> on conformance terminology in
207 [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>], most of which is taken from <a href="./rfc2119">RFC 2119</a> [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>].
208
209 Implementers should read <a href="./rfc2566#section-13">section&nbsp;13 in [RFC2566]</a> in order to
210 understand these capitalized words. The words MUST, MUST NOT, and
211 REQUIRED indicate what implementations are required to support in a
212 client or IPP object in order to be conformant to [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] and
213 [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]. MAY, NEED NOT, and OPTIONAL indicate was is merely allowed
214 as an implementer option. The verbs SHOULD and SHOULD NOT indicate
215 suggested behavior, but which is not required or disallowed,
216 respectively, in order to conform to the specification.
217
218
219
220 <span class="grey">Hastings &amp; Manros Informational [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
223
224
225 <span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a> Other terminology</span>
226
227 The term "sender" refers to the client that sends a request or an IPP
228 object that returns a response. The term "receiver" refers to the IPP
229 object that receives a request and to a client that receives a
230 response.
231
232 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a> Model and Semantics</span>
233
234 This section discusses various aspects of IPP/1.0 Model and Semantics
235 [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>].
236
237 <span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a> Summary of Operation Attributes</span>
238
239 Legend for the following table:
240
241 R indicates a REQUIRED operation or attribute for an
242 implementation to support
243
244 O indicates an OPTIONAL operation or attribute for an
245 implementation to support
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 <span class="grey">Hastings &amp; Manros Informational [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
279
280
281 Table 1. Summary of operation attributes for Printer operations
282
283 Printer Operations
284
285 Requests Responses
286
287 Operation Print- Pri Crea Get- Get- All
288 Attributes Job, nt- te- Printer- Jobs Opera-
289 Validate URI Job Attribut tions
290 -Job (O) (O) es
291
292 Operation parameters--REQUIRED to be supplied by the sender
293
294 operation-id R R R R R
295
296 status-code R
297
298 request-id R R R R R R
299
300 version-number R R R R R R
301
302 Operation attributes-REQUIRED to be supplied by the sender
303
304 attributes-charset R R R R R R
305
306 attributes- R R R R R R
307 natural-language
308
309 document-uri R
310
311 job-id*
312
313 job-uri*
314
315 last-document
316
317 printer-uri R R R R R
318
319 Operation attributes-RECOMMENDED to be supplied by the sender
320
321 job-name R R R
322
323 requesting-user- R R R R R
324 name
325
326
327
328
329
330
331
332 <span class="grey">Hastings &amp; Manros Informational [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
335
336
337 Printer Operations
338
339 Requests Responses
340
341 Operation Print- Pri Crea Get- Get- All
342 Attributes Job, nt- te- Printer Jobs Opera-
343 Vali- URI Job Attri- tions
344 date-Job (O) (O) butes
345
346 Operation attributes-OPTIONAL to be supplied by the sender
347
348 status-message O
349
350 compression O O
351
352 document-format R R O
353
354 document-name O O
355
356 document-natural- O O
357 language
358
359 ipp-attribute- R R R
360 fidelity
361
362 job-impressions O O O
363
364 job-k-octets O O O
365
366 job-media-sheets O O O
367
368 limit R
369
370 message
371
372 my-jobs R
373
374 requested- R R
375 attributes
376
377 which-jobs R
378
379 * "job-id" is REQUIRED only if used together with
380 "printer-uri" to identify the target job; otherwise, "job-
381 uri" is REQUIRED.
382
383
384
385
386
387
388 <span class="grey">Hastings &amp; Manros Informational [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
391
392
393 Table 2. Summary of operation attributes for Job operations
394
395
396 Requests Responses
397
398 Operation Send- Send- Cancel Get- All
399 Attributes Document URI -Job Job- Opera-
400 (O) (O) Attri- tions
401 butes
402
403 Operation parameters--REQUIRED to be supplied by the sender
404
405 operation-id R R R R
406
407 status-code R
408
409 request-id R R R R R
410
411 version-number R R R R R
412
413 Operation attributes-REQUIRED to be supplied by the sender
414
415 attributes- R R R R R
416 charset
417
418 attributes- R R R R R
419 natural-language
420
421 document-uri R
422
423 job-id* R R R R
424
425 job-uri* R R R R
426
427 last-document R R
428
429 printer-uri R R R R
430
431 Operation attributes-RECOMMENDED to be supplied by the
432 sender
433
434 job-name
435
436 requesting-user- R R R R
437 name
438
439
440
441
442
443
444 <span class="grey">Hastings &amp; Manros Informational [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
447
448
449 Job Operations
450
451 Requests Responses
452
453 Operation Attributes Send- Send- Cance Get- All
454 Document URI l-Job Job- Opera-
455 (O) (O) Attri- tions
456 butes
457
458 Operation attributes.OPTIONAL to be supplied by the sender
459
460 status-message O
461
462 compression O O
463
464 document-format R R
465
466 document-name O O
467
468 document-natural- O O
469 language
470
471 ipp-attribute-
472 fidelity
473
474 job-impressions
475
476 job-k-octets
477
478 job-media-sheets
479
480 limit
481
482 message O
483
484 my-jobs
485
486 requested-attributes R
487
488 which-jobs
489
490 * "job-id" is REQUIRED only if used together with "printer-
491 uri" to identify the target job; otherwise, "job-uri" is
492 REQUIRED.
493
494
495
496
497
498
499
500 <span class="grey">Hastings &amp; Manros Informational [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
503
504
505 <span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a> Suggested Operation Processing Steps for IPP Objects</span>
506
507 This section suggests the steps and error checks that an IPP object
508 MAY perform when processing requests and returning responses. An IPP
509 object MAY perform some or all of the error checks. However, some
510 implementations MAY choose to be more forgiving than the error checks
511 shown here, in order to be able to accept requests from non-
512 conforming clients. Not performing all of these error checks is a
513 so-called "forgiving" implementation. On the other hand, clients
514 that successfully submit requests to IPP objects that do perform all
515 the error checks will be more likely to be able to interoperate with
516 other IPP object implementations. Thus an implementer of an IPP
517 object needs to decide whether to be a "forgiving" or a "strict"
518 implementation. Therefore, the error status codes returned may
519 differ between implementations. Consequentially, client SHOULD NOT
520 expect exactly the error code processing described in this section.
521
522 When an IPP object receives a request, the IPP object either accepts
523 or rejects the request. In order to determine whether or not to
524 accept or reject the request, the IPP object SHOULD execute the
525 following steps. The order of the steps may be rearranged and/or
526 combined, including making one or multiple passes over the request.
527
528 A client MUST supply requests that would pass all of the error checks
529 indicated here in order to be a conforming client. Therefore, a
530 client SHOULD supply requests that are conforming, in order to avoid
531 being rejected by some IPP object implementations and/or risking
532 different semantics by different implementations of forgiving
533 implementations. For example, a forgiving implementation that
534 accepts multiple occurrences of the same attribute, rather than
535 rejecting the request might use the first occurrences, while another
536 might use the last occurrence. Thus such a non-conforming client
537 would get different results from the two forgiving implementations.
538
539 In the following, processing continues step by step until a "RETURNS
540 the xxx status code ." statement is encountered. Error returns are
541 indicated by the verb: "REJECTS". Since clients have difficulty
542 getting the status code before sending all of the document data in a
543 Print-Job request, clients SHOULD use the Validate-Job operation
544 before sending large documents to be printed, in order to validate
545 whether the IPP Printer will accept the job or not.
546
547 It is assumed that security authentication and authorization has
548 already taken place at a lower layer.
549
550
551
552
553
554
555
556 <span class="grey">Hastings &amp; Manros Informational [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
559
560
561 <span class="h4"><a class="selflink" id="section-2.2.1" href="#section-2.2.1">2.2.1</a> Suggested Operation Processing Steps for all Operations</span>
562
563 This section is intended to apply to all operations. The next
564 section contains the additional steps for the Print-Job, Validate-
565 Job, Print-URI, Create-Job, Send-Document, and Send-URI operations
566 that create jobs, adds documents, and validates jobs.
567
568 <span class="h5"><a class="selflink" id="section-2.2.1.1" href="#section-2.2.1.1">2.2.1.1</a> Validate version number</span>
569
570 Every request and every response contains the "version-number"
571 attribute. The value of this attribute is the major and minor
572 version number of the syntax and semantics that the client and IPP
573 object is using, respectively. The "version-number" attribute
574 remains in a fixed position across all future versions so that all
575 clients and IPP object that support future versions can determine
576 which version is being used. The IPP object checks to see if the
577 major version number supplied in the request is supported. If not,
578 the Printer object REJECTS the request and RETURNS the 'server-
579 error-version-not-supported' status code in the response. The IPP
580 object returns in the "version-number" response attribute the major
581 and minor version for the error response. Thus the client can learn
582 at least one major and minor version that the IPP object supports.
583 The IPP object is encouraged to return the closest version number to
584 the one supplied by the client.
585
586 The checking of the minor version number is implementation dependent,
587 however if the client supplied minor version is explicitly supported,
588 the IPP object MUST respond using that identical minor version
589 number. If the requested minor version is not supported (the
590 requested minor version is either higher or lower) than a supported
591 minor version, the IPP object SHOULD return the closest supported
592 minor version.
593
594 <span class="h5"><a class="selflink" id="section-2.2.1.2" href="#section-2.2.1.2">2.2.1.2</a> Validate operation identifier</span>
595
596 The Printer object checks to see if the "operation-id" attribute
597 supplied by the client is supported as indicated in the Printer
598 object's "operations-supported" attribute. If not, the Printer
599 REJECTS the request and returns the 'server-error-operation-not-
600 supported' status code in the response.
601
602 <span class="h5"><a class="selflink" id="section-2.2.1.3" href="#section-2.2.1.3">2.2.1.3</a> Validate the request identifier</span>
603
604 The Printer object SHOULD NOT check to see if the "request-id"
605 attribute supplied by the client is in range: between 1 and 2**31 - 1
606 (inclusive), but copies all 32 bits.
607
608
609
610
611
612 <span class="grey">Hastings &amp; Manros Informational [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
615
616
617 Note: The "version-number", "operation-id", and the "request-id"
618 parameters are in fixed octet positions in the IPP/1.0 encoding. The
619 "version-number" parameter will be the same fixed octet position in
620 all versions of the protocol. These fields are validated before
621 proceeding with the rest of the validation.
622
623 <span class="h5"><a class="selflink" id="section-2.2.1.4" href="#section-2.2.1.4">2.2.1.4</a> Validate attribute group and attribute presence and order</span>
624
625 The order of the following validation steps depends on
626 implementation.
627
628 <span class="h6"><a class="selflink" id="section-2.2.1.4.1" href="#section-2.2.1.4.1">2.2.1.4.1</a> Validate the presence and order of attribute groups</span>
629
630 Client requests and IPP object responses contain attribute groups
631 that <a href="#section-3">Section 3</a> requires to be present and in a specified order. An
632 IPP object verifies that the attribute groups are present and in the
633 correct order in requests supplied by clients (attribute groups
634 without an * in the following tables).
635
636 If an IPP object receives a request with (1) required attribute
637 groups missing, or (2) the attributes groups are out of order, or (3)
638 the groups are repeated, the IPP object REJECTS the request and
639 RETURNS the 'client-error-bad-request' status code. For example, it
640 is an error for the Job Template Attributes group to occur before the
641 Operation Attributes group, for the Operation Attributes group to be
642 omitted, or for an attribute group to occur more than once, except in
643 the Get-Jobs response.
644
645 Since this kind of attribute group error is most likely to be an
646 error detected by a client developer rather than by a customer, the
647 IPP object NEED NOT return an indication of which attribute group was
648 in error in either the Unsupported Attributes group or the Status
649 Message. Also, the IPP object NEED NOT find all attribute group
650 errors before returning this error.
651
652 <span class="h6"><a class="selflink" id="section-2.2.1.4.2" href="#section-2.2.1.4.2">2.2.1.4.2</a> Ignore unknown attribute groups in the expected position</span>
653
654 Future attribute groups may be added to the specification at the end
655 of requests just before the Document Content and at the end of
656 response, except for the Get-Jobs response, where it maybe there or
657 before the first job attributes returned. If an IPP object receives
658 an unknown attribute group in these positions, it ignores the entire
659 group, rather than returning an error, since that group may be a new
660 group in a later minor version of the protocol that can be ignored.
661 (If the new attribute group cannot be ignored without confusing the
662 client, the major version number would have been increased in the
663
664
665
666
667
668 <span class="grey">Hastings &amp; Manros Informational [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
671
672
673 protocol document and in the request). If the unknown group occurs
674 in a different position, the IPP object REJECTS the request and
675 RETURNS the 'client-error-bad-request' status code.
676
677 Clients also ignore unknown attribute groups returned in a response.
678
679 Note: By validating that requests are in the proper form, IPP
680 objects force clients to use the proper form which, in turn,
681 increases the chances that customers will be able to use such clients
682 from multiple vendors with IPP objects from other vendors.
683
684 <span class="h6"><a class="selflink" id="section-2.2.1.4.3" href="#section-2.2.1.4.3">2.2.1.4.3</a> Validate the presence of a single occurrence of required</span>
685 <span class="h6"> Operation attributes</span>
686
687 Client requests and IPP object responses contain Operation attributes
688 that <a href="./rfc2566#section-3">[RFC2566] Section&nbsp;3</a> requires to be present. Attributes within a
689 group may be in any order, except for the ordering of target,
690 charset, and natural languages attributes. These attributes MUST be
691 first, and MUST be supplied in the following order: charset, natural
692 language, and then target. An IPP object verifies that the attributes
693 that <a href="#section-4">Section 4</a> requires to be supplied by the client have been
694 supplied in the request (attributes without an * in the following
695 tables). An asterisk (*) indicates groups and Operation attributes
696 that the client may omit in a request or an IPP object may omit in a
697 response.
698
699 If an IPP object receives a request with required attributes missing
700 or repeated from a group or in the wrong position, the behavior of
701 the IPP object is IMPLEMENTATION DEPENDENT. Some of the possible
702 implementations are:
703
704 1.REJECTS the request and RETURNS the 'client-error-bad-request'
705 status code
706
707 2.accepts the request and uses the first occurrence of the
708 attribute no matter where it is
709
710 3.accepts the request and uses the last occurrence of the
711 attribute no matter where it is
712
713 4.accept the request and assume some default value for the missing
714 attribute
715
716 Therefore, client MUST send conforming requests, if they want to
717 receive the same behavior from all IPP object implementations. For
718 example, it is an error for the "attributes-charset" or "attributes-
719 natural-language" attribute to be omitted in any operation request,
720 or for an Operation attribute to be supplied in a Job Template group
721
722
723
724 <span class="grey">Hastings &amp; Manros Informational [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
727
728
729 or a Job Template attribute to be supplied in an Operation Attribute
730 group in a create request. It is also an error to supply the
731 "attributes-charset" attribute twice.
732
733 Since these kinds of attribute errors are most likely to be detected
734 by a client developer rather than by a customer, the IPP object NEED
735 NOT return an indication of which attribute was in error in either
736 the Unsupported Attributes group or the Status Message. Also, the
737 IPP object NEED NOT find all attribute errors before returning this
738 error.
739
740 The following tables list all the attributes for all the operations
741 by attribute group in each request and each response. The order of
742 the groups is the order that the client supplies the groups as
743 specified in <a href="./rfc2566#section-3">[RFC2566] Section&nbsp;3</a>. The order of the attributes within
744 a group is arbitrary, except as noted for some of the special
745 operation attributes (charset, natural language, and target). The
746 tables below use the following notation:
747
748 R indicates a REQUIRED attribute that an IPP object MUST support
749 O indicates an OPTIONAL attribute that an IPP object NEED NOT
750 support
751 * indicates that a client MAY omit the attribute in a request
752 and that an IPP object MAY omit the attribute in a
753 response. The absence of an * means that a client MUST
754 supply the attribute in a request and an IPP object MUST
755 supply the attribute in a response.
756
757 Operation Requests
758
759 The tables below show the attributes in their proper attribute groups
760 for operation requests:
761
762 Note: All operation requests contain "version-number", "operation-
763 id", and "request-id" parameters.
764
765 Print-Job Request:
766 Group 1: Operation Attributes (R)
767 attributes-charset (R)
768 attributes-natural-language (R)
769 printer-uri (R)
770 requesting-user-name (R*)
771 job-name (R*)
772 ipp-attribute-fidelity (R*)
773 document-name (R*)
774 document-format (R*)
775 document-natural-language (O*)
776 compression (O*)
777
778
779
780 <span class="grey">Hastings &amp; Manros Informational [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
783
784
785 job-k-octets (O*)
786 job-impressions (O*)
787 job-media-sheets (O*)
788 Group 2: Job Template Attributes (R*)
789 &lt;Job Template attributes&gt; (O*)
790 (see <a href="./rfc2566#section-4.2">[RFC2566] Section&nbsp;4.2</a>)
791 Group 3: Document Content (R)
792 &lt;document content&gt;
793
794 Validate-Job Request:
795 Group 1: Operation Attributes (R)
796 attributes-charset (R)
797 attributes-natural-language (R)
798 printer-uri (R)
799 requesting-user-name (R*)
800 job-name (R*)
801 ipp-attribute-fidelity (R*)
802 document-name (R*)
803 document-format (R*)
804 document-natural-language (O*)
805 compression (O*)
806 job-k-octets (O*)
807 job-impressions (O*)
808 job-media-sheets (O*)
809 Group 2: Job Template Attributes (R*)
810 &lt;Job Template attributes&gt; (O*)
811 (see <a href="./rfc2566#section-4.2">[RFC2566] Section&nbsp;4.2</a>)
812
813 Create-Job Request:
814 Group 1: Operation Attributes (R)
815 attributes-charset (R)
816 attributes-natural-language (R)
817 printer-uri (R)
818 requesting-user-name (R*)
819 job-name (R*)
820 ipp-attribute-fidelity (R*)
821 job-k-octets (O*)
822 job-impressions (O*)
823 job-media-sheets (O*)
824 Group 2: Job Template Attributes (R*)
825 &lt;Job Template attributes&gt; (O*) (see
826 (see <a href="./rfc2566#section-4.2">[RFC2566] Section&nbsp;4.2</a>)
827
828 Print-URI Request:
829 Group 1: Operation Attributes (R)
830 attributes-charset (R)
831 attributes-natural-language (R)
832 printer-uri (R)
833
834
835
836 <span class="grey">Hastings &amp; Manros Informational [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
839
840
841 document-uri (R)
842 requesting-user-name (R*)
843 job-name (R*)
844 ipp-attribute-fidelity (R*)
845 document-name (R*)
846 document-format (R*)
847 document-natural-language (O*)
848 compression (O*)
849 job-k-octets (O*)
850 job-impressions (O*)
851 job-media-sheets (O*)
852 Group 2: Job Template Attributes (R*)
853 &lt;Job Template attributes&gt; (O*) (see
854 (see <a href="./rfc2566#section-4.2">[RFC2566] Section&nbsp;4.2</a>)
855
856 Send-Document Request:
857 Group 1: Operation Attributes (R)
858 attributes-charset (R)
859 attributes-natural-language (R)
860 (printer-uri &amp; job-id) | job-uri (R)
861 last-document (R)
862 requesting-user-name (R*)
863 document-name (R*)
864 document-format (R*)
865 document-natural-language (O*)
866 compression (O*)
867 Group 2: Document Content (R*)
868 &lt;document content&gt;
869
870 Send-URI Request:
871 Group 1: Operation Attributes (R)
872 attributes-charset (R)
873 attributes-natural-language (R)
874 (printer-uri &amp; job-id) | job-uri (R)
875 last-document (R)
876 document-uri (R)
877 requesting-user-name (R*)
878 document-name (R*)
879 document-format (R*)
880 document-natural-language (O*)
881 compression (O*)
882
883
884
885
886
887
888
889
890
891
892 <span class="grey">Hastings &amp; Manros Informational [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
895
896
897 Cancel-Job Request:
898 Group 1: Operation Attributes (R)
899 attributes-charset (R)
900 attributes-natural-language (R)
901 (printer-uri &amp; job-id) | job-uri (R)
902 requesting-user-name (R*)
903 message (O*)
904
905 Get-Printer-Attributes Request:
906 Group 1: Operation Attributes (R)
907 attributes-charset (R)
908 attributes-natural-language (R)
909 printer-uri (R)
910 requesting-user-name (R*)
911 requested-attributes (R*)
912 document-format (R*)
913
914 Get-Job-Attributes Request:
915 Group 1: Operation Attributes (R)
916 attributes-charset (R)
917 attributes-natural-language (R)
918 (printer-uri &amp; job-id) | job-uri (R)
919 requesting-user-name (R*)
920 requested-attributes (R*)
921
922 Get-Jobs Request:
923 Group 1: Operation Attributes (R)
924 attributes-charset (R)
925 attributes-natural-language (R)
926 printer-uri (R)
927 requesting-user-name (R*)
928 limit (R*)
929 requested-attributes (R*)
930 which-jobs (R*)
931 my-jobs (R*)
932
933
934 Operation Responses
935
936 The tables below show the response attributes in their proper
937 attribute groups for responses.
938
939 Note: All operation responses contain "version-number", "status-
940 code", and "request-id" parameters.
941
942 Print-Job Response:
943 Print-URI Response:
944 Create-Job Response:
945
946
947
948 <span class="grey">Hastings &amp; Manros Informational [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
951
952
953 Send-Document Response:
954 Send-URI Response:
955 Group 1: Operation Attributes (R)
956 attributes-charset (R)
957 attributes-natural-language (R)
958 status-message (O*)
959 Group 2: Unsupported Attributes (R*) (see Note 3)
960 &lt;unsupported attributes&gt; (R*)
961 Group 3: Job Object Attributes(R*) (see Note 2)
962 job-uri (R)
963 job-id (R)
964 job-state (R)
965 job-state-reasons (O*)
966 job-state-message (O*)
967 number-of-intervening-jobs (O*)
968
969 Validate-Job Response:
970 Cancel-Job Response:
971 Group 1: Operation Attributes (R)
972 attributes-charset (R)
973 attributes-natural-language (R)
974 status-message (O*)
975 Group 2: Unsupported Attributes (R*) (see Note 3)
976 &lt;unsupported attributes&gt; (R*)
977
978 Note 2 - the Job Object Attributes and Printer Object Attributes are
979 returned only if the IPP object returns one of the success status
980 codes.
981
982 Note 3 - the Unsupported Attributes Group is present only if the
983 client included some Operation and/or Job Template attributes or
984 values that the Printer doesn't support whether a success or an error
985 return.
986
987 Get-Printer-Attributes Response:
988 Group 1: Operation Attributes (R)
989 attributes-charset (R)
990 attributes-natural-language (R)
991 status-message (O*)
992 Group 2: Unsupported Attributes (R*) (see Note 4)
993 &lt;unsupported attributes&gt; (R*)
994 Group 3: Printer Object Attributes(R*) (see Note 2)
995 &lt;requested attributes&gt; (R*)
996
997 Note 4 - the Unsupported Attributes Group is present only if the
998 client included some Operation attributes that the Printer doesn't
999 support whether a success or an error return.
1000
1001
1002
1003
1004 <span class="grey">Hastings &amp; Manros Informational [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1007
1008
1009 Get-Job-Attributes Response:
1010 Group 1: Operation Attributes (R)
1011 attributes-charset (R)
1012 attributes-natural-language (R)
1013 status-message (O*)
1014 Group 2: Unsupported Attributes (R*) (see Note 4)
1015 &lt;unsupported attributes&gt; (R*)
1016 Group 3: Job Object Attributes(R*) (see Note 2)
1017 &lt;requested attributes&gt; (R*)
1018
1019 Get-Jobs Response:
1020 Group 1: Operation Attributes (R)
1021 attributes-charset (R)
1022 attributes-natural-language (R)
1023 status-message (O*)
1024 Group 2: Unsupported Attributes (R*) (see Note 4)
1025 &lt;unsupported attributes&gt; (R*)
1026 Group 3: Job Object Attributes(R*) (see Note 2, 5)
1027 &lt;requested attributes&gt; (R*)
1028
1029 Note 5: for the Get-Jobs operation the response contains a separate
1030 Job Object Attributes group 3 to N containing requested-attributes
1031 for each job object in the response.
1032
1033 <span class="h5"><a class="selflink" id="section-2.2.1.5" href="#section-2.2.1.5">2.2.1.5</a> Validate the values of the REQUIRED Operation attributes</span>
1034
1035 An IPP object validates the values supplied by the client of the
1036 REQUIRED Operation attribute that the IPP object MUST support. The
1037 next section specifies the validation of the values of the OPTIONAL
1038 Operation attributes that IPP objects MAY support.
1039
1040 The IPP object performs the following syntactic validation checks of
1041 each Operation attribute value:
1042
1043 a)that the length of each Operation attribute value is correct for
1044 the attribute syntax tag supplied by the client according to
1045 <a href="./rfc2566#section-4.1">[RFC2566] Section&nbsp;4.1</a>,
1046
1047 b)that the attribute syntax tag is correct for that Operation
1048 attribute according to <a href="./rfc2566#section-3">[RFC2566] Section&nbsp;3</a>,
1049
1050 c)that the value is in the range specified for that Operation
1051 attribute according to <a href="./rfc2566#section-3">[RFC2566] Section&nbsp;3</a>,
1052
1053 d)that multiple values are supplied by the client only for
1054 operation attributes that are multi-valued, i.e., that are
1055 1setOf X according to <a href="./rfc2566#section-3">[RFC2566] Section&nbsp;3</a>.
1056
1057
1058
1059
1060 <span class="grey">Hastings &amp; Manros Informational [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1063
1064
1065 If any of these checks fail, the IPP object REJECTS the request and
1066 RETURNS the 'client-error-bad-request' or the 'client-error-request-
1067 value-too-long' status code. Since such an error is most likely to
1068 be an error detected by a client developer, rather than by an end-
1069 user, the IPP object NEED NOT return an indication of which attribute
1070 had the error in either the Unsupported Attributes Group or the
1071
1072 Status Message. The description for each of these syntactic checks
1073 is explicitly expressed in the first IF statement in the following
1074 table.
1075
1076 In addition, the IPP object checks each Operation attribute value
1077 against some Printer object attribute or some hard-coded value if
1078 there is no "xxx-supported" Printer object attribute defined. If its
1079 value is not among those supported or is not in the range supported,
1080 then the IPP object REJECTS the request and RETURNS the error status
1081 code indicated in the table by the second IF statement. If the value
1082 of the Printer object's "xxx-supported" attribute is 'no-value'
1083 (because the system administrator hasn't configured a value), the
1084 check always fails.
1085
1086 attributes-charset (charset)
1087
1088 IF NOT a single non-empty 'charset' value, REJECT/RETURN 'client-
1089 error-bad-request'.
1090
1091 IF the value length is greater than 63 octets, REJECT/RETURN '
1092 client-error-request-value-too-long'.
1093 IF NOT in the Printer object's "charset-supported" attribute,
1094 REJECT/RETURN "client-error-charset-not-supported".
1095
1096
1097 attributes-natural-language(naturalLanguage)
1098
1099 IF NOT a single non-empty 'naturalLanguage' value, REJECT/RETURN
1100 'client-error-bad-request'.
1101 IF the value length is greater than 63 octets, REJECT/RETURN '
1102 client-error-request-value-too-long'.
1103 ACCEPT the request even if not a member of the set in the Printer
1104 object's "generated-natural-language-supported" attribute. If
1105 the supplied value is not a member of the Printer object's
1106 "generated-natural-language-supported" attribute, use the
1107 Printer object's "natural-language-configured" value.
1108
1109
1110
1111
1112
1113
1114
1115
1116 <span class="grey">Hastings &amp; Manros Informational [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1119
1120
1121 requesting-user-name
1122
1123 IF NOT a single 'name' value, REJECT/RETURN 'client-error-bad-
1124 request'.
1125 IF the value length is greater than 255 octets, REJECT/RETURN
1126 'client-error-request-value-too-long'.
1127 IF the IPP object can obtain a better authenticated name, use it
1128 instead.
1129
1130
1131 job-name(name)
1132
1133 IF NOT a single 'name' value, REJECT/RETURN 'client-error-bad-
1134 request'.
1135 IF the value length is greater than 255 octets, REJECT/RETURN
1136 'client-error-request-value-too-long'.
1137 IF NOT supplied by the client, the Printer object creates a name
1138 from the document-name or document-uri.
1139
1140
1141 document-name (name)
1142
1143 IF NOT a single 'name' value, REJECT/RETURN 'client-error-bad-
1144 request'.
1145 IF the value length is greater than 255 octets, REJECT/RETURN
1146 'client-error-request-value-too-long'.
1147
1148
1149 ipp-attribute-fidelity (boolean)
1150
1151 IF NEITHER a single 'true' NOR a single 'false' 'boolean' value,
1152 REJECT/RETURN 'client-error-bad-request'.
1153 IF the value length is NOT equal to 1 octet, REJECT/RETURN '
1154 client-error-request-value-too-long'
1155 IF NOT supplied by the client, the IPP object assumes the value
1156 'false'.
1157
1158
1159 document-format (mimeMediaType)
1160
1161 IF NOT a single non-empty 'mimeMediaType' value, REJECT/RETURN
1162 'client-error-bad-request'.
1163 IF the value length is greater than 255 octets, REJECT/RETURN
1164 'client-error-request-value-too-long'.
1165 IF NOT in the Printer object's "document-format-supported"
1166 attribute, REJECT/RETURN 'client-error-document-format-not-
1167 supported'
1168
1169
1170
1171
1172 <span class="grey">Hastings &amp; Manros Informational [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1175
1176
1177 IF NOT supplied by the client, the IPP object assumes the value of
1178 the Printer object's "document-format-default" attribute.
1179
1180
1181 document-uri (uri)
1182
1183 IF NOT a single non-empty 'uri' value, REJECT/RETURN 'client-
1184 error-bad-request'.
1185 IF the value length is greater than 1023 octets, REJECT/RETURN
1186 'client-error-request-value-too-long'.
1187 IF the URI syntax is not valid, REJECT/RETURN 'client-error-bad-
1188 request'.
1189 IF scheme is NOT in the Printer object's "reference-uri-schemes-
1190 supported" attribute, REJECT/RETURN 'client-error-uri-scheme-
1191 not-supported'.
1192 The Printer object MAY check to see if the document exists and is
1193 accessible. If the document is not found or is not accessible,
1194 REJECT/RETURN 'client-error-not found'.
1195
1196
1197 last-document (boolean)
1198
1199 IF NEITHER a single 'true' NOR a single 'false' 'boolean' value,
1200 REJECT/RETURN 'client-error-bad-request'.
1201 IF the value length is NOT equal to 1 octet, REJECT/RETURN '
1202 client-error-request-value-too-long'
1203
1204
1205 job-id (integer(1:MAX))
1206
1207 IF NOT an single 'integer' value equal to 4 octets AND in the
1208 range 1 to MAX, REJECT/RETURN 'client-error-bad-request'.
1209
1210 IF NOT a job-id of an existing Job object, REJECT/RETURN 'client-
1211 error-not-found' or 'client-error-gone' status code, if keep
1212 track of recently deleted jobs.
1213
1214
1215 requested-attributes (1setOf keyword)
1216
1217 IF NOT one or more 'keyword' values, REJECT/RETURN 'client-error-
1218 bad-request'.
1219 IF the value length is greater than 255 octets, REJECT/RETURN
1220 'client-error-request-value-too-long'.
1221 Ignore unsupported values which are the keyword names of
1222 unsupported attributes. Don't bother to copy such requested
1223 (unsupported) attributes to the Unsupported Attribute response
1224 group since the response will not return them.
1225
1226
1227
1228 <span class="grey">Hastings &amp; Manros Informational [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1231
1232
1233 which-jobs (type2 keyword)
1234
1235 IF NOT a single 'keyword' value, REJECT/RETURN 'client-error-bad-
1236 request'.
1237 IF the value length is greater than 255 octets, REJECT/RETURN
1238 'client-error-request-value-too-long'.
1239 IF NEITHER 'completed' NOR 'not-completed', copy the attribute and
1240 the unsupported value to the Unsupported Attributes response
1241 group and REJECT/RETURN 'client-error-attributes-or-values-
1242 not-supported'.
1243 Note: a Printer still supports the 'completed' value even if it
1244 keeps no completed/canceled/aborted jobs: by returning no jobs
1245 when so queried.
1246 IF NOT supplied by the client, the IPP object assumes the 'not-
1247 completed' value.
1248
1249
1250 my-jobs (boolean)
1251
1252 IF NEITHER a single 'true' NOR a single 'false' 'boolean' value,
1253 REJECT/RETURN 'client-error-bad-request'.
1254 IF the value length is NOT equal to 1 octet, REJECT/RETURN '
1255 client-error-request-value-too-long'
1256 IF NOT supplied by the client, the IPP object assumes the 'false'
1257 value.
1258
1259
1260 limit (integer(1:MAX))
1261
1262 IF NOT a single 'integer' value equal to 4 octets AND in the range
1263 1 to MAX, REJECT/RETURN 'client-error-bad-request'.
1264 IF NOT supplied by the client, the IPP object returns all jobs, no
1265 matter how many.
1266
1267 <span class="h5"><a class="selflink" id="section-2.2.1.6" href="#section-2.2.1.6">2.2.1.6</a> Validate the values of the OPTIONAL Operation attributes</span>
1268
1269 OPTIONAL Operation attributes are those that an IPP object MAY or MAY
1270 NOT support. An IPP object validates the values of the OPTIONAL
1271 attributes supplied by the client. The IPP object performs the same
1272 syntactic validation checks for each OPTIONAL attribute value as in
1273 <a href="#section-2.2.1.5">Section 2.2.1.5</a>. As in <a href="#section-2.2.1.5">Section 2.2.1.5</a>, if any fail, the IPP object
1274 REJECTS the request and RETURNS the 'client-error-bad-request' or the
1275 'client-error-request-value-too-long' status code.
1276
1277 In addition, the IPP object checks each Operation attribute value
1278 against some Printer attribute or some hard-coded value if there is
1279 no "xxx-supported" Printer attribute defined. If its value is not
1280 among those supported or is not in the range supported, then the IPP
1281
1282
1283
1284 <span class="grey">Hastings &amp; Manros Informational [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1287
1288
1289 object REJECTS the request and RETURNS the error status code
1290 indicated in the table. If the value of the Printer object's "xxx-
1291 supported" attribute is 'no-value' (because the system administrator
1292 hasn't configured a value), the check always fails.
1293
1294 If the IPP object doesn't recognize/support an attribute, the IPP
1295 object treats the attribute as an unknown or unsupported attribute
1296 (see the last row in the table below).
1297
1298 document-natural-language (naturalLanguage)
1299
1300 IF NOT a single non-empty 'naturalLanguage' value, REJECT/RETURN '
1301 client-error-bad-request'.
1302 IF the value length is greater than 63 octets, REJECT/RETURN '
1303 client-error-request-value-too-long'.
1304 IF NOT a value that the Printer object supports in document
1305 formats, (no corresponding "xxx-supported" Printer attribute),
1306 REJECT/RETURN 'client-error-natural-language-not-supported'.
1307
1308
1309 compression (type3 keyword)
1310
1311 IF NOT a single 'keyword' value, REJECT/RETURN 'client-error-bad-
1312 request'.
1313 IF the value length is greater than 255 octets, REJECT/RETURN '
1314 client-error-request-value-too-long'.
1315 IF NOT in the Printer object's "compression-supported" attribute,
1316 copy the attribute and the unsupported value to the Unsupported
1317 Attributes response group and REJECT/RETURN 'client-error-
1318 attributes-or-values-not-supported'.
1319
1320
1321 job-k-octets (integer(0:MAX))
1322
1323 IF NOT a single 'integer' value equal to 4 octets,
1324 REJECT/RETURN 'client-error-bad-request'.
1325 IF NOT in the range of the Printer object's "job-k-octets-
1326 supported" attribute, copy the attribute and the unsupported
1327 value to the Unsupported Attributes response group and
1328 REJECT/RETURN 'client-error-attributes-or-values-not-
1329 supported'.
1330
1331
1332 job-impressions (integer(0:MAX))
1333
1334 IF NOT a single 'integer' value equal to 4 octets,
1335 REJECT/RETURN 'client-error-bad-request'.
1336
1337
1338
1339
1340 <span class="grey">Hastings &amp; Manros Informational [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1343
1344
1345 IF NOT in the range of the Printer object's "job-impressions-
1346 supported" attribute, copy the attribute and the unsupported
1347 value to the Unsupported Attributes response group and
1348 REJECT/RETURN 'client-error-attributes-or-values-not-
1349 supported'.
1350
1351
1352 job-media-sheets (integer(0:MAX))
1353
1354 IF NOT a single 'integer' value equal to 4 octets,
1355 REJECT/RETURN 'client-error-bad-request'.
1356 IF NOT in the range of the Printer object's "job-media-sheets-
1357 supported" attribute, copy the attribute and the unsupported
1358 value to the Unsupported Attributes response group and
1359 REJECT/RETURN 'client-error-attributes-or-values-not-
1360 supported'.
1361
1362
1363 message (text(127))
1364
1365 IF NOT a single 'text' value, REJECT/RETURN 'client-error-bad-
1366 request'.
1367 IF the value length is greater than 127 octets,
1368 REJECT/RETURN 'client-error-request-value-too-long'.
1369
1370
1371 unknown or unsupported attribute
1372
1373 IF the attribute syntax supplied by the client is supported but
1374 the length is not legal for that attribute syntax,
1375 REJECT/RETURN 'client-error-request-value-too-long'.
1376 ELSE copy the attribute and value to the Unsupported Attributes
1377 response group and change the attribute value to the "out-of-
1378 band" 'unsupported' value, but otherwise ignore the attribute.
1379
1380 Note: Future Operation attributes may be added to the protocol
1381 specification that may occur anywhere in the specified group.
1382 When the operation is otherwise successful, the IPP object returns
1383 the 'successful-ok-ignored-or-substituted-attributes' status code.
1384 Ignoring unsupported Operation attributes in all operations is
1385 analogous to the handling of unsupported Job Template attributes
1386 in the create and Validate-Job operations when the client supplies
1387 the "ipp-attribute-fidelity" Operation attribute with the 'false'
1388 value. This last rule is so that we can add OPTIONAL Operation
1389 attributes to future versions of IPP so that older clients can
1390 inter-work with new IPP objects and newer clients can inter-work
1391 with older IPP objects. (If the new attribute cannot be ignored
1392 without performing unexpectedly, the major version number would
1393
1394
1395
1396 <span class="grey">Hastings &amp; Manros Informational [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1399
1400
1401 have been increased in the protocol document and in the request).
1402 This rule for Operation attributes is independent of the value of
1403 the "ipp-attribute-fidelity" attribute. For example, if an IPP
1404 object doesn't support the OPTIONAL "job-k-octets" attribute', the
1405 IPP object treats "job-k-octets" as an unknown attribute and only
1406 checks the length for the 'integer' attribute syntax supplied by
1407 the client. If it is not four octets, the IPP object REJECTS the
1408 request and RETURNS the 'client-error-bad-request' status code,
1409 else the IPP object copies the attribute to the Unsupported
1410 Attribute response group, setting the value to the "out-of-band" '
1411 unsupported' value, but otherwise ignores the attribute.
1412
1413 <span class="h4"><a class="selflink" id="section-2.2.2" href="#section-2.2.2">2.2.2</a> Suggested Additional Processing Steps for Operations that</span>
1414 <span class="h4"> Create/Validate Jobs and Add Documents</span>
1415
1416 This section in combination with the previous section recommends the
1417 processing steps for the Print-Job, Validate-Job, Print-URI, Create-
1418 Job, Send-Document, and Send-URI operations that IPP objects SHOULD
1419 use. These are the operations that create jobs, validate a Print-Job
1420 request, and add documents to a job.
1421
1422 <span class="h5"><a class="selflink" id="section-2.2.2.1" href="#section-2.2.2.1">2.2.2.1</a> Default "ipp-attribute-fidelity" if not supplied</span>
1423
1424 The Printer object checks to see if the client supplied an "ipp-
1425 attribute-fidelity" Operation attribute. If the attribute is not
1426 supplied by the client, the IPP object assumes that the value is
1427 'false'.
1428
1429 <span class="h5"><a class="selflink" id="section-2.2.2.2" href="#section-2.2.2.2">2.2.2.2</a> Check that the Printer object is accepting jobs</span>
1430
1431 If the value of the Printer object's "printer-is-accepting-jobs" is
1432 'false', the Printer object REJECTS the request and RETURNS the
1433 'server-error-not-accepting-jobs' status code.
1434
1435 <span class="h5"><a class="selflink" id="section-2.2.2.3" href="#section-2.2.2.3">2.2.2.3</a> Validate the values of the Job Template attributes</span>
1436
1437 An IPP object validates the values of all Job Template attribute
1438 supplied by the client. The IPP object performs the analogous
1439 syntactic validation checks of each Job Template attribute value that
1440 it performs for Operation attributes (see <a href="#section-2.2.1.5">Section 2.2.1.5</a>.):
1441
1442 a)that the length of each value is correct for the attribute
1443 syntax tag supplied by the client according to [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] <a href="#section-4.1">Section</a>
1444 <a href="#section-4.1">4.1</a>.
1445
1446 b)that the attribute syntax tag is correct for that attribute
1447 according to [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] Sections <a href="#section-4.2">4.2</a> to <a href="#section-4.4">4.4</a>.
1448
1449
1450
1451
1452 <span class="grey">Hastings &amp; Manros Informational [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1455
1456
1457 c)that multiple values are supplied only for multi-valued
1458 attributes, i.e., that are 1setOf X according to [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>]
1459 Sections <a href="#section-4.2">4.2</a> to <a href="#section-4.4">4.4</a>.
1460
1461 As in <a href="#section-2.2.1.5">Section 2.2.1.5</a>, if any of these syntactic checks fail, the IPP
1462 object REJECTS the request and RETURNS the 'client-error-bad-request'
1463 or 'client-error-request-value-too-long' status code as appropriate,
1464 independent of the value of the "ipp-attribute-fidelity". Since such
1465 an error is most likely to be an error detected by a client
1466 developer, rather than by an end-user, the IPP object NEED NOT return
1467 an indication of which attribute had the error in either the
1468 Unsupported Attributes Group or the Status Message. The description
1469 for each of these syntactic checks is explicitly expressed in the
1470 first IF statement in the following table.
1471
1472 Each Job Template attribute MUST occur no more than once. If an IPP
1473 Printer receives a create request with multiple occurrences of a Job
1474 Template attribute, it MAY:
1475
1476 1.reject the operation and return the 'client-error-bad syntax'
1477 error status code
1478
1479 2.accept the operation and use the first occurrence of the
1480 attribute
1481
1482 3.accept the operation and use the last occurrence of the
1483 attribute
1484
1485 depending on implementation. Therefore, clients MUST NOT supply
1486 multiple occurrences of the same Job Template attribute in the Job
1487 Attributes group in the request.
1488
1489 <span class="h4"><a class="selflink" id="section-2.2.3" href="#section-2.2.3">2.2.3</a> Algorithm for job validation</span>
1490
1491 The process of validating a Job-Template attribute "xxx" against a
1492 Printer attribute "xxx-supported" can use the following validation
1493 algorithm (see <a href="./rfc2566#section-3.2.1.2">section&nbsp;3.2.1.2 in [RFC2566]</a>).
1494
1495 To validate the value U of Job-Template attribute "xxx" against the
1496 value V of Printer "xxx-supported", perform the following algorithm:
1497
1498 1.If U is multi-valued, validate each value X of U by performing
1499 the algorithm in Table 3 with each value X. Each validation is
1500 separate from the standpoint of returning unsupported values.
1501
1502 Example: If U is "finishings" that the client supplies with
1503 'staple', 'bind' values, then X takes on the successive values:
1504 'staple', then 'bind'
1505
1506
1507
1508 <span class="grey">Hastings &amp; Manros Informational [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1511
1512
1513 2.If V is multi-valued, validate X against each Z of V by
1514 performing the algorithm in Table 3 with each value Z. If a
1515 value Z validates, the validation for the attribute value X
1516 succeeds. If it fails, the algorithm is applied to the next
1517 value Z of V. If there are no more values Z of V, validation
1518 fails.
1519
1520 Example: If V is "sides-supported" with values: 'one-sided',
1521 'two-sided-long', and 'two-sided-short', then Z takes on the
1522 successive values: 'one-sided', 'two-sided-long', and
1523 'two-sided-short'. If the client supplies "sides" with 'two-
1524 sided-long', the first comparison fails ('one-sided' is not
1525 equal to 'two-sided-long'), the second comparison succeeds
1526 ('two-sided-long' is equal to 'two-sided-long"), and the third
1527 comparison ('two-sided-short' with 'two-sided-long') is not even
1528 performed.
1529
1530 3.If both U and V are single-valued, let X be U and Z be V and use
1531 the validation rules in Table 3.
1532
1533 Table 3 - Rules for validating single values X against Z
1534
1535 attribute attribute validated if:
1536 syntax of X syntax of Z
1537
1538 integer rangeOfInteger X is within the range of
1539 Z
1540
1541 uri uriScheme the uri scheme in X is
1542 equal to Z
1543
1544 any boolean the value of Z is TRUE
1545
1546 any any X and Z are of the same
1547 type and are equal.
1548
1549 If the value of the Printer object's "xxx-supported" attribute is '
1550 no-value' (because the system administrator hasn't configured a
1551 value), the check always fails. If the check fails, the IPP object
1552 copies the attribute to the Unsupported Attributes response group
1553 with its unsupported value. If the attribute contains more than one
1554 value, each value is checked and each unsupported value is separately
1555 copied, while supported values are not copied. If an IPP object
1556 doesn't recognize/support a Job Template attribute, i.e., there is no
1557 corresponding Printer object "xxx-supported" attribute, the IPP
1558 object treats the attribute as an unknown or unsupported attribute
1559 (see the last row in the table below).
1560
1561
1562
1563
1564 <span class="grey">Hastings &amp; Manros Informational [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1567
1568
1569 If some Job Template attributes are supported for some document
1570 formats and not for others or the values are different for different
1571 document formats, the IPP object SHOULD take that into account in
1572 this validation using the value of the "document-format" supplied by
1573 the client (or defaulted to the value of the Printer's "document-
1574 format-default" attribute, if not supplied by the client). For
1575 example, if "number-up" is supported for the 'text/plain' document
1576 format, but not for the 'application/postscript' document format, the
1577 check SHOULD (though it NEED NOT) depend on the value of the
1578 "document-format" operation attribute. See "document-format" in
1579 <a href="./rfc2566#section-3.2.1.1">[RFC2566] section&nbsp;3.2.1.1</a> and 3.2.5.1.
1580
1581 Note: whether the request is accepted or rejected is determined by
1582 the value of the "ipp-attribute-fidelity" attribute in a subsequent
1583 step, so that all Job Template attribute supplied are examined and
1584 all unsupported attributes and/or values are copied to the
1585 Unsupported Attributes response group.
1586
1587 job-priority (integer(1:100))
1588
1589 IF NOT a single 'integer' value with a length equal to 4 octets,
1590 REJECT/RETURN 'client-error-bad-request'.
1591 IF NOT supplied by the client, use the value of the Printer
1592 object's "job-priority-default" attribute at job submission
1593 time.
1594 IF NOT in the range 1 to 100, inclusive, copy the attribute and
1595 the unsupported value to the Unsupported Attributes response
1596 group.
1597 Map the value to the nearest supported value in the range 1:100 as
1598 specified by the number of discrete values indicated by the
1599 value of the Printer's "job-priority-supported" attribute. See
1600 the formula in <a href="./rfc2566#section-4.2.1">[RFC2566] Section&nbsp;4.2.1</a>.
1601
1602 job-hold-until (type3 keyword | name)
1603
1604 IF NOT a single 'keyword' or 'name' value, REJECT/RETURN 'client-
1605 error-bad-request'.
1606 IF the value length is greater than 255 octets, REJECT/RETURN
1607 'client-error-request-value-too-long'.
1608 IF NOT supplied by the client, use the value of the Printer
1609 object's "job-hold-until" attribute at job submission time.
1610 IF NOT in the Printer object's "job-hold-until-supported"
1611 attribute, copy the attribute and the unsupported value to the
1612 Unsupported Attributes response group.
1613
1614
1615
1616
1617
1618
1619
1620 <span class="grey">Hastings &amp; Manros Informational [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1623
1624
1625 job-sheets (type3 keyword | name)
1626
1627 IF NOT a single 'keyword' or 'name' value, REJECT/RETURN 'client-
1628 error-bad-request'.
1629 IF the value length is greater than 255 octets, REJECT/RETURN
1630 'client-error-request-value-too-long'.
1631 IF NOT in the Printer object's "job-sheets-supported" attribute,
1632 copy the attribute and the unsupported value to the Unsupported
1633 Attributes response group.
1634
1635 multiple-document-handling (type2 keyword)
1636
1637 IF NOT a single 'keyword' value, REJECT/RETURN 'client-error-bad-
1638 request'.
1639 IF the value length is greater than 255 octets, REJECT/RETURN
1640 'client-error-request-value-too-long'.
1641 IF NOT in the Printer object's "multiple-document-handling-
1642 supported" attribute, copy the attribute and the unsupported
1643 value to the Unsupported Attributes response group.
1644
1645 copies (integer(1:MAX))
1646
1647 IF NOT a single 'integer' value with a length equal to 4 octets,
1648 REJECT/RETURN 'client-error-bad-request'.
1649 IF NOT in range of the Printer object's "copies-supported"
1650 attribute copy the attribute and the unsupported value to the
1651 Unsupported
1652 Attributes response group.
1653
1654 finishings (1setOf type2 enum)
1655
1656 IF NOT an 'enum' value(s) each with a length equal to 4 octets,
1657 REJECT/RETURN 'client-error-bad-request'.
1658 IF NOT in the Printer object's "finishings-supported" attribute,
1659 copy the attribute and the unsupported value(s), but not any
1660 supported values, to the Unsupported Attributes response group.
1661
1662 page-ranges (1setOf rangeOfInteger(1:MAX))
1663
1664 IF NOT a 'rangeOfInteger' value(s) each with a length equal to 8
1665 octets, REJECT/RETURN 'client-error-bad-request'.
1666 IF first value is greater than second value in any range, the
1667 ranges are not in ascending order, or ranges overlap,
1668 REJECT/RETURN 'client-error-bad-request'.
1669 IF the value of the Printer object's "page-ranges-supported"
1670 attribute is 'false', copy the attribute to the Unsupported
1671 Attributes response group and set the value to the "out-of-
1672 band" 'unsupported' value.
1673
1674
1675
1676 <span class="grey">Hastings &amp; Manros Informational [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1679
1680
1681 sides (type2 keyword)
1682
1683 IF NOT a single 'keyword' value, REJECT/RETURN 'client-error-bad-
1684 request'.
1685 IF the value length is greater than 255 octets, REJECT/RETURN
1686 'client-error-request-value-too-long'.
1687 IF NOT in the Printer object's "sides-supported" attribute, copy
1688 the attribute and the unsupported value to the Unsupported
1689 Attributes response group.
1690
1691 number-up (integer(1:MAX))
1692
1693 IF NOT a single 'integer' value with a length equal to 4 octets,
1694 REJECT/RETURN 'client-error-bad-request'.
1695 IF NOT a value or in the range of one of the values of the Printer
1696 object's "number-up-supported" attribute, copy the attribute
1697 and value to the Unsupported Attribute response group.
1698
1699 orientation-requested (type2 enum)
1700
1701 IF NOT a single 'enum' value with a length equal to 4 octets,
1702 REJECT/RETURN 'client-error-bad-request'.
1703 IF NOT in the Printer object's "orientation-requested-supported"
1704 attribute, copy the attribute and the unsupported value to the
1705 Unsupported Attributes response group.
1706
1707 media (type3 keyword | name)
1708
1709 IF NOT a single 'keyword' or 'name' value, REJECT/RETURN 'client-
1710 error-bad-request'.
1711 IF the value length is greater than 255 octets, REJECT/RETURN
1712 'client-error-request-value-too-long'.
1713 IF NOT in the Printer object's "media-supported" attribute, copy
1714 the attribute and the unsupported value to the Unsupported
1715 Attributes response group.
1716
1717 printer-resolution (resolution)
1718
1719 IF NOT a single 'resolution' value with a length equal to 9
1720 octets,
1721 REJECT/RETURN 'client-error-bad-request'.
1722 IF NOT in the Printer object's "printer-resolution-supported"
1723 attribute, copy the attribute and the unsupported value to the
1724 Unsupported Attributes response group.
1725
1726
1727
1728
1729
1730
1731
1732 <span class="grey">Hastings &amp; Manros Informational [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1735
1736
1737 print-quality (type2 enum)
1738
1739 IF NOT a single 'enum' value with a length equal to 4 octets,
1740 REJECT/RETURN 'client-error-bad-request'.
1741 IF NOT in the Printer object's "print-quality-supported"
1742 attribute, copy the attribute and the unsupported value to the
1743 Unsupported Attributes response group.
1744
1745 unknown or unsupported attribute (i.e., there is no corresponding
1746 Printer object "xxx-supported" attribute)
1747
1748 IF the attribute syntax supplied by the client is supported but
1749 the length is not legal for that attribute syntax,
1750 REJECT/RETURN 'client-error-bad-request' if the length of the
1751 attribute syntax is fixed or 'client-error-request-value-too-
1752 long' if the length of the attribute syntax is variable.
1753 ELSE copy the attribute and value to the Unsupported Attributes
1754 response group and change the attribute value to the "out-of-
1755 band" 'unsupported' value. Any remaining Job Template
1756 Attributes are either unknown or unsupported Job Template
1757 attributes and are validated algorithmically according to their
1758 attribute syntax for proper length (see below).
1759
1760 If the attribute syntax is supported AND the length check
1761 fails, the IPP object REJECTS the request and RETURNS the '
1762 client-error-bad-request' if the length of the attribute syntax
1763 is fixed or the 'client-error-request-value-too-long' status
1764 code if the length of the attribute syntax is variable.
1765 Otherwise, the IPP object copies the unsupported Job Template
1766 attribute to the Unsupported Attributes response group and
1767 changes the attribute value to the "out-of-band" 'unsupported'
1768 value. The following table shows the length checks for all
1769 attribute syntaxes. In the following table: "&lt;=" means less
1770 than or equal, "=" means equal to:
1771
1772 Name Octet length check for read-write attributes
1773 ----------- --------------------------------------------
1774 'textWithLanguage &lt;= 1023 AND 'naturalLanguage' &lt;= 63
1775 'textWithoutLanguage' &lt;= 1023
1776 'nameWithLanguage' &lt;= 255 AND 'naturalLanguage' &lt;= 63
1777 'nameWithoutLanguage' &lt;= 255
1778 'keyword' &lt;= 255
1779 'enum' = 4
1780 'uri' &lt;= 1023
1781 'uriScheme' &lt;= 63
1782 'charset' &lt;= 63
1783 'naturalLanguage' &lt;= 63
1784 'mimeMediaType' &lt;= 255
1785
1786
1787
1788 <span class="grey">Hastings &amp; Manros Informational [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1791
1792
1793 'octetString' &lt;= 1023
1794 'boolean' = 1
1795 'integer' = 4
1796 'rangeOfInteger' = 8
1797 'dateTime' = 11
1798 'resolution' = 9
1799 '1setOf X'
1800
1801 <span class="h5"><a class="selflink" id="section-2.2.3.1" href="#section-2.2.3.1">2.2.3.1</a> Check for conflicting Job Template attributes values</span>
1802
1803 Once all the Operation and Job Template attributes have been checked
1804 individually, the Printer object SHOULD check for any conflicting
1805 values among all the supported values supplied by the client. For
1806 example, a Printer object might be able to staple and to print on
1807 transparencies, however due to physical stapling constraints, the
1808 Printer object might not be able to staple transparencies. The IPP
1809 object copies the supported attributes and their conflicting
1810 attribute values to the Unsupported Attributes response group. The
1811 Printer object only copies over those attributes that the Printer
1812 object either ignores or substitutes in order to resolve the
1813 conflict, and it returns the original values which were supplied by
1814 the client. For example suppose the client supplies "finishings"
1815 equals 'staple' and "media" equals 'transparency', but the Printer
1816 object does not support stapling transparencies. If the Printer
1817 chooses to ignore the stapling request in order to resolve the
1818 conflict, the Printer objects returns "finishings" equal to 'staple'
1819 in the Unsupported Attributes response group. If any attributes are
1820 multi-valued, only the conflicting values of the attributes are
1821 copied.
1822
1823 Note: The decisions made to resolve the conflict (if there is a
1824 choice) is implementation dependent.
1825
1826 <span class="h5"><a class="selflink" id="section-2.2.3.2" href="#section-2.2.3.2">2.2.3.2</a> Decide whether to REJECT the request</span>
1827
1828 If there were any unsupported Job Template attributes or
1829 unsupported/conflicting Job Template attribute values and the client
1830 supplied the "ipp-attribute-fidelity" attribute with the 'true'
1831 value, the Printer object REJECTS the request and return the status
1832 code:
1833
1834 (1) 'client-error-conflicting-attributes' status code, if there
1835 were any conflicts between attributes supplied by the client.
1836 (2) 'client-error-attributes-or-values-not-supported' status code,
1837 otherwise.
1838
1839
1840
1841
1842
1843
1844 <span class="grey">Hastings &amp; Manros Informational [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1847
1848
1849 Note: Unsupported Operation attributes or values that are returned
1850 do not affect the status returned in this step. If the unsupported
1851 Operation attribute was a serious error, the above already rejected
1852 the request in a previous step. If control gets to this step with
1853 unsupported Operation attributes being returned, they are not serious
1854 errors.
1855
1856 <span class="h5"><a class="selflink" id="section-2.2.3.3" href="#section-2.2.3.3">2.2.3.3</a> For the Validate-Job operation, RETURN one of the success</span>
1857 <span class="h5"> status codes</span>
1858
1859 If the requested operation is the Validate-Job operation, the Printer
1860 object returns:
1861
1862 (1) the "successful-ok" status code, if there are no unsupported
1863 or conflicting Job Template attributes or values.
1864 (2) the "successful-ok-conflicting-attributes, if there are any
1865 conflicting Job Template attribute or values.
1866 (3) the "successful-ok-ignored-or-substituted-attributes, if there
1867 are only unsupported Job Template attributes or values.
1868
1869 Note: Unsupported Operation attributes or values that are returned
1870 do not affect the status returned in this step. If the unsupported
1871 Operation attribute was a serious error, the above already rejected
1872 the request in a previous step. If control gets to this step with
1873 unsupported Operation attributes being returned, they are not serious
1874 errors.
1875
1876 <span class="h5"><a class="selflink" id="section-2.2.3.4" href="#section-2.2.3.4">2.2.3.4</a> Create the Job object with attributes to support</span>
1877
1878 If "ipp-attribute-fidelity" is set to 'false' (or it was not supplied
1879 by the client), the Printer object:
1880
1881 (1) creates a Job object, assigns a unique value to the job's
1882 "job-uri" and "job-id" attributes, and initializes all of the
1883 job's other supported Job Description attributes.
1884 (2) removes all unsupported attributes from the Job object.
1885 (3) for each unsupported value, removes either the unsupported
1886 value or substitutes the unsupported attribute value with some
1887 supported value. If an attribute has no values after removing
1888 unsupported values from it, the attribute is removed from the
1889 Job object (so that the normal default behavior at job
1890 processing time will take place for that attribute).
1891 (4) for each conflicting value, removes either the conflicting
1892 value or substitutes the conflicting attribute value with some
1893 other supported value. If an attribute has no values after
1894 removing conflicting values from it, the attribute is removed
1895 from the Job object (so that the normal default behavior at
1896 job processing time will take place for that attribute).
1897
1898
1899
1900 <span class="grey">Hastings &amp; Manros Informational [Page 34]</span></pre>
1901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
1902 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1903
1904
1905 If there were no attributes or values flagged as unsupported, or the
1906 value of 'ipp-attribute-fidelity" was 'false', the Printer object is
1907 able to accept the create request and create a new Job object. If
1908 the "ipp-attribute-fidelity" attribute is set to 'true', the Job
1909 Template attributes that populate the new Job object are necessarily
1910 all the Job Template attributes supplied in the create request. If
1911 the "ipp-attribute-fidelity" attribute is set to 'false', the Job
1912 Template attributes that populate the new Job object are all the
1913 client supplied Job Template attributes that are supported or that
1914 have value substitution. Thus, some of the requested Job Template
1915 attributes may not appear in the Job object because the Printer
1916 object did not support those attributes. The attributes that
1917 populate the Job object are persistently stored with the Job object
1918 for that Job. A Get-Job-Attributes operation on that Job object will
1919 return only those attributes that are persistently stored with the
1920 Job object.
1921
1922 Note: All Job Template attributes that are persistently stored with
1923 the Job object are intended to be "override values"; that is, they
1924 that take precedence over whatever other embedded instructions might
1925 be in the document data itself. However, it is not possible for all
1926 Printer objects to realize the semantics of "override". End users
1927 may query the Printer's "pdl-override-supported" attribute to
1928 determine if the Printer either attempts or does not attempt to
1929 override document data instructions with IPP attributes.
1930
1931 There are some cases, where a Printer supports a Job Template
1932 attribute and has an associated default value set for that attribute.
1933 In the case where a client does not supply the corresponding
1934 attribute, the Printer does not use its default values to populate
1935 Job attributes when creating the new Job object; only Job Template
1936 attributes actually in the create request are used to populate the
1937 Job object. The Printer's default values are only used later at Job
1938 processing time if no other IPP attribute or instruction embedded in
1939 the document data is present.
1940
1941 Note: If the default values associated with Job Template attributes
1942 that the client did not supply were to be used to populate the Job
1943 object, then these values would become "override values" rather than
1944 defaults. If the Printer supports the 'attempted' value of the
1945 "pdl-override-supported" attribute, then these override values could
1946 replace values specified within the document data. This is not the
1947 intent of the default value mechanism. A default value for an
1948 attribute is used only if the create request did not specify that
1949 attribute (or it was ignored when allowed by "ipp-attribute-fidelity"
1950 being 'false') and no value was provided within the content of the
1951 document data.
1952
1953
1954
1955
1956 <span class="grey">Hastings &amp; Manros Informational [Page 35]</span></pre>
1957 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
1958 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
1959
1960
1961 If the client does not supply a value for some Job Template
1962 attribute, and the Printer does not support that attribute, as far as
1963 IPP is concerned, the result of processing that Job (with respect to
1964 the missing attribute) is undefined.
1965
1966 <span class="h5"><a class="selflink" id="section-2.2.3.5" href="#section-2.2.3.5">2.2.3.5</a> Return one of the success status codes</span>
1967
1968 Once the Job object has been created, the Printer object accepts the
1969 request and returns to the client:
1970
1971 (1) the 'successful-ok' status code, if there are no unsupported
1972 or conflicting Job Template attributes or values.
1973 (2) the 'successful-ok-conflicting-attributes' status code, if
1974 there are any conflicting Job Template attribute or values.
1975 (3) the 'successful-ok-ignored-or-substituted-attributes' status
1976 code, if there are only unsupported Job Template attributes or
1977 values.
1978
1979 Note: Unsupported Operation attributes or values that are returned
1980 do not affect the status returned in this step. If the unsupported
1981 Operation attribute was a serious error, the above already rejected
1982 the request in a previous step. If control gets to this step with
1983 unsupported Operation attributes being returned, they are not serious
1984 errors.
1985
1986 The Printer object also returns Job status attributes that indicate
1987 the initial state of the Job ('pending', 'pending-held', '
1988 processing', etc.), etc. See Print-Job Response, [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] <a href="#section-3.2.1.2">section</a>
1989 <a href="#section-3.2.1.2">3.2.1.2</a>.
1990
1991 <span class="h5"><a class="selflink" id="section-2.2.3.6" href="#section-2.2.3.6">2.2.3.6</a> Accept appended Document Content</span>
1992
1993 The Printer object accepts the appended Document Content data and
1994 either starts it printing, or spools it for later processing.
1995
1996 <span class="h5"><a class="selflink" id="section-2.2.3.7" href="#section-2.2.3.7">2.2.3.7</a> Scheduling and Starting to Process the Job</span>
1997
1998 The Printer object uses its own configuration and implementation
1999 specific algorithms for scheduling the Job in the correct processing
2000 order. Once the Printer object begins processing the Job, the
2001 Printer changes the Job's state to 'processing'. If the Printer
2002 object supports PDL override (the "pdl-override-supported" attribute
2003 set to 'attempted'), the implementation does its best to see that IPP
2004 attributes take precedence over embedded instructions in the document
2005 data.
2006
2007
2008
2009
2010
2011
2012 <span class="grey">Hastings &amp; Manros Informational [Page 36]</span></pre>
2013 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
2014 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2015
2016
2017 <span class="h5"><a class="selflink" id="section-2.2.3.8" href="#section-2.2.3.8">2.2.3.8</a> Completing the Job</span>
2018
2019 The Printer object continues to process the Job until it can move the
2020 Job into the 'completed' state. If an Cancel-Job operation is
2021 received, the implementation eventually moves the Job into the '
2022 canceled' state. If the system encounters errors during processing
2023 that do not allow it to progress the Job into a completed state, the
2024 implementation halts all processing, cleans up any resources, and
2025 moves the Job into the 'aborted' state.
2026
2027 <span class="h5"><a class="selflink" id="section-2.2.3.9" href="#section-2.2.3.9">2.2.3.9</a> Destroying the Job after completion</span>
2028
2029 Once the Job moves to the 'completed', 'aborted', or 'canceled'
2030 state, it is an implementation decision as to when to destroy the Job
2031 object and release all associated resources. Once the Job has been
2032 destroyed, the Printer would return either the "client-error-not-
2033 found" or "client-error-gone" status codes for operations directed at
2034 that Job.
2035
2036 Note: the Printer object SHOULD NOT re-use a "job-uri" or "job-id"
2037 value for a sufficiently long time after a job has been destroyed, so
2038 that stale references kept by clients are less likely to access the
2039 wrong (newer) job.
2040
2041 <span class="h5"><a class="selflink" id="section-2.2.3.10" href="#section-2.2.3.10">2.2.3.10</a> Interaction with "ipp-attribute-fidelity"</span>
2042
2043 Some Printer object implementations may support "ipp-attribute-
2044 fidelity" set to 'true' and "pdl-override-supported" set to '
2045 attempted' and yet still not be able to realize exactly what the
2046 client specifies in the create request. This is due to legacy
2047 decisions and assumptions that have been made about the role of job
2048 instructions embedded within the document data and external job
2049 instructions that accompany the document data and how to handle
2050 conflicts between such instructions. The inability to be 100%
2051 precise about how a given implementation will behave is also
2052 compounded by the fact that the two special attributes, "ipp-
2053 attribute-fidelity" and "pdl-override-supported", apply to the whole
2054 job rather than specific values for each attribute. For example, some
2055 implementations may be able to override almost all Job Template
2056 attributes except for "number-up".
2057
2058 <span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a> Status codes returned by operation</span>
2059
2060 This section lists all status codes once in the first operation
2061 (Print-Job). Then it lists the status codes that are different or
2062 specialized for subsequent operations under each operation.
2063
2064
2065
2066
2067
2068 <span class="grey">Hastings &amp; Manros Informational [Page 37]</span></pre>
2069 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
2070 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2071
2072
2073 <span class="h4"><a class="selflink" id="section-2.3.1" href="#section-2.3.1">2.3.1</a> Printer Operations</span>
2074
2075 <span class="h5"><a class="selflink" id="section-2.3.1.1" href="#section-2.3.1.1">2.3.1.1</a> Print-Job</span>
2076
2077 The Printer object MUST return one of the following "status-code"
2078 values for the indicated reason. Whether all of the document data
2079 has been accepted or not before returning the success or error
2080 response depends on implementation. See <a href="#section-14">Section 14</a> for a more
2081 complete description of each status code.
2082
2083 For the following success status codes, the Job object has been
2084 created and the "job-id", and "job-uri" assigned and returned in the
2085 response:
2086
2087 successful-ok: no request attributes were substituted or ignored.
2088 successful-ok-ignored-or-substituted-attributes: some supplied
2089 (1) attributes were ignored or (2) unsupported attribute
2090 syntaxes or values were substituted with supported values or
2091 were ignored. Unsupported attributes, attribute syntaxes, or
2092 values MUST be returned in the Unsupported Attributes group of
2093 the response.
2094 successful-ok-conflicting-attributes: some supplied attribute
2095 values conflicted with the values of other supplied attributes
2096 and were either substituted or ignored. Attributes or values
2097 which conflict with other attributes and have been substituted
2098 or ignored MUST be returned in the Unsupported Attributes group
2099 of the response as supplied by the client.
2100
2101 [<a id="ref-RFC2566">RFC2566</a>] <a href="#section-3.1.6">section 3.1.6</a> Operation Status Codes and Messages states:
2102
2103 If the Printer object supports the "status-message" operation
2104 attribute, it SHOULD use the REQUIRED 'utf-8' charset to return
2105 a status message for the following error status codes (see
2106 <a href="#section-14">section 14</a>): 'client-error-bad-request', 'client-error-
2107 charset-not-supported', 'server-error-internal-error', '
2108 server-error-operation-not-supported', and 'server-error-
2109 version-not-supported'. In this case, it MUST set the value of
2110 the "attributes-charset" operation attribute to 'utf-8' in the
2111 error response.
2112
2113 For the following error status codes, no job is created and no "job-
2114 id" or "job-uri" is returned:
2115
2116 client-error-bad-request: The request syntax does not conform to
2117 the specification.
2118
2119
2120
2121
2122
2123
2124 <span class="grey">Hastings &amp; Manros Informational [Page 38]</span></pre>
2125 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
2126 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2127
2128
2129 client-error-forbidden: The request is being refused for
2130 authorization or authentication reasons. The implementation
2131 security policy is to not reveal whether the failure is one of
2132 authentication or authorization.
2133 client-error-not-authenticated: Either the request requires
2134 authentication information to be supplied or the authentication
2135 information is not sufficient for authorization.
2136 client-error-not-authorized: The requester is not authorized to
2137 perform the request on the target object.
2138 client-error-not-possible: The request cannot be carried out
2139 because of the state of the system. See also 'server-error-
2140 not-accepting-jobs' status code which MUST take precedence if
2141 the Printer object's "printer-accepting-jobs" attribute is '
2142 false'.
2143 client-error-timeout: not applicable.
2144 client-error-not-found: the target object does not exist.
2145 client-error-gone: the target object no longer exists and no
2146 forwarding address is known.
2147 client-error-request-entity-too-large: the size of the request
2148 and/or print data exceeds the capacity of the IPP Printer to
2149 process it.
2150 client-error-request-value-too-long: the size of request variable
2151 length attribute values, such as 'text' and 'name' attribute
2152 syntaxes, exceed the maximum length specified in [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] for
2153 the attribute and MUST be returned in the Unsupported
2154 Attributes Group.
2155 client-error-document-format-not-supported: the document format
2156 supplied is not supported. The "document-format" attribute
2157 with the unsupported value MUST be returned in the Unsupported
2158 Attributes Group. This error SHOULD take precedence over any
2159 other 'xxx-not-supported' error, except 'client-error-charset-
2160 not-supported'.
2161 client-error-attributes-or-values-not-supported: one or more
2162 supplied attributes, attribute syntaxes, or values are not
2163 supported and the client supplied the "ipp-attributes-fidelity"
2164 operation attribute with a 'true' value. They MUST be returned
2165 in the Unsupported Attributes Group as explained below.
2166 client-error-uri-scheme-not-supported: not applicable.
2167 client-error-charset-not-supported: the charset supplied in the
2168 "attributes-charset" operation attribute is not supported. The
2169 Printer's "configured-charset" MUST be returned in the response
2170 as the value of the "attributes-charset" operation attribute
2171 and used for any 'text' and 'name' attributes returned in the
2172 error response. This error SHOULD take precedence over any
2173 other error, unless the request syntax is so bad that the
2174 client's supplied "attributes-charset" cannot be determined.
2175
2176
2177
2178
2179
2180 <span class="grey">Hastings &amp; Manros Informational [Page 39]</span></pre>
2181 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
2182 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2183
2184
2185 client-error-conflicting-attributes: one or more supplied
2186 attribute va attribute values conflicted with each other and
2187 the client supplied the "ipp-attributes-fidelity" operation
2188 attribute with a 'true' value. They MUST be returned in the
2189 Unsupported Attributes Group as explained below.
2190 server-error-internal-error: an unexpected condition prevents the
2191 request from being fulfilled.
2192 server-error-operation-not-supported: not applicable (since
2193 Print-Job is REQUIRED).
2194 server-error-service-unavailable: the service is temporarily
2195 overloaded.
2196 server-error-version-not-supported: the version in the request is
2197 not supported. The "closest" version number supported MUST be
2198 returned in the response.
2199 server-error-device-error: a device error occurred while
2200 receiving or spooling the request or document data or the IPP
2201 Printer object can only accept one job at a time.
2202 server-error-temporary-error: a temporary error such as a buffer
2203 full write error, a memory overflow, or a disk full condition
2204 occurred while receiving the request and/or the document data.
2205 server-error-not-accepting-jobs: the Printer object's "printer-
2206 is-not-accepting-jobs" attribute is 'false'.
2207 server-error-busy: the Printer is too busy processing jobs to
2208 accept another job at this time.
2209 server-error-job-canceled: the job has been canceled by an
2210 operator or the system while the client was transmitting the
2211 document data.
2212
2213 <span class="h5"><a class="selflink" id="section-2.3.1.2" href="#section-2.3.1.2">2.3.1.2</a> Print-URI</span>
2214
2215 All of the Print-Job status codes described in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2216 Print-Job Response are applicable to Print-URI with the following
2217 specializations and differences. See <a href="#section-14">Section 14</a> for a more complete
2218 description of each status code.
2219
2220 server-error-uri-scheme-not-supported: the URI scheme supplied in
2221 the "document-uri" operation attribute is not supported and is
2222 returned in the Unsupported Attributes group.
2223
2224 <span class="h5"><a class="selflink" id="section-2.3.1.3" href="#section-2.3.1.3">2.3.1.3</a> Validate-Job</span>
2225
2226 All of the Print-Job status codes described in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2227 Print-Job Response are applicable to Validate-Job. See <a href="#section-14">Section 14</a>
2228 for a more complete description of each status code.
2229
2230
2231
2232
2233
2234
2235
2236 <span class="grey">Hastings &amp; Manros Informational [Page 40]</span></pre>
2237 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
2238 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2239
2240
2241 <span class="h5"><a class="selflink" id="section-2.3.1.4" href="#section-2.3.1.4">2.3.1.4</a> Create-Job</span>
2242
2243 All of the Print-Job status codes described in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2244 Print-Job Response are applicable to Create-Job with the following
2245 specializations and differences. See <a href="#section-14">Section 14</a> for a more complete
2246 description of each status code.
2247
2248 server-error-operation-not-supported: the Create-Job operation is
2249 not supported.
2250
2251 <span class="h5"><a class="selflink" id="section-2.3.1.5" href="#section-2.3.1.5">2.3.1.5</a> Get-Printer-Attributes</span>
2252
2253 All of the Print-Job status codes described in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2254 Print-Job Response are applicable to the Get-Printer-Attributes
2255 operation with the following specializations and differences. See
2256 <a href="#section-14">Section 14</a> for a more complete description of each status code.
2257
2258 For the following success status codes, the requested attributes are
2259 returned in Group 3 in the response:
2260
2261 successful-ok: no request attributes were substituted or ignored
2262 (same as Print-Job) and no requested attributes were
2263 unsupported.
2264 successful-ok-ignored-or-substituted-attributes: same as Print-
2265 Job, except the "requested-attributes" operation attribute MAY,
2266 but NEED NOT, be returned with the unsupported values.
2267 successful-ok-conflicting-attributes: same as Print-Job.
2268
2269 For the error status codes, Group 3 is returned containing no
2270 attributes or is not returned at all:
2271
2272 client-error-not-possible: Same as Print-Job, in addition the
2273 Printer object is not accepting any requests.
2274 client-error-request-entity-too-large: same as Print-job, except
2275 that no print data is involved.
2276 client-error-attributes-or-values-not-supported: not applicable,
2277 since unsupported operation attributes MUST be ignored and '
2278 successful-ok-ignored-or-substituted-attributes' returned.
2279 client-error-conflicting-attributes: same as Print-Job, except
2280 that "ipp-attribute-fidelity" is not involved.
2281 server-error-operation-not-supported: not applicable (since Get-
2282 Printer-Attributes is REQUIRED).
2283 server-error-device-error: same as Print-Job, except that no
2284 document data is involved.
2285 server-error-temporary-error: same as Print-Job, except that no
2286 document data is involved.
2287 server-error-not-accepting-jobs: not applicable.
2288
2289
2290
2291
2292 <span class="grey">Hastings &amp; Manros Informational [Page 41]</span></pre>
2293 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
2294 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2295
2296
2297 server-error-busy: same as Print-Job, except the IPP object is
2298 too busy to accept even query requests.
2299 server-error-job-canceled: not applicable.
2300
2301 <span class="h5"><a class="selflink" id="section-2.3.1.6" href="#section-2.3.1.6">2.3.1.6</a> Get-Jobs</span>
2302
2303 All of the Print-Job status codes described in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2304 Print-Job Response are applicable to the Get-Jobs operation with the
2305 following specializations and differences. See <a href="#section-14">Section 14</a> for a
2306 more complete description of each status code.
2307
2308 For the following success status codes, the requested attributes are
2309 returned in Group 3 in the response:
2310
2311 successful-ok: no request attributes were substituted or ignored
2312 (same as Print-Job) and no requested attributes were
2313 unsupported.
2314 successful-ok-ignored-or-substituted-attributes: same as Print-
2315 Job, except the "requested-attributes" operation attribute MAY,
2316 but NEED NOT, be returned with the unsupported values.
2317 successful-ok-conflicting-attributes: same as Print-Job.
2318
2319 For any error status codes, Group 3 is returned containing no
2320 attributes or is not returned at all. The following brief error
2321 status code descriptions contain unique information for use with
2322 Get-Jobs operation. See <a href="#section-14">section 14</a> for the other error status codes
2323 that apply uniformly to all operations:
2324
2325 client-error-not-possible: Same as Print-Job, in addition the
2326 Printer object is not accepting any requests.
2327 client-error-request-entity-too-large: same as Print-job, except
2328 that no print data is involved.
2329 client-error-document-format-not-supported: not applicable.
2330 client-error-attributes-or-values-not-supported: not applicable,
2331 since unsupported operation attributes MUST be ignored and '
2332 successful-ok-ignored-or-substituted-attributes' returned.
2333 client-error-conflicting-attributes: same as Print-Job, except
2334 that "ipp-attribute-fidelity" is not involved.
2335 server-error-operation-not-supported: not applicable (since Get-
2336 Jobs is REQUIRED).
2337 server-error-device-error: same as Print-Job, except that no
2338 document data is involved.
2339 server-error-temporary-error: same as Print-Job, except that no
2340 document data is involved.
2341 server-error-not-accepting-jobs: not applicable.
2342 server-error-job-canceled: not applicable.
2343
2344
2345
2346
2347
2348 <span class="grey">Hastings &amp; Manros Informational [Page 42]</span></pre>
2349 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
2350 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2351
2352
2353 <span class="h4"><a class="selflink" id="section-2.3.2" href="#section-2.3.2">2.3.2</a> Job Operations</span>
2354
2355 <span class="h5"><a class="selflink" id="section-2.3.2.1" href="#section-2.3.2.1">2.3.2.1</a> Send-Document</span>
2356
2357 All of the Print-Job status codes described in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2358 Print-Job Response are applicable to the Get-Printer-Attributes
2359 operation with the following specializations and differences. See
2360 <a href="#section-14">Section 14</a> for a more complete description of each status code.
2361
2362 For the following success status codes, the document has been added
2363 to the specified Job object and the job's "number-of-documents"
2364 attribute has been incremented:
2365
2366 successful-ok: no request attributes were substituted or ignored
2367 (same as Print-Job).
2368 successful-ok-ignored-or-substituted-attributes: same as Print-
2369 Job.
2370 successful-ok-conflicting-attributes: same as Print-Job.
2371
2372 For the error status codes, no document has been added to the Job
2373 object and the job's "number-of-documents" attribute has not been
2374 incremented:
2375
2376 client-error-not-possible: Same as Print-Job, except that the
2377 Printer's "printer-is-accepting-jobs" attribute is not
2378 involved, so that the client is able to finish submitting a
2379 multi-document job after this attribute has been set to 'true'.
2380 Another condition is that the state of the job precludes Send-
2381 Document, i.e., the job has already been closed out by the
2382 client. However, if the IPP Printer closed out the job due to
2383 timeout, the 'client-error-timeout' error status SHOULD be
2384 returned instead.
2385 client-error-timeout: This request was sent after the Printer
2386 closed the job, because it has not received a Send-Document or
2387 Send-URI operation within the Printer's "multiple-operation-
2388 time-out" period.
2389 client-error-request-entity-too-large: same as Print-Job.
2390 client-error-conflicting-attributes: same as Print-Job, except
2391 that "ipp-attributes-fidelity" operation attribute is not
2392 involved.
2393 server-error-operation-not-supported: the Send-Document request
2394 is not supported.
2395 server-error-not-accepting-jobs: not applicable.
2396 server-error-job-canceled: the job has been canceled by an
2397 operator or the system while the client was transmitting the
2398 data.
2399
2400
2401
2402
2403
2404 <span class="grey">Hastings &amp; Manros Informational [Page 43]</span></pre>
2405 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
2406 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2407
2408
2409 <span class="h5"><a class="selflink" id="section-2.3.2.2" href="#section-2.3.2.2">2.3.2.2</a> Send-URI</span>
2410
2411 All of the Print-Job status code descriptions in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2412 Print-Job Response with the specializations described for Send-
2413 Document are applicable to Send-URI. See <a href="#section-14">Section 14</a> for a more
2414 complete description of each status code.
2415
2416 server-error-uri-scheme-not-supported: the URI scheme supplied in
2417 the "document-uri" operation attribute is not supported and the
2418 "document-uri" attribute MUST be returned in the Unsupported
2419 Attributes group.
2420
2421 <span class="h5"><a class="selflink" id="section-2.3.2.3" href="#section-2.3.2.3">2.3.2.3</a> Cancel-Job</span>
2422
2423 All of the Print-Job status codes described in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2424 Print-Job Response are applicable to Cancel-Job with the following
2425 specializations and differences. See <a href="#section-14">Section 14</a> for a more complete
2426 description of each status code.
2427
2428 For the following success status codes, the Job object is being
2429 canceled or has been canceled:
2430
2431 successful-ok: no request attributes were substituted or ignored
2432 (same as Print-Job).
2433 successful-ok-ignored-or-substituted-attributes: same as Print-
2434 Job.
2435 successful-ok-conflicting-attributes: same as Print-Job.
2436
2437 For any of the error status codes, the Job object has not been
2438 canceled or was previously canceled.
2439
2440 client-error-not-possible: The request cannot be carried out
2441 because of the state of the Job object ('completed', '
2442 canceled', or 'aborted') or the state of the system.
2443 client-error-not-found: the target Printer and/or Job object does
2444 not exist.
2445 client-error-gone: the target Printer and/or Job object no longer
2446 exists and no forwarding address is known.
2447 client-error-request-entity-too-large: same as Print-Job, except
2448 no document data is involved.
2449 client-error-document-format-not-supported: not applicable.
2450 client-error-attributes-or-values-not-supported: not applicable,
2451 since unsupported operation attributes and values MUST be
2452 ignored.
2453 client-error-conflicting-attributes: same as Print-Job, except
2454 that the Printer's "printer-is-accepting-jobs" attribute is not
2455 involved.
2456
2457
2458
2459
2460 <span class="grey">Hastings &amp; Manros Informational [Page 44]</span></pre>
2461 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
2462 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2463
2464
2465 server-error-operation-not-supported: not applicable (Cancel-Job
2466 is REQUIRED).
2467 server-error-device-error: same as Print-Job, except no document
2468 data is involved.
2469 server-error-temporary-error: same as Print-Job, except no
2470 document data is involved.
2471 server-error-not-accepting-jobs: not applicable.
2472 server-error-job-canceled: not applicable.
2473
2474 <span class="h5"><a class="selflink" id="section-2.3.2.4" href="#section-2.3.2.4">2.3.2.4</a> Get-Job-Attributes</span>
2475
2476 All of the Print-Job status codes described in <a href="#section-3.2.1.2">Section 3.2.1.2</a>
2477 Print-Job Response are applicable to Get-Job-Attributes with the
2478 following specializations and differences. See <a href="#section-14">Section 14</a> for a more
2479 complete description of each status code.
2480
2481 For the following success status codes, the requested attributes are
2482 returned in Group 3 in the response:
2483
2484 successful-ok: no request attributes were substituted or ignored
2485 (same as Print-Job) and no requested attributes were
2486 unsupported.
2487 successful-ok-ignored-or-substituted-attributes: same as Print-
2488 Job, except the "requested-attributes" operation attribute MAY,
2489 but NEED NOT, be returned with the unsupported values.
2490 successful-ok-conflicting-attributes: same as Print-Job.
2491
2492 For the error status codes, Group 3 is returned containing no
2493 attributes or is not returned at all.
2494
2495 client-error-not-possible: Same as Print-Job, in addition the
2496 Printer object is not accepting any requests.
2497 client-error-document-format-not-supported: not applicable.
2498 client-error-attributes-or-values-not-supported: not applicable.
2499 client-error-uri-scheme-not-supported: not applicable.
2500 client-error-conflicting-attributes: not applicable
2501 server-error-operation-not-supported: not applicable (since Get-
2502 Job-Attributes is REQUIRED).
2503 server-error-device-error: same as Print-Job, except no document
2504 data is involved.
2505 server-error-temporary-error: sane as Print-Job, except no
2506 document data is involved.
2507 server-error-not-accepting-jobs: not applicable. server-error-
2508 job-canceled: not applicable.
2509
2510
2511
2512
2513
2514
2515
2516 <span class="grey">Hastings &amp; Manros Informational [Page 45]</span></pre>
2517 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
2518 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2519
2520
2521 <span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a> Validate-Job</span>
2522
2523 The Validate-Job operation has been designed so that its
2524 implementation may be a part of the Print-Job operation. Therefore,
2525 requiring Validate-Job is not a burden on implementers. Also it is
2526 useful for client's to be able to count on its presence in all
2527 conformance implementations, so that the client can determine before
2528 sending a long document, whether the job will be accepted by the IPP
2529 Printer or not.
2530
2531 <span class="h3"><a class="selflink" id="section-2.5" href="#section-2.5">2.5</a> Case Sensitivity in URIs</span>
2532
2533 IPP client and server implementations must be aware of the diverse
2534 uppercase/lowercase nature of URIs. <a href="./rfc2396">RFC 2396</a> defines URL schemes and
2535 Host names as case insensitive but reminds us that the rest of the
2536 URL may well demonstrate case sensitivity. When creating URL's for
2537 fields where the choice is completely arbitrary, it is probably best
2538 to select lower case. However, this cannot be guaranteed and
2539 implementations MUST NOT rely on any fields being case-sensitive or
2540 case-insensitive in the URL beyond the URL scheme and host name
2541 fields.
2542
2543 The reason that the IPP specification does not make any restrictions
2544 on URIs, is so that implementations of IPP may use off-the-shelf
2545 components that conform to the standards that define URIs, such as
2546 <a href="./rfc2396">RFC 2396</a> and the HTTP/1.1 specifications [<a href="./rfc2068" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">RFC2068</a>]. See these
2547 specifications for rules of matching, comparison, and case-
2548 sensitivity.
2549
2550 It is also recommended that System Administrators and implementations
2551 avoid creating URLs for different printers that differ only in their
2552 case. For example, don't have Printer1 and printer1 as two different
2553 IPP Printers.
2554
2555 The HTTP/1.1 specification [<a href="./rfc2068" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">RFC2068</a>] contains more details on
2556 comparing URLs.
2557
2558 <span class="h3"><a class="selflink" id="section-2.6" href="#section-2.6">2.6</a> Character Sets, natural languages, and internationalization</span>
2559
2560 This section discusses character set support, natural language
2561 support and internationalization.
2562
2563 <span class="h4"><a class="selflink" id="section-2.6.1" href="#section-2.6.1">2.6.1</a> Character set code conversion support</span>
2564
2565 IPP clients and IPP objects are REQUIRED to support UTF-8. They MAY
2566 support additional charsets. It is RECOMMENDED that an IPP object
2567 also support US-ASCII, since many clients support US-ASCII, and
2568 indicate that UTF-8 and US-ASCII are supported by populating the
2569
2570
2571
2572 <span class="grey">Hastings &amp; Manros Informational [Page 46]</span></pre>
2573 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
2574 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2575
2576
2577 Printer's "charset-supported" with 'utf-8' and 'us-ascii' values. An
2578 IPP object is required to code covert with as little loss as possible
2579 between the charsets that it supports, as indicated in the Printer's
2580 "charsets-supported" attribute.
2581
2582 How should the server handle the situation where the "attributes-
2583 charset" of the response itself is "us-ascii", but one or more
2584 attributes in that response is in the "utf-8" format?
2585
2586 Example: Consider a case where a client sends a Print-Job request
2587 with "utf-8" as the value of "attributes-charset" and with the "job-
2588 name" attribute supplied. Later another client submits a Get-Job-
2589 Attribute or Get-Jobs request. This second request contains the
2590 "attributes-charset" with value "us-ascii" and "requested-attributes"
2591 attribute with exactly one value "job-name".
2592
2593 According to the <a href="./rfc2566">RFC2566</a> document (<a href="#section-3.1.4.2">section 3.1.4.2</a>), the value of the
2594 "attributes-charset" for the response of the second request must be
2595 "us-ascii" since that is the charset specified in the request. The
2596 "job-name" value, however, is in "utf-8" format. Should the request
2597 be rejected even though both "utf-8" and "us-ascii" charsets are
2598 supported by the server? or should the "job-name" value be converted
2599 to "us-ascii" and return "successful-ok-conflicting-attributes"
2600 (0x0002) as the status code?
2601
2602 Answer: An IPP object that supports both utf-8 (REQUIRED) and us-
2603 ascii, the second paragraph of <a href="#section-3.1.4.2">section 3.1.4.2</a> applies so that the
2604 IPP object MUST accept the request, perform code set conversion
2605 between these two charsets with "the highest fidelity possible" and
2606 return 'successful-ok', rather than a warning 'successful-ok-
2607 conflicting-attributes, or an error. The printer will do the best it
2608 can to convert between each of the character sets that it supports--
2609 even if that means providing a string of question marks because none
2610 of the characters are representable in US ASCII. If it can't perform
2611 such conversion, it MUST NOT advertise us-ascii as a value of its
2612 "attributes-charset-supported" and MUST reject any request that
2613 requests 'us-ascii'.
2614
2615 One IPP object implementation strategy is to convert all request text
2616 and name values to a Unicode internal representation. This is 16-bit
2617 and virtually universal. Then convert to the specified operation
2618 attributes-charset on output.
2619
2620 Also it would be smarter for a client to ask for 'utf-8', rather than
2621 'us-ascii' and throw away characters that it doesn't understand,
2622 rather than depending on the code conversion of the IPP object.
2623
2624
2625
2626
2627
2628 <span class="grey">Hastings &amp; Manros Informational [Page 47]</span></pre>
2629 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
2630 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2631
2632
2633 <span class="h4"><a class="selflink" id="section-2.6.2" href="#section-2.6.2">2.6.2</a> What charset to return when an unsupported charset is requested?</span>
2634
2635 <a href="#section-3.1.4.1">Section 3.1.4.1</a> Request Operation attributes was clarified in
2636 November 1998 as follows:
2637
2638 All clients and IPP objects MUST support the 'utf-8' charset
2639 [<a href="./rfc2044">RFC2044</a>] and MAY support additional charsets provided that they
2640 are registered with IANA [IANA-CS]. If the Printer object does
2641 not support the client supplied charset value, the Printer object
2642 MUST reject the request, set the "attributes-charset" to 'utf-8'
2643 in the response, and return the 'client-error-charset-not-
2644 supported' status code and any 'text' or 'name' attributes using
2645 the 'utf-8' charset.
2646
2647 Since the client and IPP object MUST support UTF-8, returning any
2648 text or name attributes in UTF-8 when the client requests a charset
2649 that is not supported should allow the client to display the text or
2650 name.
2651
2652 Since such an error is a client error, rather than a user error, the
2653 client should check the status code first so that it can avoid
2654 displaying any other returned 'text' and 'name' attributes that are
2655 not in the charset requested.
2656
2657 Furthermore, <a href="./rfc2566#section-14.1.4.14">[RFC2566] section&nbsp;14.1.4.14</a> client-error-charset-not-
2658 supported (0x040D) was clarified in November 1998 as follows:
2659
2660 For any operation, if the IPP Printer does not support the charset
2661 supplied by the client in the "attributes-charset" operation
2662 attribute, the Printer MUST reject the operation and return this
2663 status and any 'text' or 'name' attributes using the 'utf-8'
2664 charset (see <a href="#section-3.1.4.1">Section 3.1.4.1</a>).
2665
2666 <span class="h4"><a class="selflink" id="section-2.6.3" href="#section-2.6.3">2.6.3</a> Natural Language Override (NLO)</span>
2667
2668 The 'text' and 'name' attributes each have two forms. One has an
2669 implicit natural language, and the other has an explicit natural
2670 language. The 'textWithoutLanguage' and 'textWithoutLanguage' are
2671 the two 'text' forms. The 'nameWithoutLanguage" and '
2672 nameWithLanguage are the two 'name' forms. If a receiver (IPP object
2673 or IPP client) supports an attribute with attribute syntax 'text', it
2674 MUST support both forms in a request and a response. A sender (IPP
2675 client or IPP object) MAY send either form for any such attribute.
2676 When a sender sends a WithoutLanguage form, the implicit natural
2677 language is specified in the "attributes-natural-language" operation
2678 attribute which all senders MUST include in every request and
2679 response.
2680
2681
2682
2683
2684 <span class="grey">Hastings &amp; Manros Informational [Page 48]</span></pre>
2685 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
2686 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2687
2688
2689 When a sender sends a WithLanguage form, it MAY be different from the
2690 implicit natural language supplied by the sender or it MAY be the
2691 same. The receiver MUST treat either form equivalently.
2692
2693 There is an implementation decision for senders, whether to always
2694 send the WithLanguage forms or use the WithoutLanguage form when the
2695 attribute's natural language is the same as the request or response.
2696 The former approach makes the sender implementation simpler. The
2697 latter approach is more efficient on the wire and allows inter-
2698 working with non-conforming receivers that fail to support the
2699 WithLanguage forms. As each approach have advantages, the choice is
2700 completely up to the implementer of the sender.
2701
2702 Furthermore, when a client receives a 'text' or 'name' job attribute
2703 that it had previously supplied, that client MUST NOT expect to see
2704 the attribute in the same form, i.e., in the same WithoutLanguage or
2705 WithLanguage form as the client supplied when it created the job.
2706 The IPP object is free to transform the attribute from the
2707 WithLanguage form to the WithoutLanguage form and vice versa, as long
2708 as the natural language is preserved. However, in order to meet this
2709 latter requirement, it is usually simpler for the IPP object
2710 implementation to store the natural language explicitly with the
2711 attribute value, i.e., to store using an internal representation that
2712 resembles the WithLanguage form.
2713
2714 The IPP Printer MUST copy the natural language of a job, i.e., the
2715 value of the "attributes-natural-language" operation attribute
2716 supplied by the client in the create operation, to the Job object as
2717 a Job Description attribute, so that a client is able to query it.
2718 In returning a Get-Job-Attributes response, the IPP object MAY return
2719 one of three natural language values in the response's "attributes-
2720 natural-language" operation attribute: (1) that requested by the
2721 requester, (2) the natural language of the job, or (3) the configured
2722 natural language of the IPP Printer, if the requested language is not
2723 supported by the IPP Printer.
2724
2725 This "attributes-natural-language" Job Description attribute is
2726 useful for an IPP object implementation that prints start sheets in
2727 the language of the user who submitted the job. This same Job
2728 Description attribute is useful to a multi-lingual operator who has
2729 to communicate with different job submitters in different natural
2730 languages. This same Job Description attribute is expected to be
2731 used in the future to generate notification messages in the natural
2732 language of the job submitter.
2733
2734 Early drafts of [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] contained a job-level natural language
2735 override (NLO) for the Get-Jobs response. A job-level (NLO) is an
2736 (unrequested) Job Attribute which then specified the implicit natural
2737
2738
2739
2740 <span class="grey">Hastings &amp; Manros Informational [Page 49]</span></pre>
2741 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
2742 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2743
2744
2745 language for any other WithoutLanguage job attributes returned in the
2746 response for that job. Interoperability testing of early
2747 implementations showed that no one was implementing the job-level NLO
2748 in Get-Job responses. So the job-level NLO was eliminated from the
2749 Get- Jobs response. This simplification makes all requests and
2750 responses consistent in that the implicit natural language for any
2751 WithoutLanguage 'text' or 'name' form is always supplied in the
2752 request's or response's "attributes-natural-language" operation
2753 attribute.
2754
2755 <span class="h3"><a class="selflink" id="section-2.7" href="#section-2.7">2.7</a> The "queued-job-count" Printer Description attribute</span>
2756
2757 <span class="h4"><a class="selflink" id="section-2.7.1" href="#section-2.7.1">2.7.1</a> Why is "queued-job-count" RECOMMENDED?</span>
2758
2759 The reason that "queued-job-count" is RECOMMENDED, is that some
2760 clients look at that attribute alone when summarizing the status of a
2761 list of printers, instead of doing a Get-Jobs to determine the number
2762 of jobs in the queue. Implementations that fail to support the
2763 "queued-job-count" will cause that client to display 0 jobs when
2764 there are actually queued jobs.
2765
2766 We would have made it a REQUIRED Printer attribute, but some
2767 implementations had already been completed before the issue was
2768 raised, so making it a SHOULD was a compromise.
2769
2770 <span class="h4"><a class="selflink" id="section-2.7.2" href="#section-2.7.2">2.7.2</a> Is "queued-job-count" a good measure of how busy a printer is?</span>
2771
2772 The "queued-job-count" is not a good measure of how busy the printer
2773 is when there are held jobs. A future registration could be to add a
2774 "held-job-count" (or an "active-job-count") Printer Description
2775 attribute if experience shows that such an attribute (combination) is
2776 needed to quickly indicate how busy a printer really is.
2777
2778 <span class="h3"><a class="selflink" id="section-2.8" href="#section-2.8">2.8</a> Sending empty attribute groups</span>
2779
2780 The [<a href="./rfc2566" title="&quot;Internet Printing Protocol/1.0: Model and Semantics&quot;">RFC2566</a>] and [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] specifications RECOMMEND that a sender
2781 not send an empty attribute group in a request or a response.
2782 However, they REQUIRE a receiver to accept an empty attribute group
2783 as equivalent to the omission of that group. So a client SHOULD omit
2784 the Job Template Attributes group entirely in a create operation that
2785 is not supplying any Job Template attributes. Similarly, an IPP
2786 object SHOULD omit an empty Unsupported Attributes group if there are
2787 no unsupported attributes to be returned in a response.
2788
2789
2790
2791
2792
2793
2794
2795
2796 <span class="grey">Hastings &amp; Manros Informational [Page 50]</span></pre>
2797 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
2798 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2799
2800
2801 The [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] specification REQUIRES a receiver to be able to receive
2802 either an empty attribute group or an omitted attribute group and
2803 treat them equivalently. The term "receiver" means an IPP object for
2804 a request and a client for a response. The term "sender' means a
2805 client for a request and an IPP object for a response.
2806
2807 There is an exception to the rule for Get-Jobs when there are no
2808 attributes to be returned. [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] contains the following
2809 paragraph:
2810
2811 The syntax allows an xxx-attributes-tag to be present when the
2812 xxx-attribute-sequence that follows is empty. The syntax is
2813 defined this way to allow for the response of Get-Jobs where no
2814 attributes are returned for some job-objects. Although it is
2815 RECOMMENDED that the sender not send an xxx-attributes-tag if
2816 there are no attributes (except in the Get-Jobs response just
2817 mentioned), the receiver MUST be able to decode such syntax.
2818
2819 <span class="h3"><a class="selflink" id="section-2.9" href="#section-2.9">2.9</a> Returning unsupported attributes in Get-Xxxx responses</span>
2820
2821 In the Get-Printer-Attributes, Get-Jobs, or Get-Job-Attributes
2822 responses, the client cannot depend on getting unsupported attributes
2823 returned in the Unsupported Attributes group that the client
2824 requested, but are not supported by the IPP object. However, such
2825 unsupported requested attributes will not be returned in the Job
2826 Attributes or Printer Attributes group (since they are unsupported).
2827 Furthermore, the IPP object is REQUIRED to return the 'successful-
2828 ok-ignored-or-substituted-attributes' status code, so that the client
2829 knows that not all that was requested has been returned.
2830
2831 <span class="h3"><a class="selflink" id="section-2.10" href="#section-2.10">2.10</a> Returning job-state in Print-Job response</span>
2832
2833 An IPP client submits a small job via Print-Job. By the time the IPP
2834 printer/print server is putting together a response to the operation,
2835 the job has finished printing and been removed as an object from the
2836 print system. What should the job-state be in the response?
2837
2838 The Model suggests that the Printer return a response before it even
2839 accepts the document content. The Job Object Attributes are returned
2840 only if the IPP object returns one of the success status codes. Then
2841 the job-state would always be "pending" or "pending-held".
2842
2843 This issue comes up for the implementation of an IPP Printer object
2844 as a server that forwards jobs to devices that do not provide job
2845 status back to the server. If the server is reasonably certain that
2846 the job completed successfully, then it should return the job-state
2847 as 'completed'. Also the server can keep the job in its "job
2848 history" long after the job is no longer in the device. Then a user
2849
2850
2851
2852 <span class="grey">Hastings &amp; Manros Informational [Page 51]</span></pre>
2853 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
2854 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2855
2856
2857 could query the server and see that the job was in the 'completed'
2858 state and completed as specified by the job's "time-at-completed"
2859 time which would be the same as the server submitted the job to the
2860 device.
2861
2862 An alternative is for the server to respond to the client before or
2863 while sending the job to the device, instead of waiting until the
2864 server has finished sending the job to the device. In this case, the
2865 server can return the job's state as 'pending' with the 'job-
2866 outgoing' value in the job's "job-state-reasons" attribute.
2867
2868 If the server doesn't know for sure whether the job completed
2869 successfully (or at all), it could return the (out-of-band) 'unknown'
2870 value.
2871
2872 On the other hand, if the server is able to query the device and/or
2873 setup some sort of event notification that the device initiates when
2874 the job makes state transitions, then the server can return the
2875 current job state in the Print-Job response and in subsequent queries
2876 because the server knows what the job state is in the device (or can
2877 query the device).
2878
2879 All of these alternatives depend on implementation of the server and
2880 the device.
2881
2882 <span class="h3"><a class="selflink" id="section-2.11" href="#section-2.11">2.11</a> Flow controlling the data portion of a Print-Job request</span>
2883
2884 A paused printer (or one that is stopped due to paper out or jam or
2885 spool space full or buffer space full, may flow control the data of a
2886 Print-Job operation (at the TCP/IP layer), so that the client is not
2887 able to send all the document data. Consequently, the Printer will
2888 not return a response until the condition is changed.
2889
2890 The Printer should not return a Print-Job response with an error code
2891 in any of these conditions, since either the printer will be resumed
2892 and/or the condition will be freed either by human intervention or as
2893 jobs print.
2894
2895 In writing test scripts to test IPP Printers, the script must also be
2896 written not to expect a response, if the printer has been paused,
2897 until the printer is resumed, in order to work with all possible
2898 implementations.
2899
2900 <span class="h3"><a class="selflink" id="section-2.12" href="#section-2.12">2.12</a> Multi-valued attributes</span>
2901
2902 What is the attribute syntax for a multi-valued attribute? Since
2903 some attributes support values in more than one data type, such as
2904 "media", "job-hold-until", and "job-sheets", IPP semantics associate
2905
2906
2907
2908 <span class="grey">Hastings &amp; Manros Informational [Page 52]</span></pre>
2909 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
2910 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2911
2912
2913 the attribute syntax with each value, not with the attribute as a
2914 whole. The protocol associates the attribute syntax tag with each
2915 value. Don't be fooled, just because the attribute syntax tag comes
2916 before the attribute keyword. All attribute values after the first
2917 have a zero length attribute keyword as the indication of a
2918 subsequent value of the same attribute.
2919
2920 <span class="h3"><a class="selflink" id="section-2.13" href="#section-2.13">2.13</a> Querying jobs with IPP that were submitted using other job</span>
2921 <span class="h3"> submission protocols</span>
2922
2923 The following clarification was added to <a href="./rfc2566#section-8.5">[RFC2566] section&nbsp;8.5</a>:
2924
2925 8.5 Queries on jobs submitted using non-IPP protocols
2926
2927 If the device that an IPP Printer is representing is able to
2928 accept jobs using other job submission protocols in addition to
2929 IPP, it is RECOMMEND that such an implementation at least allow
2930 such "foreign" jobs to be queried using Get-Jobs returning "job-
2931 id" and "job-uri" as 'unknown'. Such an implementation NEED NOT
2932 support all of the same IPP job attributes as for IPP jobs. The
2933 IPP object returns the 'unknown' out-of-band value for any
2934 requested attribute of a foreign job that is supported for IPP
2935 jobs, but not for foreign jobs.
2936
2937 It is further RECOMMENDED, that the IPP Printer generate "job-id"
2938 and "job-uri" values for such "foreign jobs", if possible, so that
2939 they may be targets of other IPP operations, such as Get-Job-
2940 Attributes and Cancel-Job. Such an implementation also needs to
2941 deal with the problem of authentication of such foreign jobs. One
2942 approach would be to treat all such foreign jobs as belonging to
2943 users other than the user of the IPP client. Another approach
2944 would be for the foreign job to belong to 'anonymous'. Only if
2945 the IPP client has been authenticated as an operator or
2946 administrator of the IPP Printer object, could the foreign jobs be
2947 queried by an IPP request. Alternatively, if the security policy
2948 is to allow users to query other users' jobs, then the foreign
2949 jobs would also be visible to an end-user IPP client using Get-
2950 Jobs and Get-Job-Attributes.
2951
2952 Thus IPP MAY be implemented as a "universal" protocol that provides
2953 access to jobs submitted with any job submission protocol. As IPP
2954 becomes widely implemented, providing a more universal access makes
2955 sense.
2956
2957
2958
2959
2960
2961
2962
2963
2964 <span class="grey">Hastings &amp; Manros Informational [Page 53]</span></pre>
2965 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
2966 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
2967
2968
2969 <span class="h3"><a class="selflink" id="section-2.14" href="#section-2.14">2.14</a> The 'none' value for empty sets</span>
2970
2971 [<a id="ref-RFC2566">RFC2566</a>] states that the 'none' value should be used as the value of
2972 a 1SetOf when the set is empty. In most cases, sets that are
2973 potentially empty contain keywords so the keyword 'none' is used, but
2974 for the 3 finishings attributes, the values are enums and thus the
2975 empty set is represented by the enum 3. Currently there are no other
2976 attributes with 1SetOf values which can be empty and can contain
2977 values that are not keywords. This exception requires special code
2978 and is a potential place for bugs. It would have been better if we
2979 had chosen an out-of-band value, either "no-value" or some new value,
2980 such as 'none'. Since we didn't, implementations have to deal with
2981 the different representations of 'none', depending on the attribute
2982 syntax.
2983
2984 <span class="h3"><a class="selflink" id="section-2.15" href="#section-2.15">2.15</a> Get-Jobs, my-jobs='true', and 'requesting-user-name'?</span>
2985
2986 In <a href="./rfc2566#section-3.2.6.1">[RFC2566] section&nbsp;3.2.6.1</a> 'Get-Jobs Request', if the attribute '
2987 my-jobs' is present and set to TRUE, MUST the 'requesting-user-name'
2988 attribute be there to, and if it's not present what should the IPP
2989 printer do?
2990
2991 [<a id="ref-RFC2566">RFC2566</a>] <a href="#section-8.3">Section 8.3</a> describes the various cases of "requesting-
2992 user-name" being present or not for any operation. If the client
2993 does not supply a value for "requesting-user-name", the printer MUST
2994 assume that the client is supplying some anonymous name, such as
2995 "anonymous".
2996
2997 <span class="h3"><a class="selflink" id="section-2.16" href="#section-2.16">2.16</a> The "multiple-document-handling" Job Template attribute and support</span>
2998 <span class="h3"> of multiple document jobs</span>
2999
3000 ISSUE: IPP/1.0 is silent on which of the four effects an
3001 implementation would perform if it supports Create-Job, but does not
3002 support "multiple-document-handling".
3003
3004 A fix to IPP/1.0 would be to require implementing all four values of
3005 "multiple-document-handling" if Create-Job is supported at all. Or
3006 at least 'single-document-new-sheet' and 'separate-documents-
3007 uncollated-copies'. In any case, an implementation that supports
3008 Create-Job SHOULD also support "multiple-document-handling". Support
3009 for all four values is RECOMMENDED, but at least the 'single-
3010 document-new-sheet' and 'separate-documents-uncollated-copies'
3011 values, along with the "multiple-document-handling-default"
3012 indicating the default behavior and "multiple-document-handling-
3013 supported" values. If an implementation spools the data, it should
3014 also support the 'separate-documents-collated-copies' value as well.
3015
3016
3017
3018
3019
3020 <span class="grey">Hastings &amp; Manros Informational [Page 54]</span></pre>
3021 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
3022 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3023
3024
3025 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a> Encoding and Transport</span>
3026
3027 This section discusses various aspects of IPP/1.0 Encoding and
3028 Transport [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>].
3029
3030 A server is not required to send a response until after it has
3031 received the client.s entire request. Hence, a client must not
3032 expect a response until after it has sent the entire request.
3033 However, we recommend that the server return a response as soon as
3034 possible if an error is detected while the client is still sending
3035 the data, rather than waiting until all of the data is received.
3036 Therefore, we also recommend that a client listen for an error
3037 response that an IPP server MAY send before it receives all the data.
3038 In this case a client, if chunking the data, can send a premature
3039 zero-length chunk to end the request before sending all the data (and
3040 so the client can keep the connection open for other requests, rather
3041 than closing it). If the request is blocked for some reason, a client
3042 MAY determine the reason by opening another connection to query the
3043 server using Get-Printer-Attributes.
3044
3045 In the following sections, there are a tables of all HTTP headers
3046 which describe their use in an IPP client or server. The following
3047 is an explanation of each column in these tables.
3048
3049 - the .header. column contains the name of a header.
3050 - the .request/client. column indicates whether a client sends the
3051 header.
3052 - the .request/ server. column indicates whether a server supports
3053 the header when received.
3054 - the .response/ server. column indicates whether a server sends
3055 the header.
3056 - the .response /client. column indicates whether a client
3057 supports the header when received.
3058 - the .values and conditions. column specifies the allowed header
3059 values and the conditions for the header to be present in a
3060 request/response.
3061
3062 The table for .request headers. does not have columns for responses,
3063 and the table for .response headers. does not have columns for
3064 requests.
3065
3066 The following is an explanation of the values in the .request/client.
3067 and .response/ server. columns.
3068
3069 - must: the client or server MUST send the header,
3070 - must-if: the client or server MUST send the header when the
3071 condition described in the .values and conditions. column is
3072 met,
3073
3074
3075
3076 <span class="grey">Hastings &amp; Manros Informational [Page 55]</span></pre>
3077 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
3078 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3079
3080
3081 - may: the client or server MAY send the header
3082 - not: the client or server SHOULD NOT send the header. It is not
3083 relevant to an IPP implementation.
3084
3085 The following is an explanation of the values in the
3086 .response/client. and .request/ server. columns.
3087
3088 - must: the client or server MUST support the header,
3089 - may: the client or server MAY support the header
3090 - not: the client or server SHOULD NOT support the header. It is
3091 not relevant to an IPP implementation.
3092
3093 <span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a> General Headers</span>
3094
3095
3096 The following is a table for the general headers.
3097
3098
3099 General- Request Response Values and Conditions
3100 Header
3101
3102 Client Server Server Client
3103
3104 Cache- must not must not .no-cache. only
3105 Control
3106
3107 Connection must-if must must- must .close. only. Both
3108 if client and server
3109 SHOULD keep a
3110 connection for the
3111 duration of a sequence
3112 of operations. The
3113 client and server MUST
3114 include this header
3115 for the last operation
3116 in such a sequence.
3117
3118 Date may may must may per <a href="./rfc1123">RFC 1123</a> [<a href="./rfc1123" title="&quot;Requirements for Internet Hosts - Application and Support&quot;">RFC1123</a>]
3119 from <a href="./rfc2068">RFC 2068</a>
3120 [<a href="./rfc2068" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">RFC2068</a>]
3121
3122 Pragma must not must not .no-cache. only
3123
3124 Transfer- must-if must must- must .chunked. only .
3125 Encoding if Header MUST be present
3126 if Content-Length is
3127 absent.
3128
3129
3130
3131
3132 <span class="grey">Hastings &amp; Manros Informational [Page 56]</span></pre>
3133 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
3134 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3135
3136
3137 Upgrade not not not not
3138
3139 Via not not not not
3140
3141 <span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a> Request </span>Headers
3142
3143
3144 The following is a table for the request headers.
3145
3146
3147 Request-Header Client Server Request Values and Conditions
3148
3149 Accept may must .application/ipp. only. This
3150 value is the default if the
3151
3152 Request-Header Client Server Request Values and Conditions
3153
3154 client omits it
3155
3156 Accept-Charset not not Charset information is within
3157 the application/ipp entity
3158
3159 Accept-Encoding may must empty and per <a href="./rfc2068">RFC 2068</a> [<a href="./rfc2068" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">RFC2068</a>]
3160 and IANA registry for content-
3161 codings
3162
3163 Accept-Language not not language information is within
3164 the application/ipp entity
3165
3166 Authorization must-if must per <a href="./rfc2068">RFC 2068</a>. A client MUST send
3167 this header when it receives a
3168 401 .Unauthorized. response and
3169 does not receive a .Proxy-
3170 Authenticate. header.
3171
3172 From not not per <a href="./rfc2068">RFC 2068</a>. Because RFC
3173 recommends sending this header
3174 only with the user.s approval, it
3175 is not very useful
3176
3177 Host must must per <a href="./rfc2068">RFC 2068</a>
3178
3179 If-Match not not
3180
3181 If-Modified- not not
3182 Since
3183
3184 If-None-Match not not
3185
3186
3187
3188 <span class="grey">Hastings &amp; Manros Informational [Page 57]</span></pre>
3189 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
3190 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3191
3192
3193 If-Range not not
3194
3195 If-Unmodified- not not
3196 Since
3197
3198 Max-Forwards not not
3199
3200 Proxy- must-if not per <a href="./rfc2068">RFC 2068</a>. A client MUST send
3201 Authorization this header when it receives a
3202 401 .Unauthorized. response and a
3203 .Proxy-Authenticate. header.
3204
3205 Range not not
3206
3207 Referer not not
3208
3209 User-Agent not not
3210
3211
3212 <span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a> Response Headers</span>
3213
3214
3215 The following is a table for the request headers.
3216
3217
3218 Response- Server Client Response Values and Conditions
3219 Header
3220
3221 Accept-Ranges not not
3222
3223 Age not not
3224
3225 Location must-if may per <a href="./rfc2068">RFC 2068</a>. When URI needs
3226 redirection.
3227
3228 Proxy- not must per <a href="./rfc2068">RFC 2068</a>
3229 Authenticate
3230
3231 Public may may per <a href="./rfc2068">RFC 2068</a>
3232
3233 Retry-After may may per <a href="./rfc2068">RFC 2068</a>
3234
3235 Server not not
3236
3237 Vary not not
3238
3239 Warning may may per <a href="./rfc2068">RFC 2068</a>
3240
3241
3242
3243
3244 <span class="grey">Hastings &amp; Manros Informational [Page 58]</span></pre>
3245 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
3246 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3247
3248
3249 WWW- must-if must per <a href="./rfc2068">RFC 2068</a>. When a server needs to
3250 Authenticate authenticate a client.
3251
3252 <span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a> Entity </span>Headers
3253
3254
3255 The following is a table for the entity headers.
3256
3257
3258 Entity-Header Request Response Values and Conditions
3259
3260 Client Server Server Client
3261
3262 Allow not not not not
3263
3264 Content-Base not not not not
3265
3266 Content- may must must must per <a href="./rfc2068">RFC 2068</a> and IANA
3267 Encoding registry for content
3268 codings.
3269
3270 Content- not not not not Application/ipp
3271 Language handles language
3272
3273 Content- must-if must must-if must the length of the
3274 Length message-body per <a href="./rfc2068">RFC</a>
3275 <a href="./rfc2068">2068</a>. Header MUST be
3276 present if Transfer-
3277
3278 Entity-Header Request Response Values and Conditions
3279
3280 Client Server Server Client
3281
3282 Encoding is absent.
3283
3284 Content- not not not not
3285 Location
3286
3287 Content-MD5 may may may may per <a href="./rfc2068">RFC 2068</a>
3288
3289 Content-Range not not not not
3290
3291 Content-Type must must must must .application/ipp.
3292 only
3293
3294 ETag not not not not
3295
3296 Expires not not not not
3297
3298
3299
3300 <span class="grey">Hastings &amp; Manros Informational [Page 59]</span></pre>
3301 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
3302 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3303
3304
3305 Last-Modified not not not not
3306
3307
3308 <span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a> Optional support for HTTP/1.0</span>
3309
3310 IPP implementations consist of an HTTP layer and an IPP layer. In
3311 the following discussion, the term "client" refers to the HTTP client
3312 layer and the term "server" refers to the HTTP server layer. The
3313 Encoding and Transport document [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] requires that HTTP 1.1 MUST
3314 be supported by all clients and all servers. However, a client
3315 and/or a server implementation may choose to also support HTTP 1.0.
3316
3317 - This option means that a server may choose to communicate with a
3318 (non-conforming) client that only supports HTTP 1.0. In such cases
3319 the server should not use any HTTP 1.1 specific parameters or
3320 features and should respond using HTTP version number 1.0.
3321
3322 - This option also means that a client may choose to communicate with
3323 a (non-conforming) server that only supports HTTP 1.0. In such
3324 cases, if the server responds with an HTTP .unsupported version
3325 number. to an HTTP 1.1 request, the client should retry using HTTP
3326 version number 1.0.
3327
3328 <span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a> HTTP/1.1 Chunking</span>
3329
3330 <span class="h4"><a class="selflink" id="section-3.6.1" href="#section-3.6.1">3.6.1</a> Disabling IPP Server Response Chunking</span>
3331
3332 Clients MUST anticipate that the HTTP/1.1 server may chunk responses
3333 and MUST accept them in responses. However, a (non-conforming) HTTP
3334 client that is unable to accept chunked responses may attempt to
3335 request an HTTP 1.1 server not to use chunking in its response to an
3336 operation by using the following HTTP header:
3337
3338 TE: identity
3339
3340 This mechanism should not be used by a server to disable a client
3341 from chunking a request, since chunking of document data is an
3342 important feature for clients to send long documents.
3343
3344 <span class="h4"><a class="selflink" id="section-3.6.2" href="#section-3.6.2">3.6.2</a> Warning About the Support of Chunked Requests</span>
3345
3346 This section describes some problems with the use of chunked requests
3347 and HTTP/1.1 servers.
3348
3349 The HTTP/1.1 standard [<a href="#ref-HTTP" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">HTTP</a>] requires that conforming servers support
3350 chunked requests for any method. However, in spite of this
3351 requirement, some HTTP/1.1 implementations support chunked responses
3352 in the GET method, but do not support chunked POST method requests.
3353
3354
3355
3356 <span class="grey">Hastings &amp; Manros Informational [Page 60]</span></pre>
3357 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
3358 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3359
3360
3361 Some HTTP/1.1 implementations that support CGI scripts [<a href="#ref-CGI" title="&quot;The WWW Common Gateway Interface Version 1.1 (CGI/1.1)&quot;">CGI</a>] and/or
3362 servlets [<a href="#ref-Servlet">Servlet</a>] require that the client supply a Content-Length.
3363 These implementations might reject a chunked POST method and return a
3364 411 status code (Length Required), might attempt to buffer the
3365 request and run out of room returning a 413 status code (Request
3366 Entity Too Large), or might successfully accept the chunked request.
3367
3368 Because of this lack of conformance of HTTP servers to the HTTP/1.1
3369 standard, the IPP standard [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] REQUIRES that a conforming IPP
3370 Printer object implementation support chunked requests and that
3371 conforming clients accept chunked responses. Therefore, IPP object
3372 implementers are warned to seek HTTP server implementations that
3373 support chunked POST requests in order to conform to the IPP standard
3374 and/or use implementation techniques that support chunked POST
3375 requests.
3376
3377 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a> References</span>
3378
3379 [<a id="ref-CGI">CGI</a>] Coar, K. and D. Robinson, "The WWW Common Gateway Interface
3380 Version 1.1 (CGI/1.1)", Work in Progress.
3381
3382 [<a id="ref-HTTP">HTTP</a>] Fielding, R., Gettys,J., Mogul, J., Frystyk,, H., Masinter,
3383 L., Leach, P. and T. Berners-Lee, "Hypertext Transfer
3384 Protocol -- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.
3385
3386 [<a id="ref-RFC2569">RFC2569</a>] Herriot, R., Hastings, T., Jacobs, N. and J. Martin,
3387 "Mapping between LPD and IPP Protocols", <a href="./rfc2569">RFC 2569</a>, April
3388 1999.
3389
3390 [<a id="ref-RFC2566">RFC2566</a>] deBry, R., Hastings, T., Herriot, R., Isaacson, S. and P.
3391 Powell, "Internet Printing Protocol/1.0: Model and
3392 Semantics", <a href="./rfc2566">RFC 2566</a>, April 1999.
3393
3394 [<a id="ref-RFC2565">RFC2565</a>] Herriot, R., Butler, S., Moore, P. and R. Tuner, "Internet
3395 Printing Protocol/1.0: Encoding and Transport", <a href="./rfc2565">RFC 2565</a>,
3396 April 1999.
3397
3398 [<a id="ref-RFC2568">RFC2568</a>] Zilles, S., "Rationale for the Structure and Model and
3399 Protocol for the Internet Printing Protocol", <a href="./rfc2568">RFC 2568</a>,
3400 April 1999.
3401
3402 [<a id="ref-RFC2567">RFC2567</a>] Wright, D., "Design Goals for an Internet Printing
3403 Protocol", <a href="./rfc2567">RFC 2567</a>, April 1999.
3404
3405 [<a id="ref-RFC1123">RFC1123</a>] Braden, S., "Requirements for Internet Hosts - Application
3406 and Support", STD 3, <a href="./rfc1123">RFC 1123</a>, October 1989.
3407
3408
3409
3410
3411
3412 <span class="grey">Hastings &amp; Manros Informational [Page 61]</span></pre>
3413 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
3414 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3415
3416
3417 [<a id="ref-RFC2026">RFC2026</a>] Bradner, S., "The Internet Standards Process -- Revision
3418 3", <a href="https://www.rfc-editor.org/bcp/bcp9">BCP 9</a>, <a href="./rfc2026">RFC 2026</a>, October 1996.
3419
3420 [<a id="ref-RFC2068">RFC2068</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H. and T.
3421 Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", <a href="./rfc2068">RFC</a>
3422 <a href="./rfc2068">2068</a>, January 1997.
3423
3424 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
3425 Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
3426
3427 [<a id="ref-RFC2396">RFC2396</a>] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform
3428 Resource Identifiers (URI): Generic Syntax", <a href="./rfc2396">RFC 2396</a>,
3429 August 1998.
3430
3431 [<a id="ref-Servlet">Servlet</a>] Servlet Specification Version 2.1
3432 (<a href="http://java.sun.com/products/servlet/2.1/index.html">http://java.sun.com/products/servlet/2.1/index.html</a>).
3433
3434 [<a id="ref-SSL">SSL</a>] Netscape, The SSL Protocol, Version 3, (Text version 3.02),
3435 November 1996.
3436
3437 <span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a> Authors' Addresses</span>
3438
3439 Thomas N. Hastings
3440 Xerox Corporation
3441 701 Aviation Blvd.
3442 El Segundo, CA 90245
3443
3444 EMail: [email protected]
3445
3446
3447 Carl-Uno Manros
3448 Xerox Corporation
3449 701 Aviation Blvd.
3450 El Segundo, CA 90245
3451
3452 EMail: [email protected]
3453
3454 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a> Security Considerations</span>
3455
3456 Security issues are discussed in sections <a href="#section-2.2">2.2</a>, <a href="#section-2.3.1">2.3.1</a>, and <a href="#section-8.5">8.5</a>.
3457
3458 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a> Notices</span>
3459
3460 The IETF takes no position regarding the validity or scope of any
3461 intellectual property or other rights that might be claimed to
3462 pertain to the implementation or use of the technology described in
3463 this document or the extent to which any license under such rights
3464 might or might not be available; neither does it represent that it
3465
3466
3467
3468 <span class="grey">Hastings &amp; Manros Informational [Page 62]</span></pre>
3469 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
3470 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3471
3472
3473 has made any effort to identify any such rights. Information on the
3474 IETF's procedures with respect to rights in standards-track and
3475 standards-related documentation can be found in <a href="https://www.rfc-editor.org/bcp/bcp11">BCP-11</a> [BCP-11].
3476 Copies of claims of rights made available for publication and any
3477 assurances of licenses to be made available, or the result of an
3478 attempt made to obtain a general license or permission for the use of
3479 such proprietary rights by implementers or users of this
3480 specification can be obtained from the IETF Secretariat.
3481
3482 The IETF invites any interested party to bring to its attention any
3483 copyrights, patents or patent applications, or other proprietary
3484 rights which may cover technology that may be required to practice
3485 this standard. Please address the information to the IETF Executive
3486 Director.
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524 <span class="grey">Hastings &amp; Manros Informational [Page 63]</span></pre>
3525 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
3526 <span class="grey"><a href="./rfc2639">RFC 2639</a> IPP/1.0: Implementer's Guide July 1999</span>
3527
3528
3529 Full Copyright Statement
3530
3531 Copyright (C) The Internet Society (1999). All Rights Reserved.
3532
3533 This document and translations of it may be copied and furnished to
3534 others, and derivative works that comment on or otherwise explain it
3535 or assist in its implementation may be prepared, copied, published
3536 and distributed, in whole or in part, without restriction of any
3537 kind, provided that the above copyright notice and this paragraph are
3538 included on all such copies and derivative works. However, this
3539 document itself may not be modified in any way, such as by removing
3540 the copyright notice or references to the Internet Society or other
3541 Internet organizations, except as needed for the purpose of
3542 developing Internet standards in which case the procedures for
3543 copyrights defined in the Internet Standards process must be
3544 followed, or as required to translate it into languages other than
3545 English.
3546
3547 The limited permissions granted above are perpetual and will not be
3548 revoked by the Internet Society or its successors or assigns.
3549
3550 This document and the information contained herein is provided on an
3551 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
3552 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
3553 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
3554 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
3555 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
3556
3557 Acknowledgement
3558
3559 Funding for the RFC Editor function is currently provided by the
3560 Internet Society.
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580 Hastings &amp; Manros Informational [Page 64]
3581 </pre>