Debian Codegraph @

rfc2566.html

raw
1 <pre>Network Working Group R. deBry
2 Request for Comments: 2566 Utah Valley State College
3 Category: Experimental T. Hastings
4 Xerox Corporation
5 R. Herriot
6 Xerox Corporation
7 S. Isaacson
8 Novell, Inc.
9 P. Powell
10 Astart Technologies
11 April 1999
12
13
14 <span class="h1">Internet Printing Protocol/1.0: Model and Semantics</span>
15
16 Status of this Memo
17
18 This memo defines an Experimental Protocol for the Internet
19 community. It does not specify an Internet standard of any kind.
20 Discussion and suggestions for improvement are requested.
21 Distribution of this memo is unlimited.
22
23 Copyright Notice
24
25 Copyright (C) The Internet Society (1999). All Rights Reserved.
26
27 IESG Note
28
29 This document defines an Experimental protocol for the Internet
30 community. The IESG expects that a revised version of this protocol
31 will be published as Proposed Standard protocol. The Proposed
32 Standard, when published, is expected to change from the protocol
33 defined in this memo. In particular, it is expected that the
34 standards-track version of the protocol will incorporate strong
35 authentication and privacy features, and that an "ipp:" URL type will
36 be defined which supports those security measures. Other changes to
37 the protocol are also possible. Implementors are warned that future
38 versions of this protocol may not interoperate with the version of
39 IPP defined in this document, or if they do interoperate, that some
40 protocol features may not be available.
41
42 The IESG encourages experimentation with this protocol, especially in
43 combination with Transport Layer Security (TLS) [<a href="./rfc2246">RFC 2246</a>], to help
44 determine how TLS may effectively be used as a security layer for
45 IPP.
46
47
48
49
50
51
52 <span class="grey">deBry, et al. Experimental [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
55
56
57 Abstract
58
59 This document is one of a set of documents, which together describe
60 all aspects of a new Internet Printing Protocol (IPP). IPP is an
61 application level protocol that can be used for distributed printing
62 using Internet tools and technologies. This document describes a
63 simplified model consisting of abstract objects, their attributes,
64 and their operations that is independent of encoding and transport.
65 The model consists of a Printer and a Job object. A Job optionally
66 supports multiple documents. IPP 1.0 semantics allow end-users and
67 operators to query printer capabilities, submit print jobs, inquire
68 about the status of print jobs and printers, and cancel print jobs.
69 This document also addresses security, internationalization, and
70 directory issues.
71
72 The full set of IPP documents includes:
73
74 Design Goals for an Internet Printing Protocol [<a href="./rfc2567" title="&quot;Design Goals for an Internet Printing Protocol&quot;">RFC2567</a>]
75 Rationale for the Structure and Model and Protocol for the Internet
76 Printing Protocol [<a href="./rfc2568" title="&quot;Rationale for the Structure and Model and Protocol for the Internet Printing Protocol&quot;">RFC2568</a>]
77 Internet Printing Protocol/1.0: Model and Semantics (this document)
78 Internet Printing Protocol/1.0: Encoding and Transport [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]
79 Internet Printing Protocol/1.0: Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>]
80 Mapping between LPD and IPP Protocols [<a href="./rfc2569" title="&quot;Mapping between LPD and IPP Protocols&quot;">RFC2569</a>]
81
82 The "Design Goals for an Internet Printing Protocol" document takes a
83 broad look at distributed printing functionality, and it enumerates
84 real-life scenarios that help to clarify the features that need to be
85 included in a printing protocol for the Internet. It identifies
86 requirements for three types of users: end users, operators, and
87 administrators. It calls out a subset of end user requirements that
88 are satisfied in IPP/1.0. Operator and administrator requirements
89 are out of scope for version 1.0.
90
91 The "Rationale for the Structure and Model and Protocol for the
92 Internet Printing Protocol" document describes IPP from a high level
93 view, defines a roadmap for the various documents that form the suite
94 of IPP specifications, and gives background and rationale for the
95 IETF working group's major decisions.
96
97 The "Internet Printing Protocol/1.0: Encoding and Transport" document
98 is a formal mapping of the abstract operations and attributes defined
99 in the model document onto HTTP/1.1. It defines the encoding rules
100 for a new Internet media type called "application/ipp".
101
102 The "Internet Printing Protocol/1.0: Implementer's Guide" document
103 gives insight and advice to implementers of IPP clients and IPP
104 objects. It is intended to help them understand IPP/1.0 and some of
105
106
107
108 <span class="grey">deBry, et al. Experimental [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
111
112
113 the considerations that may assist them in the design of their client
114 and/or IPP object implementations. For example, a typical order of
115 processing requests is given, including error checking. Motivation
116 for some of the specification decisions is also included.
117
118 The "Mapping between LPD and IPP Protocols" document gives some
119 advice to implementers of gateways between IPP and LPD (Line Printer
120 Daemon) implementations.
121
122 Table of Contents
123
124 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction </span> 8
125 1.1 Simplified Printing Model 9
126 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. IPP Objects </span> 11
127 2.1 Printer Object 12
128 2.2 Job Object 14
129 2.3 Object Relationships 14
130 2.4 Object Identity 15
131 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. IPP Operations </span> 18
132 3.1 Common Semantics 19
133 3.1.1 Required Parameters 19
134 3.1.2 Operation IDs and Request IDs 20
135 3.1.3 Attributes 20
136 3.1.4 Character Set and Natural Language Operation Attributes 22
137 3.1.4.1 Request Operation Attributes 22
138 3.1.4.2 Response Operation Attributes 26
139 3.1.5 Operation Targets 28
140 3.1.6 Operation Status Codes and Messages 29
141 3.1.7 Versions 30
142 3.1.8 Job Creation Operations 32
143 3.2 Printer Operations 34
144 3.2.1 Print-Job Operation 34
145 3.2.1.1 Print-Job Request 34
146 3.2.1.2 Print-Job Response 38
147 3.2.2 Print-URI Operation 41
148 3.2.3 Validate-Job Operation 42
149 3.2.4 Create-Job Operation 42
150 3.2.5 Get-Printer-Attributes Operation 43
151 3.2.5.1 Get-Printer-Attributes Request 44
152 3.2.5.2 Get-Printer-Attributes Response 46
153 3.2.6 Get-Jobs Operation 47
154 3.2.6.1 Get-Jobs Request 47
155 3.2.6.2 Get-Jobs Response 49
156 3.3 Job Operations 50
157 3.3.1 Send-Document Operation 50
158 3.3.1.1 Send-Document Request 51
159 3.3.1.2 Send-Document Response 53
160 3.3.2 Send-URI Operation 54
161
162
163
164 <span class="grey">deBry, et al. Experimental [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
167
168
169 3.3.3 Cancel-Job Operation 54
170 3.3.3.1 Cancel-Job Request 54
171 3.3.3.2 Cancel-Job Response 55
172 3.3.4 Get-Job-Attributes Operation 56
173 3.3.4.1 Get-Job-Attributes Request 57
174 3.3.4.2 Get-Job-Attributes Response 57
175 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Object Attributes </span> 58
176 4.1 Attribute Syntaxes 59
177 4.1.1 'text' 60
178 4.1.1.1 'textWithoutLanguage' 61
179 4.1.1.2 'textWithLanguage' 61
180 4.1.2 'name' 62
181 4.1.2.1 'nameWithoutLanguage' 62
182 4.1.2.2 'nameWithLanguage' 63
183 4.1.2.3 Matching 'name' attribute values 63
184 4.1.3 'keyword' 64
185 4.1.4 'enum' 65
186 4.1.5 'uri' 65
187 4.1.6 'uriScheme' 65
188 4.1.7 'charset' 66
189 4.1.8 'naturalLanguage' 67
190 4.1.9 'mimeMediaType' 67
191 4.1.10 'octetString' 69
192 4.1.11 'boolean' 69
193 4.1.12 'integer' 69
194 4.1.13 'rangeOfInteger' 69
195 4.1.14 'dateTime' 69
196 4.1.15 'resolution' 69
197 4.1.16 '1setOf X' 70
198 4.2 Job Template Attributes 70
199 4.2.1 job-priority (integer(1:100)) 74
200 4.2.2 job-hold-until (type3 keyword | name (MAX)) 75
201 4.2.3 job-sheets (type3 keyword | name(MAX)) 75
202 4.2.4 multiple-document-handling (type2 keyword) 76
203 4.2.5 copies (integer(1:MAX)) 77
204 4.2.6 finishings (1setOf type2 enum) 78
205 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX)) 79
206 4.2.8 sides (type2 keyword) 80
207 4.2.9 number-up (integer(1:MAX)) 80
208 4.2.10 orientation-requested (type2 enum) 81
209 4.2.11 media (type3 keyword | name(MAX)) 82
210 4.2.12 printer-resolution (resolution) 83
211 4.2.13 print-quality (type2 enum) 83
212 4.3 Job Description Attributes 84
213 4.3.1 job-uri (uri) 85
214 4.3.2 job-id (integer(1:MAX)) 85
215 4.3.3 job-printer-uri (uri) 86
216 4.3.4 job-more-info (uri) 86
217
218
219
220 <span class="grey">deBry, et al. Experimental [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
223
224
225 4.3.5 job-name (name(MAX)) 86
226 4.3.6 job-originating-user-name (name(MAX)) 86
227 4.3.7 job-state (type1 enum) 87
228 4.3.8 job-state-reasons (1setOf type2 keyword) 90
229 4.3.9 job-state-message (text(MAX)) 92
230 4.3.10 number-of-documents (integer(0:MAX)) 93
231 4.3.11 output-device-assigned (name(127)) 93
232 4.3.12 time-at-creation (integer(0:MAX)) 93
233 4.3.13 time-at-processing (integer(0:MAX)) 93
234 4.3.14 time-at-completed (integer(0:MAX)) 94
235 4.3.15 number-of-intervening-jobs (integer(0:MAX)) 94
236 4.3.16 job-message-from-operator (text(127)) 94
237 4.3.17 job-k-octets (integer(0:MAX)) 94
238 4.3.18 job-impressions (integer(0:MAX)) 95
239 4.3.19 job-media-sheets (integer(0:MAX)) 95
240 4.3.20 job-k-octets-processed (integer(0:MAX)) 96
241 4.3.21 job-impressions-completed (integer(0:MAX)) 96
242 4.3.22 job-media-sheets-completed (integer(0:MAX)) 96
243 4.3.23 attributes-charset (charset) 97
244 4.3.24 attributes-natural-language (naturalLanguage) 97
245 4.4 Printer Description Attributes 97
246 4.4.1 printer-uri-supported (1setOf uri) 99
247 4.4.2 uri-security-supported (1setOf type2 keyword) 100
248 4.4.3 printer-name (name(127)) 101
249 4.4.4 printer-location (text(127)) 101
250 4.4.5 printer-info (text(127)) 101
251 4.4.6 printer-more-info (uri) 101
252 4.4.7 printer-driver-installer (uri) 102
253 4.4.8 printer-make-and-model (text(127)) 102
254 4.4.9 printer-more-info-manufacturer (uri) 102
255 4.4.10 printer-state (type1 enum) 102
256 4.4.11 printer-state-reasons (1setOf type2 keyword) 103
257 4.4.12 printer-state-message (text(MAX)) 106
258 4.4.13 operations-supported (1setOf type2 enum) 106
259 4.4.14 charset-configured (charset) 107
260 4.4.15 charset-supported (1setOf charset) 107
261 4.4.16 natural-language-configured (naturalLanguage) 107
262 4.4.17 generated-natural-language-supported(1setOf naturalLanguage108
263 4.4.18 document-format-default (mimeMediaType) 108
264 4.4.19 document-format-supported (1setOf mimeMediaType) 108
265 4.4.20 printer-is-accepting-jobs (boolean) 109
266 4.4.21 queued-job-count (integer(0:MAX)) 109
267 4.4.22 printer-message-from-operator (text(127)) 109
268 4.4.23 color-supported (boolean) 109
269 4.4.24 reference-uri-schemes-supported (1setOf uriScheme) 109
270 4.4.25 pdl-override-supported (type2 keyword) 110
271 4.4.26 printer-up-time (integer(1:MAX)) 110
272 4.4.27 printer-current-time (dateTime) 111
273
274
275
276 <span class="grey">deBry, et al. Experimental [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
279
280
281 4.4.28 multiple-operation-time-out (integer(1:MAX)) 111
282 4.4.29 compression-supported (1setOf type3 keyword) 111
283 4.4.30 job-k-octets-supported (rangeOfInteger(0:MAX)) 112
284 4.4.31 job-impressions-supported (rangeOfInteger(0:MAX)) 112
285 4.4.32 job-media-sheets-supported (rangeOfInteger(0:MAX)) 112
286 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Conformance </span> 112
287 5.1 Client Conformance Requirements 112
288 5.2 IPP Object Conformance Requirements 113
289 5.2.1 Objects 113
290 5.2.2 Operations 113
291 5.2.3 IPP Object Attributes 114
292 5.2.4 Extensions 114
293 5.2.5 Attribute Syntaxes 115
294 5.3 Charset and Natural Language Requirements 115
295 5.4 Security Conformance Requirements 115
296 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations (registered and private extensions) </span> 116
297 6.1 Typed 'keyword' and 'enum' Extensions 116
298 6.2 Attribute Extensibility 119
299 6.3 Attribute Syntax Extensibility 119
300 6.4 Operation Extensibility 120
301 6.5 Attribute Groups 120
302 6.6 Status Code Extensibility 120
303 6.7 Registration of MIME types/sub-types for document-formats 121
304 6.8 Registration of charsets for use in 'charset' attribute values121
305 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Internationalization Considerations </span> 121
306 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Security Considerations </span> 125
307 8.1 Security Scenarios 126
308 8.1.1 Client and Server in the Same Security Domain 126
309 8.1.2 Client and Server in Different Security Domains 126
310 8.1.3 Print by Reference 127
311 8.2 URIs for SSL3 and non-SSL3 Access 127
312 8.3 The "requesting-user-name" (name(MAX)) Operation Attribute 127
313 8.4 Restricted Queries 129
314 8.5 Queries on jobs submitted using non-IPP protocols 129
315 8.6 IPP Security Application Profile for SSL3 130
316 <span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. References </span> 131
317 <span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Authors' Addresses </span> 134
318 <span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Formats for IPP Registration Proposals </span> 136
319 11.1 Type2 keyword attribute values registration 136
320 11.2 Type3 keyword attribute values registration 137
321 11.3 Type2 enum attribute values registration 137
322 11.4 Type3 enum attribute values registration 137
323 11.5 Attribute registration 138
324 11.6 Attribute Syntax registration 138
325 11.7 Operation registration 139
326 11.8 Attribute Group registration 139
327 11.9 Status code registration 139
328 12.APPENDIX A: Terminology 141
329
330
331
332 <span class="grey">deBry, et al. Experimental [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
335
336
337 12.1 Conformance Terminology 141
338 12.1.1 NEED NOT 141
339 12.2 Model Terminology 141
340 12.2.1 Keyword 141
341 12.2.2 Attributes 141
342 12.2.2.1 Attribute Name 141
343 12.2.2.2 Attribute Group Name 142
344 12.2.2.3 Attribute Value 142
345 12.2.2.4 Attribute Syntax 142
346 12.2.3 Supports 142
347 12.2.4 print-stream page 144
348 12.2.5 impression 144
349 13.APPENDIX B: Status Codes and Suggested Status Code Messages 145
350 13.1 Status Codes 146
351 13.1.1 Informational 146
352 13.1.2 Successful Status Codes 146
353 13.1.2.1 successful-ok (0x0000) 146
354 13.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001) 146
355 13.1.2.3 successful-ok-conflicting-attributes (0x0002) 147
356 13.1.3 Redirection Status Codes 147
357 13.1.4 Client Error Status Codes 147
358 13.1.4.1 client-error-bad-request (0x0400) 147
359 13.1.4.2 client-error-forbidden (0x0401) 147
360 13.1.4.3 client-error-not-authenticated (0x0402) 148
361 13.1.4.4 client-error-not-authorized (0x0403) 148
362 13.1.4.5 client-error-not-possible (0x0404) 148
363 13.1.4.6 client-error-timeout (0x0405) 148
364 13.1.4.7 client-error-not-found (0x0406) 149
365 13.1.4.8 client-error-gone (0x0407) 149
366 13.1.4.9 client-error-request-entity-too-large (0x0408) 149
367 13.1.4.10client-error-request-value-too-long (0x0409) 150
368 13.1.4.11client-error-document-format-not-supported (0x040A) 150
369 13.1.4.12client-error-attributes-or-values-not-supported (0x040B) 150
370 13.1.4.13client-error-uri-scheme-not-supported (0x040C) 151
371 13.1.4.14client-error-charset-not-supported (0x040D) 151
372 13.1.4.15client-error-conflicting-attributes (0x040E) 151
373 13.1.5 Server Error Status Codes 151
374 13.1.5.1 server-error-internal-error (0x0500) 151
375 13.1.5.2 server-error-operation-not-supported (0x0501) 152
376 13.1.5.3 server-error-service-unavailable (0x0502) 152
377 13.1.5.4 server-error-version-not-supported (0x0503) 152
378 13.1.5.5 server-error-device-error (0x0504) 152
379 13.1.5.6 server-error-temporary-error (0x0505) 153
380 13.1.5.7 server-error-not-accepting-jobs (0x0506) 153
381 13.1.5.8 server-error-busy (0x0507) 153
382 13.1.5.9 server-error-job-canceled (0x0508) 153
383 13.2 Status Codes for IPP Operations 153
384 14.APPENDIX C: "media" keyword values 155
385
386
387
388 <span class="grey">deBry, et al. Experimental [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
391
392
393 15.APPENDIX D: Processing IPP Attributes 160
394 15.1 Fidelity 160
395 15.2 Page Description Language (PDL) Override 161
396 15.3 Using Job Template Attributes During Document Processing. 163
397 16.APPENDIX E: Generic Directory Schema 166
398 17.APPENDIX F: Change History for the Model and Semantics document 168
399 18.FULL COPYRIGHT STATEMENT 173
400
401 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
402
403 The Internet Printing Protocol (IPP) is an application level protocol
404 that can be used for distributed printing using Internet tools and
405 technologies. IPP version 1.0 (IPP/1.0) focuses only on end user
406 functionality. This document is just one of a suite of documents
407 that fully define IPP. The full set of IPP documents includes:
408
409 Design Goals for an Internet Printing Protocol [<a href="./rfc2567" title="&quot;Design Goals for an Internet Printing Protocol&quot;">RFC2567</a>]
410 Rationale for the Structure and Model and Protocol for the Internet
411 Printing Protocol [<a href="./rfc2568" title="&quot;Rationale for the Structure and Model and Protocol for the Internet Printing Protocol&quot;">RFC2568</a>]
412 Internet Printing Protocol/1.0: Model and Semantics (this document)
413 Internet Printing Protocol/1.0: Encoding and Transport [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]
414 Internet Printing Protocol/1.0: Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>]
415 Mapping between LPD and IPP Protocols [<a href="./rfc2569" title="&quot;Mapping between LPD and IPP Protocols&quot;">RFC2569</a>]
416
417 Anyone reading these documents for the first time is strongly
418 encouraged to read the IPP documents in the above order.
419
420 This document is laid out as follows:
421
422 - The rest of <a href="#section-1">Section 1</a> is an introduction to the IPP simplified
423 model for distributed printing.
424 - <a href="#section-2">Section 2</a> introduces the object types covered in the model with
425 their basic behaviors, attributes, and interactions.
426 - <a href="#section-3">Section 3</a> defines the operations included in IPP/1.0. IPP
427 operations are synchronous, therefore, for each operation, there
428 is a both request and a response.
429 - <a href="#section-4">Section 4</a> defines the attributes (and their syntaxes) that are
430 used in the model.
431 - Sections <a href="#section-5">5</a> - <a href="#section-6">6</a> summarizes the implementation conformance
432 requirements for objects that support the protocol and IANA
433 considerations, respectively.
434 - Sections <a href="#section-7">7</a> - <a href="#section-11">11</a> cover the Internationalization and Security
435 considerations as well as References, Author contact information,
436 and Formats for Registration Proposals.
437 - Sections <a href="#section-12">12</a> - <a href="#section-14">14</a> are appendices that cover Terminology, Status
438 Codes and Messages, and "media" keyword values.
439
440
441
442
443
444 <span class="grey">deBry, et al. Experimental [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
447
448
449 Note: This document uses terms such as "attributes",
450 "keywords", and "support". These terms have special
451 meaning and are defined in the model terminology <a href="#section-12.2">section</a>
452 <a href="#section-12.2">12.2</a>. Capitalized terms, such as MUST, MUST NOT, REQUIRED,
453 SHOULD, SHOULD NOT, MAY, NEED NOT, and OPTIONAL, have
454 special meaning relating to conformance. These terms are
455 defined in <a href="#section-12.1">section 12.1</a> on conformance terminology, most of
456 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>].
457
458 - <a href="#section-15">Section 15</a> is an appendix that helps to clarify the effects of
459 interactions between related attributes and their values.
460 - <a href="#section-16">Section 16</a> is an appendix that enumerates the subset of Printer
461 attributes that form a generic directory schema. These
462 attributes are useful when registering a Printer so that a
463 client can find the Printer not just by name, but by filtered
464 searches as well.
465 - <a href="#section-17">Section 17</a> is an appendix that provides a Change History
466 summarizing the clarification and changes that might affect an
467 implementation since the June 30, 1998 draft.
468
469 <span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a> Simplified Printing Model</span>
470
471 In order to achieve its goal of realizing a workable printing
472 protocol for the Internet, the Internet Printing Protocol (IPP) is
473 based on a simplified printing model that abstracts the many
474 components of real world printing solutions. The Internet is a
475 distributed computing environment where requesters of print services
476 (clients, applications, printer drivers, etc.) cooperate and interact
477 with print service providers. This model and semantics document
478 describes a simple, abstract model for IPP even though the underlying
479 configurations may be complex "n-tier" client/server systems. An
480 important simplifying step in the IPP model is to expose only the key
481 objects and interfaces required for printing. The model described in
482 this model document does not include features, interfaces, and
483 relationships that are beyond the scope of the first version of IPP
484 (IPP/1.0). IPP/1.0 incorporates many of the relevant ideas and
485 lessons learned from other specification and development efforts
486 [<a href="#ref-HTPP" title="&quot;Initial Draft - Hypertext Printing Protocol - HTPP/1.0&quot;">HTPP</a>] [<a href="#ref-ISO10175">ISO10175</a>] [<a href="#ref-LDPA" title="&quot;LDPA - Lightweight Document Printing Application&quot;">LDPA</a>] [<a href="#ref-P1387.4" title="M. (Editor)">P1387.4</a>] [<a href="#ref-PSIS" title="R. (editor)">PSIS</a>] [<a href="./rfc1179" title="&quot;Line Printer Daemon Protocol&quot;">RFC1179</a>] [<a href="#ref-SWP" title="&quot;Simple Web Printing SWP/1.0&quot;">SWP</a>]. IPP is
487 heavily influenced by the printing model introduced in the Document
488 Printing Application (DPA) [<a href="#ref-ISO10175">ISO10175</a>] standard. Although DPA
489 specifies both end user and administrative features, IPP version 1.0
490 (IPP/1.0) focuses only on end user functionality.
491
492 The IPP/1.0 model encapsulates the important components of
493 distributed printing into two object types:
494
495 - Printer (<a href="#section-2.1">Section 2.1</a>)
496 - Job (<a href="#section-2.2">Section 2.2</a>)
497
498
499
500 <span class="grey">deBry, et al. Experimental [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
503
504
505 Each object type has an associated set of operations (see <a href="#section-3">section 3</a>)
506 and attributes (see <a href="#section-4">section 4</a>).
507
508 It is important, however, to understand that in real system
509 implementations (which lie underneath the abstracted IPP/1.0 model),
510 there are other components of a print service which are not
511 explicitly defined in the IPP/1.0 model. The following figure
512 illustrates where IPP/1.0 fits with respect to these other
513 components.
514
515 +--------------+
516 | Application |
517 o +. . . . . . . |
518 \|/ | Spooler |
519 / \ +. . . . . . . | +---------+
520 End-User | Print Driver |---| File |
521 +-----------+ +-----+ +------+-------+ +----+----+
522 | Browser | | GUI | | |
523 +-----+-----+ +--+--+ | |
524 | | | |
525 | +---+------------+---+ |
526 N D S | | IPP Client |------------+
527 O I E | +---------+----------+
528 T R C | |
529 I E U |
530 F C R -------------- Transport ------------------
531 I T I
532 C O T | --+
533 A R Y +--------+--------+ |
534 T Y | IPP Server | |
535 I +--------+--------+ |
536 O | |
537 N +-----------------+ | IPP Printer
538 | Print Service | |
539 +-----------------+ |
540 | --+
541 +-----------------+
542 | Output Device(s)|
543 +-----------------+
544
545 An IPP Printer object encapsulates the functions normally associated
546 with physical output devices along with the spooling, scheduling and
547 multiple device management functions often associated with a print
548 server. Printer objects are optionally registered as entries in a
549 directory where end users find and select them based on some sort of
550 filtered and context based searching mechanism (see <a href="#section-16">section 16</a>). The
551 directory is used to store relatively static information about the
552 Printer, allowing end users to search for and find Printers that
553
554
555
556 <span class="grey">deBry, et al. Experimental [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
559
560
561 match their search criteria, for example: name, context, printer
562 capabilities, etc. The more dynamic information, such as state,
563 currently loaded and ready media, number of jobs at the Printer,
564 errors, warnings, and so forth, is directly associated with the
565 Printer object itself rather than with the entry in the directory
566 which only represents the Printer object.
567
568 IPP clients implement the IPP protocol on the client side and give
569 end users (or programs running on behalf of end users) the ability to
570 query Printer objects and submit and manage print jobs. An IPP
571 server is just that part of the Printer object that implements the
572 server-side protocol. The rest of the Printer object implements (or
573 gateways into) the application semantics of the print service itself.
574 The Printer objects may be embedded in an output device or may be
575 implemented on a host on the network that communicates with an output
576 device.
577
578 When a job is submitted to the Printer object and the Printer object
579 validates the attributes in the submission request, the Printer
580 object creates a new Job object. The end user then interacts with
581 this new Job object to query its status and monitor the progress of
582 the job. End users may also cancel the print job by using the Job
583 object's Cancel-Job operation. The notification service is out of
584 scope for IPP/1.0, but using such a notification service, the end
585 user is able to register for and receive Printer specific and Job
586 specific events. An end user can query the status of Printer objects
587 and can follow the progress of Job objects by polling using the Get-
588 Printer-Attributes, Get-Jobs, and Get-Job-Attributes operations.
589
590 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. IPP Objects</span>
591
592 The IPP/1.0 model introduces objects of type Printer and Job. Each
593 type of object models relevant aspects of a real-world entity such as
594 a real printer or real print job. Each object type is defined as a
595 set of possible attributes that may be supported by instances of that
596 object type. For each object (instance), the actual set of supported
597 attributes and values describe a specific implementation. The
598 object's attributes and values describe its state, capabilities,
599 realizable features, job processing functions, and default behaviors
600 and characteristics. For example, the Printer object type is defined
601 as a set of attributes that each Printer object potentially supports.
602 In the same manner, the Job object type is defined as a set of
603 attributes that are potentially supported by each Job object.
604
605 Each attribute included in the set of attributes defining an object
606 type is labeled as:
607
608
609
610
611
612 <span class="grey">deBry, et al. Experimental [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
615
616
617 - "REQUIRED": each object MUST support the attribute.
618 - "OPTIONAL": each object MAY support the attribute.
619
620 There is no such similar labeling of attribute values. However, if
621 an implementation supports an attribute, it MUST support at least one
622 of the possible values for that attribute.
623
624 <span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a> Printer Object</span>
625
626 The major component of the IPP/1.0 model is the Printer object. A
627 Printer object implements the server-side of the IPP/1.0 protocol.
628 Using the protocol, end users may query the attributes of the Printer
629 object and submit print jobs to the Printer object. The actual
630 implementation components behind the Printer abstraction may take on
631 different forms and different configurations. However, the model
632 abstraction allows the details of the configuration of real
633 components to remain opaque to the end user. <a href="#section-3">Section 3</a> describes
634 each of the Printer operations in detail.
635
636 The capabilities and state of a Printer object are described by its
637 attributes. Printer attributes are divided into two groups:
638
639 - "job-template" attributes: These attributes describe supported
640 job processing capabilities and defaults for the Printer object.
641 (See <a href="#section-4.2">section 4.2</a>)
642 - "printer-description" attributes: These attributes describe the
643 Printer object's identification, state, location, references to
644 other sources of information about the Printer object, etc. (see
645 <a href="#section-4.4">section 4.4</a>)
646
647 Since a Printer object is an abstraction of a generic document output
648 device and print service provider, a Printer object could be used to
649 represent any real or virtual device with semantics consistent with
650 the Printer object, such as a fax device, an imager, or even a CD
651 writer.
652
653 Some examples of configurations supporting a Printer object include:
654
655 1) An output device with no spooling capabilities
656 2) An output device with a built-in spooler
657 3) A print server supporting IPP with one or more associated output
658 devices
659 3a) The associated output devices may or may not be capable of
660 spooling jobs
661 3b) The associated output devices may or may not support IPP
662
663
664
665
666
667
668 <span class="grey">deBry, et al. Experimental [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
671
672
673 The following figures show some examples of how Printer objects can
674 be realized on top of various distributed printing configurations.
675 The embedded case below represents configurations 1 and 2. The hosted
676 and fan-out figures below represent configurations 3a and 3b.
677
678 Legend:
679
680 ##### indicates a Printer object which is
681 either embedded in an output device or is
682 hosted in a server. The Printer object
683 might or might not be capable of queuing/spooling.
684
685 any indicates any network protocol or direct
686 connect, including IPP
687
688
689 embedded printer:
690 output device
691 +---------------+
692 O +--------+ | ########### |
693 /|\ | client |------------IPP------------&gt;# Printer # |
694 / \ +--------+ | # Object # |
695 | ########### |
696 +---------------+
697
698
699 hosted printer:
700 +---------------+
701 O +--------+ ########### | |
702 /|\ | client |--IPP--&gt;# Printer #-any-&gt;| output device |
703 / \ +--------+ # Object # | |
704 ########### +---------------+
705
706
707
708 +---------------+
709 fan out: | |
710 +--&gt;| output device |
711 any/ | |
712 O +--------+ ########### / +---------------+
713 /|\ | client |-IPP-&gt;# Printer #--*
714 / \ +--------+ # Object # \ +---------------+
715 ########### any\ | |
716 +--&gt;| output device |
717 | |
718 +---------------+
719
720
721
722
723
724 <span class="grey">deBry, et al. Experimental [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
727
728
729 <span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a> Job Object</span>
730
731 A Job object is used to model a print job. A Job object contains
732 documents. The information required to create a Job object is sent
733 in a create request from the end user via an IPP Client to the
734 Printer object. The Printer object validates the create request, and
735 if the Printer object accepts the request, the Printer object creates
736 the new Job object. <a href="#section-3">Section 3</a> describes each of the Job operations
737 in detail.
738
739 The characteristics and state of a Job object are described by its
740 attributes. Job attributes are grouped into two groups as follows:
741
742 - "job-template" attributes: These attributes can be supplied by
743 the client or end user and include job processing instructions
744 which are intended to override any Printer object defaults and/or
745 instructions embedded within the document data. (See <a href="#section-4.2">section 4.2</a>)
746 - "job-description" attributes: These attributes describe the Job
747 object's identification, state, size, etc. The client supplies
748 some of these attributes, and the Printer object generates others.
749 (See <a href="#section-4.3">section 4.3</a>)
750
751 An implementation MUST support at least one document per Job object.
752 An implementation MAY support multiple documents per Job object. A
753 document is either:
754
755 - a stream of document data in a format supported by the Printer
756 object (typically a Page Description Language - PDL), or
757 - a reference to such a stream of document data
758
759 In IPP/1.0, a document is not modeled as an IPP object, therefore it
760 has no object identifier or associated attributes. All job
761 processing instructions are modeled as Job object attributes. These
762 attributes are called Job Template attributes and they apply equally
763 to all documents within a Job object.
764
765 <span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a> Object Relationships</span>
766
767 IPP objects have relationships that are maintained persistently along
768 with the persistent storage of the object attributes.
769
770 A Printer object can represent either one or more physical output
771 devices or a logical device which "processes" jobs but never actually
772 uses a physical output device to put marks on paper. Examples of
773 logical devices include a Web page publisher or a gateway into an
774 online document archive or repository. A Printer object contains
775 zero or more Job objects.
776
777
778
779
780 <span class="grey">deBry, et al. Experimental [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
783
784
785 A Job object is contained by exactly one Printer object, however the
786 identical document data associated with a Job object could be sent to
787 either the same or a different Printer object. In this case, a
788 second Job object would be created which would be almost identical to
789 the first Job object, however it would have new (different) Job
790 object identifiers (see <a href="#section-2.4">section 2.4</a>).
791
792 A Job object is either empty (before any documents have been added)
793 or contains one or more documents. If the contained document is a
794 stream of document data, that stream can be contained in only one
795 document. However, there can be identical copies of the stream in
796 other documents in the same or different Job objects. If the
797 contained document is just a reference to a stream of document data,
798 other documents (in the same or different Job object(s)) may contain
799 the same reference.
800
801 <span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a> Object Identity</span>
802
803 All Printer and Job objects are identified by a Uniform Resource
804 Identifier (URI) [<a href="./rfc2396" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">RFC2396</a>] so that they can be persistently and
805 unambiguously referenced. The notion of a URI is a useful concept,
806 however, until the notion of URI is more stable (i.e., defined more
807 completely and deployed more widely), it is expected that the URIs
808 used for IPP objects will actually be URLs [<a href="./rfc2396" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">RFC2396</a>]. Since every
809 URL is a specialized form of a URI, even though the more generic term
810 URI is used throughout the rest of this document, its usage is
811 intended to cover the more specific notion of URL as well.
812
813 An administrator configures Printer objects to either support or not
814 support authentication and/or message privacy using SSL3 [<a href="#ref-SSL" title="Version 3">SSL</a>] (the
815 mechanism for security configuration is outside the scope of
816 IPP/1.0). In some situations, both types of connections (both
817 authenticated and unauthenticated) can be established using a single
818 communication channel that has some sort of negotiation mechanism.
819 In other situations, multiple communication channels are used, one
820 for each type of security configuration. <a href="#section-8">Section 8</a> provides a full
821 description of all security considerations and configurations.
822
823 If a Printer object supports more than one communication channel,
824 some or all of those channels might support and/or require different
825 security mechanisms. In such cases, an administrator could expose
826 the simultaneous support for these multiple communication channels as
827 multiple URIs for a single Printer object where each URI represents
828 one of the communication channels to the Printer object. To support
829 this flexibility, the IPP Printer object type defines a multi-valued
830 identification attribute called the "printer-uri-supported"
831 attribute. It MUST contain at least one URI. It MAY contain more
832 than one URI. That is, every Printer object will have at least one
833
834
835
836 <span class="grey">deBry, et al. Experimental [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
839
840
841 URI that identifies at least one communication channel to the Printer
842 object, but it may have more than one URI where each URI identifies a
843 different communication channel to the Printer object. The
844 "printer-uri-supported" attribute has a companion attribute, the
845 "uri-security-supported" attribute, that has the same cardinality as
846 "printer-uri-supported". The purpose of the "uri-security-supported"
847 attribute is to indicate the security mechanisms (if any) used for
848 each URI listed in "printer-uri-supported". These two attributes are
849 fully described in sections <a href="#section-4.4.1">4.4.1</a> and <a href="#section-4.4.2">4.4.2</a>.
850
851 When a job is submitted to the Printer object via a create request,
852 the client supplies only a single Printer object URI. The client
853 supplied Printer object URI MUST be one of the values in the
854 "printer-uri-supported" Printer attribute.
855
856 Note: IPP/1.0 does not specify how the client obtains the client
857 supplied URI, but it is RECOMMENDED that a Printer object be
858 registered as an entry in a directory service. End-users and
859 programs can then interrogate the directory searching for Printers.
860 <a href="#section-16">Section 16</a> defines a generic schema for Printer object entries in the
861 directory service and describes how the entry acts as a bridge to the
862 actual IPP Printer object. The entry in the directory that
863 represents the IPP Printer object includes the possibly many URIs for
864 that Printer object as values in one its attributes.
865
866 When a client submits a create request to the Printer object, the
867 Printer object validates the request and creates a new Job object.
868 The Printer object assigns the new Job object a URI which is stored
869 in the "job-uri" Job attribute. This URI is then used by clients as
870 the target for subsequent Job operations. The Printer object
871 generates a Job URI based on its configured security policy and the
872 URI used by the client in the create request.
873
874 For example, consider a Printer object that supports both a
875 communication channel secured by the use of SSL3 (using HTTP over
876 SSL3 with an "https" schemed URI) and another open communication
877 channel that is not secured with SSL3 (using a simple "http" schemed
878 URI). If a client were to submit a job using the secure URI, the
879 Printer object would assign the new Job object a secure URI as well.
880 If a client were to submit a job using the open-channel URI, the
881 Printer would assign the new Job object an open-channel URI.
882
883 In addition, the Printer object also populates the Job object's
884 "job-printer-uri" attribute. This is a reference back to the Printer
885 object that created the Job object. If a client only has access to a
886 Job object's "job-uri" identifier, the client can query the Job's
887 "job-printer-uri" attribute in order to determine which Printer
888 object created the Job object. If the Printer object supports more
889
890
891
892 <span class="grey">deBry, et al. Experimental [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
895
896
897 than one URI, the Printer object picks the one URI supplied by the
898 client when creating the job to build the value for and to populate
899 the Job's "job-printer-uri" attribute.
900
901 Allowing Job objects to have URIs allows for flexibility and
902 scalability. For example, in some implementations, the Printer
903 object might create Jobs that are processed in the same local
904 environment as the Printer object itself. In this case, the Job URI
905 might just be a composition of the Printer's URI and some unique
906 component for the Job object, such as the unique 32-bit positive
907 integer mentioned later in this paragraph. In other implementations,
908 the Printer object might be a central clearing-house for validating
909 all Job object creation requests, but the Job object itself might be
910 created in some environment that is remote from the Printer object.
911 In this case, the Job object's URI may have no physical-location
912 relationship at all to the Printer object's URI. Again, the fact
913 that Job objects have URIs allows for flexibility and scalability,
914 however, many existing printing systems have local models or
915 interface constraints that force print jobs to be identified using
916 only a 32-bit positive integer rather than an independent URI. This
917 numeric Job ID is only unique within the context of the Printer
918 object to which the create request was originally submitted.
919 Therefore, in order to allow both types of client access to IPP Job
920 objects (either by Job URI or by numeric Job ID), when the Printer
921 object successfully processes a create request and creates a new Job
922 object, the Printer object MUST generate both a Job URI and a Job ID.
923 The Job ID (stored in the "job-id" attribute) only has meaning in the
924 context of the Printer object to which the create request was
925 originally submitted. This requirement to support both Job URIs and
926 Job IDs allows all types of clients to access Printer objects and Job
927 objects no matter the local constraints imposed on the client
928 implementation.
929
930 In addition to identifiers, Printer objects and Job objects have
931 names ("printer-name" and "job-name"). An object name NEED NOT be
932 unique across all instances of all objects. A Printer object's name
933 is chosen and set by an administrator through some mechanism outside
934 the scope of IPP/1.0. A Job object's name is optionally chosen and
935 supplied by the IPP client submitting the job. If the client does
936 not supply a Job object name, the Printer object generates a name for
937 the new Job object. In all cases, the name only has local meaning.
938
939 To summarize:
940
941 - Each Printer object is identified with one or more URIs. The
942 Printer's "printer-uri-supported" attribute contains the URI(s).
943
944
945
946
947
948 <span class="grey">deBry, et al. Experimental [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
951
952
953 - The Printer object's "uri-security-supported" attribute
954 identifies the communication channel security protocols that may
955 or may not have been configured for the various Printer object
956 URIs (e.g., 'ssl3' or 'none').
957 - Each Job object is identified with a Job URI. The Job's "job-uri"
958 attribute contains the URI.
959 - Each Job object is also identified with Job ID which is a 32-bit,
960 positive integer. The Job's "job-id" attribute contains the Job
961 ID. The Job ID is only unique within the context of the Printer
962 object which created the Job object.
963 - Each Job object has a "job-printer-uri" attribute which contains
964 the URI of the Printer object that was used to create the Job
965 object. This attribute is used to determine the Printer object
966 that created a Job object when given only the URI for the Job
967 object. This linkage is necessary to determine the languages,
968 charsets, and operations which are supported on that Job (the
969 basis for such support comes from the creating Printer object).
970 - Each Printer object has a name (which is not necessarily unique).
971 The administrator chooses and sets this name through some
972 mechanism outside the scope of IPP/1.0 itself. The Printer
973 object's "printer-name" attribute contains the name.
974 - Each Job object has a name (which is not necessarily unique). The
975 client optionally supplies this name in the create request. If
976 the client does not supply this name, the Printer object generates
977 a name for the Job object. The Job object's "job-name" attribute
978 contains the name.
979
980 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. IPP Operations</span>
981
982 IPP objects support operations. An operation consists of a request
983 and a response. When a client communicates with an IPP object, the
984 client issues an operation request to the URI for that object.
985 Operation requests and responses have parameters that identify the
986 operation. Operations also have attributes that affect the run-time
987 characteristics of the operation (the intended target, localization
988 information, etc.). These operation-specific attributes are called
989 operation attributes (as compared to object attributes such as
990 Printer object attributes or Job object attributes). Each request
991 carries along with it any operation attributes, object attributes,
992 and/or document data required to perform the operation. Each request
993 requires a response from the object. Each response indicates success
994 or failure of the operation with a status code as a response
995 parameter. The response contains any operation attributes, object
996 attributes, and/or status messages generated during the execution of
997 the operation request.
998
999
1000
1001
1002
1003
1004 <span class="grey">deBry, et al. Experimental [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1007
1008
1009 This section describes the semantics of the IPP operations, both
1010 requests and responses, in terms of the parameters, attributes, and
1011 other data associated with each operation.
1012
1013 The IPP/1.0 Printer operations are:
1014
1015 Print-Job (<a href="#section-3.2.1">section 3.2.1</a>)
1016 Print-URI (<a href="#section-3.2.2">section 3.2.2</a>)
1017 Validate-Job (<a href="#section-3.2.3">section 3.2.3</a>)
1018 Create-Job (<a href="#section-3.2.4">section 3.2.4</a>)
1019 Get-Printer-Attributes (<a href="#section-3.2.5">section 3.2.5</a>)
1020 Get-Jobs (<a href="#section-3.2.6">section 3.2.6</a>)
1021
1022 The Job operations are:
1023
1024 Send-Document (<a href="#section-3.3.1">section 3.3.1</a>)
1025 Send-URI (<a href="#section-3.3.2">section 3.3.2</a>)
1026 Cancel-Job (<a href="#section-3.3.3">section 3.3.3</a>)
1027 Get-Job-Attributes (<a href="#section-3.3.4">section 3.3.4</a>)
1028
1029 The Send-Document and Send-URI Job operations are used to add a new
1030 document to an existing multi-document Job object created using the
1031 Create-Job operation.
1032
1033 <span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a> Common Semantics</span>
1034
1035 All IPP operations require some common parameters and operation
1036 attributes. These common elements and their semantic characteristics
1037 are defined and described in more detail in the following sections.
1038
1039 <span class="h4"><a class="selflink" id="section-3.1.1" href="#section-3.1.1">3.1.1</a> Required Parameters</span>
1040
1041 Every operation request contains the following REQUIRED parameters:
1042
1043 - a "version-number",
1044 - an "operation-id",
1045 - a "request-id", and
1046 - the attributes that are REQUIRED for that type of request.
1047
1048 Every operation response contains the following REQUIRED parameters:
1049
1050 - a "version-number",
1051 - a "status-code",
1052 - the "request-id" that was supplied in the corresponding request,
1053 and
1054 - the attributes that are REQUIRED for that type of response.
1055
1056
1057
1058
1059
1060 <span class="grey">deBry, et al. Experimental [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1063
1064
1065 The encoding and transport document [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] defines special rules
1066 for the encoding of these parameters. All other operation elements
1067 are represented using the more generic encoding rules for attributes
1068 and groups of attributes.
1069
1070 <span class="h4"><a class="selflink" id="section-3.1.2" href="#section-3.1.2">3.1.2</a> Operation IDs and Request IDs</span>
1071
1072 Each IPP operation request includes an identifying "operation-id"
1073 value. Valid values are defined in the "operations-supported"
1074 Printer attribute section (see <a href="#section-4.4.13">section 4.4.13</a>). The client specifies
1075 which operation is being requested by supplying the correct
1076 "operation-id" value.
1077
1078 In addition, every invocation of an operation is identified by a
1079 "request-id" value. For each request, the client chooses the
1080 "request-id" which MUST be an integer (possibly unique depending on
1081 client requirements) in the range from 1 to 2**31 - 1 (inclusive).
1082 This "request-id" allows clients to manage multiple outstanding
1083 requests. The receiving IPP object copies all 32-bits of the client-
1084 supplied "request-id" attribute into the response so that the client
1085 can match the response with the correct outstanding request, even if
1086 the "request-id" is out of range. If the request is terminated
1087 before the complete "request-id" is received, the IPP object rejects
1088 the request and returns a response with a "request-id" of 0.
1089
1090 Note: In some cases, the transport protocol underneath IPP might be a
1091 connection oriented protocol that would make it impossible for a
1092 client to receive responses in any order other than the order in
1093 which the corresponding requests were sent. In such cases, the
1094 "request-id" attribute would not be essential for correct protocol
1095 operation. However, in other mappings, the operation responses can
1096 come back in any order. In these cases, the "request-id" would be
1097 essential.
1098
1099 <span class="h4"><a class="selflink" id="section-3.1.3" href="#section-3.1.3">3.1.3</a> Attributes</span>
1100
1101 Operation requests and responses are both composed of groups of
1102 attributes and/or document data. The attributes groups are:
1103
1104 - Operation Attributes: These attributes are passed in the
1105 operation and affect the IPP object's behavior while processing
1106 the operation request and may affect other attributes or groups
1107 of attributes. Some operation attributes describe the document
1108 data associated with the print job and are associated with new
1109 Job objects, however most operation attributes do not persist
1110 beyond the life of the operation. The description of each
1111 operation attribute includes conformance statements indicating
1112 which operation attributes are REQUIRED and which are OPTIONAL
1113
1114
1115
1116 <span class="grey">deBry, et al. Experimental [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1119
1120
1121 for an IPP object to support and which attributes a client MUST
1122 supply in a request and an IPP object MUST supply in a response.
1123 - Job Template Attributes: These attributes affect the processing
1124 of a job. A client OPTIONALLY supplies Job Template Attributes
1125 in a create request, and the receiving object MUST be prepared to
1126 receive all supported attributes. The Job object can later be
1127 queried to find out what Job Template attributes were originally
1128 requested in the create request, and such attributes are returned
1129 in the response as Job Object Attributes. The Printer object can
1130 be queried about its Job Template attributes to find out what
1131 type of job processing capabilities are supported and/or what the
1132 default job processing behaviors are, though such attributes are
1133 returned in the response as Printer Object Attributes. The
1134 "ipp-attribute-fidelity" operation attribute affects processing
1135 of all client-supplied Job Template attributes (see <a href="#section-15">section 15</a>
1136 for a full description of "ipp-attribute-fidelity" and its
1137 relationship to other attributes).
1138 - Job Object Attributes: These attributes are returned in response
1139 to a query operation directed at a Job object.
1140 - Printer Object Attributes: These attributes are returned in
1141 response to a query operation directed at a Printer object.
1142 - Unsupported Attributes: In a create request, the client supplies
1143 a set of Operation and Job Template attributes. If any of these
1144 attributes or their values is unsupported by the Printer object,
1145 the Printer object returns the set of unsupported attributes in
1146 the response. <a href="#section-15">Section 15</a> gives a full description of how Job
1147 Template attributes supplied by the client in a create request
1148 are processed by the Printer object and how unsupported
1149 attributes are returned to the client. Because of extensibility,
1150 any IPP object might receive a request that contains new or
1151 unknown attributes or values for which it has no support. In such
1152 cases, the IPP object processes what it can and returns the
1153 unsupported attributes in the response.
1154
1155 Later in this section, each operation is formally defined by
1156 identifying the allowed and expected groups of attributes for each
1157 request and response. The model identifies a specific order for each
1158 group in each request or response, but the attributes within each
1159 group may be in any order, unless specified otherwise.
1160
1161 Each attribute specification includes the attribute's name followed
1162 by the name of its attribute syntax(es) in parenthesizes. In
1163 addition, each 'integer' attribute is followed by the allowed range
1164 in parentheses, (m:n), for values of that attribute. Each 'text' or
1165 'name' attribute is followed by the maximum size in octets in
1166 parentheses, (size), for values of that attribute. For more details
1167 on attribute syntax notation, see the descriptions of these
1168 attributes syntaxes in <a href="#section-4.1">section 4.1</a>.
1169
1170
1171
1172 <span class="grey">deBry, et al. Experimental [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1175
1176
1177 Note: Document data included in the operation is not strictly an
1178 attribute, but it is treated as a special attribute group for
1179 ordering purposes. The only operations that support supplying the
1180 document data within an operation request are Print-Job and Send-
1181 Document. There are no operation responses that include document
1182 data.
1183
1184 Note: Some operations are REQUIRED for IPP objects to support; the
1185 others are OPTIONAL (see <a href="#section-5.2.2">section 5.2.2</a>). Therefore, before using an
1186 OPTIONAL operation, a client SHOULD first use the REQUIRED Get-
1187 Printer-Attributes operation to query the Printer's "operations-
1188 supported" attribute in order to determine which OPTIONAL Printer and
1189 Job operations are actually supported. The client SHOULD NOT use an
1190 OPTIONAL operation that is not supported. When an IPP object
1191 receives a request to perform an operation it does not support, it
1192 returns the 'server-error-operation-not-supported' status code (see
1193 <a href="#section-13.1.5.2">section 13.1.5.2</a>). An IPP object is non-conformant if it does not
1194 support a REQUIRED operation.
1195
1196 <span class="h4"><a class="selflink" id="section-3.1.4" href="#section-3.1.4">3.1.4</a> Character Set and Natural Language Operation Attributes</span>
1197
1198 Some Job and Printer attributes have values that are text strings and
1199 names intended for human understanding rather than machine
1200 understanding (see the 'text' and 'name' attribute syntax
1201 descriptions in <a href="#section-4.1">section 4.1</a>). The following sections describe two
1202 special Operation Attributes called "attributes-charset" and
1203 "attributes-natural-language". These attributes are always part of
1204 the Operation Attributes group. For most attribute groups, the order
1205 of the attributes within the group is not important. However, for
1206 these two attributes within the Operation Attributes group, the order
1207 is critical. The "attributes-charset" attribute MUST be the first
1208 attribute in the group and the "attributes-natural-language"
1209 attribute MUST be the second attribute in the group. In other words,
1210 these attributes MUST be supplied in every IPP request and response,
1211 they MUST come first in the group, and MUST come in the specified
1212 order. For job creation operations, the IPP Printer implementation
1213 saves these two attributes with the new Job object as Job Description
1214 attributes. For the sake of brevity in this document, these
1215 operation attribute descriptions are not repeated with every
1216 operation request and response, but have a reference back to this
1217 section instead.
1218
1219 <span class="h5"><a class="selflink" id="section-3.1.4.1" href="#section-3.1.4.1">3.1.4.1</a> Request Operation Attributes</span>
1220
1221 The client MUST supply and the Printer object MUST support the
1222 following REQUIRED operation attributes in every IPP/1.0 operation
1223 request:
1224
1225
1226
1227
1228 <span class="grey">deBry, et al. Experimental [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1231
1232
1233 "attributes-charset" (charset):
1234 This operation attribute identifies the charset (coded character
1235 set and encoding method) used by any 'text' and 'name'
1236 attributes that the client is supplying in this request. It
1237 also identifies the charset that the Printer object MUST use (if
1238 supported) for all 'text' and 'name' attributes and status
1239 messages that the Printer object returns in the response to this
1240 request. See Sections <a href="#section-4.1.1">4.1.1</a> and <a href="#section-4.1.2">4.1.2</a> for the specification of
1241 the 'text' and 'name' attribute syntaxes.
1242
1243 All clients and IPP objects MUST support the 'utf-8' charset
1244 [<a href="./rfc2279" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC2279</a>] and MAY support additional charsets provided that they
1245 are registered with IANA [<a href="#ref-IANA-CS">IANA-CS</a>]. If the Printer object does
1246 not support the client supplied charset value, the Printer
1247 object MUST reject the request, set the "attributes-charset" to
1248 'utf-8' in the response, and return the 'client-error-charset-
1249 not-supported' status code and any 'text' or 'name' attributes
1250 using the 'utf-8' charset. The Printer object MUST indicate the
1251 charset(s) supported as the values of the "charset-supported"
1252 Printer attribute (see <a href="#section-4.4.15">Section 4.4.15</a>), so that the client can
1253 query to determine which charset(s) are supported.
1254
1255 Note to client implementers: Since IPP objects are only required
1256 to support the 'utf-8' charset, in order to maximize
1257 interoperability with multiple IPP object implementations, a
1258 client may want to supply 'utf-8' in the "attributes-charset"
1259 operation attribute, even though the client is only passing and
1260 able to present a simpler charset, such as US-ASCII or ISO-
1261 8859-1. Then the client will have to filter out (or charset
1262 convert) those characters that are returned in the response that
1263 it cannot present to its user. On the other hand, if both the
1264 client and the IPP objects also support a charset in common
1265 besides utf-8, the client may want to use that charset in order
1266 to avoid charset conversion or data loss.
1267
1268 See the 'charset' attribute syntax description in <a href="#section-4.1.7">Section 4.1.7</a>
1269 for the syntax and semantic interpretation of the values of this
1270 attribute and for example values.
1271
1272 "attributes-natural-language" (naturalLanguage):
1273 This operation attribute identifies the natural language used by
1274 any 'text' and 'name' attributes that the client is supplying in
1275 this request. This attribute also identifies the natural
1276 language that the Printer object SHOULD use for all 'text' and '
1277 name' attributes and status messages that the Printer object
1278 returns in the response to this request.
1279
1280
1281
1282
1283
1284 <span class="grey">deBry, et al. Experimental [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1287
1288
1289 There are no REQUIRED natural languages required for the Printer
1290 object to support. However, the Printer object's "generated-
1291 natural-language-supported" attribute identifies the natural
1292 languages supported by the Printer object and any contained Job
1293 objects for all text strings generated by the IPP object. A
1294 client MAY query this attribute to determine which natural
1295 language(s) are supported for generated messages.
1296
1297 For any of the attributes for which the Printer object generates
1298 text, i.e., for the "job-state-message", "printer-state-
1299 message", and status messages (see <a href="#section-3.1.6">Section 3.1.6</a>), the Printer
1300 object MUST be able to generate these text strings in any of its
1301 supported natural languages. If the client requests a natural
1302 language that is not supported, the Printer object MUST return
1303 these generated messages in the Printer's configured natural
1304 language as specified by the Printer's "natural-language-
1305 configured" attribute" (see <a href="#section-4.4.16">Section 4.4.16</a>).
1306
1307 For other 'text' and 'name' attributes supplied by the client,
1308 authentication system, operator, system administrator, or
1309 manufacturer (i.e., for "job-originating-user-name", "printer-
1310 name" (name), "printer-location" (text), "printer-info" (text),
1311 and "printer-make-and-model" (text)), the Printer object is only
1312 required to support the configured natural language of the
1313 Printer identified by the Printer object's "natural-language-
1314 configured" attribute, though support of additional natural
1315 languages for these attributes is permitted.
1316
1317 For any 'text' or 'name' attribute in the request that is in a
1318 different natural language than the value supplied in the
1319 "attributes-natural-language" operation attribute, the client
1320 MUST use the Natural Language Override mechanism (see sections
1321 4.1.1.2 and 4.1.2.2) for each such attribute value supplied.
1322 The client MAY use the Natural Language Override mechanism
1323 redundantly, i.e., use it even when the value is in the same
1324 natural language as the value supplied in the "attributes-
1325 natural-language" operation attribute of the request.
1326
1327 The IPP object MUST accept any natural language and any Natural
1328 Language Override, whether the IPP object supports that natural
1329 language or not (and independent of the value of the "ipp-
1330 attribute-fidelity" Operation attribute). That is the IPP
1331 object accepts all client supplied values no matter what the
1332 values are in the Printer object's "generated-natural-language-
1333 supported" attribute. That attribute, "generated-natural-
1334 language-supported", only applies to generated messages,
1335
1336
1337
1338
1339
1340 <span class="grey">deBry, et al. Experimental [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1343
1344
1345 not client supplied messages. The IPP object MUST remember that
1346 natural language for all client-supplied attributes, and when
1347 returning those attributes in response to a query, the IPP
1348 object MUST indicate that natural language.
1349
1350 Each value whose attribute syntax type is 'text' or 'name' (see
1351 sections <a href="#section-4.1.1">4.1.1</a> and <a href="#section-4.1.2">4.1.2</a>) has an Associated Natural-Language.
1352 This document does not specify how this association is stored in
1353 a Printer or Job object. When such a value is encoded in a
1354 request or response, the natural language is either implicit or
1355 explicit:
1356
1357 - In the implicit case, the value contains only the
1358 text/name value, and the language is specified by the
1359 "attributes-natural-language" operation attribute in the
1360 request or response (see sections <a href="#section-4.1.1.1">4.1.1.1</a>
1361 textWithoutLanguage and 4.1.2.1 nameWithoutLanguage).
1362
1363 - In the explicit case (also known as the Natural-Language
1364 Override case), the value contains both the language and
1365 the text/name value (see sections <a href="#section-4.1.1.2">4.1.1.2</a>
1366 textWithLanguage and 4.1.2.2 nameWithLanguage).
1367
1368 For example, the "job-name" attribute MAY be supplied by the
1369 client in a create request. The text value for this attribute
1370 will be in the natural language identified by the "attribute-
1371 natural-language" attribute, or if different, as identified by
1372 the Natural Language Override mechanism. If supplied, the IPP
1373 object will use the value of the "job-name" attribute to
1374 populate the Job object's "job-name" attribute. Whenever any
1375 client queries the Job object's "job-name" attribute, the IPP
1376 object returns the attribute as stored and uses the Natural
1377 Language Override mechanism to specify the natural language, if
1378 it is different from that reported in the "attributes-natural-
1379 language" operation attribute of the response. The IPP object
1380 MAY use the Natural Language Override mechanism redundantly,
1381 i.e., use it even when the value is in the same natural language
1382 as the value supplied in the "attributes-natural-language"
1383 operation attribute of the response.
1384
1385 An IPP object MUST NOT reject a request based on a supplied
1386 natural language in an "attributes-natural-language" Operation
1387 attribute or in any attribute that uses the Natural Language
1388 Override.
1389
1390 See the 'naturalLanguage' attribute syntax description in
1391 <a href="#section-4.1.8">section 4.1.8</a> for the syntax and semantic interpretation of the
1392 values of this attribute and for example values.
1393
1394
1395
1396 <span class="grey">deBry, et al. Experimental [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1399
1400
1401 Clients SHOULD NOT supply 'text' or 'name' attributes that use an
1402 illegal combination of natural language and charset. For example,
1403 suppose a Printer object supports charsets 'utf-8', 'iso-8859-1', and
1404 'iso-8859-7'. Suppose also, that it supports natural languages 'en'
1405 (English), 'fr' (French), and 'el' (Greek). Although the Printer
1406 object supports the charset 'iso-8859-1' and natural language 'el',
1407 it probably does not support the combination of Greek text strings
1408 using the 'iso-8859-1' charset. The Printer object handles this
1409 apparent incompatibility differently depending on the context in
1410 which it occurs:
1411
1412 - In a create request: If the client supplies a text or name
1413 attribute (for example, the "job-name" operation attribute) that
1414 uses an apparently incompatible combination, it is a client
1415 choice that does not affect the Printer object or its correct
1416 operation. Therefore, the Printer object simply accepts the
1417 client supplied value, stores it with the Job object, and
1418 responds back with the same combination whenever the client (or
1419 any client) queries for that attribute.
1420 - In a query-type operation, like Get-Printer-Attributes: If the
1421 client requests an apparently incompatible combination, the
1422 Printer object responds (as described in <a href="#section-3.1.4.2">section 3.1.4.2</a>) using
1423 the Printer's configured natural language rather than the natural
1424 language requested by the client.
1425
1426 In either case, the Printer object does not reject the request
1427 because of the apparent incompatibility. The potential incompatible
1428 combination of charset and natural language can occur either at the
1429 global operation level or at the Natural Language Override
1430 attribute-by-attribute level. In addition, since the response always
1431 includes explicit charset and natural language information, there is
1432 never any question or ambiguity in how the client interprets the
1433 response.
1434
1435 <span class="h5"><a class="selflink" id="section-3.1.4.2" href="#section-3.1.4.2">3.1.4.2</a> Response Operation Attributes</span>
1436
1437 The Printer object MUST supply and the client MUST support the
1438 following REQUIRED operation attributes in every IPP/1.0 operation
1439 response:
1440
1441 "attributes-charset" (charset):
1442 This operation attribute identifies the charset used by any '
1443 text' and 'name' attributes that the Printer object is returning
1444 in this response. The value in this response MUST be the same
1445 value as the "attributes-charset" operation attribute supplied
1446 by the client in the request. If this is not possible
1447
1448
1449
1450
1451
1452 <span class="grey">deBry, et al. Experimental [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1455
1456
1457 (i.e., the charset requested is not supported), the request
1458 would have been rejected. See "attributes-charset" described in
1459 <a href="#section-3.1.4.1">Section 3.1.4.1</a> above.
1460
1461 If the Printer object supports more than just the 'utf-8'
1462 charset, the Printer object MUST be able to code convert between
1463 each of the charsets supported on a highest fidelity possible
1464 basis in order to return the 'text' and 'name' attributes in the
1465 charset requested by the client. However, some information loss
1466 MAY occur during the charset conversion depending on the
1467 charsets involved. For example, the Printer object may convert
1468 from a UTF-8 'a' to a US-ASCII 'a' (with no loss of
1469 information), from an ISO Latin 1 CAPITAL LETTER A WITH ACUTE
1470 ACCENT to US-ASCII 'A' (losing the accent), or from a UTF-8
1471 Japanese Kanji character to some ISO Latin 1 error character
1472 indication such as '?', decimal code equivalent, or to the
1473 absence of a character, depending on implementation.
1474
1475 Note: Whether an implementation that supports more than one
1476 charset stores the data in the charset supplied by the client or
1477 code converts to one of the other supported charsets, depends on
1478 implementation. The strategy should try to minimize loss of
1479 information during code conversion. On each response, such an
1480 implementation converts from its internal charset to that
1481 requested.
1482
1483 "attributes-natural-language" (naturalLanguage):
1484 This operation attribute identifies the natural language used by
1485 any 'text' and 'name' attributes that the IPP object is
1486 returning in this response. Unlike the "attributes-charset"
1487 operation attribute, the IPP object NEED NOT return the same
1488 value as that supplied by the client in the request. The IPP
1489 object MAY return the natural language of the Job object or the
1490 Printer's configured natural language as identified by the
1491 Printer object's "natural-language-configured" attribute, rather
1492 than the natural language supplied by the client. For any '
1493 text' or 'name' attribute or status message in the response that
1494 is in a different natural language than the value returned in
1495 the "attributes-natural-language" operation attribute, the IPP
1496 object MUST use the Natural Language Override mechanism (see
1497 sections <a href="#section-4.1.1.2">4.1.1.2</a> and <a href="#section-4.1.2.2">4.1.2.2</a>) on each attribute value returned.
1498 The IPP object MAY use the Natural Language Override mechanism
1499 redundantly, i.e., use it even when the value is in the same
1500 natural language as the value supplied in the "attributes-
1501 natural-language" operation attribute of the response.
1502
1503
1504
1505
1506
1507
1508 <span class="grey">deBry, et al. Experimental [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1511
1512
1513 <span class="h4"><a class="selflink" id="section-3.1.5" href="#section-3.1.5">3.1.5</a> Operation Targets</span>
1514
1515 All IPP operations are directed at IPP objects. For Printer
1516 operations, the operation is always directed at a Printer object
1517 using one of its URIs (i.e., one of the values in the Printer
1518 object's "printer-uri-supported" attribute). Even if the Printer
1519 object supports more than one URI, the client supplies only one URI
1520 as the target of the operation. The client identifies the target
1521 object by supplying the correct URI in the "printer-uri (uri)"
1522 operation attribute.
1523
1524 For Job operations, the operation is directed at either:
1525
1526 - The Job object itself using the Job object's URI. In this case,
1527 the client identifies the target object by supplying the correct
1528 URI in the "job-uri (uri)" operation attribute.
1529 - The Printer object that created the Job object using both the
1530 Printer objects URI and the Job object's Job ID. Since the
1531 Printer object that created the Job object generated the Job ID,
1532 it MUST be able to correctly associate the client supplied Job ID
1533 with the correct Job object. The client supplies the Printer
1534 object's URI in the "printer-uri (uri)" operation attribute and
1535 the Job object's Job ID in the "job-id (integer(1:MAX))"
1536 operation attribute.
1537
1538 If the operation is directed at the Job object directly using the Job
1539 object's URI, the client MUST NOT include the redundant "job-id"
1540 operation attribute.
1541
1542 The operation target attributes are REQUIRED operation attributes
1543 that MUST be included in every operation request. Like the charset
1544 and natural language attributes (see <a href="#section-3.1.4">section 3.1.4</a>), the operation
1545 target attributes are specially ordered operation attributes. In all
1546 cases, the operation target attributes immediately follow the
1547 "attributes-charset" and "attributes-natural-language" attributes
1548 within the operation attribute group, however the specific ordering
1549 rules are:
1550
1551 - In the case where there is only one operation target attribute
1552 (i.e., either only the "printer-uri" attribute or only the "job-
1553 uri" attribute), that attribute MUST be the third attribute in
1554 the operation attributes group.
1555 - In the case where Job operations use two operation target
1556 attributes (i.e., the "printer-uri" and "job-id" attributes), the
1557 "printer-uri" attribute MUST be the third attribute and the
1558 "job-id" attribute MUST be the fourth attribute.
1559
1560
1561
1562
1563
1564 <span class="grey">deBry, et al. Experimental [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1567
1568
1569 In all cases, the target URIs contained within the body of IPP
1570 operation requests and responses must be in absolute format rather
1571 than relative format (a relative URL identifies a resource with the
1572 scope of the HTTP server, but does not include scheme, host or port).
1573
1574 The following rules apply to the use of port numbers in URIs that
1575 identify IPP objects:
1576
1577 1. If the URI scheme allows the port number to be explicitly
1578 included in the URI string, and a port number is specified
1579 within the URI, then that port number MUST be used by the client
1580 to contact the IPP object.
1581
1582 2. If the URI scheme allows the port number to be explicitly
1583 included in the URI string, and a port number is not specified
1584 within the URI, then default port number implied by that URI
1585 scheme MUST be used by the client to contact the IPP object.
1586
1587 3. If the URI scheme does not allow an explicit port number to be
1588 specified within the URI, then the default port number implied
1589 by that URI MUST be used by the client to contact the IPP
1590 object.
1591
1592 Note: The IPP encoding and transport document [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] shows a
1593 mapping of IPP onto HTTP/1.1 and defines a new default port number
1594 for using IPP over HTTP/1.1.
1595
1596 <span class="h4"><a class="selflink" id="section-3.1.6" href="#section-3.1.6">3.1.6</a> Operation Status Codes and Messages</span>
1597
1598 Every operation response includes a REQUIRED "status-code" parameter
1599 and an OPTIONAL "status-message" operation attribute. The "status-
1600 code" provides information on the processing of a request. A
1601 "status-message" attribute provides a short textual description of
1602 the status of the operation. The status code is intended for use by
1603 automata, and the status message is intended for the human end user.
1604 If a response does include a "status-message" attribute, an IPP
1605 client NEED NOT examine or display the message, however it SHOULD do
1606 so in some implementation specific manner.
1607
1608 The "status-code" value is a numeric value that has semantic meaning.
1609 The "status-code" syntax is similar to a "type2 enum" (see <a href="#section-4.1">section</a>
1610 <a href="#section-4.1">4.1</a> on "Attribute Syntaxes") except that values can range only from
1611 0x0000 to 0x7FFF. <a href="#section-13">Section 13</a> describes the status codes, assigns the
1612 numeric values, and suggests a corresponding status message for each
1613 status code. The "status-message" attribute's syntax is "text(255)".
1614 A client implementation of IPP SHOULD convert status code values into
1615 any localized message that has semantic meaning to the end user.
1616
1617
1618
1619
1620 <span class="grey">deBry, et al. Experimental [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1623
1624
1625 If the Printer object supports the "status-message" operation
1626 attribute, the Printer object MUST be able to generate this message
1627 in any of the natural languages identified by the Printer object's
1628 "generated-natural-language-supported" attribute (see the
1629 "attributes-natural-language" operation attribute specified in
1630 <a href="#section-3.1.4.1">section 3.1.4.1</a>). As described in <a href="#section-3.1.4.1">section 3.1.4.1</a> for any returned '
1631 text' attribute, if there is a choice for generating this message,
1632 the Printer object uses the natural language indicated by the value
1633 of the "attributes-natural-language" in the client request if
1634 supported, otherwise the Printer object uses the value in the Printer
1635 object's own "natural-language-configured" attribute. If the Printer
1636 object supports the "status-message" operation attribute, it SHOULD
1637 use the REQUIRED 'utf-8' charset to return a status message for the
1638 following error status codes (see <a href="#section-13">section 13</a>): 'client-error-bad-
1639 request', 'client-error-charset-not-supported', 'server-error-
1640 internal-error', 'server-error-operation-not-supported', and '
1641 server-error-version-not-supported'. In this case, it MUST set the
1642 value of the "attributes-charset" operation attribute to 'utf-8' in
1643 the error response.
1644
1645 <span class="h4"><a class="selflink" id="section-3.1.7" href="#section-3.1.7">3.1.7</a> Versions</span>
1646
1647 Each operation request and response carries with it a "version-
1648 number" parameter. Each value of the "version-number" is in the form
1649 "X.Y" where X is the major version number and Y is the minor version
1650 number. By including a version number in the client request, it
1651 allows the client to identify which version of IPP it is interested
1652 in using. If the IPP object does not support that version, the
1653 object responds with a status code of 'server-error-version-not-
1654 supported' along with the closest version number that is supported
1655 (see <a href="#section-13.1.5.4">section 13.1.5.4</a>).
1656
1657 There is no version negotiation per se. However, if after receiving
1658 a 'server-error-version-not-supported' status code from an IPP
1659 object, there is nothing that prevents a client from trying again
1660 with a different version number. In order to conform to IPP/1.0, an
1661 implementation MUST support at least version '1.0'.
1662
1663 There is only one notion of "version number" that covers both IPP
1664 Model and IPP Protocol changes. Thus the version number MUST change
1665 when introducing a new version of the Model and Semantics document
1666 [<a href="./rfc2566">RFC2566</a>] or a new version of the Encoding and Transport document
1667 [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>].
1668
1669 Changes to the major version number indicate structural or syntactic
1670 changes that make it impossible for older version of IPP clients and
1671 Printer objects to correctly parse and process the new or changed
1672 attributes, operations and responses. If the major version number
1673
1674
1675
1676 <span class="grey">deBry, et al. Experimental [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1679
1680
1681 changes, the minor version numbers is set to zero. As an example,
1682 adding the "ipp-attribute-fidelity" attribute (if it had not been
1683 part of version '1.0'), would have required a change to the major
1684 version number. Items that might affect the changing of the major
1685 version number include any changes to the Model and Semantics
1686 document [<a href="./rfc2566">RFC2566</a>] or the Encoding and Transport [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] itself,
1687 such as:
1688
1689 - reordering of ordered attributes or attribute sets
1690 - changes to the syntax of existing attributes
1691 - changing Operation or Job Template attributes from OPTIONAL to
1692 REQUIRED and vice versa
1693 - adding REQUIRED (for an IPP object to support) operation
1694 attributes
1695 - adding REQUIRED (for an IPP object to support) operation
1696 attribute groups
1697 - adding values to existing operation attributes
1698 - adding REQUIRED operations
1699
1700 Changes to the minor version number indicate the addition of new
1701 features, attributes and attribute values that may not be understood
1702 by all IPP objects, but which can be ignored if not understood.
1703 Items that might affect the changing of the minor version number
1704 include any changes to the model objects and attributes but not the
1705 encoding and transport rules [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] (except adding attribute
1706 syntaxes). Examples of such changes are:
1707
1708 - grouping all extensions not included in a previous version into
1709 a new version
1710 - adding new attribute values
1711 - adding new object attributes
1712 - adding OPTIONAL (for an IPP object to support) operation
1713 attributes (i.e., those attributes that an IPP object can ignore
1714 without confusing clients)
1715 - adding OPTIONAL (for an IPP object to support) operation
1716 attribute groups (i.e., those attributes that an IPP object can
1717 ignore without confusing clients)
1718 - adding new attribute syntaxes
1719 - adding OPTIONAL operations
1720 - changing Job Description attributes or Printer Description
1721 attributes from OPTIONAL to REQUIRED or vice versa.
1722
1723 The encoding of the "operation-id", the "version-number", the
1724 "status-code", and the "request-id" MUST NOT change over any version
1725 number (either major or minor). This rule guarantees that all future
1726 versions will be backwards compatible with all previous versions (at
1727 least for checking the "operation-id", the "version-number", and the
1728 "request-id"). In addition, any protocol elements (attributes, error
1729
1730
1731
1732 <span class="grey">deBry, et al. Experimental [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1735
1736
1737 codes, tags, etc.) that are not carried forward from one version to
1738 the next are deprecated so that they can never be reused with new
1739 semantics.
1740
1741 Implementations that support a certain major version NEED NOT support
1742 ALL previous versions. As each new major version is defined (through
1743 the release of a new specification), that major version will specify
1744 which previous major versions MUST be supported in compliant
1745 implementations.
1746
1747 <span class="h4"><a class="selflink" id="section-3.1.8" href="#section-3.1.8">3.1.8</a> Job Creation Operations</span>
1748
1749 In order to "submit a print job" and create a new Job object, a
1750 client issues a create request. A create request is any one of
1751 following three operation requests:
1752
1753 - The Print-Job Request: A client that wants to submit a print job
1754 with only a single document uses the Print-Job operation. The
1755 operation allows for the client to "push" the document data to
1756 the Printer object by including the document data in the request
1757 itself.
1758
1759 - The Print-URI Request: A client that wants to submit a print job
1760 with only a single document (where the Printer object "pulls" the
1761 document data instead of the client "pushing" the data to the
1762 Printer object) uses the Print-URI operation. In this case, the
1763 client includes in the request only a URI reference to the
1764 document data (not the document data itself).
1765
1766 - The Create-Job Request: A client that wants to submit a print job
1767 with multiple documents uses the Create-Job operation. This
1768 operation is followed by an arbitrary number of Send-Document
1769 and/or Send-URI operations (each creating another document for
1770 the newly create Job object). The Send-Document operation
1771 includes the document data in the request (the client "pushes"
1772 the document data to the printer), and the Send-URI operation
1773 includes only a URI reference to the document data in the request
1774 (the Printer "pulls" the document data from the referenced
1775 location). The last Send-Document or Send-URI request for a
1776 given Job object includes a "last-document" operation attribute
1777 set to 'true' indicating that this is the last request.
1778
1779 Throughout this model specification, the term "create request" is
1780 used to refer to any of these three operation requests.
1781
1782 A Create-Job operation followed by only one Send-Document operation
1783 is semantically equivalent to a Print-Job operation, however, for
1784 performance reasons, the client SHOULD use the Print-Job operation
1785
1786
1787
1788 <span class="grey">deBry, et al. Experimental [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1791
1792
1793 for all single document jobs. Also, Print-Job is a REQUIRED
1794 operation (all implementations MUST support it) whereas Create-Job is
1795 an OPTIONAL operation, hence some implementations might not support
1796 it.
1797
1798 Job submission time is the point in time when a client issues a
1799 create request. The initial state of every Job object is the '
1800 pending' or 'pending-held' state. Later, the Printer object begins
1801 processing the print job. At this point in time, the Job object's
1802 state moves to 'processing'. This is known as job processing time.
1803 There are validation checks that must be done at job submission time
1804 and others that must be performed at job processing time.
1805
1806 At job submission time and at the time a Validate-Job operation is
1807 received, the Printer MUST do the following:
1808
1809 1. Process the client supplied attributes and either accept or
1810 reject the request
1811 2. Validate the syntax of and support for the scheme of any client
1812 supplied URI
1813
1814 At job submission time the Printer object MUST validate whether or
1815 not the supplied attributes, attribute syntaxes, and values are
1816 supported by matching them with the Printer object's corresponding
1817 "xxx-supported" attributes. See <a href="#section-3.2.1.2">section 3.2.1.2</a> for details. [ipp-
1818 iig] presents suggested steps for an IPP object to either accept or
1819 reject any request and additional steps for processing create
1820 requests.
1821
1822 At job submission time the Printer object NEED NOT perform the
1823 validation checks reserved for job processing time such as:
1824
1825 1. Validating the document data
1826 2. Validating the actual contents of any client supplied URI
1827 (resolve the reference and follow the link to the document data)
1828
1829 At job submission time, these additional job processing time
1830 validation checks are essentially useless, since they require
1831 actually parsing and interpreting the document data, are not
1832 guaranteed to be 100% accurate, and MUST be done, yet again, at job
1833 processing time. Also, in the case of a URI, checking for
1834 availability at job submission time does not guarantee availability
1835 at job processing time. In addition, at job processing time, the
1836 Printer object might discover any of the following conditions that
1837 were not detectable at job submission time:
1838
1839 - runtime errors in the document data,
1840 - nested document data that is in an unsupported format,
1841
1842
1843
1844 <span class="grey">deBry, et al. Experimental [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1847
1848
1849 - the URI reference is no longer valid (i.e., the server hosting
1850 the document might be down), or
1851 - any other job processing error
1852
1853 At job processing time, since the Printer object has already
1854 responded with a successful status code in the response to the create
1855 request, if the Printer object detects an error, the Printer object
1856 is unable to inform the end user of the error with an operation
1857 status code. In this case, the Printer, depending on the error, can
1858 set the "job-state", "job-state-reasons", or "job-state-message"
1859 attributes to the appropriate value(s) so that later queries can
1860 report the correct job status.
1861
1862 Note: Asynchronous notification of events is outside the scope of
1863 IPP/1.0.
1864
1865 <span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a> Printer Operations</span>
1866
1867 All Printer operations are directed at Printer objects. A client
1868 MUST always supply the "printer-uri" operation attribute in order to
1869 identify the correct target of the operation.
1870
1871 <span class="h4"><a class="selflink" id="section-3.2.1" href="#section-3.2.1">3.2.1</a> Print-Job Operation</span>
1872
1873 This REQUIRED operation allows a client to submit a print job with
1874 only one document and supply the document data (rather than just a
1875 reference to the data). See <a href="#section-15">Section 15</a> for the suggested steps for
1876 processing create operations and their Operation and Job Template
1877 attributes.
1878
1879 <span class="h5"><a class="selflink" id="section-3.2.1.1" href="#section-3.2.1.1">3.2.1.1</a> Print-Job Request</span>
1880
1881 The following groups of attributes are supplied as part of the
1882 Print-Job Request:
1883
1884 Group 1: Operation Attributes
1885
1886 Natural Language and Character Set:
1887 The "attributes-charset" and "attributes-natural-language"
1888 attributes as described in <a href="#section-3.1.4.1">section 3.1.4.1</a>. The Printer object
1889 MUST copy these values to the corresponding Job Description
1890 attributes described in sections <a href="#section-4.3.23">4.3.23</a> and <a href="#section-4.3.24">4.3.24</a>.
1891
1892 Target:
1893 The "printer-uri" (uri) operation attribute which is the target
1894 for this operation as described in <a href="#section-3.1.5">section 3.1.5</a>.
1895
1896
1897
1898
1899
1900 <span class="grey">deBry, et al. Experimental [Page 34]</span></pre>
1901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
1902 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1903
1904
1905 Requesting User Name:
1906 The "requesting-user-name" (name(MAX)) attribute SHOULD be
1907 supplied by the client as described in <a href="#section-8.3">section 8.3</a>.
1908
1909 "job-name" (name(MAX)):
1910 The client OPTIONALLY supplies this attribute. The Printer
1911 object MUST support this attribute. It contains the client
1912 supplied Job name. If this attribute is supplied by the client,
1913 its value is used for the "job-name" attribute of the newly
1914 created Job object. The client MAY automatically include any
1915 information that will help the end-user distinguish amongst
1916 his/her jobs, such as the name of the application program along
1917 with information from the document, such as the document name,
1918 document subject, or source file name. If this attribute is not
1919 supplied by the client, the Printer generates a name to use in
1920 the "job-name" attribute of the newly created Job object (see
1921 <a href="#section-4.3.5">Section 4.3.5</a>).
1922
1923 "ipp-attribute-fidelity" (boolean):
1924 The client OPTIONALLY supplies this attribute. The Printer
1925 object MUST support this attribute. The value 'true' indicates
1926 that total fidelity to client supplied Job Template attributes
1927 and values is required, else the Printer object MUST reject the
1928 Print-Job request. The value 'false' indicates that a
1929 reasonable attempt to print the Job object is acceptable and the
1930 Printer object MUST accept the Print-job request. If not
1931 supplied, the Printer object assumes the value is 'false'. All
1932 Printer objects MUST support both types of job processing. See
1933 <a href="#section-15">section 15</a> for a full description of "ipp-attribute-fidelity"
1934 and its relationship to other attributes, especially the Printer
1935 object's "pdl-override-supported" attribute.
1936
1937 "document-name" (name(MAX)):
1938 The client OPTIONALLY supplies this attribute. The Printer
1939 object MUST support this attribute. It contains the client
1940 supplied document name. The document name MAY be different than
1941 the Job name. Typically, the client software automatically
1942 supplies the document name on behalf of the end user by using a
1943 file name or an application generated name. If this attribute
1944 is supplied, its value can be used in a manner defined by each
1945 implementation. Examples include: printed along with the Job
1946 (job start sheet, page adornments, etc.), used by accounting or
1947 resource tracking management tools, or even stored along with
1948 the document as a document level attribute. IPP/1.0 does not
1949 support the concept of document level attributes.
1950
1951
1952
1953
1954
1955
1956 <span class="grey">deBry, et al. Experimental [Page 35]</span></pre>
1957 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
1958 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
1959
1960
1961 "document-format" (mimeMediaType) :
1962 The client OPTIONALLY supplies this attribute. The Printer
1963 object MUST support this attribute. The value of this attribute
1964 identifies the format of the supplied document data. If the
1965 client does not supply this attribute, the Printer object
1966 assumes that the document data is in the format defined by the
1967 Printer object's "document-format-default" attribute. If the
1968 client supplies this attribute, but the value is not supported
1969 by the Printer object, i.e., the value is not one of the values
1970 of the Printer object's "document-format-supported" attribute,
1971 the Printer object MUST reject the request and return the '
1972 client-error-document-format-not-supported' status code.
1973
1974 "document-natural-language" (naturalLanguage):
1975 The client OPTIONALLY supplies this attribute. The Printer
1976 object OPTIONALLY supports this attribute. This attribute
1977 specifies the natural language of the document for those
1978 document-formats that require a specification of the natural
1979 language in order to image the document unambiguously. There are
1980 no particular values required for the Printer object to support.
1981
1982 "compression" (type3 keyword)
1983 The client OPTIONALLY supplies this attribute. The Printer
1984 object OPTIONALLY supports this attribute and the "compression-
1985 supported" attribute (see <a href="#section-4.4.29">section 4.4.29</a>). The client supplied
1986 "compression" operation attribute identifies the compression
1987 algorithm used on the document data. If the client omits this
1988 attribute, the Printer object MUST assume that the data is not
1989 compressed. If the client supplies the attribute and the
1990 Printer object supports the attribute, the Printer object uses
1991 the corresponding decompression algorithm on the document data.
1992 If the client supplies this attribute, but the value is not
1993 supported by the Printer object, i.e., the value is not one of
1994 the values of the Printer object's "compression-supported"
1995 attribute, the Printer object MUST copy the attribute and its
1996 value to the Unsupported Attributes response group, reject the
1997 request, and return the 'client-error-attributes-or-values-not-
1998 supported' status code.
1999
2000 "job-k-octets" (integer(0:MAX))
2001 The client OPTIONALLY supplies this attribute. The Printer
2002 object OPTIONALLY supports this attribute and the "job-k-
2003 octets-supported" attribute (see <a href="#section-4.4.30">section 4.4.30</a>). The client
2004 supplied "job-k-octets" operation attribute identifies the total
2005 size of the document(s) in K octets being submitted (see <a href="#section-4.3.17">section</a>
2006 <a href="#section-4.3.17">4.3.17</a> for the complete semantics). If the client supplies the
2007
2008
2009
2010
2011
2012 <span class="grey">deBry, et al. Experimental [Page 36]</span></pre>
2013 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
2014 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2015
2016
2017 attribute and the Printer object supports the attribute, the
2018 value of the attribute is used to populate the Job object's
2019 "job-k-octets" Job Description attribute.
2020
2021 Note: For this attribute and the following two attributes
2022 ("job-impressions", and "job-media-sheets"), if the client
2023 supplies the attribute, but the Printer object does not support
2024 the attribute, the Printer object ignores the client-supplied
2025 value. If the client supplies the attribute and the Printer
2026 supports the attribute, and the value is within the range of the
2027 corresponding Printer object's "xxx-supported" attribute, the
2028 Printer object MUST use the value to populate the Job object's
2029 "xxx" attribute. If the client supplies the attribute and the
2030 Printer supports the attribute, but the value is outside the
2031 range of the corresponding Printer object's "xxx-supported"
2032 attribute, the Printer object MUST copy the attribute and its
2033 value to the Unsupported Attributes response group, reject the
2034 request, and return the 'client-error-attributes-or-values-not-
2035 supported' status code. If the client does not supply the
2036 attribute, the Printer object MAY choose to populate the
2037 corresponding Job object attribute depending on whether the
2038 Printer object supports the attribute and is able to calculate
2039 or discern the correct value.
2040
2041 "job-impressions" (integer(0:MAX))
2042 The client OPTIONALLY supplies this attribute. The Printer
2043 object OPTIONALLY supports this attribute and the "job-
2044 impressions-supported" attribute (see <a href="#section-4.4.31">section 4.4.31</a>). The
2045 client supplied "job-impressions" operation attribute identifies
2046 the total size in number of impressions of the document(s) being
2047 submitted (see <a href="#section-4.3.18">section 4.3.18</a> for the complete semantics).
2048
2049 See note under "job-k-octets".
2050
2051 "job-media-sheets" (integer(0:MAX))
2052 The client OPTIONALLY supplies this attribute. The Printer
2053 object OPTIONALLY supports this attribute and the "job-media-
2054 sheets-supported" attribute (see <a href="#section-4.4.32">section 4.4.32</a>). The client
2055 supplied "job-media-sheets" operation attribute identifies the
2056 total number of media sheets to be produced for this job (see
2057 <a href="#section-4.3.19">section 4.3.19</a> for the complete semantics).
2058
2059 See note under "job-k-octets".
2060
2061
2062
2063
2064
2065
2066
2067
2068 <span class="grey">deBry, et al. Experimental [Page 37]</span></pre>
2069 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
2070 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2071
2072
2073 Group 2: Job Template Attributes
2074
2075 The client OPTIONALLY supplies a set of Job Template attributes
2076 as defined in <a href="#section-4.2">section 4.2</a>. If the client is not supplying any
2077 Job Template attributes in the request, the client SHOULD omit
2078 Group 2 rather than sending an empty group. However, a Printer
2079 object MUST be able to accept an empty group.
2080
2081 Group 3: Document Content
2082
2083 The client MUST supply the document data to be processed.
2084
2085 Note: In addition to the MANDATORY parameters required for every
2086 operation request, the simplest Print-Job Request consists of just
2087 the "attributes-charset" and "attributes-natural-language" operation
2088 attributes; the "printer-uri" target operation attribute; the
2089 Document Content and nothing else. In this simple case, the Printer
2090 object:
2091
2092 - creates a new Job object (the Job object contains a single
2093 document),
2094 - stores a generated Job name in the "job-name" attribute in the
2095 natural language and charset requested (see <a href="#section-3.1.4.1">Section 3.1.4.1</a>) (if
2096 those are supported, otherwise using the Printer object's default
2097 natural language and charset), and
2098 - at job processing time, uses its corresponding default value
2099 attributes for the supported Job Template attributes that were
2100 not supplied by the client as IPP attribute or embedded
2101 instructions in the document data.
2102
2103 <span class="h5"><a class="selflink" id="section-3.2.1.2" href="#section-3.2.1.2">3.2.1.2</a> Print-Job Response</span>
2104
2105 The Printer object MUST return to the client the following sets
2106 of attributes as part of the Print-Job Response:
2107
2108 Group 1: Operation Attributes
2109
2110 Status Message:
2111 In addition to the REQUIRED status code returned in every
2112 response, the response OPTIONALLY includes a "status-message"
2113 (text) operation attribute as described in sections <a href="#section-14">14</a> and
2114 3.1.6. If the client supplies unsupported or conflicting Job
2115 Template attributes or values, the Printer object MUST reject or
2116 accept the Print-Job request depending on the whether the client
2117 supplied a 'true' or 'false' value for the "ipp-attribute-
2118 fidelity" operation attribute. See the Implementer's Guide
2119 [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>] for a complete description of the suggested steps for
2120 processing a create request.
2121
2122
2123
2124 <span class="grey">deBry, et al. Experimental [Page 38]</span></pre>
2125 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
2126 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2127
2128
2129 Natural Language and Character Set:
2130 The "attributes-charset" and "attributes-natural-language"
2131 attributes as described in <a href="#section-3.1.4.2">section 3.1.4.2</a>.
2132
2133 Group 2: Unsupported Attributes
2134
2135 This is a set of Operation and Job Template attributes supplied
2136 by the client (in the request) that are not supported by the
2137 Printer object or that conflict with one another (see the
2138 Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>]). If the Printer object is not
2139 returning any Unsupported Attributes in the response, the
2140 Printer object SHOULD omit Group 2 rather than sending an empty
2141 group. However, a client MUST be able to accept an empty group.
2142
2143 Unsupported attributes fall into three categories:
2144
2145 1. The Printer object does not support the supplied attribute
2146 (no matter what the attribute syntax or value).
2147 2. The Printer object does support the attribute, but does not
2148 support some or all of the particular attribute syntaxes or
2149 values supplied by the client (i.e., the Printer object does
2150 not have those attribute syntaxes or values in its
2151 corresponding "xxx-supported" attribute).
2152 3. The Printer object does support the attributes and values
2153 supplied, but the particular values are in conflict with one
2154 another, because they violate a constraint, such as not being
2155 able to staple transparencies.
2156
2157 In the case of an unsupported attribute name, the Printer object
2158 returns the client-supplied attribute with a substituted "out-
2159 of-band" value of 'unsupported' indicating no support for the
2160 attribute itself (see the beginning of <a href="#section-4.1">section 4.1</a>).
2161
2162 In the case of a supported attribute with one or more
2163 unsupported attribute syntaxes or values, the Printer object
2164 simply returns the client-supplied attribute with the
2165 unsupported attribute syntaxes or values as supplied by the
2166 client. This indicates support for the attribute, but no
2167 support for that particular attribute syntax or value. If the
2168 client supplies a multi-valued attribute with more than one
2169 value and the Printer object supports the attribute but only
2170 supports a subset of the client-supplied attribute syntaxes or
2171 values, the Printer object MUST return only those attribute
2172 syntaxes or values that are unsupported.
2173
2174 In the case of two (or more) supported attribute values that are
2175 in conflict with one another (although each is supported
2176 independently, the values conflict when requested together
2177
2178
2179
2180 <span class="grey">deBry, et al. Experimental [Page 39]</span></pre>
2181 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
2182 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2183
2184
2185 within the same job), the Printer object MUST return all the
2186 values that it ignores or substitutes to resolve the conflict,
2187 but not any of the values that it is still using. The choice
2188 for exactly how to resolve the conflict is implementation
2189 dependent. See The Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>] for an
2190 example.
2191
2192 In these three cases, the value of the "ipp-attribute-fidelity"
2193 supplied by the client does not affect what the Printer object
2194 returns. The value of "ipp-attribute-fidelity" only affects
2195 whether the Print-Job operation is accepted or rejected. If the
2196 job is accepted, the client may query the job using the Get-
2197 Job-Attributes operation requesting the unsupported attributes
2198 that were returned in the create response to see which
2199 attributes were ignored (not stored on the Job object) and which
2200 attributes were stored with other (substituted) values.
2201
2202 Group 3: Job Object Attributes
2203
2204 "job-uri" (uri):
2205 The Printer object MUST return the Job object's URI by returning
2206 the contents of the REQUIRED "job-uri" Job object attribute.
2207 The client uses the Job object's URI when directing operations
2208 at the Job object. The Printer object always uses its
2209 configured security policy when creating the new URI. However,
2210 if the Printer object supports more than one URI, the Printer
2211 object also uses information about which URI was used in the
2212 Print-Job Request to generated the new URI so that the new URI
2213 references the correct access channel. In other words, if the
2214 Print-Job Request comes in over a secure channel, the Printer
2215 object MUST generate a Job URI that uses the secure channel as
2216 well.
2217
2218 "job-id" (integer(1:MAX)):
2219 The Printer object MUST return the Job object's Job ID by
2220 returning the REQUIRED "job-id" Job object attribute. The
2221 client uses this "job-id" attribute in conjunction with the
2222 "printer-uri" attribute used in the Print-Job Request when
2223 directing Job operations at the Printer object.
2224
2225 "job-state":
2226 The Printer object MUST return the Job object's REQUIRED "job-
2227 state" attribute. The value of this attribute (along with the
2228 value of the next attribute "job-state-reasons") is taken from a
2229 "snapshot" of the new Job object at some meaningful point in
2230 time (implementation defined) between when the Printer object
2231 receives the Print-Job Request and when the Printer object
2232 returns the response.
2233
2234
2235
2236 <span class="grey">deBry, et al. Experimental [Page 40]</span></pre>
2237 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
2238 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2239
2240
2241 "job-state-reasons":
2242 The Printer object OPTIONALLY returns the Job object's OPTIONAL
2243 "job-state-reasons" attribute. If the Printer object supports
2244 this attribute then it MUST be returned in the response. If
2245 this attribute is not returned in the response, the client can
2246 assume that the "job-state-reasons" attribute is not supported
2247 and will not be returned in a subsequent Job object query.
2248
2249 "job-state-message":
2250 The Printer object OPTIONALLY returns the Job object's OPTIONAL
2251 "job-state-message" attribute. If the Printer object supports
2252 this attribute then it MUST be returned in the response. If
2253 this attribute is not returned in the response, the client can
2254 assume that the "job-state-message" attribute is not supported
2255 and will not be returned in a subsequent Job object query.
2256
2257 "number-of-intervening-jobs":
2258 The Printer object OPTIONALLY returns the Job object's OPTIONAL
2259 "number-of-intervening-jobs" attribute. If the Printer object
2260 supports this attribute then it MUST be returned in the
2261 response. If this attribute is not returned in the response,
2262 the client can assume that the "number-of-intervening-jobs"
2263 attribute is not supported and will not be returned in a
2264 subsequent Job object query.
2265
2266 Note: Since any printer state information which affects a job's
2267 state is reflected in the "job-state" and "job-state-reasons"
2268 attributes, it is sufficient to return only these attributes and
2269 no specific printer status attributes.
2270
2271 Note: In addition to the MANDATORY parameters required for every
2272 operation response, the simplest response consists of the just the
2273 "attributes-charset" and "attributes-natural-language" operation
2274 attributes and the "job-uri", "job-id", and "job-state" Job Object
2275 Attributes. In this simplest case, the status code is "successful-
2276 ok" and there is no "status-message" operation attribute.
2277
2278 <span class="h4"><a class="selflink" id="section-3.2.2" href="#section-3.2.2">3.2.2</a> Print-URI Operation</span>
2279
2280 This OPTIONAL operation is identical to the Print-Job operation
2281 (<a href="#section-3.2.1">section 3.2.1</a>) except that a client supplies a URI reference to the
2282 document data using the "document-uri" (uri) operation attribute (in
2283 Group 1) rather than including the document data itself. Before
2284 returning the response, the Printer MUST validate that the Printer
2285 supports the retrieval method (e.g., http, ftp, etc.) implied by the
2286 URI, and MUST check for valid URI syntax. If the client-supplied URI
2287 scheme is not supported, i.e. the value is not in the Printer
2288 object's "referenced-uri-scheme-supported" attribute, the Printer
2289
2290
2291
2292 <span class="grey">deBry, et al. Experimental [Page 41]</span></pre>
2293 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
2294 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2295
2296
2297 object MUST reject the request and return the 'client-error-uri-
2298 scheme-not-supported' status code. See The Implementer's Guide
2299 [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>] for suggested additional checks. The Printer NEED NOT
2300 follow the reference and validate the contents of the reference.
2301
2302 If the Printer object supports this operation, it MUST support the
2303 "reference-uri-schemes-supported" Printer attribute (see <a href="#section-4.4.24">section</a>
2304 <a href="#section-4.4.24">4.4.24</a>).
2305
2306 It is up to the IPP object to interpret the URI and subsequently
2307 "pull" the document from the source referenced by the URI string.
2308
2309 <span class="h4"><a class="selflink" id="section-3.2.3" href="#section-3.2.3">3.2.3</a> Validate-Job Operation</span>
2310
2311 This REQUIRED operation is similar to the Print-Job operation
2312 (<a href="#section-3.2.1">section 3.2.1</a>) except that a client supplies no document data and
2313 the Printer allocates no resources (i.e., it does not create a new
2314 Job object). This operation is used only to verify capabilities of a
2315 printer object against whatever attributes are supplied by the client
2316 in the Validate-Job request. By using the Validate-Job operation a
2317 client can validate that an identical Print-Job operation (with the
2318 document data) would be accepted. The Validate-Job operation also
2319 performs the same security negotiation as the Print-Job operation
2320 (see <a href="#section-8">section 8</a>), so that a client can check that the client and
2321 Printer object security requirements can be met before performing a
2322 Print-Job operation.
2323
2324 Note: The Validate-Job operation does not accept a "document-uri"
2325 attribute in order to allow a client to check that the same Print-URI
2326 operation will be accepted, since the client doesn't send the data
2327 with the Print-URI operation. The client SHOULD just issue the
2328 Print-URI request.
2329
2330 The Printer object returns the same status codes, Operation
2331 Attributes (Group 1) and Unsupported Attributes (Group 2) as the
2332 Print-Job operation. However, no Job Object Attributes (Group 3) are
2333 returned, since no Job object is created.
2334
2335 <span class="h4"><a class="selflink" id="section-3.2.4" href="#section-3.2.4">3.2.4</a> Create-Job Operation</span>
2336
2337 This OPTIONAL operation is similar to the Print-Job operation
2338 (<a href="#section-3.2.1">section 3.2.1</a>) except that in the Create-Job request, a client does
2339 not supply document data or any reference to document data. Also,
2340 the client does not supply any of the "document-name", "document-
2341 format", "compression", or "document-natural-language" operation
2342 attributes. This operation is followed by one or more Send-Document
2343 or Send-URI operations. In each of those operation requests, the
2344
2345
2346
2347
2348 <span class="grey">deBry, et al. Experimental [Page 42]</span></pre>
2349 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
2350 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2351
2352
2353 client OPTIONALLY supplies the "document-name", "document-format",
2354 and "document-natural-language" attributes for each document in the
2355 multi-document Job object.
2356
2357 If a Printer object supports the Create-Job operation, it MUST also
2358 support the Send-Document operation and also MAY support the Send-URI
2359 operation.
2360
2361 If the Printer object supports this operation, it MUST support the
2362 "multiple-operation-time-out" Printer attribute (see <a href="#section-4.4.28">section 4.4.28</a>).
2363
2364
2365 <span class="h4"><a class="selflink" id="section-3.2.5" href="#section-3.2.5">3.2.5</a> Get-Printer-Attributes Operation</span>
2366
2367 This REQUIRED operation allows a client to request the values of the
2368 attributes of a Printer object. In the request, the client supplies
2369 the set of Printer attribute names and/or attribute group names in
2370 which the requester is interested. In the response, the Printer
2371 object returns a corresponding attribute set with the appropriate
2372 attribute values filled in.
2373
2374 For Printer objects, the possible names of attribute groups are:
2375
2376 - 'job-template': all of the Job Template attributes that apply to
2377 a Printer object (the last two columns of the table in <a href="#section-4.2">Section</a>
2378 <a href="#section-4.2">4.2</a>).
2379 - 'printer-description': the attributes specified in <a href="#section-4.4">Section 4.4</a>.
2380 - 'all': the special group 'all' that includes all supported
2381 attributes.
2382
2383 Since a client MAY request specific attributes or named groups, there
2384 is a potential that there is some overlap. For example, if a client
2385 requests, 'printer-name' and 'all', the client is actually requesting
2386 the "printer-name" attribute twice: once by naming it explicitly, and
2387 once by inclusion in the 'all' group. In such cases, the Printer
2388 object NEED NOT return each attribute only once in the response even
2389 if it is requested multiple times. The client SHOULD NOT request the
2390 same attribute in multiple ways.
2391
2392 It is NOT REQUIRED that a Printer object support all attributes
2393 belonging to a group (since some attributes are OPTIONAL). However,
2394 it is REQUIRED that each Printer object support all group names.
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404 <span class="grey">deBry, et al. Experimental [Page 43]</span></pre>
2405 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
2406 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2407
2408
2409 <span class="h5"><a class="selflink" id="section-3.2.5.1" href="#section-3.2.5.1">3.2.5.1</a> Get-Printer-Attributes Request</span>
2410
2411 The following sets of attributes are part of the Get-Printer-
2412 Attributes Request:
2413
2414 Group 1: Operation Attributes
2415
2416 Natural Language and Character Set:
2417 attributes-charset" and "attributes-natural-language" butes as
2418 described in <a href="#section-3.1.4.1">section 3.1.4.1</a>.
2419
2420 Target:
2421 The "printer-uri" (uri) operation attribute which is the target
2422 for this operation as described in <a href="#section-3.1.5">section 3.1.5</a>.
2423
2424 Requesting User Name:
2425 The "requesting-user-name" (name(MAX)) attribute SHOULD be
2426 supplied by the client as described in <a href="#section-8.3">section 8.3</a>.
2427
2428 "requested-attributes" (1setOf keyword) :
2429 The client OPTIONALLY supplies a set of attribute names and/or
2430 attribute group names in whose values the requester is
2431 interested. The Printer object MUST support this attribute. If
2432 the client omits this attribute, the Printer MUST respond as if
2433 this attribute had been supplied with a value of 'all'.
2434
2435 "document-format" (mimeMediaType) :
2436 The client OPTIONALLY supplies this attribute. The Printer
2437 object MUST support this attribute. This attribute is useful
2438 for a Printer object to determine the set of supported attribute
2439 values that relate to the requested document format. The
2440 Printer object MUST return the attributes and values that it
2441 uses to validate a job on a create or Validate-Job operation in
2442 which this document format is supplied. The Printer object
2443 SHOULD return only (1) those attributes that are supported for
2444 the specified format and (2) the attribute values that are
2445 supported for the specified document format. By specifying the
2446 document format, the client can get the Printer object to
2447 eliminate the attributes and values that are not supported for a
2448 specific document format. For example, a Printer object might
2449 have multiple interpreters to support both '
2450 application/postscript' (for PostScript) and 'text/plain' (for
2451 text) documents. However, for only one of those interpreters
2452 might the Printer object be able to support "number-up" with
2453 values of '1', '2', and '4'. For the other interpreter it might
2454 be able to only support "number-up" with a value of '1'. Thus a
2455
2456
2457
2458
2459
2460 <span class="grey">deBry, et al. Experimental [Page 44]</span></pre>
2461 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
2462 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2463
2464
2465 client can use the Get-Printer-Attributes operation to obtain
2466 the attributes and values that will be used to accept/reject a
2467 create job operation.
2468
2469 If the Printer object does not distinguish between different
2470 sets of supported values for each different document format when
2471 validating jobs in the create and Validate-Job operations, it
2472 MUST NOT distinguish between different document formats in the
2473 Get-Printer-Attributes operation. If the Printer object does
2474 distinguish between different sets of supported values for each
2475 different document format specified by the client, this
2476 specialization applies only to the following Printer object
2477 attributes:
2478
2479 - Printer attributes that are Job Template attributes ("xxx-
2480 default" "xxx-supported", and "xxx-ready" in the Table in
2481 <a href="#section-4.2">Section 4.2</a>),
2482 - "pdl-override-supported",
2483 - "compression-supported",
2484 - "job-k-octets-supported",
2485 - "job-impressions-supported,
2486 - "job-media-sheets-supported"
2487 - "printer-driver-installer",
2488 - "color-supported", and
2489 - "reference-uri-schemes-supported"
2490
2491 The values of all other Printer object attributes (including
2492 "document-format-supported") remain invariant with respect to
2493 the client supplied document format (except for new Printer
2494 description attribute as registered according to <a href="#section-6.2">section 6.2</a>).
2495
2496 If the client omits this "document-format" operation attribute,
2497 the Printer object MUST respond as if the attribute had been
2498 supplied with the value of the Printer object's "document-
2499 format-default" attribute. It is recommended that the client
2500 always supply a value for "document-format", since the Printer
2501 object's "document-format-default" may be 'application/octet-
2502 stream', in which case the returned attributes and values are
2503 for the union of the document formats that the Printer can
2504 automatically sense. For more details, see the description of
2505 the 'mimeMediaType' attribute syntax in <a href="#section-4.1.9">section 4.1.9</a>.
2506
2507 If the client supplies a value for the "document-format"
2508 Operation attribute that is not supported by the Printer, i.e.,
2509 is not among the values of the Printer object's "document-
2510 format-supported" attribute, the Printer object MUST reject the
2511 operation and return the 'client-error-document-format-not-
2512 supported' status code.
2513
2514
2515
2516 <span class="grey">deBry, et al. Experimental [Page 45]</span></pre>
2517 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
2518 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2519
2520
2521 <span class="h5"><a class="selflink" id="section-3.2.5.2" href="#section-3.2.5.2">3.2.5.2</a> Get-Printer-Attributes Response</span>
2522
2523 The Printer object returns the following sets of attributes as part
2524 of the Get-Printer-Attributes Response:
2525
2526 Group 1: Operation Attributes
2527
2528 Status Message:
2529 In addition to the REQUIRED status code returned in every
2530 response, the response OPTIONALLY includes a "status-message"
2531 (text) operation attribute as described in <a href="#section-3.1.6">section 3.1.6</a>.
2532
2533 Natural Language and Character Set:
2534 The "attributes-charset" and "attributes-natural-language"
2535 attributes as described in <a href="#section-3.1.4.2">section 3.1.4.2</a>.
2536
2537 Group 2: Unsupported Attributes
2538
2539 This is a set of Operation attributes supplied by the client (in
2540 the request) that are not supported by the Printer object or
2541 that conflict with one another (see sections <a href="#section-3.2.1.2">3.2.1.2</a> and <a href="#section-16">16</a>).
2542 The response NEED NOT contain the "requested-attributes"
2543 operation attribute with any supplied values (attribute
2544 keywords) that were requested by the client but are not
2545 supported by the IPP object. If the Printer object is not
2546 returning any Unsupported Attributes in the response, the
2547 Printer object SHOULD omit Group 2 rather than sending an empty
2548 group. However, a client MUST be able to accept an empty group.
2549
2550 Group 3: Printer Object Attributes
2551
2552 This is the set of requested attributes and their current
2553 values. The Printer object ignores (does not respond with) any
2554 requested attribute which is not supported. The Printer object
2555 MAY respond with a subset of the supported attributes and
2556 values, depending on the security policy in force. However, the
2557 Printer object MUST respond with the 'unknown' value for any
2558 supported attribute (including all REQUIRED attributes) for
2559 which the Printer object does not know the value. Also the
2560 Printer object MUST respond with the 'no-value' for any
2561 supported attribute (including all REQUIRED attributes) for
2562 which the system administrator has not configured a value. See
2563 the description of the "out-of-band" values in the beginning of
2564 <a href="#section-4.1">Section 4.1</a>.
2565
2566
2567
2568
2569
2570
2571
2572 <span class="grey">deBry, et al. Experimental [Page 46]</span></pre>
2573 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
2574 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2575
2576
2577 <span class="h4"><a class="selflink" id="section-3.2.6" href="#section-3.2.6">3.2.6</a> Get-Jobs Operation</span>
2578
2579 This REQUIRED operation allows a client to retrieve the list of Job
2580 objects belonging to the target Printer object. The client may also
2581 supply a list of Job attribute names and/or attribute group names. A
2582 group of Job object attributes will be returned for each Job object
2583 that is returned.
2584
2585 This operation is similar to the Get-Job-Attributes operation, except
2586 that this Get-Jobs operation returns attributes from possibly more
2587 than one object (see the description of Job attribute group names in
2588 <a href="#section-3.3.4">section 3.3.4</a>).
2589
2590 <span class="h5"><a class="selflink" id="section-3.2.6.1" href="#section-3.2.6.1">3.2.6.1</a> Get-Jobs Request</span>
2591
2592 The client submits the Get-Jobs request to a Printer object.
2593
2594 The following groups of attributes are part of the Get-Jobs Request:
2595
2596 Group 1: Operation Attributes
2597
2598 Natural Language and Character Set:
2599 The "attributes-charset" and "attributes-natural-language"
2600 attributes as described in <a href="#section-3.1.4.1">section 3.1.4.1</a>.
2601
2602 Target:
2603 The "printer-uri" (uri) operation attribute which is the target
2604 for this operation as described in <a href="#section-3.1.5">section 3.1.5</a>.
2605
2606 Requesting User Name:
2607 The "requesting-user-name" (name(MAX)) attribute SHOULD be
2608 supplied by the client as described in <a href="#section-8.3">section 8.3</a>.
2609
2610 "limit" (integer(1:MAX)):
2611 The client OPTIONALLY supplies this attribute. The Printer
2612 object MUST support this attribute. It is an integer value that
2613 indicates a limit to the number of Job objects returned. The
2614 limit is a "stateless limit" in that if the value supplied by
2615 the client is 'N', then only the first 'N' jobs are returned in
2616 the Get-Jobs Response. There is no mechanism to allow for the
2617 next 'M' jobs after the first 'N' jobs. If the client does not
2618 supply this attribute, the Printer object responds with all
2619 applicable jobs.
2620
2621 "requested-attributes" (1setOf keyword):
2622 The client OPTIONALLY supplies this attribute. The Printer
2623 object MUST support this attribute. It is a set of Job
2624 attribute names and/or attribute groups names in whose values
2625
2626
2627
2628 <span class="grey">deBry, et al. Experimental [Page 47]</span></pre>
2629 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
2630 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2631
2632
2633 the requester is interested. This set of attributes is returned
2634 for each Job object that is returned. The allowed attribute
2635 group names are the same as those defined in the Get-Job-
2636 Attributes operation in <a href="#section-3.3.4">section 3.3.4</a>. If the client does not
2637 supply this attribute, the Printer MUST respond as if the client
2638 had supplied this attribute with two values: 'job-uri' and '
2639 job-id'.
2640
2641 "which-jobs" (type2 keyword):
2642 The client OPTIONALLY supplies this attribute. The Printer
2643 object MUST support this attribute. It indicates which Job
2644 objects MUST be returned by the Printer object. The values for
2645 this attribute are:
2646
2647 'completed': This includes any Job object whose state is
2648 'completed', 'canceled', or 'aborted'.
2649 'not-completed': This includes any Job object whose state is '
2650 pending', 'processing', 'processing-stopped', or 'pending-
2651 held'.
2652
2653 A Printer object MUST support both values. However, if the
2654 mentation does not keep jobs in the 'completed', 'canceled', '
2655 aborted' states, then it returns no jobs when the 'completed'
2656 value is supplied.
2657
2658 If a client supplies some other value, the Printer object MUST
2659 copy the attribute and the unsupported value to the Unsupported
2660 Attributes response group, reject the request, and return the '
2661 client-error-attributes-or-values-not-supported' status code.
2662
2663 If the client does not supply this attribute, the Printer object
2664 MUST respond as if the client had supplied the attribute with a
2665 value of 'not-completed'.
2666
2667 "my-jobs" (boolean):
2668 The client OPTIONALLY supplies this attribute. The Printer
2669 object MUST support this attribute. It indicates whether all
2670 jobs or just the jobs submitted by the requesting user of this
2671 request MUST be returned by the Printer object. If the client
2672 does not supply this attribute, the Printer object MUST respond
2673 as if the client had supplied the attribute with a value of '
2674 false', i.e., all jobs. The means for authenticating the
2675 requesting user and matching the jobs is described in <a href="#section-8">section 8</a>.
2676
2677
2678
2679
2680
2681
2682
2683
2684 <span class="grey">deBry, et al. Experimental [Page 48]</span></pre>
2685 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
2686 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2687
2688
2689 <span class="h5"><a class="selflink" id="section-3.2.6.2" href="#section-3.2.6.2">3.2.6.2</a> Get-Jobs Response</span>
2690
2691 The Printer object returns all of the Job objects that match the
2692 criteria as defined by the attribute values supplied by the client in
2693 the request. It is possible that no Job objects are returned since
2694 there may literally be no Job objects at the Printer, or there may be
2695 no Job objects that match the criteria supplied by the client. If
2696 the client requests any Job attributes at all, there is a set of Job
2697 Object Attributes returned for each Job object.
2698
2699 Group 1: Operation Attributes
2700
2701 Status Message:
2702 In addition to the REQUIRED status code returned in every
2703 response, the response OPTIONALLY includes a "status-message"
2704 (text) operation attribute as described in sections <a href="#section-14">14</a> and
2705 3.1.6.
2706
2707 Natural Language and Character Set:
2708 The "attributes-charset" and "attributes-natural-language"
2709 attributes as described in <a href="#section-3.1.4.2">section 3.1.4.2</a>.
2710
2711 Group 2: Unsupported Attributes
2712
2713 This is a set of Operation attributes supplied by the client (in
2714 the request) that are not supported by the Printer object or
2715 that conflict with one another (see sections <a href="#section-3.2.1.2">3.2.1.2</a> and the
2716 Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>]). The response NEED NOT contain
2717 the "requested-attributes" operation attribute with any supplied
2718 values (attribute keywords) that were requested by the client
2719 but are not supported by the IPP object. If the Printer object
2720 is not returning any Unsupported Attributes in the response, the
2721 Printer object SHOULD omit Group 2 rather than sending an empty
2722 group. However, a client MUST be able to accept an empty group.
2723
2724 Groups 3 to N: Job Object Attributes
2725
2726 The Printer object responds with one set of Job Object
2727 Attributes for each returned Job object. The Printer object
2728 ignores (does not respond with) any requested attribute or value
2729 which is not supported or which is restricted by the security
2730 policy in force, including whether the requesting user is the
2731 user that submitted the job (job originating user) or not (see
2732 <a href="#section-8">section 8</a>). However, the Printer object MUST respond with the '
2733 unknown' value for any supported attribute (including all
2734 REQUIRED attributes) for which the Printer object does not know
2735
2736
2737
2738
2739
2740 <span class="grey">deBry, et al. Experimental [Page 49]</span></pre>
2741 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
2742 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2743
2744
2745 the value, unless it would violate the security policy. See the
2746 description of the "out-of-band" values in the beginning of
2747 <a href="#section-4.1">Section 4.1</a>.
2748
2749 Jobs are returned in the following order:
2750
2751 - If the client requests all 'completed' Jobs (Jobs in the '
2752 completed', 'aborted', or 'canceled' states), then the Jobs
2753 are returned newest to oldest (with respect to actual
2754 completion time)
2755 - If the client requests all 'not-completed' Jobs (Jobs in the
2756 'pending', 'processing', 'pending-held', and 'processing-
2757 stopped' states), then Jobs are returned in relative
2758 chronological order of expected time to complete (based on
2759 whatever scheduling algorithm is configured for the Printer
2760 object).
2761
2762 <span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a> Job Operations</span>
2763
2764 All Job operations are directed at Job objects. A client MUST always
2765 supply some means of identifying the Job object in order to identify
2766 the correct target of the operation. That job identification MAY
2767 either be a single Job URI or a combination of a Printer URI with a
2768 Job ID. The IPP object implementation MUST support both forms of
2769 identification for every job.
2770
2771 <span class="h4"><a class="selflink" id="section-3.3.1" href="#section-3.3.1">3.3.1</a> Send-Document Operation</span>
2772
2773 This OPTIONAL operation allows a client to create a multi-document
2774 Job object that is initially "empty" (contains no documents). In the
2775 Create-Job response, the Printer object returns the Job object's URI
2776 (the "job-uri" attribute) and the Job object's 32-bit identifier (the
2777 "job-id" attribute). For each new document that the client desires
2778 to add, the client uses a Send-Document operation. Each Send-
2779 Document Request contains the entire stream of document data for one
2780 document.
2781
2782 Since the Create-Job and the send operations (Send-Document or Send-
2783 URI operations) that follow could occur over an arbitrarily long
2784 period of time for a particular job, a client MUST send another send
2785 operation within an IPP Printer defined minimum time interval after
2786 the receipt of the previous request for the job. If a Printer object
2787 supports multiple document jobs, the Printer object MUST support the
2788 "multiple-operation-time-out" attribute (see <a href="#section-4.4.28">section 4.4.28</a>). This
2789 attribute indicates the minimum number of seconds the Printer object
2790 will wait for the next send operation before taking some recovery
2791 action.
2792
2793
2794
2795
2796 <span class="grey">deBry, et al. Experimental [Page 50]</span></pre>
2797 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
2798 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2799
2800
2801 An IPP object MUST recover from an errant client that does not supply
2802 a send operation, sometime after the minimum time interval specified
2803 by the Printer object's "multiple-operation-time-out" attribute.
2804 Such recovery MAY include any of the following or other recovery
2805 actions:
2806
2807 1. Assume that the Job is an invalid job, start the process of
2808 changing the job state to 'aborted', add the 'aborted-by-system'
2809 value to the job's "job-state-reasons" attribute (see <a href="#section-4.3.8">section</a>
2810 <a href="#section-4.3.8">4.3.8</a>), if supported, and clean up all resources associated with
2811 the Job. In this case, if another send operation is finally
2812 received, the Printer responds with an "client-error-not-
2813 possible" or "client-error-not-found" depending on whether or
2814 not the Job object is still around when the send operation
2815 finally arrives.
2816 2. Assume that the last send operation received was in fact the
2817 last document (as if the "last-document" flag had been set to '
2818 true'), close the Job object, and proceed to process it (i.e.,
2819 move the Job's state to 'pending').
2820 3. Assume that the last send operation received was in fact the
2821 last document, close the Job, but move it to the 'pending-held'
2822 and add the 'submission-interrupted' value to the job's "job-
2823 state-reasons" attribute (see <a href="#section-4.3.8">section 4.3.8</a>), if supported.
2824 This action allows the user or an operator to determine whether
2825 to continue processing the Job by moving it back to the '
2826 pending' state or to cancel the job.
2827
2828 Each implementation is free to decide the "best" action to take
2829 depending on local policy, whether any documents have been added,
2830 whether the implementation spools jobs or not, and/or any other piece
2831 of information available to it. If the choice is to abort the Job
2832 object, it is possible that the Job object may already have been
2833 processed to the point that some media sheet pages have been printed.
2834
2835 <span class="h5"><a class="selflink" id="section-3.3.1.1" href="#section-3.3.1.1">3.3.1.1</a> Send-Document Request</span>
2836
2837 The following attribute sets are part of the Send-Document Request:
2838
2839 Group 1: Operation Attributes
2840
2841 Natural Language and Character Set:
2842 The "attributes-charset" and "attributes-natural-language"
2843 attributes as described in <a href="#section-3.1.4.1">section 3.1.4.1</a>.
2844
2845
2846
2847
2848
2849
2850
2851
2852 <span class="grey">deBry, et al. Experimental [Page 51]</span></pre>
2853 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
2854 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2855
2856
2857 Target:
2858 Either (1) the "printer-uri" (uri) plus "job-id"
2859 (integer(1:MAX))or (2) the "job-uri" (uri) operation
2860 attribute(s) which define the target for this operation as
2861 described in <a href="#section-3.1.5">section 3.1.5</a>.
2862
2863 Requesting User Name:
2864 "requesting-user-name" (name(MAX)) attribute SHOULD be supplied
2865 by the client as described in <a href="#section-8.3">section 8.3</a>.
2866
2867 "document-name" (name(MAX)):
2868 The client OPTIONALLY supplies this attribute. The Printer
2869 object MUST support this attribute. It contains the client
2870 supplied document name. The document name MAY be different than
2871 the Job name. It might be helpful, but NEED NOT be unique
2872 across multiple documents in the same Job. Typically, the
2873 client software automatically supplies the document name on
2874 behalf of the end user by using a file name or an application
2875 generated name. See the description of the "document-name"
2876 operation attribute in the Print-Job Request (<a href="#section-3.2.1.1">section 3.2.1.1</a>)
2877 for more information about this attribute
2878
2879 "document-format" (mimeMediaType):
2880 The client OPTIONALLY supplies this attribute. The Printer
2881 object MUST support this attribute. The value of this attribute
2882 identifies the format of the supplied document data. If the
2883 client does not supply this attribute, the Printer object
2884 assumes that the document data is in the format defined by the
2885 Printer object's "document-format-default" attribute. If the
2886 client supplies this attribute, but the value is not supported
2887 by the Printer object, i.e., the value is not one of the values
2888 of the Printer object's "document-format-supported" attribute,
2889 the Printer object MUST reject the request and return the '
2890 client-error-document-format-not-supported' status code.
2891
2892 "document-natural-language" (naturalLanguage):
2893 The client OPTIONALLY supplies this attribute. The Printer
2894 object OPTIONALLY supports this attribute. This attribute
2895 specifies the natural language of the document for those
2896 document-formats that require a specification of the natural
2897 language in order to image the document unambiguously. There
2898 are no particular values required for the Printer object to
2899 support.
2900
2901 "compression" (type3 keyword)
2902 The client OPTIONALLY supplies this attribute. The Printer
2903 object OPTIONALLY supports this attribute and the "compression-
2904 supported" attribute (see <a href="#section-4.4.29">section 4.4.29</a>). The client supplied
2905
2906
2907
2908 <span class="grey">deBry, et al. Experimental [Page 52]</span></pre>
2909 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
2910 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2911
2912
2913 "compression" operation attribute identifies the compression
2914 algorithm used on the document data. If the client omits this
2915 attribute, the Printer object MUST assume that the data is not
2916 compressed. If the client supplies the attribute and the
2917 Printer object supports the attribute, the Printer object MUST
2918 use the corresponding decompression algorithm on the document
2919 data. If the client supplies this attribute, but the value is
2920 not supported by the Printer object, i.e., the value is not one
2921 of the values of the Printer object's "compression-supported"
2922 attribute, the Printer object MUST copy the attribute and its
2923 value to the Unsupported Attributes response group, reject the
2924 request, and return the 'client-error-attributes-or-values-not-
2925 supported' status code.
2926
2927 "last-document" (boolean):
2928 The client MUST supply this attribute. The Printer object MUST
2929 support this attribute. It is a boolean flag that is set to '
2930 true' if this is the last document for the Job, 'false'
2931 otherwise.
2932
2933 Group 2: Document Content
2934
2935 The client MUST supply the document data if the "last-document"
2936 flag is set to 'false'. However, since a client might not know
2937 that the previous document sent with a Send-Document (or Send-
2938 URI) operation was the last document (i.e., the "last-document"
2939 attribute was set to 'false'), it is legal to send a Send-
2940 Document request with no document data where the "last-document"
2941 flag is set to 'true'. Such a request MUST NOT increment the
2942 value of the Job object's "number-of-documents" attribute, since
2943 no real document was added to the job.
2944
2945 <span class="h5"><a class="selflink" id="section-3.3.1.2" href="#section-3.3.1.2">3.3.1.2</a> Send-Document Response</span>
2946
2947 The following sets of attributes are part of the Send-Document
2948 Response:
2949
2950 Group 1: Operation Attributes
2951
2952 Status Message:
2953 In addition to the REQUIRED status code returned in every
2954 response, the response OPTIONALLY includes a "status-message"
2955 (text) operation attribute as described in sections <a href="#section-14">14</a> and
2956 3.1.6.
2957
2958 Natural Language and Character Set:
2959 The "attributes-charset" and "attributes-natural-language"
2960 attributes as described in <a href="#section-3.1.4.2">section 3.1.4.2</a>.
2961
2962
2963
2964 <span class="grey">deBry, et al. Experimental [Page 53]</span></pre>
2965 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
2966 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
2967
2968
2969 Group 2: Unsupported Attributes
2970
2971 This is a set of Operation attributes supplied by the client (in
2972 the request) that are not supported by the Printer object or
2973 that conflict with one another (see sections <a href="#section-3.2.1.2">3.2.1.2</a> and the
2974 Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>]). If the Printer object is not
2975 returning any Unsupported Attributes in the response, the
2976 Printer object SHOULD omit Group 2 rather than sending an empty
2977 group. However, a client MUST be able to accept an empty group.
2978
2979 Group 3: Job Object Attributes
2980
2981 This is the same set of attributes as described in the Print-Job
2982 response (see <a href="#section-3.2.1.2">section 3.2.1.2</a>).
2983
2984 <span class="h4"><a class="selflink" id="section-3.3.2" href="#section-3.3.2">3.3.2</a> Send-URI Operation</span>
2985
2986 This OPTIONAL operation is identical to the Send-Document operation
2987 (see <a href="#section-3.3.1">section 3.3.1</a>) except that a client MUST supply a URI reference
2988 ("document-uri" operation attribute) rather than the document data
2989 itself. If a Printer object supports this operation, clients can use
2990 both Send-URI or Send-Document operations to add new documents to an
2991 existing multi-document Job object. However, if a client needs to
2992 indicate that the previous Send-URI or Send-Document was the last
2993 document, the client MUST use the Send-Document operation with no
2994 document data and the "last-document" flag set to 'true' (rather than
2995 using a Send-URI operation with no "document-uri" operation
2996 attribute).
2997
2998 If a Printer object supports this operation, it MUST also support the
2999 Print-URI operation (see <a href="#section-3.2.2">section 3.2.2</a>).
3000
3001 The Printer object MUST validate the syntax and URI scheme of the
3002 supplied URI before returning a response, just as in the Print-URI
3003 operation.
3004
3005 <span class="h4"><a class="selflink" id="section-3.3.3" href="#section-3.3.3">3.3.3</a> Cancel-Job Operation</span>
3006
3007 This REQUIRED operation allows a client to cancel a Print Job from
3008 the time the job is created up to the time it is completed, canceled,
3009 or aborted. Since a Job might already be printing by the time a
3010 Cancel-Job is received, some media sheet pages might be printed
3011 before the job is actually terminated.
3012
3013 <span class="h5"><a class="selflink" id="section-3.3.3.1" href="#section-3.3.3.1">3.3.3.1</a> Cancel-Job Request</span>
3014
3015 The following groups of attributes are part of the Cancel-Job
3016 Request:
3017
3018
3019
3020 <span class="grey">deBry, et al. Experimental [Page 54]</span></pre>
3021 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
3022 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3023
3024
3025 Group 1: Operation Attributes
3026
3027 Natural Language and Character Set:
3028 The "attributes-charset" and "attributes-natural-language"
3029 attributes as described in <a href="#section-3.1.4.1">section 3.1.4.1</a>.
3030
3031 Target:
3032 Either (1) the "printer-uri" (uri) plus "job-id"
3033 (integer(1:MAX))or (2) the "job-uri" (uri) operation
3034 attribute(s) which define the target for this operation as
3035 described in <a href="#section-3.1.5">section 3.1.5</a>.
3036
3037 Requesting User Name:
3038 The "requesting-user-name" (name(MAX)) attribute SHOULD be
3039 supplied by the client as described in <a href="#section-8.3">section 8.3</a>.
3040
3041 "message" (text(127)):
3042 The client OPTIONALLY supplies this attribute. The Printer
3043 object OPTIONALLY supports this attribute. It is a message to
3044 the operator. This "message" attribute is not the same as the
3045 "job-message-from-operator" attribute. That attribute is used
3046 to report a message from the operator to the end user that
3047 queries that attribute. This "message" operation attribute is
3048 used to send a message from the client to the operator along
3049 with the operation request. It is an implementation decision of
3050 how or where to display this message to the operator (if at
3051 all).
3052
3053 <span class="h5"><a class="selflink" id="section-3.3.3.2" href="#section-3.3.3.2">3.3.3.2</a> Cancel-Job Response</span>
3054
3055 The following sets of attributes are part of the Cancel-Job Response:
3056
3057 Group 1: Operation Attributes
3058
3059 Status Message:
3060 In addition to the REQUIRED status code returned in every
3061 response, the response OPTIONALLY includes a "status-message"
3062 (text) operation attribute as described in sections <a href="#section-14">14</a> and
3063 3.1.6.
3064
3065 If the job is already in the 'completed', 'aborted', or '
3066 canceled' state, or the 'process-to-stop-point' value is set in
3067 the Job's "job-state-reasons" attribute, the Printer object MUST
3068 reject the request and return the 'client-error-not-possible'
3069 error status code.
3070
3071
3072
3073
3074
3075
3076 <span class="grey">deBry, et al. Experimental [Page 55]</span></pre>
3077 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
3078 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3079
3080
3081 Natural Language and Character Set:
3082 The "attributes-charset" and "attributes-natural-language"
3083 attributes as described in <a href="#section-3.1.4.2">section 3.1.4.2</a>.
3084
3085 Group 2: Unsupported Attributes
3086
3087 This is a set of Operation attributes supplied by the client (in
3088 the request) that are not supported by the Printer object or
3089 that conflict with one another (see <a href="#section-3.2.1.2">section 3.2.1.2</a> and the
3090 Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>]). If the Printer object is not
3091 returning any Unsupported Attributes in the response, the
3092 Printer object SHOULD omit Group 2 rather than sending an empty
3093 group. However, a client MUST be able to accept an empty group.
3094
3095 Once a successful response has been sent, the implementation
3096 guarantees that the Job will eventually end up in the 'canceled'
3097 state. Between the time of the Cancel-Job operation is accepted and
3098 when the job enters the 'canceled' job-state (see <a href="#section-4.3.7">section 4.3.7</a>), the
3099 "job-state-reasons" attribute SHOULD contain the 'processing-to-
3100 stop-point' value which indicates to later queries that although the
3101 Job might still be 'processing', it will eventually end up in the '
3102 canceled' state, not the 'completed' state.
3103
3104 <span class="h4"><a class="selflink" id="section-3.3.4" href="#section-3.3.4">3.3.4</a> Get-Job-Attributes Operation</span>
3105
3106 This REQUIRED operation allows a client to request the values of
3107 attributes of a Job object and it is almost identical to the Get-
3108 Printer-Attributes operation (see <a href="#section-3.2.5">section 3.2.5</a>). The only
3109 differences are that the operation is directed at a Job object rather
3110 than a Printer object, there is no "document-format" operation
3111 attribute used when querying a Job object, and the returned attribute
3112 group is a set of Job object attributes rather than a set of Printer
3113 object attributes.
3114
3115 For Jobs, the possible names of attribute groups are:
3116
3117 - 'job-template': all of the Job Template attributes that apply to a
3118 Job object (the first column of the table in <a href="#section-4.2">Section 4.2</a>).
3119 - 'job-description': all of the Job Description attributes specified
3120 in <a href="#section-4.3">Section 4.3</a>.
3121 - 'all': the special group 'all' that includes all supported
3122 attributes.
3123
3124 Since a client MAY request specific attributes or named groups, there
3125 is a potential that there is some overlap. For example, if a client
3126 requests, 'job-name' and 'job-description', the client is actually
3127 requesting the "job-name" attribute once by naming it explicitly, and
3128 once by inclusion in the 'job-description' group. In such cases, the
3129
3130
3131
3132 <span class="grey">deBry, et al. Experimental [Page 56]</span></pre>
3133 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
3134 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3135
3136
3137 Printer object NEED NOT return the attribute only once in the
3138 response even if it is requested multiple times. The client SHOULD
3139 NOT request the same attribute in multiple ways.
3140
3141 It is NOT REQUIRED that a Job object support all attributes belonging
3142 to a group (since some attributes are OPTIONAL). However it is
3143 REQUIRED that each Job object support all group names.
3144
3145 <span class="h5"><a class="selflink" id="section-3.3.4.1" href="#section-3.3.4.1">3.3.4.1</a> Get-Job-Attributes Request</span>
3146
3147 The following groups of attributes are part of the Get-Job-Attributes
3148 Request when the request is directed at a Job object:
3149
3150 Group 1: Operation Attributes
3151
3152 Natural Language and Character Set:
3153 The "attributes-charset" and "attributes-natural-language"
3154 attributes as described in <a href="#section-3.1.4.1">section 3.1.4.1</a>.
3155
3156 Target:
3157 Either (1) the "printer-uri" (uri) plus "job-id"
3158 (integer(1:MAX)) or (2) the "job-uri" (uri) operation
3159 attribute(s) which define the target for this operation as
3160 described in <a href="#section-3.1.5">section 3.1.5</a>.
3161
3162 Requesting User Name:
3163 The "requesting-user-name" (name(MAX)) attribute SHOULD be
3164 supplied by the client as described in <a href="#section-8.3">section 8.3</a>.
3165
3166 "requested-attributes" (1setOf keyword) :
3167 The client OPTIONALLY supplies this attribute. The IPP object
3168 MUST support this attribute. It is a set of attribute names
3169 and/or attribute group names in whose values the requester is
3170 interested. If the client omits this attribute, the IPP object
3171 MUST respond as if this attribute had been supplied with a value
3172 of 'all'.
3173
3174 <span class="h5"><a class="selflink" id="section-3.3.4.2" href="#section-3.3.4.2">3.3.4.2</a> Get-Job-Attributes Response</span>
3175
3176 The Printer object returns the following sets of attributes as part
3177 of the Get-Job-Attributes Response:
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188 <span class="grey">deBry, et al. Experimental [Page 57]</span></pre>
3189 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
3190 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3191
3192
3193 Group 1: Operation Attributes
3194
3195 Status Message:
3196 In addition to the REQUIRED status code returned in every
3197 response, the response OPTIONALLY includes a "status-message"
3198 (text) operation attribute as described in sections <a href="#section-14">14</a> and
3199 3.1.6.
3200
3201 Natural Language and Character Set:
3202 The "attributes-charset" and "attributes-natural-language"
3203 attributes as described in <a href="#section-3.1.4.2">section 3.1.4.2</a>. The "attributes-
3204 natural-language" MAY be the natural language of the Job object,
3205 rather than the one requested.
3206
3207 Group 2: Unsupported Attributes
3208
3209 This is a set of Operation attributes supplied by the client (in
3210 the request) that are not supported by the Printer object or
3211 that conflict with one another (see sections <a href="#section-3.2.1.2">3.2.1.2</a> and the
3212 Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>]). The response NEED NOT contain
3213 the "requested-attributes" operation attribute with any supplied
3214 values (attribute keywords) that were requested by the client
3215 but are not supported by the IPP object. If the Printer object
3216 is not returning any Unsupported Attributes in the response, the
3217 Printer object SHOULD omit Group 2 rather than sending an empty
3218 group. However, a client MUST be able to accept an empty group.
3219
3220 Group 3: Job Object Attributes
3221
3222 This is the set of requested attributes and their current
3223 values. The IPP object ignores (does not respond with) any
3224 requested attribute or value which is not supported or which is
3225 restricted by the security policy in force, including whether
3226 the requesting user is the user that submitted the job (job
3227 originating user) or not (see <a href="#section-8">section 8</a>). However, the IPP
3228 object MUST respond with the 'unknown' value for any supported
3229 attribute (including all RED butes) for which the IPP object
3230 does not know the value, s it would violate the security policy.
3231 See the description e "out-of-band" values in the beginning of
3232 <a href="#section-4.1">Section 4.1</a>.
3233
3234 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Object Attributes</span>
3235
3236 This section describes the attributes with their corresponding
3237 attribute syntaxes and values that are part of the IPP model. The
3238 sections below show the objects and their associated attributes which
3239 are included within the scope of this protocol. Many of these
3240 attributes are derived from other relevant specifications:
3241
3242
3243
3244 <span class="grey">deBry, et al. Experimental [Page 58]</span></pre>
3245 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
3246 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3247
3248
3249 - Document Printing Application (DPA) [<a href="#ref-ISO10175">ISO10175</a>]
3250 - <a href="./rfc1759">RFC 1759</a> Printer MIB [<a href="./rfc1759" title="&quot;Printer MIB&quot;">RFC1759</a>]
3251
3252 Each attribute is uniquely identified in this document using a
3253 "keyword" (see <a href="#section-12.2.1">section 12.2.1</a>) which is the name of the attribute.
3254 The keyword is included in the section header describing that
3255 attribute.
3256
3257 Note: Not only are keywords used to identify attributes, but one of
3258 the attribute syntaxes described below is "keyword" so that some
3259 attributes have keyword values. Therefore, these attributes are
3260 defined as having an attribute syntax that is a set of keywords.
3261
3262 <span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a> Attribute Syntaxes</span>
3263
3264 This section defines the basic attribute syntax types that all clients
3265 and IPP objects MUST be able to accept in responses and accept in
3266 requests, respectively. Each attribute description in sections <a href="#section-3">3</a> and
3267 4 includes the name of attribute syntax(es) in the heading (in
3268 parentheses). A conforming implementation of an attribute MUST
3269 include the semantics of the attribute syntax(es) so identified.
3270 <a href="#section-6.3">Section 6.3</a> describes how the protocol can be extended with new
3271 attribute syntaxes.
3272
3273 The attribute syntaxes are specified in the following sub-sections,
3274 where the sub-section heading is the keyword name of the attribute
3275 syntax inside the single quotes. In operation requests and responses
3276 each attribute value MUST be represented as one of the attribute
3277 syntaxes specified in the sub-section heading for the attribute. In
3278 addition, the value of an attribute in a response (but not in a
3279 request) MAY be one of the "out-of-band" values. Standard
3280 "out-of-band" values are:
3281
3282 'unknown': The attribute is supported by the IPP object, but the
3283 value is unknown to the IPP object for some reason.
3284 'unsupported': The attribute is unsupported by the IPP object. This
3285 value MUST be returned only as the value of an attribute in the
3286 Unsupported Attributes Group.
3287 'no-value': The attribute is supported by the Printer object, but
3288 the system administrator has not yet configured a value.
3289
3290 The Encoding and Transport specification [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] defines mechanisms
3291 for passing "out-of-band" values. All attributes in a request MUST
3292 have one or more values as defined in Sections <a href="#section-4.2">4.2</a> to <a href="#section-4.4">4.4</a>. Thus
3293 clients MUST NOT supply attributes with "out-of-band" values. All
3294 attribute in a response MUST have one or more values as defined in
3295 Sections <a href="#section-4.2">4.2</a> to <a href="#section-4.4">4.4</a> or a single "out-of-band" value.
3296
3297
3298
3299
3300 <span class="grey">deBry, et al. Experimental [Page 59]</span></pre>
3301 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
3302 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3303
3304
3305 Most attributes are defined to have a single attribute syntax.
3306 However, a few attributes (e.g., "job-sheet", "media", "job-hold-
3307 until") are defined to have several attribute syntaxes, depending on
3308 the value. These multiple attribute syntaxes are separated by the
3309 "|" character in the sub-section heading to indicate the choice.
3310 Since each value MUST be tagged as to its attribute syntax in the
3311
3312 protocol, a single-valued attribute instance may have any one of its
3313 attribute syntaxes and a multi-valued attribute instance may have a
3314 mixture of its defined attribute syntaxes.
3315
3316 <span class="h4"><a class="selflink" id="section-4.1.1" href="#section-4.1.1">4.1.1</a> 'text'</span>
3317
3318 A text attribute is an attribute whose value is a sequence of zero or
3319 more characters encoded in a maximum of 1023 ('MAX') octets. MAX is
3320 the maximum length for each value of any text attribute. However, if
3321 an attribute will always contain values whose maximum length is much
3322 less than MAX, the definition of that attribute will include a
3323 qualifier that defines the maximum length for values of that
3324 attribute. For example: the "printer-location" attribute is
3325 specified as "printer-location (text(127))". In this case, text
3326 values for "printer-location" MUST NOT exceed 127 octets; if supplied
3327 with a longer text string via some external interface (other than the
3328 protocol), implementations are free to truncate to this shorter
3329 length limitation.
3330
3331 In this specification, all text attributes are defined using the '
3332 text' syntax. However, 'text' is used only for brevity; the formal
3333 interpretation of 'text' is: 'textWithoutLanguage |
3334 textWithLanguage'. That is, for any attribute defined in this
3335 specification using the 'text' attribute syntax, all IPP objects and
3336 clients MUST support both the 'textWithoutLanguage' and '
3337 textWithLanguage' attribute syntaxes. However, in actual usage and
3338 protocol execution, objects and clients accept and return only one of
3339 the two syntax per attribute. The syntax 'text' never appears "on-
3340 the-wire".
3341
3342 Both 'textWithoutLanguage' and 'textWithLanguage' are needed to
3343 support the real world needs of interoperability between sites and
3344 systems that use different natural languages as the basis for human
3345 communication. Generally, one natural language applies to all text
3346 attributes in a given request or response. The language is indicated
3347 by the "attributes-natural-language" operation attribute defined in
3348 <a href="#section-3.1.4">section 3.1.4</a> or "attributes-natural-language" job attribute defined
3349 in <a href="#section-4.3.24">section 4.3.24</a>, and there is no need to identify the natural
3350 language for each text string on a value-by-value basis. In these
3351 cases, the attribute syntax 'textWithoutLanguage' is used for text
3352 attributes. In other cases, the client needs to supply or the
3353
3354
3355
3356 <span class="grey">deBry, et al. Experimental [Page 60]</span></pre>
3357 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
3358 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3359
3360
3361 Printer object needs to return a text value in a natural language
3362 that is different from the rest of the text values in the request or
3363 response. In these cases, the client or Printer object uses the
3364 attribute syntax 'textWithLanguage' for text attributes (this is the
3365 Natural Language Override mechanism described in <a href="#section-3.1.4">section 3.1.4</a>).
3366
3367 The 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes
3368 are described in more detail in the following sections.
3369
3370 <span class="h5"><a class="selflink" id="section-4.1.1.1" href="#section-4.1.1.1">4.1.1.1</a> 'textWithoutLanguage'</span>
3371
3372 The 'textWithoutLanguage' syntax indicates a value that is sequence
3373 of zero or more characters. Text strings are encoded using the rules
3374 of some charset. The Printer object MUST support the UTF-8 charset
3375 [<a href="./rfc2279" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC2279</a>] and MAY support additional charsets to represent 'text'
3376 values, provided that the charsets are registered with IANA [IANA-
3377 CS]. See <a href="#section-4.1.7">Section 4.1.7</a> for the specification of the 'charset'
3378 attribute syntax, including restricted semantics and examples of
3379 charsets.
3380
3381 <span class="h5"><a class="selflink" id="section-4.1.1.2" href="#section-4.1.1.2">4.1.1.2</a> 'textWithLanguage'</span>
3382
3383 The 'textWithLanguage' attribute syntax is a compound attribute
3384 syntax consisting of two parts: a 'textWithoutLanguage' part plus an
3385 additional 'naturalLanguage' (see <a href="#section-4.1.8">section 4.1.8</a>) part that overrides
3386 the natural language in force. The 'naturalLanguage' part explicitly
3387 identifies the natural language that applies to the text part of that
3388 value and that value alone. For any give text attribute, the '
3389 textWithoutLanguage' part is limited to the maximum length defined
3390 for that attribute, but the 'naturalLanguage' part is always limited
3391 to 63 octets. Using the 'textWithLanguage' attribute syntax rather
3392 than the normal 'textWithoutLanguage' syntax is the so-called Natural
3393 Language Override mechanism and MUST be supported by all IPP objects
3394 and clients.
3395
3396 If the attribute is multi-valued (1setOf text), then the '
3397 textWithLanguage' attribute syntax MUST be used to explicitly specify
3398 each attribute value whose natural language needs to be overridden.
3399 Other values in a multi-valued 'text' attribute in a request or a
3400 response revert to the natural language of the operation attribute.
3401
3402 In a create request, the Printer object MUST accept and store with
3403 the Job object any natural language in the "attributes-natural-
3404 language" operation attribute, whether the Printer object supports
3405 that natural language or not. Furthermore, the Printer object MUST
3406 accept and store any 'textWithLanguage' attribute value, whether the
3407
3408
3409
3410
3411
3412 <span class="grey">deBry, et al. Experimental [Page 61]</span></pre>
3413 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
3414 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3415
3416
3417 Printer object supports that natural language or not. These
3418 requirements are independent of the value of the "ipp-attribute-
3419 fidelity" operation attribute that the client MAY supply.
3420
3421 Example: If the client supplies the "attributes-natural-language"
3422 operation attribute with the value: 'en' indicating English, but the
3423 value of the "job-name" attribute is in French, the client MUST use
3424 the 'textWithLanguage' attribute syntax with the following two
3425 values:
3426
3427 'fr': Natural Language Override indicating French
3428 'Rapport Mensuel': the job name in French
3429
3430 See the Encoding and Transport document [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] for a detailed
3431 example of the 'textWithLanguage' attribute syntax.
3432
3433 <span class="h4"><a class="selflink" id="section-4.1.2" href="#section-4.1.2">4.1.2</a> 'name'</span>
3434
3435 This syntax type is used for user-friendly strings, such as a Printer
3436 name, that, for humans, are more meaningful than identifiers. Names
3437 are never translated from one natural language to another. The '
3438 name' attribute syntax is essentially the same as 'text', including
3439 the REQUIRED support of UTF-8 except that the sequence of characters
3440 is limited so that its encoded form MUST NOT exceed 255 (MAX) octets.
3441
3442 Also like 'text', 'name' is really an abbreviated notation for either
3443 'nameWithoutLanguage' or 'nameWithLanguage'. That is, all IPP
3444 objects and clients MUST support both the 'nameWithoutLanguage' and '
3445 nameWithLanguage' attribute syntaxes. However, in actual usage and
3446 protocol execution, objects and clients accept and return only one of
3447 the two syntax per attribute. The syntax 'name' never appears "on-
3448 the-wire".
3449
3450 Note: Only the 'text' and 'name' attribute syntaxes permit the
3451 Natural Language Override mechanism.
3452
3453 Some attributes are defined as 'type3 keyword | name'. These
3454 attributes support values that are either type3 keywords or names.
3455 This dual-syntax mechanism enables a site administrator to extend
3456 these attributes to legally include values that are locally defined
3457 by the site administrator. Such names are not registered with IANA.
3458
3459 <span class="h5"><a class="selflink" id="section-4.1.2.1" href="#section-4.1.2.1">4.1.2.1</a> 'nameWithoutLanguage'</span>
3460
3461 The 'nameWithoutLanguage' syntax indicates a value that is sequence
3462 of zero or more characters so that its encoded form does not exceed
3463 MAX octets.
3464
3465
3466
3467
3468 <span class="grey">deBry, et al. Experimental [Page 62]</span></pre>
3469 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
3470 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3471
3472
3473 <span class="h5"><a class="selflink" id="section-4.1.2.2" href="#section-4.1.2.2">4.1.2.2</a> 'nameWithLanguage'</span>
3474
3475 The 'nameWithLanguage' attribute syntax is a compound attribute
3476 syntax consisting of two parts: a 'nameWithoutLanguage' part plus an
3477 additional 'naturalLanguage' (see <a href="#section-4.1.8">section 4.1.8</a>) part that overrides
3478 the natural language in force. The 'naturalLanguage' part explicitly
3479 identifies the natural language that applies to that name value and
3480 that name value alone.
3481
3482 The 'nameWithLanguage' attribute syntax behaves the same as the '
3483 textWithLanguage' syntax. If a name is in a language that is
3484 different than the rest of the object or operation, then this '
3485 nameWithLanguage' syntax is used rather than the generic '
3486 nameWithoutLanguage' syntax.
3487
3488 Example: If the client supplies the "attributes-natural-language"
3489 operation attribute with the value: 'en' indicating English, but the
3490 "printer-name" attribute is in German, the client MUST use the '
3491 nameWithLanguage' attribute syntax as follows:
3492
3493 'de': Natural Language Override indicating German
3494 'Farbdrucker': the Printer name in German
3495
3496 <span class="h5"><a class="selflink" id="section-4.1.2.3" href="#section-4.1.2.3">4.1.2.3</a> Matching 'name' attribute values</span>
3497
3498 For purposes of matching two 'name' attribute values for equality,
3499 such as in job validation (where a client-supplied value for
3500 attribute "xxx" is checked to see if the value is among the values of
3501 the Printer object's corresponding "xxx-supported" attribute), the
3502 following match rules apply:
3503
3504 1. 'keyword' values never match 'name' values.
3505
3506 2. 'name' (nameWithoutLanguage and nameWithLanguage) values
3507 match if (1) the name parts match and (2) the Associated
3508 Natural-Language parts (see <a href="#section-3.1.4.1">section 3.1.4.1</a>) match. The
3509 matching rules are:
3510
3511 a. the name parts match if the two names are identical
3512 character by character, except it is RECOMMENDED that case
3513 be ignored. For example: 'Ajax-letter-head-white' MUST
3514 match 'Ajax-letter-head-white' and SHOULD match 'ajax-
3515 letter-head-white' and 'AJAX-LETTER-HEAD-WHITE'.
3516
3517 b. the Associated Natural-Language parts match if the
3518 shorter of the two meets the syntactic requirements of <a href="./rfc1766">RFC</a>
3519 <a href="./rfc1766">1766</a> [<a href="./rfc1766" title="&quot;Tags for the Identification of Languages&quot;">RFC1766</a>] and matches byte for byte with the longer.
3520 For example, 'en' matches 'en', 'en-us' and 'en-gb', but
3521
3522
3523
3524 <span class="grey">deBry, et al. Experimental [Page 63]</span></pre>
3525 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
3526 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3527
3528
3529 matches neither 'fr' nor 'e'.
3530
3531 <span class="h4"><a class="selflink" id="section-4.1.3" href="#section-4.1.3">4.1.3</a> 'keyword'</span>
3532
3533 The 'keyword' attribute syntax is a sequence of characters, length: 1
3534 to 255, containing only the US-ASCII [<a href="#ref-ASCII">ASCII</a>] encoded values for
3535 lowercase letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot
3536 ("."), and underscore ("_"). The first character MUST be a lowercase
3537 letter. Furthermore, keywords MUST be in U.S. English.
3538
3539 This syntax type is used for enumerating semantic identifiers of
3540 entities in the abstract protocol, i.e., entities identified in this
3541 document. Keywords are used as attribute names or values of
3542 attributes. Unlike 'text' and 'name' attribute values, 'keyword'
3543 values MUST NOT use the Natural Language Override mechanism, since
3544 they MUST always be US-ASCII and U.S. English.
3545
3546 Keywords are for use in the protocol. A user interface will likely
3547 provide a mapping between protocol keywords and displayable user-
3548 friendly words and phrases which are localized to the natural
3549 language of the user. While the keywords specified in this document
3550 MAY be displayed to users whose natural language is U.S. English,
3551 they MAY be mapped to other U.S. English words for U.S. English
3552 users, since the user interface is outside the scope of this
3553 document.
3554
3555 In the definition for each attribute of this syntax type, the full
3556 set of defined keyword values for that attribute are listed.
3557
3558 When a keyword is used to represent an attribute (its name), it MUST
3559 be unique within the full scope of all IPP objects and attributes.
3560 When a keyword is used to represent a value of an attribute, it MUST
3561 be unique just within the scope of that attribute. That is, the same
3562 keyword MUST NOT be used for two different values within the same
3563 attribute to mean two different semantic ideas. However, the same
3564 keyword MAY be used across two or more attributes, representing
3565 different semantic ideas for each attribute. <a href="#section-6.1">Section 6.1</a> describes
3566 how the protocol can be extended with new keyword values. Examples
3567 of attribute name keywords:
3568
3569 "job-name"
3570 "attributes-charset"
3571
3572 Note: This document uses "type1", "type2", and "type3" prefixes to
3573 the "keyword" basic syntax to indicate different levels of review for
3574 extensions (see <a href="#section-6.1">section 6.1</a>).
3575
3576
3577
3578
3579
3580 <span class="grey">deBry, et al. Experimental [Page 64]</span></pre>
3581 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
3582 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3583
3584
3585 <span class="h4"><a class="selflink" id="section-4.1.4" href="#section-4.1.4">4.1.4</a> 'enum'</span>
3586
3587 The 'enum' attribute syntax is an enumerated integer value that is in
3588 the range from 1 to 2**31 - 1 (MAX). Each value has an associated '
3589 keyword' name. In the definition for each attribute of this syntax
3590 type, the full set of possible values for that attribute are listed.
3591 This syntax type is used for attributes for which there are enum
3592 values assigned by other standards, such as SNMP MIBs. A number of
3593 attribute enum values in this specification are also used for
3594 corresponding attributes in other standards [<a href="./rfc1759" title="&quot;Printer MIB&quot;">RFC1759</a>]. This syntax
3595 type is not used for attributes to which the system administrator may
3596 assign values. <a href="#section-6.1">Section 6.1</a> describes how the protocol can be
3597 extended with new enum values.
3598
3599 Enum values are for use in the protocol. A user interface will
3600 provide a mapping between protocol enum values and displayable user-
3601 friendly words and phrases which are localized to the natural
3602 language of the user. While the enum symbols specified in this
3603 document MAY be displayed to users whose natural language is U.S.
3604 English, they MAY be mapped to other U.S. English words for U.S.
3605 English users, since the user interface is outside the scope of this
3606 document.
3607
3608 Note: SNMP MIBs use '2' for 'unknown' which corresponds to the IPP
3609 "out-of-band" value 'unknown'. See the description of the "out-of-
3610 band" values at the beginning of <a href="#section-4.1">Section 4.1</a>. Therefore, attributes
3611 of type 'enum' start at '3'.
3612
3613 Note: This document uses "type1", "type2", and "type3" prefixes to
3614 the "enum" basic syntax to indicate different levels of review for
3615 extensions (see <a href="#section-6.1">section 6.1</a>).
3616
3617 <span class="h4"><a class="selflink" id="section-4.1.5" href="#section-4.1.5">4.1.5</a> 'uri'</span>
3618
3619 The 'uri' attribute syntax is any valid Uniform Resource Identifier
3620 or URI [<a href="./rfc2396" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">RFC2396</a>]. Most often, URIs are simply Uniform Resource
3621 Locators or URLs. The maximum length of URIs used as values of IPP
3622 attributes is 1023 octets. Although most other IPP attribute syntax
3623 types allow for only lower-cased values, this attribute syntax type
3624 conforms to the case-sensitive and case-insensitive rules specified
3625 in [<a href="./rfc2396" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">RFC2396</a>].
3626
3627 <span class="h4"><a class="selflink" id="section-4.1.6" href="#section-4.1.6">4.1.6</a> 'uriScheme'</span>
3628
3629 The 'uriScheme' attribute syntax is a sequence of characters
3630 representing a URI scheme according to <a href="./rfc2396">RFC 2396</a> [<a href="./rfc2396" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">RFC2396</a>]. Though
3631 <a href="./rfc2396">RFC 2396</a> requires that the values be case-insensitive, IPP requires
3632
3633
3634
3635
3636 <span class="grey">deBry, et al. Experimental [Page 65]</span></pre>
3637 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
3638 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3639
3640
3641 all lower case values in IPP attributes to simplify comparing by IPP
3642 clients and Printer objects. Standard values for this syntax type
3643 are the following keywords:
3644
3645 'http': for HTTP schemed URIs (e.g., "http:...")
3646 'https': for use with HTTPS schemed URIs (e.g., "https:...")
3647 (not on IETF standards track)
3648 'ftp': for FTP schemed URIs (e.g., "ftp:...")
3649 'mailto': for SMTP schemed URIs (e.g., "mailto:...")
3650 'file': for file schemed URIs (e.g., "file:...")
3651
3652 A Printer object MAY support any URI 'scheme' that has been
3653 registered with IANA [<a href="#ref-IANA-MT">IANA-MT</a>]. The maximum length of URI 'scheme'
3654 values used to represent IPP attribute values is 63 octets.
3655
3656 <span class="h4"><a class="selflink" id="section-4.1.7" href="#section-4.1.7">4.1.7</a> 'charset'</span>
3657
3658 The 'charset' attribute syntax is a standard identifier for a
3659 charset. A charset is a coded character set and encoding scheme.
3660 Charsets are used for labeling certain document contents and 'text'
3661 and 'name' attribute values. The syntax and semantics of this
3662 attribute syntax are specified in <a href="./rfc2046">RFC 2046</a> [<a href="./rfc2046" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types&quot;">RFC2046</a>] and contained in
3663 the IANA character-set Registry [<a href="#ref-IANA-CS">IANA-CS</a>] according to the IANA
3664 procedures [<a href="./rfc2278" title="&quot;IANA Charset Registration Procedures&quot;">RFC2278</a>]. Though <a href="./rfc2046">RFC 2046</a> requires that the values be
3665 case-insensitive US-ASCII, IPP requires all lower case values in IPP
3666 attributes to simplify comparing by IPP clients and Printer objects.
3667 When a character-set in the IANA registry has more than one name
3668 (alias), the name labeled as "(preferred MIME name)", if present,
3669 MUST be used.
3670
3671 The maximum length of 'charset' values used to represent IPP
3672 attribute values is 63 octets.
3673
3674 Some examples are:
3675
3676 'utf-8': ISO 10646 Universal Multiple-Octet Coded Character Set
3677 (UCS) represented as the UTF-8 [<a href="./rfc2279" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC2279</a>] transfer encoding
3678 scheme in which US-ASCII is a subset charset.
3679 'us-ascii': 7-bit American Standard Code for Information
3680 Interchange (ASCII), ANSI X3.4-1986 [<a href="#ref-ASCII">ASCII</a>]. That standard
3681 defines US-ASCII, but <a href="./rfc2045">RFC 2045</a> [<a href="./rfc2045" title="&quot; Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">RFC2045</a>] eliminates most of the
3682 control characters from conformant usage in MIME and IPP.
3683 'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet
3684 Nr 1 [<a href="#ref-ISO8859-1" title="&quot;Information technology -- 8-bit One-Byte Coded Character Set - Part 1: Latin Alphabet Nr 1&quot;">ISO8859-1</a>]. That standard defines a coded character set
3685 that is used by Latin languages in the Western Hemisphere and
3686 Western Europe. US-ASCII is a subset charset.
3687
3688
3689
3690
3691
3692 <span class="grey">deBry, et al. Experimental [Page 66]</span></pre>
3693 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
3694 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3695
3696
3697 'iso-10646-ucs-2': ISO 10646 Universal Multiple-Octet Coded
3698 Character Set (UCS) represented as two octets (UCS-2), with the
3699 high order octet of each pair coming first (so-called Big Endian
3700 integer).
3701
3702 Some attribute descriptions MAY place additional requirements on
3703 charset values that may be used, such as REQUIRED values that MUST be
3704 supported or additional restrictions, such as requiring that the
3705 charset have US-ASCII as a subset charset.
3706
3707 <span class="h4"><a class="selflink" id="section-4.1.8" href="#section-4.1.8">4.1.8</a> 'naturalLanguage'</span>
3708
3709 The 'naturalLanguage' attribute syntax is a standard identifier for a
3710 natural language and optionally a country. The values for this
3711 syntax type are defined by <a href="./rfc1766">RFC 1766</a> [<a href="./rfc1766" title="&quot;Tags for the Identification of Languages&quot;">RFC1766</a>]. Though <a href="./rfc1766">RFC 1766</a>
3712 requires that the values be case-insensitive US-ASCII, IPP requires
3713 all lower case to simplify comparing by IPP clients and Printer
3714 objects. Examples include:
3715
3716 'en': for English
3717 'en-us': for US English
3718 'fr': for French
3719 'de': for German
3720
3721 The maximum length of 'naturalLanguage' values used to represent IPP
3722 attribute values is 63 octets.
3723
3724 <span class="h4"><a class="selflink" id="section-4.1.9" href="#section-4.1.9">4.1.9</a> 'mimeMediaType'</span>
3725
3726 The 'mimeMediaType' attribute syntax is the Internet Media Type
3727 (sometimes called MIME type) as defined by <a href="./rfc2046">RFC 2046</a> [<a href="./rfc2046" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types&quot;">RFC2046</a>] and
3728 registered according to the procedures of <a href="./rfc2048">RFC 2048</a> [<a href="./rfc2048" title="&quot;Multipurpose Internet Mail Extension (MIME) Part Four: Registration Procedures&quot;">RFC2048</a>] for
3729 identifying a document format. The value MAY include a charset
3730 parameter, depending on the specification of the Media Type in the
3731 IANA Registry [<a href="#ref-IANA-MT">IANA-MT</a>]. Although most other IPP syntax types allow
3732 for only lower-cased values, this syntax type allows for mixed-case
3733 values which are case-insensitive.
3734
3735 Examples are:
3736
3737 'text/html': An HTML document
3738 'text/plain': A plain text document in US-ASCII (<a href="./rfc2046">RFC 2046</a> indicates
3739 that in the absence of the charset parameter MUST mean US-ASCII
3740 rather than simply unspecified) [<a href="./rfc2046" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types&quot;">RFC2046</a>].
3741 'text/plain; charset=US-ASCII': A plain text document in US-ASCII
3742 [52, 56].
3743 'text/plain; charset=ISO-8859-1': A plain text document in ISO
3744 8859-1 (Latin 1) [<a href="#ref-ISO8859-1" title="&quot;Information technology -- 8-bit One-Byte Coded Character Set - Part 1: Latin Alphabet Nr 1&quot;">ISO8859-1</a>].
3745
3746
3747
3748 <span class="grey">deBry, et al. Experimental [Page 67]</span></pre>
3749 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
3750 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3751
3752
3753 'text/plain; charset=utf-8': A plain text document in ISO 10646
3754 represented as UTF-8 [<a href="./rfc2279" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC2279</a>]
3755 'text/plain, charset=iso-10646-ucs-2': A plain text document in
3756 ISO 10646 represented in two octets (UCS-2) [<a href="#ref-ISO10646-1" title="&quot;Information technology -- Universal Multiple-Octet Coded Character Set (UCS) - Part 1: Architecture and Basic Multilingual Plane">ISO10646-1</a>]
3757 'application/postscript': A PostScript document [<a href="./rfc2046" title="&quot;Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types&quot;">RFC2046</a>]
3758 'application/vnd.hp-PCL': A PCL document [<a href="#ref-IANA-MT">IANA-MT</a>] (charset escape
3759 sequence embedded in the document data)
3760 'application/octet-stream': Auto-sense - see below
3761
3762 One special type is 'application/octet-stream'. If the Printer
3763 object supports this value, the Printer object MUST be capable of
3764 auto-sensing the format of the document data. If the Printer
3765 object's default value attribute "document-format-default" is set to
3766 'application/octet-stream', the Printer object not only supports
3767 auto-sensing of the document format, but will depend on the result of
3768 applying its auto-sensing when the client does not supply the
3769 "document-format" attribute. If the client supplies a document
3770 format value, the Printer MUST rely on the supplied attribute, rather
3771 than trust its auto-sensing algorithm. To summarize:
3772
3773 1. If the client does not supply a document format value, the
3774 Printer MUST rely on its default value setting (which may be '
3775 application/octet-stream' indicating an auto-sensing mechanism).
3776 2. If the client supplies a value other than 'application/octet-
3777 stream', the client is supplying valid information about the
3778 format of the document data and the Printer object MUST trust
3779 the client supplied value more than the outcome of applying an
3780 automatic format detection mechanism. For example, the client
3781 may be requesting the printing of a PostScript file as a '
3782 text/plain' document. The Printer object MUST print a text
3783 representation of the PostScript commands rather than interpret
3784 the stream of PostScript commands and print the result.
3785 3. If the client supplies a value of 'application/octet-stream',
3786 the client is indicating that the Printer object MUST use its
3787 auto-sensing mechanism on the client supplied document data
3788 whether auto-sensing is the Printer object's default or not.
3789
3790 Note: Since the auto-sensing algorithm is probabilistic, if the
3791 client requests both auto-sensing ("document-format" set to '
3792 application/octet-stream') and true fidelity ("ipp-attribute-
3793 fidelity" set to 'true'), the Printer object might not be able to
3794 guarantee exactly what the end user intended (the auto-sensing
3795 algorithm might mistake one document format for another ), but it is
3796 able to guarantee that its auto-sensing mechanism be used.
3797
3798 The maximum length of a 'mimeMediaType' value to represent IPP
3799 attribute values is 255 octets.
3800
3801
3802
3803
3804 <span class="grey">deBry, et al. Experimental [Page 68]</span></pre>
3805 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
3806 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3807
3808
3809 <span class="h4"><a class="selflink" id="section-4.1.10" href="#section-4.1.10">4.1.10</a> 'octetString'</span>
3810
3811 The 'octetString' attribute syntax is a sequence of octets encoded in
3812 a maximum of 1023 octets which is indicated in sub-section headers
3813 using the notation: octetString(MAX). This syntax type is used for
3814 opaque data.
3815
3816 <span class="h4"><a class="selflink" id="section-4.1.11" href="#section-4.1.11">4.1.11</a> 'boolean'</span>
3817
3818 The 'boolean' attribute syntax has only two values: 'true' and '
3819 false'.
3820
3821 <span class="h4"><a class="selflink" id="section-4.1.12" href="#section-4.1.12">4.1.12</a> 'integer'</span>
3822
3823 The 'integer' attribute syntax is an integer value that is in the
3824 range from -2**31 (MIN) to 2**31 - 1 (MAX). Each individual
3825 attribute may specify the range constraint explicitly in sub-section
3826 headers if the range is different from the full range of possible
3827 integer values. For example: job-priority (integer(1:100)) for the
3828 "job-priority" attribute. However, the enforcement of that
3829 additional constraint is up to the IPP objects, not the protocol.
3830
3831 <span class="h4"><a class="selflink" id="section-4.1.13" href="#section-4.1.13">4.1.13</a> 'rangeOfInteger'</span>
3832
3833 The 'rangeOfInteger' attribute syntax is an ordered pair of integers
3834 that defines an inclusive range of integer values. The first integer
3835 specifies the lower bound and the second specifies the upper bound.
3836 If a range constraint is specified in the header description for an
3837 attribute in this document whose attribute syntax is 'rangeOfInteger'
3838 (i.e., 'X:Y' indicating X as a minimum value and Y as a maximum
3839 value), then the constraint applies to both integers.
3840
3841 <span class="h4"><a class="selflink" id="section-4.1.14" href="#section-4.1.14">4.1.14</a> 'dateTime'</span>
3842
3843 The 'dateTime' attribute syntax is a standard, fixed length, 11 octet
3844 representation of the "DateAndTime" syntax as defined in <a href="./rfc2579">RFC 2579</a>
3845 [<a href="./rfc2579" title="&quot;Textual Conventions for SMIv2&quot;">RFC2579</a>]. <a href="./rfc2579">RFC 2579</a> also identifies an 8 octet representation of a
3846 "DateAndTime" value, but IPP objects MUST use the 11 octet
3847 representation. A user interface will provide a mapping between
3848 protocol dateTime values and displayable user-friendly words or
3849 presentation values and phrases which are localized to the natural
3850 language and date format of the user.
3851
3852 <span class="h4"><a class="selflink" id="section-4.1.15" href="#section-4.1.15">4.1.15</a> 'resolution'</span>
3853
3854 The 'resolution' attribute syntax specifies a two-dimensional
3855 resolution in the indicated units. It consists of 3 values: a cross
3856 feed direction resolution (positive integer value), a feed direction
3857
3858
3859
3860 <span class="grey">deBry, et al. Experimental [Page 69]</span></pre>
3861 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
3862 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3863
3864
3865 resolution (positive integer value), and a units value. The
3866 semantics of these three components are taken from the Printer MIB
3867 [<a href="./rfc1759" title="&quot;Printer MIB&quot;">RFC1759</a>] suggested values. That is, the cross feed direction
3868 component resolution component is the same as the
3869 prtMarkerAddressabilityXFeedDir object in the Printer MIB, the feed
3870 direction component resolution component is the same as the
3871 prtMarkerAddressabilityFeedDir in the Printer MIB, and the units
3872 component is the same as the prtMarkerAddressabilityUnit object in
3873 the Printer MIB (namely, '3' indicates dots per inch and '4'
3874 indicates dots per centimeter). All three values MUST be present
3875 even if the first two values are the same. Example: '300', '600', '
3876 3' indicates a 300 dpi cross-feed direction resolution, a 600 dpi
3877 feed direction resolution, since a '3' indicates dots per inch (dpi).
3878
3879 <span class="h4"><a class="selflink" id="section-4.1.16" href="#section-4.1.16">4.1.16</a> '1setOf </span>X'
3880
3881 The '1setOf X' attribute syntax is 1 or more values of attribute
3882 syntax type X. This syntax type is used for multi-valued attributes.
3883 The syntax type is called '1setOf' rather than just 'setOf' as a
3884 reminder that the set of values MUST NOT be empty (i.e., a set of
3885 size 0). Sets are normally unordered. However each attribute
3886 description of this type may specify that the values MUST be in a
3887 certain order for that attribute.
3888
3889 <span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a> Job Template Attributes</span>
3890
3891 Job Template attributes describe job processing behavior. Support
3892 for Job Template attributes by a Printer object is OPTIONAL (see
3893 <a href="#section-13.2.3">section 13.2.3</a> for a description of support for OPTIONAL attributes).
3894 Also, clients OPTIONALLY supply Job Template attributes in create
3895 requests.
3896
3897 Job Template attributes conform to the following rules. For each Job
3898 Template attribute called "xxx":
3899
3900 1. If the Printer object supports "xxx" then it MUST support both a
3901 "xxx-default" attribute (unless there is a "No" in the table
3902 below) and a "xxx-supported" attribute. If the Printer object
3903 doesn't support "xxx", then it MUST support neither an "xxx-
3904 default" attribute nor an "xxx-supported" attribute, and it MUST
3905 treat an attribute "xxx" supplied by a client as unsupported.
3906 An attribute "xxx" may be supported for some document formats
3907 and not supported for other document formats. For example, it
3908 is expected that a Printer object would only support
3909 "orientation-requested" for some document formats (such as '
3910 text/plain' or 'text/html') but not others (such as '
3911 application/postscript').
3912
3913
3914
3915
3916 <span class="grey">deBry, et al. Experimental [Page 70]</span></pre>
3917 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
3918 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3919
3920
3921 2. "xxx" is OPTIONALLY supplied by the client in a create request.
3922 If "xxx" is supplied, the client is indicating a desired job
3923 processing behavior for this Job. When "xxx" is not supplied,
3924 the client is indicating that the Printer object apply its
3925 default job processing behavior at job processing time if the
3926 document content does not contain an embedded instruction
3927 indicating an xxx-related behavior.
3928
3929 Note: Since an administrator MAY change the default value
3930 attribute after a Job object has been submitted but before it
3931 has been processed, the default value used by the Printer object
3932 at job processing time may be different that the default value
3933 in effect at job submission time.
3934
3935 3. The "xxx-supported" attribute is a Printer object attribute that
3936 describes which job processing behaviors are supported by that
3937 Printer object. A client can query the Printer object to find
3938 out what xxx-related behaviors are supported by inspecting the
3939 returned values of the "xxx-supported" attribute.
3940
3941 Note: The "xxx" in each "xxx-supported" attribute name is
3942 singular, even though an "xxx-supported" attribute usually has
3943 more than one value, such as "job-sheet-supported", unless the
3944 "xxx" Job Template attribute is plural, such as "finishings" or
3945 "sides". In such cases the "xxx-supported" attribute names are:
3946 "finishings-supported" and "sides-supported".
3947
3948 4. The "xxx-default" default value attribute describes what will be
3949 done at job processing time when no other job processing
3950 information is supplied by the client (either explicitly as an
3951 IPP attribute in the create request or implicitly as an embedded
3952 instruction within the document data).
3953
3954 If an application wishes to present an end user with a list of
3955 supported values from which to choose, the application SHOULD query
3956 the Printer object for its supported value attributes. The
3957 application SHOULD also query the default value attributes. If the
3958 application then limits selectable values to only those value that
3959 are supported, the application can guarantee that the values supplied
3960 by the client in the create request all fall within the set of
3961 supported values at the Printer. When querying the Printer, the
3962 client MAY enumerate each attribute by name in the Get-Printer-
3963 Attributes Request, or the client MAY just name the "job-template"
3964 group in order to get the complete set of supported attributes (both
3965 supported and default attributes).
3966
3967
3968
3969
3970
3971
3972 <span class="grey">deBry, et al. Experimental [Page 71]</span></pre>
3973 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
3974 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
3975
3976
3977 The "finishings" attribute is an example of a Job Template attribute.
3978 It can take on a set of values such as 'staple', 'punch', and/or '
3979 cover'. A client can query the Printer object for the "finishings-
3980 supported" attribute and the "finishings-default" attribute. The
3981 supported attribute contains a set of supported values. The default
3982 value attribute contains the finishing value(s) that will be used for
3983 a new Job if the client does not supply a "finishings" attribute in
3984 the create request and the document data does not contain any
3985 corresponding finishing instructions. If the client does supply the
3986 "finishings" attribute in the create request, the IPP object
3987 validates the value or values to make sure that they are a subset of
3988 the supported values identified in the Printer object's "finishings-
3989 supported" attribute. See <a href="#section-3.2.1.2">section 3.2.1.2</a>.
3990
3991 The table below summarizes the names and relationships for all Job
3992 Template attributes. The first column of the table (labeled "Job
3993 Attribute") shows the name and syntax for each Job Template attribute
3994 in the Job object. These are the attributes that can optionally be
3995 supplied by the client in a create request. The last two columns
3996 (labeled "Printer: Default Value Attribute" and "Printer: Supported
3997 Values Attribute") shows the name and syntax for each Job Template
3998 attribute in the Printer object (the default value attribute and the
3999 supported values attribute). A "No" in the table means the Printer
4000 MUST NOT support the attribute (that is, the attribute is simply not
4001 applicable). For brevity in the table, the 'text' and 'name' entries
4002 do not show the maximum length for each attribute.
4003
4004 +===================+======================+======================+
4005 | Job Attribute |Printer: Default Value| Printer: Supported |
4006 | | Attribute | Values Attribute |
4007 +===================+======================+======================+
4008 | job-priority | job-priority-default |job-priority-supported|
4009 | (integer 1:100) | (integer 1:100) |(integer 1:100) |
4010 +-------------------+----------------------+----------------------+
4011 | job-hold-until | job-hold-until- |job-hold-until- |
4012 | (type3 keyword | | default | supported |
4013 | name) | (type3 keyword | |(1setOf |
4014 | | name) | type3 keyword | name)|
4015 +-------------------+----------------------+----------------------+
4016 | job-sheets | job-sheets-default |job-sheets-supported |
4017 | (type3 keyword | | (type3 keyword | |(1setOf |
4018 | name) | name) | type3 keyword | name)|
4019 +-------------------+----------------------+----------------------+
4020 |multiple-document- |multiple-document- |multiple-document- |
4021 | handling | handling-default |handling-supported |
4022 | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
4023 +-------------------+----------------------+----------------------+
4024
4025
4026
4027
4028 <span class="grey">deBry, et al. Experimental [Page 72]</span></pre>
4029 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
4030 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4031
4032
4033 +===================+======================+======================+
4034 | Job Attribute |Printer: Default Value| Printer: Supported |
4035 | | Attribute | Values Attribute |
4036 +===================+======================+======================+
4037 | copies | copies-default | copies-supported |
4038 | (integer (1:MAX)) | (integer (1:MAX)) | (rangeOfInteger |
4039 | | | (1:MAX)) |
4040 +-------------------+----------------------+----------------------+
4041 | finishings | finishings-default | finishings-supported |
4042 |(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) |
4043 +-------------------+----------------------+----------------------+
4044 | page-ranges | No | page-ranges- |
4045 | (1setOf | | supported (boolean) |
4046 | rangeOfInteger | | |
4047 | (1:MAX)) | | |
4048 +-------------------+----------------------+----------------------+
4049 | sides | sides-default | sides-supported |
4050 | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
4051 +-------------------+----------------------+----------------------+
4052 | number-up | number-up-default | number-up-supported |
4053 | (integer (1:MAX)) | (integer (1:MAX)) |(1setOf integer |
4054 | | | (1:MAX) | |
4055 | | | rangeOfInteger |
4056 | | | (1:MAX)) |
4057 +-------------------+----------------------+----------------------+
4058 | orientation- |orientation-requested-|orientation-requested-|
4059 | requested | default | supported |
4060 | (type2 enum) | (type2 enum) | (1setOf type2 enum) |
4061 +-------------------+----------------------+----------------------+
4062 | media | media-default | media-supported |
4063 | (type3 keyword | | (type3 keyword | |(1setOf |
4064 | name) | name) | type3 keyword | name)|
4065 | | | |
4066 | | | media-ready |
4067 | | |(1setOf |
4068 | | | type3 keyword | name)|
4069 +-------------------+----------------------+----------------------+
4070 | printer-resolution| printer-resolution- | printer-resolution- |
4071 | (resolution) | default | supported |
4072 | | (resolution) |(1setOf resolution) |
4073 +-------------------+----------------------+----------------------+
4074 | print-quality | print-quality-default| print-quality- |
4075 | (type2 enum) | (type2 enum) | supported |
4076 | | |(1setOf type2 enum) |
4077 +-------------------+----------------------+----------------------+
4078
4079
4080
4081
4082
4083
4084 <span class="grey">deBry, et al. Experimental [Page 73]</span></pre>
4085 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
4086 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4087
4088
4089 <span class="h4"><a class="selflink" id="section-4.2.1" href="#section-4.2.1">4.2.1</a> job-priority (integer(1:100))</span>
4090
4091 This attribute specifies a priority for scheduling the Job. A higher
4092 value specifies a higher priority. The value 1 indicates the lowest
4093 possible priority. The value 100 indicates the highest possible
4094 priority. Among those jobs that are ready to print, a Printer MUST
4095 print all jobs with a priority value of n before printing those with
4096 a priority value of n-1 for all n.
4097
4098 If the Printer object supports this attribute, it MUST always support
4099 the full range from 1 to 100. No administrative restrictions are
4100 permitted. This way an end-user can always make full use of the
4101 entire range with any Printer object. If privileged jobs are
4102 implemented outside IPP/1.0, they MUST have priorities higher than
4103 100, rather than restricting the range available to end-users.
4104
4105 If the client does not supply this attribute and this attribute is
4106 supported by the Printer object, the Printer object MUST use the
4107 value of the Printer object's "job-priority-default" at job
4108 submission time (unlike most Job Template attributes that are used if
4109 necessary at job processing time).
4110
4111 The syntax for the "job-priority-supported" is also integer(1:100).
4112 This single integer value indicates the number of priority levels
4113 supported. The Printer object MUST take the value supplied by the
4114 client and map it to the closest integer in a sequence of n integers
4115 values that are evenly distributed over the range from 1 to 100 using
4116 the formula:
4117
4118 roundToNearestInt((100x+50)/n)
4119
4120 where n is the value of "job-priority-supported" and x ranges from 0
4121 through n-1.
4122
4123 For example, if n=1 the sequence of values is 50; if n=2, the
4124 sequence of values is: 25 and 75; if n = 3, the sequence of values
4125 is: 17, 50 and 83; if n = 10, the sequence of values is: 5, 15, 25,
4126 35, 45, 55, 65, 75, 85, and 95; if n = 100, the sequence of values
4127 is: 1, 2, 3, . 100.
4128
4129 If the value of the Printer object's "job-priority-supported" is 10
4130 and the client supplies values in the range 1 to 10, the Printer
4131 object maps them to 5, in the range 11 to 20, the Printer object maps
4132 them to 15, etc.
4133
4134
4135
4136
4137
4138
4139
4140 <span class="grey">deBry, et al. Experimental [Page 74]</span></pre>
4141 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
4142 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4143
4144
4145 <span class="h4"><a class="selflink" id="section-4.2.2" href="#section-4.2.2">4.2.2</a> job-hold-until (type3 keyword | name (MAX))</span>
4146
4147 This attribute specifies the named time period during which the Job
4148 MUST become a candidate for printing.
4149
4150 Standard keyword values for named time periods are:
4151
4152 'no-hold': immediately, if there are not other reasons to hold the
4153 job
4154 'day-time': during the day
4155 'evening': evening
4156 'night': night
4157 'weekend': weekend
4158 'second-shift': second-shift (after close of business)
4159 'third-shift': third-shift (after midnight)
4160
4161 An administrator MUST associate allowable print times with a named
4162 time period (by means outside IPP/1.0). An administrator is
4163 encouraged to pick names that suggest the type of time period. An
4164 administrator MAY define additional values using the 'name' or '
4165 keyword' attribute syntax, depending on implementation.
4166
4167 If the value of this attribute specifies a time period that is in the
4168 future, the Printer MUST add the 'job-hold-until-specified' value to
4169 the job's "job-state-reasons" attribute, move the job to the '
4170 pending-held' state, and MUST NOT schedule the job for printing until
4171 the specified time-period arrives. When the specified time period
4172 arrives, the Printer MUST remove the 'job-hold-until-specified' value
4173 from the job's "job-state-reason" attribute and, if there are no
4174 other job state reasons that keep the job in the 'pending-held'
4175 state, the Printer MUST consider the job as a candidate for
4176 processing by moving the job to the 'pending' state.
4177
4178 If this job attribute value is the named value 'no-hold', or the
4179 specified time period has already started, the job MUST be a
4180 candidate for processing immediately.
4181
4182 If the client does not supply this attribute and this attribute is
4183 supported by the Printer object, the Printer object MUST use the
4184 value of the Printer object's "job-hold-until-default" at job
4185 submission time (unlike most Job Template attributes that are used if
4186 necessary at job processing time).
4187
4188 <span class="h4"><a class="selflink" id="section-4.2.3" href="#section-4.2.3">4.2.3</a> job-sheets (type3 keyword | name(MAX))</span>
4189
4190 This attribute determines which job start/end sheet(s), if any, MUST
4191 be printed with a job.
4192
4193
4194
4195
4196 <span class="grey">deBry, et al. Experimental [Page 75]</span></pre>
4197 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
4198 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4199
4200
4201 Standard keyword values are:
4202
4203 'none': no job sheet is printed
4204 'standard': one or more site specific standard job sheets are
4205 printed, e.g. a single start sheet or both start and end sheet
4206 is printed
4207
4208 An administrator MAY define additional values using the 'name' or '
4209 keyword' attribute syntax, depending on implementation.
4210
4211 Note: The effect of this attribute on jobs with multiple documents
4212 MAY be affected by the "multiple-document-handling" job attribute
4213 (<a href="#section-4.2.4">section 4.2.4</a>), depending on the job sheet semantics.
4214
4215 <span class="h4"><a class="selflink" id="section-4.2.4" href="#section-4.2.4">4.2.4</a> multiple-document-handling (type2 keyword)</span>
4216
4217 This attribute is relevant only if a job consists of two or more
4218 documents. The attribute controls finishing operations and the
4219 placement of one or more print-stream pages into impressions and onto
4220 media sheets. When the value of the "copies" attribute exceeds 1, it
4221 also controls the order in which the copies that result from
4222 processing the documents are produced. For the purposes of this
4223 explanations, if "a" represents an instance of document data, then
4224 the result of processing the data in document "a" is a sequence of
4225 media sheets represented by "a(*)".
4226
4227 Standard keyword values are:
4228
4229 'single-document': If a Job object has multiple documents, say, the
4230 document data is called a and b, then the result of processing
4231 all the document data (a and then b) MUST be treated as a single
4232 sequence of media sheets for finishing operations; that is,
4233 finishing would be performed on the concatenation of the
4234 sequences a(*),b(*). The Printer object MUST NOT force the data
4235 in each document instance to be formatted onto a new print-
4236 stream page, nor to start a new impression on a new media sheet.
4237 If more than one copy is made, the ordering of the sets of media
4238 sheets resulting from processing the document data MUST be a(*),
4239 b(*), a(*), b(*), ..., and the Printer object MUST force each
4240 copy (a(*),b(*)) to start on a new media sheet.
4241 'separate-documents-uncollated-copies': If a Job object has
4242 multiple documents, say, the document data is called a and b,
4243 then the result of processing the data in each document instance
4244 MUST be treated as a single sequence of media sheets for
4245 finishing operations; that is, the sets a(*) and b(*) would each
4246 be finished separately. The Printer object MUST force each copy
4247 of the result of processing the data in a single document to
4248 start on a new media sheet. If more than one copy is made, the
4249
4250
4251
4252 <span class="grey">deBry, et al. Experimental [Page 76]</span></pre>
4253 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
4254 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4255
4256
4257 ordering of the sets of media sheets resulting from processing
4258 the document data MUST be a(*), a(*), ..., b(*), b(*) ... .
4259 'separate-documents-collated-copies': If a Job object has multiple
4260 documents, say, the document data is called a and b, then the
4261 result of processing the data in each document instance MUST be
4262 treated as a single sequence of media sheets for finishing
4263 operations; that is, the sets a(*) and b(*) would each be
4264 finished separately. The Printer object MUST force each copy of
4265 the result of processing the data in a single document to start
4266 on a new media sheet. If more than one copy is made, the
4267 ordering of the sets of media sheets resulting from processing
4268 the document data MUST be a(*), b(*), a(*), b(*), ... .
4269 'single-document-new-sheet': Same as 'single-document', except
4270 that the Printer object MUST ensure that the first impression of
4271 each document instance in the job is placed on a new media
4272 sheet. This value allows multiple documents to be stapled
4273 together with a single staple where each document starts on a
4274 new sheet.
4275
4276 The 'single-document' value is the same as 'separate-documents-
4277 collated-copies' with respect to ordering of print-stream pages, but
4278 not media sheet generation, since 'single-document' will put the
4279 first page of the next document on the back side of a sheet if an odd
4280 number of pages have been produced so far for the job, while '
4281 separate-documents-collated-copies' always forces the next document
4282 or document copy on to a new sheet. In addition, if the "finishings"
4283 attribute specifies 'staple', then with 'single-document', documents
4284 a and b are stapled together as a single document with no regard to
4285 new sheets, with 'single-document-new-sheet', documents a and b are
4286 stapled together as a single document, but document b starts on a new
4287 sheet, but with 'separate-documents-uncollated-copies' and '
4288 separate-documents-collated-copies', documents a and b are stapled
4289 separately.
4290
4291 Note: None of these values provide means to produce uncollated sheets
4292 within a document, i.e., where multiple copies of sheet n are
4293 produced before sheet n+1 of the same document.
4294
4295 The relationship of this attribute and the other attributes that
4296 control document processing is described in <a href="#section-15.3">section 15.3</a>.
4297
4298 <span class="h4"><a class="selflink" id="section-4.2.5" href="#section-4.2.5">4.2.5</a> copies (integer(1:MAX))</span>
4299
4300 This attribute specifies the number of copies to be printed.
4301
4302 On many devices the supported number of collated copies will be
4303 limited by the number of physical output bins on the device, and may
4304 be different from the number of uncollated copies which can be
4305
4306
4307
4308 <span class="grey">deBry, et al. Experimental [Page 77]</span></pre>
4309 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
4310 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4311
4312
4313 supported.
4314
4315 Note: The effect of this attribute on jobs with multiple documents is
4316 controlled by the "multiple-document-handling" job attribute (<a href="#section-4.2.4">section</a>
4317 <a href="#section-4.2.4">4.2.4</a>) and the relationship of this attribute and the other
4318 attributes that control document processing is described in <a href="#section-15.3">section</a>
4319 <a href="#section-15.3">15.3</a>.
4320
4321 <span class="h4"><a class="selflink" id="section-4.2.6" href="#section-4.2.6">4.2.6</a> finishings (1setOf type2 enum)</span>
4322
4323 This attribute identifies the finishing operations that the Printer
4324 uses for each copy of each printed document in the Job. For Jobs with
4325 multiple documents, the "multiple-document-handling" attribute
4326 determines what constitutes a "copy" for purposes of finishing.
4327
4328 Standard enum values are:
4329
4330 Value Symbolic Name and Description
4331
4332 '3' 'none': Perform no finishing
4333 '4' 'staple': Bind the document(s) with one or more staples.
4334 The exact number and placement of the staples is
4335 site-defined.
4336 '5' 'punch': This value indicates that holes are required in
4337 the finished document. The exact number and placement
4338 of the holes is site-defined The punch specification
4339 MAY be satisfied (in a site- and implementation-
4340 specific manner) either by drilling/punching, or by
4341 substituting pre-drilled media.
4342 '6' 'cover': This value is specified when it is desired to
4343 select a non-printed (or pre-printed) cover for the
4344 document. This does not supplant the specification of
4345 a printed cover (on cover stock medium) by the
4346 document itself.
4347 '7' 'bind': This value indicates that a binding is to be
4348 applied to the document; the type and placement of the
4349 binding is site-defined."
4350
4351 Note: The effect of this attribute on jobs with multiple documents is
4352 controlled by the "multiple-document-handling" job attribute (<a href="#section-4.2.4">section</a>
4353 <a href="#section-4.2.4">4.2.4</a>) and the relationship of this attribute and the other
4354 attributes that control document processing is described in <a href="#section-15.3">section</a>
4355 <a href="#section-15.3">15.3</a>.
4356
4357 If the client supplies a value of 'none' along with any other
4358 combination of values, it is the same as if only that other
4359 combination of values had been supplied (that is the 'none' value has
4360 no effect).
4361
4362
4363
4364 <span class="grey">deBry, et al. Experimental [Page 78]</span></pre>
4365 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-79" ></span>
4366 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4367
4368
4369 <span class="h4"><a class="selflink" id="section-4.2.7" href="#section-4.2.7">4.2.7</a> page-ranges (1setOf rangeOfInteger (1:MAX))</span>
4370
4371 This attribute identifies the range(s) of print-stream pages that the
4372 Printer object uses for each copy of each document which are to be
4373 printed. Nothing is printed for any pages identified that do not
4374 exist in the document(s). Ranges MUST be in ascending order, for
4375 example: 1-3, 5-7, 15-19 and MUST NOT overlap, so that a non-spooling
4376 Printer object can process the job in a single pass. If the ranges
4377 are not ascending or are overlapping, the IPP object MUST reject the
4378 request and return the 'client-error-bad-request' status code. The
4379 attribute is associated with print-stream pages not application-
4380 numbered pages (for example, the page numbers found in the headers
4381 and or footers for certain word processing applications).
4382
4383 For Jobs with multiple documents, the "multiple-document-handling"
4384 attribute determines what constitutes a "copy" for purposes of the
4385 specified page range(s). When "multiple-document-handling" is '
4386 single-document', the Printer object MUST apply each supplied page
4387 range once to the concatenation of the print-stream pages. For
4388 example, if there are 8 documents of 10 pages each, the page-range '
4389 41:60' prints the pages in the 5th and 6th documents as a single
4390 document and none of the pages of the other documents are printed.
4391 When "multiple-document-handling" is 'separate-documents-uncollated-
4392 copies' or 'separate-documents-collated-copies', the Printer object
4393 MUST apply each supplied page range repeatedly to each document copy.
4394 For the same job, the page-range '1:3, 10:10' would print the first 3
4395 pages and the 10th page of each of the 8 documents in the Job, as 8
4396 separate documents.
4397
4398 In most cases, the exact pages to be printed will be generated by a
4399 device driver and this attribute would not be required. However,
4400 when printing an archived document which has already been formatted,
4401 the end user may elect to print just a subset of the pages contained
4402 in the document. In this case, if page-range = n.m is specified, the
4403 first page to be printed will be page n. All subsequent pages of the
4404 document will be printed through and including page m.
4405
4406 "page-ranges-supported" is a boolean value indicating whether or not
4407 the printer is capable of supporting the printing of page ranges.
4408 This capability may differ from one PDL to another. There is no
4409 "page-ranges-default" attribute. If the "page-ranges" attribute is
4410 not supplied by the client, all pages of the document will be
4411 printed.
4412
4413
4414
4415
4416
4417
4418
4419
4420 <span class="grey">deBry, et al. Experimental [Page 79]</span></pre>
4421 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-80" ></span>
4422 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4423
4424
4425 Note: The effect of this attribute on jobs with multiple documents is
4426 controlled by the "multiple-document-handling" job attribute (<a href="#section-4.2.4">section</a>
4427 <a href="#section-4.2.4">4.2.4</a>) and the relationship of this attribute and the other
4428 attributes that control document processing is described in <a href="#section-15.3">section</a>
4429 <a href="#section-15.3">15.3</a>.
4430
4431 <span class="h4"><a class="selflink" id="section-4.2.8" href="#section-4.2.8">4.2.8</a> sides (type2 keyword)</span>
4432
4433 This attribute specifies how print-stream pages are to be imposed
4434 upon the sides of an instance of a selected medium, i.e., an
4435 impression.
4436
4437 The standard keyword values are:
4438
4439 'one-sided': imposes each consecutive print-stream page upon the
4440 same side of consecutive media sheets.
4441 'two-sided-long-edge': imposes each consecutive pair of print-
4442 stream pages upon front and back sides of consecutive media
4443 sheets, such that the orientation of each pair of print-stream
4444 pages on the medium would be correct for the reader as if for
4445 binding on the long edge. This imposition is sometimes called '
4446 duplex' or 'head-to-head'.
4447 'two-sided-short-edge': imposes each consecutive pair of print-
4448 stream pages upon front and back sides of consecutive media
4449 sheets, such that the orientation of each pair of print-stream
4450 pages on the medium would be correct for the reader as if for
4451 binding on the short edge. This imposition is sometimes called
4452 'tumble' or 'head-to-toe'.
4453
4454 'two-sided-long-edge', 'two-sided-short-edge', 'tumble', and 'duplex'
4455 all work the same for portrait or landscape. However 'head-to-toe'
4456 is 'tumble' in portrait but 'duplex' in landscape. 'head-to-head'
4457 also switches between 'duplex' and 'tumble' when using portrait and
4458 landscape modes.
4459
4460 Note: The effect of this attribute on jobs with multiple documents is
4461 controlled by the "multiple-document-handling" job attribute (<a href="#section-4.2.4">section</a>
4462 <a href="#section-4.2.4">4.2.4</a>) and the relationship of this attribute and the other
4463 attributes that control document processing is described in <a href="#section-15.3">section</a>
4464 <a href="#section-15.3">15.3</a>.
4465
4466 <span class="h4"><a class="selflink" id="section-4.2.9" href="#section-4.2.9">4.2.9</a> number-up (integer(1:MAX))</span>
4467
4468 This attribute specifies the number of print-stream pages to impose
4469 upon a single side of an instance of a selected medium. For example,
4470 if the value is:
4471
4472
4473
4474
4475
4476 <span class="grey">deBry, et al. Experimental [Page 80]</span></pre>
4477 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-81" ></span>
4478 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4479
4480
4481 Value Description
4482
4483 '1' the Printer MUST place one print-stream page on a single
4484 side of an instance of the selected medium (MAY add
4485 some sort of translation, scaling, or rotation).
4486 '2' the Printer MUST place two print-stream pages on a single
4487 side of an instance of the selected medium (MAY add
4488 some sort of translation, scaling, or rotation).
4489 '4' the Printer MUST place four print-stream pages on a single
4490 side of an instance of the selected medium (MAY add
4491 some sort of translation, scaling, or rotation).
4492
4493 This attribute primarily controls the translation, scaling and
4494 rotation of print-stream pages.
4495
4496 Note: The effect of this attribute on jobs with multiple documents is
4497 controlled by the "multiple-document-handling" job attribute (<a href="#section-4.2.4">section</a>
4498 <a href="#section-4.2.4">4.2.4</a>) and the relationship of this attribute and the other
4499 attributes that control document processing is described in <a href="#section-15.3">section</a>
4500 <a href="#section-15.3">15.3</a>.
4501
4502 <span class="h4"><a class="selflink" id="section-4.2.10" href="#section-4.2.10">4.2.10</a> orientation-requested (type2 enum)</span>
4503
4504 This attribute indicates the desired orientation for printed print-
4505 stream pages; it does not describe the orientation of the client-
4506 supplied print-stream pages.
4507
4508 For some document formats (such as 'application/postscript'), the
4509 desired orientation of the print-stream pages is specified within the
4510 document data. This information is generated by a device driver
4511 prior to the submission of the print job. Other document formats
4512 (such as 'text/plain') do not include the notion of desired
4513 orientation within the document data. In the latter case it is
4514 possible for the Printer object to bind the desired orientation to
4515 the document data after it has been submitted. It is expected that a
4516 Printer object would only support "orientations-requested" for some
4517 document formats (e.g., 'text/plain' or 'text/html') but not others
4518 (e.g., 'application/postscript'). This is no different than any
4519 other Job Template attribute since <a href="#section-4.2">section 4.2</a>, item 1, points out
4520 that a Printer object may support or not support any Job Template
4521 attribute based on the document format supplied by the client.
4522 However, a special mention is made here since it is very likely that
4523 a Printer object will support "orientation-requested" for only a
4524 subset of the supported document formats.
4525
4526
4527
4528
4529
4530
4531
4532 <span class="grey">deBry, et al. Experimental [Page 81]</span></pre>
4533 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-82" ></span>
4534 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4535
4536
4537 Standard enum values are:
4538
4539 Value Symbolic Name and Description
4540
4541 '3' 'portrait': The content will be imaged across the short
4542 edge of the medium.
4543 '4' 'landscape': The content will be imaged across the long
4544 edge of the medium. Landscape is defined to be a
4545 rotation of the print-stream page to be imaged by +90
4546 degrees with respect to the medium (i.e. anti-
4547 clockwise) from the portrait orientation. Note: The
4548 +90 direction was chosen because simple finishing on
4549 the long edge is the same edge whether portrait or
4550 landscape
4551 '5' 'reverse-landscape': The content will be imaged across the
4552 long edge of the medium. Reverse-landscape is defined
4553 to be a rotation of the print-stream page to be imaged
4554 by - 90 degrees with respect to the medium (i.e.
4555 clockwise) from the portrait orientation. Note: The '
4556 reverse-landscape' value was added because some
4557 applications rotate landscape -90 degrees from
4558 portrait, rather than +90 degrees.
4559 '6' 'reverse-portrait': The content will be imaged across the
4560 short edge of the medium. Reverse-portrait is defined
4561 to be a rotation of the print-stream page to be imaged
4562 by 180 degrees with respect to the medium from the
4563 portrait orientation. Note: The 'reverse-portrait'
4564 value was added for use with the "finishings"
4565 attribute in cases where the opposite edge is desired
4566 for finishing a portrait document on simple finishing
4567 devices that have only one finishing position. Thus a
4568 'text'/plain' portrait document can be stapled "on the
4569 right" by a simple finishing device as is common use
4570 with some middle eastern languages such as Hebrew.
4571
4572 Note: The effect of this attribute on jobs with multiple documents is
4573 controlled by the "multiple-document-handling" job attribute (<a href="#section-4.2.4">section</a>
4574 <a href="#section-4.2.4">4.2.4</a>) and the relationship of this attribute and the other
4575 attributes that control document processing is described in <a href="#section-15.3">section</a>
4576 <a href="#section-15.3">15.3</a>.
4577
4578 <span class="h4"><a class="selflink" id="section-4.2.11" href="#section-4.2.11">4.2.11</a> media (type3 keyword | name(MAX))</span>
4579
4580 This attribute identifies the medium that the Printer uses for all
4581 impressions of the Job.
4582
4583 The values for "media" include medium-names, medium-sizes, input-
4584 trays and electronic forms so that one attribute specifies the media.
4585
4586
4587
4588 <span class="grey">deBry, et al. Experimental [Page 82]</span></pre>
4589 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-83" ></span>
4590 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4591
4592
4593 If a Printer object supports a medium name as a value of this
4594 attribute, such a medium name implicitly selects an input-tray that
4595 contains the specified medium. If a Printer object supports a medium
4596 size as a value of this attribute, such a medium size implicitly
4597 selects a medium name that in turn implicitly selects an input-tray
4598 that contains the medium with the specified size. If a Printer
4599 object supports an input-tray as the value of this attribute, such an
4600 input-tray implicitly selects the medium that is in that input-tray
4601 at the time the job prints. This case includes manual-feed input-
4602 trays. If a Printer object supports an electronic form as the value
4603 of this attribute, such an electronic form implicitly selects a
4604 medium-name that in turn implicitly selects an input-tray that
4605 contains the medium specified by the electronic form. The electronic
4606 form also implicitly selects an image that the Printer MUST merge
4607 with the document data as its prints each page.
4608
4609 Standard keyword values are (taken from ISO DPA and the Printer MIB)
4610 and are listed in <a href="#section-14">section 14</a>. An administrator MAY define additional
4611 values using the 'name' or 'keyword' attribute syntax, depending on
4612 implementation.
4613
4614 There is also an additional Printer attribute named "media-ready"
4615 which differs from "media-supported" in that legal values only
4616 include the subset of "media-supported" values that are physically
4617 loaded and ready for printing with no operator intervention required.
4618 If an IPP object supports "media-supported", it NEED NOT support
4619 "media-ready".
4620
4621 The relationship of this attribute and the other attributes that
4622 control document processing is described in <a href="#section-15.3">section 15.3</a>.
4623
4624 <span class="h4"><a class="selflink" id="section-4.2.12" href="#section-4.2.12">4.2.12</a> printer-resolution (resolution)</span>
4625
4626 This attribute identifies the resolution that Printer uses for the
4627 Job.
4628
4629 <span class="h4"><a class="selflink" id="section-4.2.13" href="#section-4.2.13">4.2.13</a> print-quality (type2 enum)</span>
4630
4631 This attribute specifies the print quality that the Printer uses for
4632 the Job.
4633
4634 The standard enum values are:
4635
4636 Value Symbolic Name and Description
4637
4638 '3' 'draft': lowest quality available on the printer
4639 '4' 'normal': normal or intermediate quality on the printer
4640 '5' 'high': highest quality available on the printer
4641
4642
4643
4644 <span class="grey">deBry, et al. Experimental [Page 83]</span></pre>
4645 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-84" ></span>
4646 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4647
4648
4649 <span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a> Job Description Attributes</span>
4650
4651 The attributes in this section form the attribute group called "job-
4652 description". The following table summarizes these attributes. The
4653 third column indicates whether the attribute is a REQUIRED attribute
4654 that MUST be supported by Printer objects. If it is not indicated as
4655 REQUIRED, then it is OPTIONAL. The maximum size in octets for 'text'
4656 and 'name' attributes is indicated in parenthesizes.
4657
4658 +----------------------------+----------------------+----------------+
4659 | Attribute | Syntax | REQUIRED? |
4660 +----------------------------+----------------------+----------------+
4661 | job-uri | uri | REQUIRED |
4662 +----------------------------+----------------------+----------------+
4663 | job-id | integer(1:MAX) | REQUIRED |
4664 +----------------------------+----------------------+----------------+
4665 | job-printer-uri | uri | REQUIRED |
4666 +----------------------------+----------------------+----------------+
4667 | job-more-info | uri | |
4668 +----------------------------+----------------------+----------------+
4669 | job-name | name (MAX) | REQUIRED |
4670 +----------------------------+----------------------+----------------+
4671 | job-originating-user-name | name (MAX) | REQUIRED |
4672 +----------------------------+----------------------+----------------+
4673 | job-state | type1 enum | REQUIRED |
4674 +----------------------------+----------------------+----------------+
4675 | job-state-reasons | 1setOf type2 keyword | |
4676 +----------------------------+----------------------+----------------+
4677 | job-state-message | text (MAX) | |
4678 +----------------------------+----------------------+----------------+
4679 | number-of-documents | integer (0:MAX) | |
4680 +----------------------------+----------------------+----------------+
4681 | output-device-assigned | name (127) | |
4682 +----------------------------+----------------------+----------------+
4683 | time-at-creation | integer (0:MAX) | |
4684 +----------------------------+----------------------+----------------+
4685 | time-at-processing | integer (0:MAX) | |
4686 +----------------------------+----------------------+----------------+
4687 | time-at-completed | integer (0:MAX) | |
4688 +----------------------------+----------------------+----------------+
4689 | number-of-intervening-jobs | integer (0:MAX) | |
4690 +----------------------------+----------------------+----------------+
4691 | job-message-from-operator | text (127) | |
4692 +----------------------------+----------------------+----------------+
4693 | job-k-octets | integer (0:MAX) | |
4694 +----------------------------+----------------------+----------------+
4695 | job-impressions | integer (0:MAX) | |
4696 +----------------------------+----------------------+----------------+
4697
4698
4699
4700 <span class="grey">deBry, et al. Experimental [Page 84]</span></pre>
4701 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-85" ></span>
4702 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4703
4704
4705 +----------------------------+----------------------+----------------+
4706 | Attribute | Syntax | REQUIRED? |
4707 +----------------------------+----------------------+----------------+
4708 | job-media-sheets | integer (0:MAX) | |
4709 +----------------------------+----------------------+----------------+
4710 | job-k-octets-processed | integer (0:MAX) | |
4711 +----------------------------+----------------------+----------------+
4712 | job-impressions-completed | integer (0:MAX) | |
4713 +----------------------------+----------------------+----------------+
4714 | job-media-sheets-completed | integer (0:MAX) | |
4715 +----------------------------+----------------------+----------------+
4716 | attributes-charset | charset | REQUIRED |
4717 +----------------------------+----------------------+----------------+
4718 | attributes-natural-language| naturalLanguage | REQUIRED |
4719 +----------------------------+----------------------+----------------+
4720
4721
4722 <span class="h4"><a class="selflink" id="section-4.3.1" href="#section-4.3.1">4.3.1</a> job-uri (uri)</span>
4723
4724 This REQUIRED attribute contains the URI for the job. The Printer
4725 object, on receipt of a new job, generates a URI which identifies the
4726 new Job. The Printer object returns the value of the "job-uri"
4727 attribute as part of the response to a create request. The precise
4728 format of a Job URI is implementation dependent. If the Printer
4729 object supports more than one URI and there is some relationship
4730 between the newly formed Job URI and the Printer object's URI, the
4731 Printer object uses the Printer URI supplied by the client in the
4732 create request. For example, if the create request comes in over a
4733 secure channel, the new Job URI MUST use the same secure channel.
4734 This can be guaranteed because the Printer object is responsible for
4735 generating the Job URI and the Printer object is aware of its
4736 security configuration and policy as well as the Printer URI used in
4737 the create request.
4738
4739 For a description of this attribute and its relationship to "job-id"
4740 and "job-printer-uri" attribute, see the discussion in <a href="#section-2.4">section 2.4</a> on
4741 "Object Identity".
4742
4743 <span class="h4"><a class="selflink" id="section-4.3.2" href="#section-4.3.2">4.3.2</a> job-id (integer(1:MAX))</span>
4744
4745 This REQUIRED attribute contains the ID of the job. The Printer, on
4746 receipt of a new job, generates an ID which identifies the new Job on
4747 that Printer. The Printer returns the value of the "job-id"
4748 attribute as part of the response to a create request. The 0 value
4749 is not included to allow for compatibility with SNMP index values
4750 which also cannot be 0.
4751
4752
4753
4754
4755
4756 <span class="grey">deBry, et al. Experimental [Page 85]</span></pre>
4757 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-86" ></span>
4758 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4759
4760
4761 For a description of this attribute and its relationship to "job-uri"
4762 and "job-printer-uri" attribute, see the discussion in <a href="#section-2.4">section 2.4</a> on
4763 "Object Identity".
4764
4765 <span class="h4"><a class="selflink" id="section-4.3.3" href="#section-4.3.3">4.3.3</a> job-printer-uri (uri)</span>
4766
4767 This REQUIRED attribute identifies the Printer object that created
4768 this Job object. When a Printer object creates a Job object, it
4769 populates this attribute with the Printer object URI that was used in
4770 the create request. This attribute permits a client to identify the
4771 Printer object that created this Job object when only the Job
4772 object's URI is available to the client. The client queries the
4773 creating Printer object to determine which languages, charsets,
4774 operations, are supported for this Job.
4775
4776 For a description of this attribute and its relationship to "job-uri"
4777 and "job-id" attribute, see the discussion in <a href="#section-2.4">section 2.4</a> on "Object
4778 Identity".
4779
4780 <span class="h4"><a class="selflink" id="section-4.3.4" href="#section-4.3.4">4.3.4</a> job-more-info (uri)</span>
4781
4782 Similar to "printer-more-info", this attribute contains the URI
4783 referencing some resource with more information about this Job
4784 object, perhaps an HTML page containing information about the Job.
4785
4786 <span class="h4"><a class="selflink" id="section-4.3.5" href="#section-4.3.5">4.3.5</a> job-name (name(MAX))</span>
4787
4788 This REQUIRED attribute is the name of the job. It is a name that is
4789 more user friendly than the "job-uri" attribute value. It does not
4790 need to be unique between Jobs. The Job's "job-name" attribute is
4791 set to the value supplied by the client in the "job-name" operation
4792 attribute in the create request (see <a href="#section-3.2.1.1">Section 3.2.1.1</a>). If, however,
4793 the "job-name" operation attribute is not supplied by the client in
4794 the create request, the Printer object, on creation of the Job, MUST
4795 generate a name. The printer SHOULD generate the value of the Job's
4796 "job-name" attribute from the first of the following sources that
4797 produces a value: 1) the "document-name" operation attribute of the
4798 first (or only) document, 2) the "document-URI" attribute of the
4799 first (or only) document, or 3) any other piece of Job specific
4800 and/or Document Content information.
4801
4802 <span class="h4"><a class="selflink" id="section-4.3.6" href="#section-4.3.6">4.3.6</a> job-originating-user-name (name(MAX))</span>
4803
4804 This REQUIRED attribute contains the name of the end user that
4805 submitted the print job. The Printer object sets this attribute to
4806 the most authenticated printable name that it can obtain from the
4807 authentication service over which the IPP operation was received.
4808
4809
4810
4811
4812 <span class="grey">deBry, et al. Experimental [Page 86]</span></pre>
4813 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-87" ></span>
4814 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4815
4816
4817 Only if such is not available, does the Printer object use the value
4818 supplied by the client in the "requesting-user-name" operation
4819 attribute of the create operation (see <a href="#section-8">Section 8</a>).
4820
4821 Note: The Printer object needs to keep an internal originating user
4822 id of some form, typically as a credential of a principal, with the
4823 Job object. Since such an internal attribute is implementation-
4824 dependent and not of interest to clients, it is not specified as a
4825 Job Description attribute. This originating user id is used for
4826 authorization checks (if any) on all subsequent operation.
4827
4828 <span class="h4"><a class="selflink" id="section-4.3.7" href="#section-4.3.7">4.3.7</a> job-state (type1 enum)</span>
4829
4830 This REQUIRED attribute identifies the current state of the job.
4831 Even though the IPP protocol defines eight values for job states,
4832 implementations only need to support those states which are
4833 appropriate for the particular implementation. In other words, a
4834 Printer supports only those job states implemented by the output
4835 device and available to the Printer object implementation.
4836
4837 Standard enum values are:
4838
4839 Values Symbolic Name and Description
4840
4841 '3' 'pending': The job is a candidate to start processing, but
4842 is not yet processing.
4843
4844 '4' 'pending-held': The job is not a candidate for processing
4845 for any number of reasons but will return to the '
4846 pending' state as soon as the reasons are no longer
4847 present. The job's "job-state-reason" attribute MUST
4848 indicate why the job is no longer a candidate for
4849 processing.
4850
4851 '5' 'processing': One or more of:
4852
4853 1. the job is using, or is attempting to use, one or
4854 more purely software processes that are analyzing,
4855 creating, or interpreting a PDL, etc.,
4856 2. the job is using, or is attempting to use, one or
4857 more hardware devices that are interpreting a PDL,
4858 making marks on a medium, and/or performing finishing,
4859 such as stapling, etc.,
4860 3. the Printer object has made the job ready for
4861 printing, but the output device is not yet printing
4862 it, either because the job hasn't reached the output
4863
4864
4865
4866
4867
4868 <span class="grey">deBry, et al. Experimental [Page 87]</span></pre>
4869 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-88" ></span>
4870 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4871
4872
4873 device or because the job is queued in the output
4874 device or some other spooler, awaiting the output
4875 device to print it.
4876
4877 When the job is in the 'processing' state, the entire
4878 job state includes the detailed status represented in
4879 the printer's "printer-state", "printer-state-
4880 reasons", and "printer-state-message" attributes.
4881
4882 Implementations MAY, though they NEED NOT, include
4883 additional values in the job's "job-state-reasons"
4884 attribute to indicate the progress of the job, such as
4885 adding the 'job-printing' value to indicate when the
4886 output device is actually making marks on paper and/or
4887 the 'processing-to-stop-point' value to indicate that
4888 the IPP object is in the process of canceling or
4889 aborting the job. Most implementations won't bother
4890 with this nuance.
4891
4892 '6' 'processing-stopped': The job has stopped while processing
4893 for any number of reasons and will return to the '
4894 processing' state as soon as the reasons are no longer
4895 present.
4896
4897 The job's "job-state-reason" attribute MAY indicate
4898 why the job has stopped processing. For example, if
4899 the output device is stopped, the 'printer-stopped'
4900 value MAY be included in the job's "job-state-reasons"
4901 attribute.
4902
4903 Note: When an output device is stopped, the device
4904 usually indicates its condition in human readable form
4905 locally at the device. A client can obtain more
4906 complete device status remotely by querying the
4907 Printer object's "printer-state", "printer-state-
4908 reasons" and "printer-state-message" attributes.
4909
4910 '7' 'canceled': The job has been canceled by a Cancel-Job
4911 operation and the Printer object has completed
4912 canceling the job and all job status attributes have
4913 reached their final values for the job. While the
4914 Printer object is canceling the job, the job remains
4915 in its current state, but the job's "job-state-
4916 reasons" attribute SHOULD contain the 'processing-to-
4917 stop-point' value and one of the 'canceled-by-user', '
4918 canceled-by-operator', or 'canceled-at-device' value.
4919
4920
4921
4922
4923
4924 <span class="grey">deBry, et al. Experimental [Page 88]</span></pre>
4925 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-89" ></span>
4926 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4927
4928
4929 When the job moves to the 'canceled' state, the '
4930 processing-to-stop-point' value, if present, MUST be
4931 removed, but the 'canceled-by-xxx', if present, MUST
4932 remain.
4933
4934 '8' 'aborted': The job has been aborted by the system, usually
4935 while the job was in the 'processing' or 'processing-
4936 stopped' state and the Printer has completed aborting
4937 the job and all job status attributes have reached
4938 their final values for the job. While the Printer
4939 object is aborting the job, the job remains in its
4940 current state, but the job's "job-state-reasons"
4941 attribute SHOULD contain the 'processing-to-stop-
4942 point' and 'aborted-by-system' values. When the job
4943 moves to the 'aborted' state, the 'processing-to-
4944 stop-point' value, if present, MUST be removed, but
4945 the 'aborted-by-system' value, if present, MUST
4946 remain.
4947
4948 '9' 'completed': The job has completed successfully or with
4949 warnings or errors after processing and all of the job
4950 media sheets have been successfully stacked in the
4951 appropriate output bin(s) and all job status
4952 attributes have reached their final values for the
4953 job. The job's "job-state-reasons" attribute SHOULD
4954 contain one of: 'completed-successfully', '
4955 completed-with-warnings', or 'completed-with-errors'
4956 values.
4957
4958 The final value for this attribute MUST be one of: 'completed', '
4959 canceled', or 'aborted' before the Printer removes the job
4960 altogether. The length of time that jobs remain in the 'canceled', '
4961 aborted', and 'completed' states depends on implementation.
4962
4963 The following figure shows the normal job state transitions.
4964
4965 +----&gt; canceled
4966 /
4967 +----&gt; pending --------&gt; processing ---------+------&gt; completed
4968 | ^ ^ \
4969 ---&gt;+ | | +----&gt; aborted
4970 | v v /
4971 +----&gt; pending-held processing-stopped ---+
4972
4973 Normally a job progresses from left to right. Other state
4974 transitions are unlikely, but are not forbidden. Not shown are the
4975 transitions to the 'canceled' state from the 'pending', 'pending-
4976 held', and 'processing-stopped' states.
4977
4978
4979
4980 <span class="grey">deBry, et al. Experimental [Page 89]</span></pre>
4981 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-90" ></span>
4982 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
4983
4984
4985 Jobs reach one of the three terminal states: 'completed', 'canceled',
4986 or 'aborted', after the jobs have completed all activity, including
4987 stacking output media, after the jobs have completed all activity,
4988 and all job status attributes have reached their final values for the
4989 job.
4990
4991 Note: As with all other IPP attributes, if the implementation can not
4992 determine the correct value for this attribute, it SHOULD respond
4993 with the out-of-band value 'unknown' (see <a href="#section-4.1">section 4.1</a>) rather than
4994 try to guess at some possibly incorrect value and give the end user
4995 the wrong impression about the state of the Job object. For example,
4996 if the implementation is just a gateway into some printing system
4997 that does not provide detailed status about the print job, the IPP
4998 Job object's state might literally be 'unknown'.
4999
5000 <span class="h4"><a class="selflink" id="section-4.3.8" href="#section-4.3.8">4.3.8</a> job-state-reasons (1setOf </span>type2 keyword)
5001
5002 This attribute provides additional information about the job's
5003 current state, i.e., information that augments the value of the job's
5004 "job-state" attribute.
5005
5006 Implementation of these values is OPTIONAL, i.e., a Printer NEED NOT
5007 implement them, even if (1) the output device supports the
5008 functionality represented by the reason and (2) is available to the
5009 Printer object implementation. These values MAY be used with any job
5010 state or states for which the reason makes sense. Furthermore, when
5011 implemented, the Printer MUST return these values when the reason
5012 applies and MUST NOT return them when the reason no longer applies
5013 whether the value of the Job's "job-state" attribute changed or not.
5014 When the Job does not have any reasons for being in its current
5015 state, the value of the Job's "job-state-reasons" attribute MUST be '
5016 none'.
5017
5018 Note: While values cannot be added to the 'job-state' attribute
5019 without impacting deployed clients that take actions upon receiving
5020 "job-state" values, it is the intent that additional "job-state-
5021 reasons" values can be defined and registered without impacting such
5022 deployed clients. In other words, the "job-state-reasons" attribute
5023 is intended to be extensible.
5024
5025 The following standard keyword values are defined. For ease of
5026 understanding, the values are presented in the order in which the
5027 reasons are likely to occur (if implemented), starting with the '
5028 job-incoming' value:
5029
5030 'none': There are no reasons for the job's current state.
5031 'job-incoming': The Create-Job operation has been accepted by the
5032 Printer, but the Printer is expecting additional Send-Document
5033
5034
5035
5036 <span class="grey">deBry, et al. Experimental [Page 90]</span></pre>
5037 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-91" ></span>
5038 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5039
5040
5041 and/or Send-URI operations and/or is accessing/accepting
5042 document data.
5043 'submission-interrupted': The job was not completely submitted for
5044 some unforeseen reason, such as: (1) the Printer has crashed
5045 before the job was closed by the client, (2) the Printer or the
5046 document transfer method has crashed in some non-recoverable way
5047 before the document data was entirely transferred to the
5048 Printer, (3) the client crashed or failed to close the job
5049 before the time-out period. See <a href="#section-4.4.28">section 4.4.28</a>.
5050 'job-outgoing': The Printer is transmitting the job to the output
5051 device.
5052 'job-hold-until-specified': The value of the job's "job-hold-
5053 until" attribute was specified with a time period that is still
5054 in the future. The job MUST NOT be a candidate for processing
5055 until this reason is removed and there are no other reasons to
5056 hold the job.
5057 'resources-are-not-ready': At least one of the resources needed by
5058 the job, such as media, fonts, resource objects, etc., is not
5059 ready on any of the physical printer's for which the job is a
5060 candidate. This condition MAY be detected when the job is
5061 accepted, or subsequently while the job is pending or
5062 processing, depending on implementation. The job may remain in
5063 its current state or be moved to the 'pending-held' state,
5064 depending on implementation and/or job scheduling policy.
5065 'printer-stopped-partly': The value of the Printer's "printer-
5066 state-reasons" attribute contains the value 'stopped-partly'.
5067 'printer-stopped': The value of the Printer's "printer-state"
5068 attribute is 'stopped'.
5069 'job-interpreting': Job is in the 'processing' state, but more
5070 specifically, the Printer is interpreting the document data.
5071 'job-queued': Job is in the 'processing' state, but more
5072 specifically, the Printer has queued the document data.
5073 'job-transforming': Job is in the 'processing' state, but more
5074 specifically, the Printer is interpreting document data and
5075 producing another electronic representation.
5076 'job-printing': The output device is marking media. This value is
5077 useful for Printers which spend a great deal of time processing
5078 (1) when no marking is happening and then want to show that
5079 marking is now happening or (2) when the job is in the process
5080 of being canceled or aborted while the job remains in the '
5081 processing' state, but the marking has not yet stopped so that
5082 impression or sheet counts are still increasing for the job.
5083 'job-canceled-by-user': The job was canceled by the owner of the
5084 job using the Cancel-Job request, i.e., by a user whose
5085 authenticated identity is the same as the value of the
5086 originating user that created the Job object, or by some other
5087 authorized end-user, such as a member of the job owner's
5088 security group.
5089
5090
5091
5092 <span class="grey">deBry, et al. Experimental [Page 91]</span></pre>
5093 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-92" ></span>
5094 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5095
5096
5097 'job-canceled-by-operator': The job was canceled by the operator
5098 using the Cancel-Job request, i.e., by a user who has been
5099 authenticated as having operator privileges (whether local or
5100 remote). If the security policy is to allow anyone to cancel
5101 anyone's job, then this value may be used when the job is
5102 canceled by other than the owner of the job. For such a
5103 security policy, in effect, everyone is an operator as far as
5104 canceling jobs with IPP is concerned.
5105 'job-canceled-at-device': The job was canceled by an unidentified
5106 local user, i.e., a user at a console at the device.
5107 'aborted-by-system': The job (1) is in the process of being
5108 aborted, (2) has been aborted by the system and placed in the '
5109 aborted' state, or (3) has been aborted by the system and placed
5110 in the 'pending-held' state, so that a user or operator can
5111 manually try the job again.
5112 'processing-to-stop-point': The requester has issued a Cancel-Job
5113 operation or the Printer object has aborted the job, but is
5114 still performing some actions on the job until a specified stop
5115 point occurs or job termination/cleanup is completed.
5116
5117 This reason is recommended to be used in conjunction with the '
5118 processing' job state to indicate that the Printer object is
5119 still performing some actions on the job while the job remains
5120 in the 'processing' state. After all the job's job description
5121 attributes have stopped incrementing, the Printer object moves
5122 the job from the 'processing' state to the 'canceled' or '
5123 aborted' job states.
5124
5125 'service-off-line': The Printer is off-line and accepting no jobs.
5126 All 'pending' jobs are put into the 'pending-held' state. This
5127 situation could be true if the service's or document transform's
5128 input is impaired or broken.
5129 'job-completed-successfully': The job completed successfully.
5130 'job-completed-with-warnings': The job completed with warnings.
5131 'job-completed-with-errors': The job completed with errors (and
5132 possibly warnings too).
5133
5134 <span class="h4"><a class="selflink" id="section-4.3.9" href="#section-4.3.9">4.3.9</a> job-state-message (text(MAX))</span>
5135
5136 This attribute specifies information about the "job-state" and "job-
5137 state-reasons" attributes in human readable text. If the Printer
5138 object supports this attribute, the Printer object MUST be able to
5139 generate this message in any of the natural languages identified by
5140 the Printer's "generated-natural-language-supported" attribute (see
5141 the "attributes-natural-language" operation attribute specified in
5142 <a href="#section-3.1.4.1">Section 3.1.4.1</a>).
5143
5144
5145
5146
5147
5148 <span class="grey">deBry, et al. Experimental [Page 92]</span></pre>
5149 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-93" ></span>
5150 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5151
5152
5153 Note: the value SHOULD NOT contain additional information not
5154 contained in the values of the "job-state" and "job-states-reasons"
5155 attributes, such as interpreter error information. Otherwise,
5156 application programs might attempt to parse the (localized text).
5157 For such additional information such as interpreter errors for
5158 application program consumption, a new attribute with keyword values,
5159 needs to be developed and registered.
5160
5161 <span class="h4"><a class="selflink" id="section-4.3.10" href="#section-4.3.10">4.3.10</a> number-of-documents (integer(0:MAX))</span>
5162
5163 This attribute indicates the number of documents in the job, i.e.,
5164 the number of Send-Document, Send-URI, Print-Job, or Print-URI
5165 operations that the Printer has accepted for this job, regardless of
5166 whether the document data has reached the Printer object or not.
5167
5168 Implementations supporting the OPTIONAL Create-Job/Send-
5169 Document/Send-URI operations SHOULD support this attribute so that
5170 clients can query the number of documents in each job.
5171
5172 <span class="h4"><a class="selflink" id="section-4.3.11" href="#section-4.3.11">4.3.11</a> output-device-assigned (name(127))</span>
5173
5174 This attribute identifies the output device to which the Printer
5175 object has assigned this job. If an output device implements an
5176 embedded Printer object, the Printer object NEED NOT set this
5177 attribute. If a print server implements a Printer object, the value
5178 MAY be empty (zero-length string) or not returned until the Printer
5179 object assigns an output device to the job. This attribute is
5180 particularly useful when a single Printer object support multiple
5181 devices (so called "fan-out").
5182
5183 <span class="h4"><a class="selflink" id="section-4.3.12" href="#section-4.3.12">4.3.12</a> time-at-creation (integer(0:MAX))</span>
5184
5185 This attribute indicates the point in time at which the Job object
5186 was created. In order to populate this attribute, the Printer object
5187 uses the value in its "printer-up-time" attribute at the time the Job
5188 object is created.
5189
5190 <span class="h4"><a class="selflink" id="section-4.3.13" href="#section-4.3.13">4.3.13</a> time-at-processing (integer(0:MAX))</span>
5191
5192 This attribute indicates the point in time at which the Job object
5193 began processing. In order to populate this attribute, the Printer
5194 object uses the value in its "printer-up-time" attribute at the time
5195 the Job object is moved into the 'processing' state for the first
5196 time.
5197
5198
5199
5200
5201
5202
5203
5204 <span class="grey">deBry, et al. Experimental [Page 93]</span></pre>
5205 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-94" ></span>
5206 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5207
5208
5209 <span class="h4"><a class="selflink" id="section-4.3.14" href="#section-4.3.14">4.3.14</a> time-at-completed (integer(0:MAX))</span>
5210
5211 This attribute indicates the point in time at which the Job object
5212 completed (or was cancelled or aborted). In order to populate this
5213 attribute, the Printer object uses the value in its "printer-up-time"
5214 attribute at the time the Job object is moved into the 'completed' or
5215 'canceled' or 'aborted' state.
5216
5217 <span class="h4"><a class="selflink" id="section-4.3.15" href="#section-4.3.15">4.3.15</a> number-of-intervening-jobs (integer(0:MAX))</span>
5218
5219 This attribute indicates the number of jobs that are "ahead" of this
5220 job in the relative chronological order of expected time to complete
5221 (i.e., the current scheduled order). For efficiency, it is only
5222 necessary to calculate this value when an operation is performed that
5223 requests this attribute.
5224
5225 <span class="h4"><a class="selflink" id="section-4.3.16" href="#section-4.3.16">4.3.16</a> job-message-from-operator (text(127))</span>
5226
5227 This attribute provides a message from an operator, system
5228 administrator or "intelligent" process to indicate to the end user
5229 the reasons for modification or other management action taken on a
5230 job.
5231
5232 <span class="h4"><a class="selflink" id="section-4.3.17" href="#section-4.3.17">4.3.17</a> job-k-octets (integer(0:MAX))</span>
5233
5234 This attribute specifies the total size of the document(s) in K
5235 octets, i.e., in units of 1024 octets requested to be processed in
5236 the job. The value MUST be rounded up, so that a job between 1 and
5237 1024 octets MUST be indicated as being 1, 1025 to 2048 MUST be 2,
5238 etc.
5239
5240 This value MUST NOT include the multiplicative factors contributed by
5241 the number of copies specified by the "copies" attribute, independent
5242 of whether the device can process multiple copies without making
5243 multiple passes over the job or document data and independent of
5244 whether the output is collated or not. Thus the value is independent
5245 of the implementation and indicates the size of the document(s)
5246 measured in K octets independent of the number of copies.
5247
5248 This value MUST also not include the multiplicative factor due to a
5249 copies instruction embedded in the document data. If the document
5250 data actually includes replications of the document data, this value
5251 will include such replication. In other words, this value is always
5252 the size of the source document data, rather than a measure of the
5253 hardcopy output to be produced.
5254
5255
5256
5257
5258
5259
5260 <span class="grey">deBry, et al. Experimental [Page 94]</span></pre>
5261 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-95" ></span>
5262 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5263
5264
5265 Note: This attribute and the following two attributes ("job-
5266 impressions" and "job-media-sheets") are not intended to be counters;
5267 they are intended to be useful routing and scheduling information if
5268 known. For these three attributes, the Printer object may try to
5269 compute the value if it is not supplied in the create request. Even
5270 if the client does supply a value for these three attributes in the
5271 create request, the Printer object MAY choose to change the value if
5272 the Printer object is able to compute a value which is more accurate
5273 than the client supplied value. The Printer object may be able to
5274 determine the correct value for these three attributes either right
5275 at job submission time or at any later point in time.
5276
5277 <span class="h4"><a class="selflink" id="section-4.3.18" href="#section-4.3.18">4.3.18</a> job-impressions (integer(0:MAX))</span>
5278
5279 This attribute specifies the total size in number of impressions of
5280 the document(s) being submitted (see the definition of impression in
5281 <a href="#section-13.2.5">section 13.2.5</a>).
5282
5283 As with "job-k-octets", this value MUST NOT include the
5284 multiplicative factors contributed by the number of copies specified
5285 by the "copies" attribute, independent of whether the device can
5286 process multiple copies without making multiple passes over the job
5287 or document data and independent of whether the output is collated or
5288 not. Thus the value is independent of the implementation and
5289 reflects the size of the document(s) measured in impressions
5290 independent of the number of copies.
5291
5292 As with "job-k-octets", this value MUST also not include the
5293 multiplicative factor due to a copies instruction embedded in the
5294 document data. If the document data actually includes replications
5295 of the document data, this value will include such replication. In
5296 other words, this value is always the number of impressions in the
5297 source document data, rather than a measure of the number of
5298 impressions to be produced by the job.
5299
5300 See the Note in the "job-k-octets" attribute that also applies to
5301 this attribute.
5302
5303 <span class="h4"><a class="selflink" id="section-4.3.19" href="#section-4.3.19">4.3.19</a> job-media-sheets (integer(0:MAX))</span>
5304
5305 This attribute specifies the total number of media sheets to be
5306 produced for this job.
5307
5308 Unlike the "job-k-octets" and the "job-impressions" attributes, this
5309 value MUST include the multiplicative factors contributed by the
5310 number of copies specified by the "copies" attribute and a 'number of
5311 copies' instruction embedded in the document data, if any. This
5312 difference allows the system administrator to control the lower and
5313
5314
5315
5316 <span class="grey">deBry, et al. Experimental [Page 95]</span></pre>
5317 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-96" ></span>
5318 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5319
5320
5321 upper bounds of both (1) the size of the document(s) with "job-k-
5322 octets-supported" and "job-impressions-supported" and (2) the size of
5323 the job with "job-media-sheets-supported".
5324
5325 See the Note in the "job-k-octets" attribute that also applies to
5326 this attribute.
5327
5328 <span class="h4"><a class="selflink" id="section-4.3.20" href="#section-4.3.20">4.3.20</a> job-k-octets-processed (integer(0:MAX))</span>
5329
5330 This attribute specifies the total number of octets processed in K
5331 octets, i.e., in units of 1024 octets so far. The value MUST be
5332 rounded up, so that a job between 1 and 1024 octets inclusive MUST be
5333 indicated as being 1, 1025 to 2048 inclusive MUST be 2, etc.
5334
5335 For implementations where multiple copies are produced by the
5336 interpreter with only a single pass over the data, the final value
5337 MUST be equal to the value of the "job-k-octets" attribute. For
5338 implementations where multiple copies are produced by the interpreter
5339 by processing the data for each copy, the final value MUST be a
5340 multiple of the value of the "job-k-octets" attribute.
5341
5342 Note: This attribute and the following two attributes ("job-
5343 impressions-completed" and "job-sheets-completed") are intended to be
5344 counters. That is, the value for a job that has not started
5345 processing MUST be 0. When the job's "job-state" is 'processing' or
5346 'processing-stopped', this value is intended to contain the amount of
5347 the job that has been processed to the time at which the attributes
5348 are requested.
5349
5350 <span class="h4"><a class="selflink" id="section-4.3.21" href="#section-4.3.21">4.3.21</a> job-impressions-completed (integer(0:MAX))</span>
5351
5352 This job attribute specifies the number of impressions completed for
5353 the job so far. For printing devices, the impressions completed
5354 includes interpreting, marking, and stacking the output.
5355
5356 See the note in "job-k-octets-processed" which also applies to this
5357 attribute.
5358
5359 <span class="h4"><a class="selflink" id="section-4.3.22" href="#section-4.3.22">4.3.22</a> job-media-sheets-completed (integer(0:MAX))</span>
5360
5361 This job attribute specifies the media-sheets completed marking and
5362 stacking for the entire job so far whether those sheets have been
5363 processed on one side or on both.
5364
5365 See the note in "job-k-octets-processed" which also applies to this
5366 attribute.
5367
5368
5369
5370
5371
5372 <span class="grey">deBry, et al. Experimental [Page 96]</span></pre>
5373 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-97" ></span>
5374 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5375
5376
5377 <span class="h4"><a class="selflink" id="section-4.3.23" href="#section-4.3.23">4.3.23</a> attributes-charset (charset)</span>
5378
5379 This REQUIRED attribute is populated using the value in the client
5380 supplied "attributes-charset" attribute in the create request. It
5381 identifies the charset (coded character set and encoding method) used
5382 by any Job attributes with attribute syntax 'text' and 'name' that
5383 were supplied by the client in the create request. See <a href="#section-3.1.4">Section 3.1.4</a>
5384 for a complete description of the "attributes-charset" operation
5385 attribute.
5386
5387 This attribute does not indicate the charset in which the 'text' and
5388 'name' values are stored internally in the Job object. The internal
5389 charset is implementation-defined. The IPP object MUST convert from
5390 whatever the internal charset is to that being requested in an
5391 operation as specified in <a href="#section-3.1.4">Section 3.1.4</a>.
5392
5393 <span class="h4"><a class="selflink" id="section-4.3.24" href="#section-4.3.24">4.3.24</a> attributes-natural-language (naturalLanguage)</span>
5394
5395 This REQUIRED attribute is populated using the value in the client
5396 supplied "attributes-natural-language" attribute in the create
5397 request. It identifies the natural language used for any Job
5398 attributes with attribute syntax 'text' and 'name' that were supplied
5399 by the client in the create request. See <a href="#section-3.1.4">Section 3.1.4</a> for a
5400 complete description of the "attributes-natural-language" operation
5401 attribute. See Sections <a href="#section-4.1.1.2">4.1.1.2</a> and <a href="#section-4.1.2.2">4.1.2.2</a> for how a Natural
5402 Language Override may be supplied explicitly for each 'text' and '
5403 name' attribute value that differs from the value identified by the
5404 "attributes-natural-language" attribute.
5405
5406 <span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a> Printer Description Attributes</span>
5407
5408 These attributes form the attribute group called "printer-
5409 description". The following table summarizes these attributes, their
5410 syntax, and whether or not they are REQUIRED for a Printer object to
5411 support. If they are not indicated as REQUIRED, they are OPTIONAL.
5412 The maximum size in octets for 'text' and 'name' attributes is
5413 indicated in parenthesizes.
5414
5415 Note: How these attributes are set by an Administrator is outside the
5416 scope of this specification.
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428 <span class="grey">deBry, et al. Experimental [Page 97]</span></pre>
5429 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-98" ></span>
5430 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5431
5432
5433 +----------------------------+----------------------+----------------+
5434 | Attribute | Syntax | REQUIRED? |
5435 +----------------------------+----------------------+----------------+
5436 | printer-uri-supported | 1setOf uri | REQUIRED |
5437 +----------------------------+----------------------+----------------+
5438 | uri-security-supported | 1setOf type2 keyword | REQUIRED |
5439 +----------------------------+----------------------+----------------+
5440 | printer-name | name (127) | REQUIRED |
5441 +----------------------------+----------------------+----------------+
5442 | printer-location | text (127) | |
5443 +----------------------------+----------------------+----------------+
5444 | printer-info | text (127) | |
5445 +----------------------------+----------------------+----------------+
5446 | printer-more-info | uri | |
5447 +----------------------------+----------------------+----------------+
5448 | printer-driver-installer | uri | |
5449 +----------------------------+----------------------+----------------+
5450 | printer-make-and-model | text (127) | |
5451 +----------------------------+----------------------+----------------+
5452 | printer-more-info- | uri | |
5453 | manufacturer | | |
5454 +----------------------------+----------------------+----------------+
5455 | printer-state | type1 enum | REQUIRED |
5456 +----------------------------+----------------------+----------------+
5457 | printer-state-reasons | 1setOf type2 keyword | |
5458 +----------------------------+----------------------+----------------+
5459 | printer-state-message | text (MAX) | |
5460 +----------------------------+----------------------+----------------+
5461 | operations-supported | 1setOf type2 enum | REQUIRED |
5462 +----------------------------+----------------------+----------------+
5463 | charset-configured | charset | REQUIRED |
5464 +----------------------------+----------------------+----------------+
5465 | charset-supported | 1setOf charset | REQUIRED |
5466 +----------------------------+----------------------+----------------+
5467 | natural-language-configured| naturalLanguage | REQUIRED |
5468 +----------------------------+----------------------+----------------+
5469 | generated-natural-language-| 1setOf | REQUIRED |
5470 | supported | naturalLanguage | |
5471 +----------------------------+----------------------+----------------+
5472 | document-format-default | mimeMediaType | REQUIRED |
5473 +----------------------------+----------------------+----------------+
5474 | document-format- | 1setOf | REQUIRED |
5475 | supported | mimeMediaType | |
5476 +----------------------------+----------------------+----------------+
5477 | printer-is-accepting-jobs | boolean | REQUIRED |
5478 +----------------------------+----------------------+----------------+
5479 | queued-job-count | integer (0:MAX) | RECOMMENDED |
5480 +----------------------------+----------------------+----------------+
5481
5482
5483
5484 <span class="grey">deBry, et al. Experimental [Page 98]</span></pre>
5485 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-99" ></span>
5486 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5487
5488
5489 +----------------------------+----------------------+----------------+
5490 | Attribute | Syntax | REQUIRED? |
5491 +----------------------------+----------------------+----------------+
5492 | printer-message-from- | text (127) | |
5493 | operator | | |
5494 +----------------------------+----------------------+----------------+
5495 | color-supported | boolean | |
5496 +----------------------------+----------------------+----------------+
5497 | reference-uri-schemes- | 1setOf uriScheme | |
5498 | supported | | |
5499 +----------------------------+----------------------+----------------+
5500 | pdl-override-supported | type2 keyword | REQUIRED |
5501 +----------------------------+----------------------+----------------+
5502 | printer-up-time | integer (1:MAX) | REQUIRED |
5503 +----------------------------+----------------------+----------------+
5504 | printer-current-time | dateTime | |
5505 +----------------------------+----------------------+----------------+
5506 | multiple-operation-time-out| integer (1:MAX) | |
5507 +----------------------------+----------------------+----------------+
5508 | compression-supported | 1setOf type3 keyword | |
5509 +----------------------------+----------------------+----------------+
5510 | job-k-octets-supported | rangeOfInteger | |
5511 | | (0:MAX) | |
5512 +----------------------------+----------------------+----------------+
5513 | job-impressions-supported | rangeOfInteger | |
5514 | | (0:MAX) | |
5515 +----------------------------+----------------------+----------------+
5516 | job-media-sheets-supported | rangeOfInteger | |
5517 | | (0:MAX) | |
5518 +----------------------------+----------------------+----------------+
5519
5520 <span class="h4"><a class="selflink" id="section-4.4.1" href="#section-4.4.1">4.4.1</a> printer-uri-supported (1setOf uri)</span>
5521
5522 This REQUIRED Printer attribute contains at least one URI for the
5523 Printer object. It OPTIONALLY contains more than one URI for the
5524 Printer object. An administrator determines a Printer object's
5525 URI(s) and configures this attribute to contain those URIs by some
5526 means outside the scope of IPP/1.0. The precise format of this URI
5527 is implementation dependent and depends on the protocol. See the
5528 next section for a description "uri-security-supported" which is the
5529 REQUIRED companion attribute to this "printer-uri-supported"
5530 attribute. See <a href="#section-2.4">section 2.4</a> on Printer object identity and <a href="#section-8.2">section</a>
5531 <a href="#section-8.2">8.2</a> on security and URIs for more information.
5532
5533
5534
5535
5536
5537
5538
5539
5540 <span class="grey">deBry, et al. Experimental [Page 99]</span></pre>
5541 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-100" ></span>
5542 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5543
5544
5545 <span class="h4"><a class="selflink" id="section-4.4.2" href="#section-4.4.2">4.4.2</a> uri-security-supported (1setOf type2 keyword)</span>
5546
5547 This REQUIRED Printer attribute MUST have the same cardinality
5548 (contain the same number of values) as the "printer-uri-supported"
5549 attribute. This attribute identifies the security mechanisms used
5550 for each URI listed in the "printer-uri-supported" attribute. The "i
5551 th" value in "uri-security-supported" corresponds to the "i th" value
5552 in "printer-uri-supported" and it describes the security mechanisms
5553 used for accessing the Printer object via that URI. The following
5554 standard values are defined:
5555
5556 'none': There are no secure communication channel protocols in use
5557 for the given URI.
5558
5559 'ssl3': SSL3 [<a href="#ref-SSL" title="Version 3">SSL</a>] is the secure communications channel protocol in
5560 use for the given URI.
5561
5562 Consider the following example. For a single Printer object, an
5563 administrator configures the "printer-uri-supported" and "uri-
5564 security-supported" attributes as follows:
5565
5566 "printer-uri-supported": 'http://acme.com/open-use-printer', '
5567 <a href="http://acme">http://acme</a>.com/restricted-use-printer', '
5568 <a href="http://acme">http://acme</a>.com/private-printer'
5569 "uri-security-supported": 'none', 'none', 'ssl3'
5570
5571 In this case, one Printer object has three URIs.
5572
5573 - For the first URI, 'http://acme.com/open-use-printer', the value
5574 'none' in "uri-security-supported" indicates that there is no
5575 secure channel protocol configured to run under HTTP. The name
5576 implies that there is no Basic or Digest authentication being
5577 used, but it is up to the client to determine that while using
5578 HTTP underneath the IPP application protocol.
5579 - For the second URI, 'http://acme.com/restricted-use-printer', the
5580 value 'none' in "uri-security-supported" indicates that there is
5581 no secure channel protocol configured to run under HTTP. In
5582 this case, although the name does imply that there is some sort
5583 of Basic or Digest authentication being used within HTTP, it is
5584 up to the client to determine that while using HTTP and by
5585 processing any '401 Unauthorized' HTTP error messages.
5586 - For the third URI, 'http://acme.com/private-printer', the value '
5587 ssl3' in "uri-security-supported" indicates that SSL3 is being
5588 used to secure the channel. The client SHOULD be prepared to
5589 use SSL3 framing to negotiate an acceptable ciphersuite to use
5590 while communicating with the Printer object. In this case, the
5591 name implies the use of a secure communications channel, but the
5592 fact is made explicit by the presence of the 'ssl3' value in
5593
5594
5595
5596 <span class="grey">deBry, et al. Experimental [Page 100]</span></pre>
5597 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-101" ></span>
5598 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5599
5600
5601 "uri-security-supported". The client does not need to resort to
5602 understanding which security it must use by following naming
5603 conventions or by parsing the URI to determine which security
5604 mechanisms are implied.
5605
5606 It is expected that many IPP Printer objects will be configured to
5607 support only one channel (either configured to use SSL3 access or
5608 not), and will therefore only ever have one URI listed in the
5609 "printer-uri-supported" attribute. No matter the configuration of
5610 the Printer object (whether it has only one URI or more than one
5611 URI), a client MUST supply only one URI in the target "printer-uri"
5612 operation attribute.
5613
5614 <span class="h4"><a class="selflink" id="section-4.4.3" href="#section-4.4.3">4.4.3</a> printer-name (name(127))</span>
5615
5616 This REQUIRED Printer attribute contains the name of the Printer
5617 object. It is a name that is more end-user friendly than a URI. An
5618 administrator determines a printer's name and sets this attribute to
5619 that name. This name may be the last part of the printer's URI or it
5620 may be unrelated. In non-US-English locales, a name may contain
5621 characters that are not allowed in a URI.
5622
5623 <span class="h4"><a class="selflink" id="section-4.4.4" href="#section-4.4.4">4.4.4</a> printer-location (text(127))</span>
5624
5625 This Printer attribute identifies the location of the device. This
5626 could include things like: "in Room 123A, second floor of building
5627 XYZ".
5628
5629 <span class="h4"><a class="selflink" id="section-4.4.5" href="#section-4.4.5">4.4.5</a> printer-info (text(127))</span>
5630
5631 This Printer attribute identifies the descriptive information about
5632 this Printer object. This could include things like: "This printer
5633 can be used for printing color transparencies for HR presentations",
5634 or "Out of courtesy for others, please print only small (1-5 page)
5635 jobs at this printer", or even "This printer is going away on July 1,
5636 1997, please find a new printer".
5637
5638 <span class="h4"><a class="selflink" id="section-4.4.6" href="#section-4.4.6">4.4.6</a> printer-more-info (uri)</span>
5639
5640 This Printer attribute contains a URI used to obtain more information
5641 about this specific Printer object. For example, this could be an
5642 HTTP type URI referencing an HTML page accessible to a Web Browser.
5643 The information obtained from this URI is intended for end user
5644 consumption. Features outside the scope of IPP can be accessed from
5645 this URI. The information is intended to be specific to this printer
5646 instance and site specific services (e.g. job pricing, services
5647 offered, end user assistance). The device manufacturer may initially
5648 populate this attribute.
5649
5650
5651
5652 <span class="grey">deBry, et al. Experimental [Page 101]</span></pre>
5653 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-102" ></span>
5654 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5655
5656
5657 <span class="h4"><a class="selflink" id="section-4.4.7" href="#section-4.4.7">4.4.7</a> printer-driver-installer (uri)</span>
5658
5659 This Printer attribute contains a URI to use to locate the driver
5660 installer for this Printer object. This attribute is intended for
5661 consumption by automata. The mechanics of print driver installation
5662 is outside the scope of IPP. The device manufacturer may initially
5663 populate this attribute.
5664
5665 <span class="h4"><a class="selflink" id="section-4.4.8" href="#section-4.4.8">4.4.8</a> printer-make-and-model (text(127))</span>
5666
5667 This Printer attribute identifies the make and model of the device.
5668 The device manufacturer may initially populate this attribute.
5669
5670 <span class="h4"><a class="selflink" id="section-4.4.9" href="#section-4.4.9">4.4.9</a> printer-more-info-manufacturer (uri)</span>
5671
5672 This Printer attribute contains a URI used to obtain more information
5673 about this type of device. The information obtained from this URI is
5674 intended for end user consumption. Features outside the scope of IPP
5675 can be accessed from this URI (e.g., latest firmware, upgrades, print
5676 drivers, optional features available, details on color support). The
5677 information is intended to be germane to this printer without regard
5678 to site specific modifications or services. The device manufacturer
5679 may initially populate this attribute.
5680
5681 <span class="h4"><a class="selflink" id="section-4.4.10" href="#section-4.4.10">4.4.10</a> printer-state (type1 enum)</span>
5682
5683 This REQUIRED Printer attribute identifies the current state of the
5684 device. The "printer-state reasons" attribute augments the
5685 "printer-state" attribute to give more detailed information about the
5686 Printer in the given printer state.
5687
5688 A Printer object need only update this attribute before responding to
5689 an operation which requests the attribute; the Printer object NEED
5690 NOT update this attribute continually, since asynchronous event
5691 notification is not part of IPP/1.0. A Printer NEED NOT implement
5692 all values if they are not applicable to a given implementation.
5693
5694 The following standard enum values are defined:
5695
5696 Value Symbolic Name and Description
5697
5698 '3' 'idle': If a Printer receives a job (whose required
5699 resources are ready) while in this state, such a job
5700 MUST transit into the 'processing' state immediately.
5701 If the "printer-state-reasons" attribute contains any
5702 reasons, they MUST be reasons that would not prevent a
5703 job from transiting into the 'processing' state
5704 immediately, e.g., 'toner-low'. Note: if a Printer
5705
5706
5707
5708 <span class="grey">deBry, et al. Experimental [Page 102]</span></pre>
5709 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-103" ></span>
5710 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5711
5712
5713 controls more than one output device, the above
5714 definition implies that a Printer is 'idle' if at
5715 least one output device is idle.
5716
5717 '4' 'processing': If a Printer receives a job (whose required
5718 resources are ready) while in this state, such a job
5719 MUST transit into the 'pending' state immediately.
5720 Such a job MUST transit into the 'processing' state
5721 only after jobs ahead of it complete. If the
5722 "printer-state-reasons" attribute contains any
5723 reasons, they MUST be reasons that do not prevent the
5724 current job from printing, e.g. 'toner-low'. Note:
5725 if a Printer controls more than one output device, the
5726 above definition implies that a Printer is '
5727 processing' if at least one output device is
5728 processing, and none is idle.
5729
5730 '5' 'stopped': If a Printer receives a job (whose required
5731 resources are ready) while in this state, such a job
5732 MUST transit into the 'pending' state immediately.
5733 Such a job MUST transit into the 'processing' state
5734 only after some human fixes the problem that stopped
5735 the printer and after jobs ahead of it complete
5736 processing. If supported, the "printer-state-reasons"
5737 attribute MUST contain at least one reason, e.g. '
5738 media-jam', which prevents it from either processing
5739 the current job or transitioning a 'pending' job to
5740 the 'processing' state.
5741
5742 Note: if a Printer controls more than one output
5743 device, the above definition implies that a Printer is
5744 'stopped' only if all output devices are stopped.
5745 Also, it is tempting to define 'stopped' as when a
5746 sufficient number of output devices are stopped and
5747 leave it to an implementation to define the sufficient
5748 number. But such a rule complicates the definition of
5749 'stopped' and 'processing'. For example, with this
5750 alternate definition of 'stopped', a job can move from
5751 'pending' to 'processing' without human intervention,
5752 even though the Printer is stopped.
5753
5754 <span class="h4"><a class="selflink" id="section-4.4.11" href="#section-4.4.11">4.4.11</a> printer-state-reasons (1setOf type2 keyword)</span>
5755
5756 This Printer attribute supplies additional detail about the device's
5757 state.
5758
5759
5760
5761
5762
5763
5764 <span class="grey">deBry, et al. Experimental [Page 103]</span></pre>
5765 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-104" ></span>
5766 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5767
5768
5769 Each keyword value MAY have a suffix to indicate its level of
5770 severity. The three levels are: report (least severe), warning, and
5771 error (most severe).
5772
5773 - '-report': This suffix indicates that the reason is a "report".
5774 An implementation may choose to omit some or all reports. Some
5775 reports specify finer granularity about the printer state;
5776 others serve as a precursor to a warning. A report MUST contain
5777 nothing that could affect the printed output.
5778 - '-warning': This suffix indicates that the reason is a "warning".
5779 An implementation may choose to omit some or all warnings.
5780 Warnings serve as a precursor to an error. A warning MUST
5781 contain nothing that prevents a job from completing, though in
5782 some cases the output may be of lower quality.
5783 - '-error': This suffix indicates that the reason is an "error".
5784 An implementation MUST include all errors. If this attribute
5785 contains one or more errors, printer MUST be in the stopped
5786 state.
5787
5788 If the implementation does not add any one of the three suffixes, all
5789 parties MUST assume that the reason is an "error".
5790
5791 If a Printer object controls more than one output device, each value
5792 of this attribute MAY apply to one or more of the output devices. An
5793 error on one output device that does not stop the Printer object as a
5794 whole MAY appear as a warning in the Printer's "printer-state-reasons
5795 attribute". If the "printer-state" for such a Printer has a value of
5796 'stopped', then there MUST be an error reason among the values in the
5797 "printer-state-reasons" attribute.
5798
5799 The following standard keyword values are defined:
5800
5801 'other': The device has detected an error other than one listed in
5802 this document.
5803 'none': There are not reasons. This state reason is semantically
5804 equivalent to "printer-state-reasons" without any value.
5805 'media-needed': A tray has run out of media.
5806 'media-jam': The device has a media jam.
5807 'paused': Someone has paused the Printer object. In this state, a
5808 Printer MUST NOT produce printed output, but it MUST perform
5809 other operations requested by a client. If a Printer had been
5810 printing a job when the Printer was paused, the Printer MUST
5811 resume printing that job when the Printer is no longer paused
5812 and leave no evidence in the printed output of such a pause.
5813 'shutdown': Someone has removed a Printer object from service, and
5814 the device may be powered down or physically removed. In this
5815 state, a Printer object MUST NOT produce printed output, and
5816 unless the Printer object is realized by a print server that is
5817
5818
5819
5820 <span class="grey">deBry, et al. Experimental [Page 104]</span></pre>
5821 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-105" ></span>
5822 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5823
5824
5825 still active, the Printer object MUST perform no other
5826 operations requested by a client, including returning this
5827 value. If a Printer object had been printing a job when it was
5828 shutdown, the Printer NEED NOT resume printing that job when the
5829 Printer is no longer shutdown. If the Printer resumes printing
5830 such a job, it may leave evidence in the printed output of such
5831 a shutdown, e.g. the part printed before the shutdown may be
5832 printed a second time after the shutdown.
5833 'connecting-to-device': The Printer object has scheduled a job on
5834 the output device and is in the process of connecting to a
5835 shared network output device (and might not be able to actually
5836 start printing the job for an arbitrarily long time depending on
5837 the usage of the output device by other servers on the network).
5838 'timed-out': The server was able to connect to the output device
5839 (or is always connected), but was unable to get a response from
5840 the output device.
5841 'stopping': The Printer object is in the process of stopping the
5842 device and will be stopped in a while. When the device is
5843 stopped, the Printer object will change the Printer object's
5844 state to 'stopped'. The 'stopping-warning' reason is never an
5845 error, even for a Printer with a single output device. When an
5846 output-device ceases accepting jobs, the Printer will have this
5847 reason while the output device completes printing.
5848 'stopped-partly': When a Printer object controls more than one
5849 output device, this reason indicates that one or more output
5850 devices are stopped. If the reason is a report, fewer than half
5851 of the output devices are stopped. If the reason is a warning,
5852 fewer than all of the output devices are stopped.
5853 'toner-low': The device is low on toner.
5854 'toner-empty': The device is out of toner.
5855 'spool-area-full': The limit of persistent storage allocated for
5856 spooling has been reached.
5857 'cover-open': One or more covers on the device are open.
5858 'interlock-open': One or more interlock devices on the printer are
5859 unlocked.
5860 'door-open': One or more doors on the device are open.
5861 'input-tray-missing': One or more input trays are not in the
5862 device.
5863 'media-low': At least one input tray is low on media.
5864 'media-empty': At least one input tray is empty.
5865 'output-tray-missing': One or more output trays are not in the
5866 device
5867 'output-area-almost-full': One or more output area is almost full
5868 (e.g. tray, stacker, collator).
5869 'output-area-full': One or more output area is full. (e.g. tray,
5870 stacker, collator)
5871 'marker-supply-low': The device is low on at least one marker
5872 supply. (e.g. toner, ink, ribbon)
5873
5874
5875
5876 <span class="grey">deBry, et al. Experimental [Page 105]</span></pre>
5877 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-106" ></span>
5878 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5879
5880
5881 'marker-supply-empty: The device is out of at least one marker
5882 supply. (e.g. toner, ink, ribbon)
5883 'marker-waste-almost-full': The device marker supply waste
5884 receptacle is almost full.
5885 'marker-waste-full': The device marker supply waste receptacle is
5886 full.
5887 'fuser-over-temp': The fuser temperature is above normal.
5888 'fuser-under-temp': The fuser temperature is below normal.
5889 'opc-near-eol': The optical photo conductor is near end of life.
5890 'opc-life-over': The optical photo conductor is no longer
5891 functioning.
5892 'developer-low': The device is low on developer.
5893 'developer-empty: The device is out of developer.
5894 'interpreter-resource-unavailable': An interpreter resource is
5895 unavailable (i.e. font, form)
5896
5897 <span class="h4"><a class="selflink" id="section-4.4.12" href="#section-4.4.12">4.4.12</a> printer-state-message (text(MAX))</span>
5898
5899 This Printer attribute specifies the additional information about the
5900 printer state and printer state reasons in human readable text. If
5901 the Printer object supports this attribute, the Printer object MUST
5902 be able to generate this message in any of the natural languages
5903 identified by the Printer's "generated-natural-language-supported"
5904 attribute (see the "attributes-natural-language" operation attribute
5905 specified in <a href="#section-3.1.4.1">Section 3.1.4.1</a>).
5906
5907 <span class="h4"><a class="selflink" id="section-4.4.13" href="#section-4.4.13">4.4.13</a> operations-supported (1setOf type2 enum)</span>
5908
5909 This REQUIRED Printer attribute specifies the set of supported
5910 operations for this Printer object and contained Job objects. All
5911 32-bit enum values for this attribute MUST NOT exceed 0x8FFF, since
5912 these values are passed in two octets in each Protocol request
5913 [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>].
5914
5915 The following standard enum and "operation-id" (see <a href="#section-3.1.2">section 3.1.2</a>)
5916 values are defined:
5917
5918 Value Operation Name
5919 ----------------- -------------------------------------
5920
5921 0x0000 reserved, not used
5922 0x0001 reserved, not used
5923 0x0002 Print-Job
5924 0x0003 Print-URI
5925 0x0004 Validate-Job
5926 0x0005 Create-Job
5927 0x0006 Send-Document
5928 0x0007 Send-URI
5929
5930
5931
5932 <span class="grey">deBry, et al. Experimental [Page 106]</span></pre>
5933 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-107" ></span>
5934 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5935
5936
5937 0x0008 Cancel-Job
5938 0x0009 Get-Job-Attributes
5939 0x000A Get-Jobs
5940 0x000B Get-Printer-Attributes
5941 0x000C-0x3FFF reserved for future operations
5942 0x4000-0x8FFF reserved for private extensions
5943
5944 This allows for certain vendors to implement private extensions that
5945 are guaranteed to not conflict with future registered extensions.
5946 However, there is no guarantee that two or more private extensions
5947 will not conflict.
5948
5949 <span class="h4"><a class="selflink" id="section-4.4.14" href="#section-4.4.14">4.4.14</a> charset-configured (charset)</span>
5950
5951 This REQUIRED Printer attribute identifies the charset that the
5952 Printer object has been configured to represent 'text' and 'name'
5953 Printer attributes that are set by the operator, system
5954 administrator, or manufacturer, i.e., for "printer-name" (name),
5955 "printer-location" (text), "printer-info" (text), and "printer-make-
5956 and-model" (text). Therefore, the value of the Printer object's
5957 "charset-configured" attribute MUST also be among the values of the
5958 Printer object's "charset-supported" attribute.
5959
5960 <span class="h4"><a class="selflink" id="section-4.4.15" href="#section-4.4.15">4.4.15</a> charset-supported (1setOf charset)</span>
5961
5962 This REQUIRED Printer attribute identifies the set of charsets that
5963 the Printer and contained Job objects support in attributes with
5964 attribute syntax 'text' and 'name'. At least the value 'utf-8' MUST
5965 be present, since IPP objects MUST support the UTF-8 [<a href="./rfc2279" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC2279</a>]
5966 charset. If a Printer object supports a charset, it means that for
5967 all attributes of syntax 'text' and 'name' the IPP object MUST (1)
5968 accept the charset in requests and return the charset in responses as
5969 needed.
5970
5971 If more charsets than UTF-8 are supported, the IPP object MUST
5972 perform charset conversion between the charsets as described in
5973 <a href="#section-3.2.1.2">Section 3.2.1.2</a>.
5974
5975 <span class="h4"><a class="selflink" id="section-4.4.16" href="#section-4.4.16">4.4.16</a> natural-language-configured (naturalLanguage)</span>
5976
5977 This REQUIRED Printer attribute identifies the natural language that
5978 the Printer object has been configured to represent 'text' and 'name'
5979 Printer attributes that are set by the operator, system
5980 administrator, or manufacturer, i.e., for "printer-name" (name),
5981 "printer-location" (text), "printer-info" (text), and "printer-make-
5982 and-model" (text). When returning these Printer attributes, the
5983 Printer object MAY return them in the configured natural language
5984 specified by this attribute, instead of the natural language
5985
5986
5987
5988 <span class="grey">deBry, et al. Experimental [Page 107]</span></pre>
5989 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-108" ></span>
5990 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
5991
5992
5993 requested by the client in the "attributes-natural-language"
5994 operation attribute. See <a href="#section-3.1.4.1">Section 3.1.4.1</a> for the specification of
5995 the OPTIONAL multiple natural language support. Therefore, the value
5996 of the Printer object's "natural-language-configured" attribute MUST
5997 also be among the values of the Printer object's "generated-natural-
5998 language-supported" attribute.
5999
6000 <span class="h4"><a class="selflink" id="section-4.4.17" href="#section-4.4.17">4.4.17</a> generated-natural-language-supported (1setOf naturalLanguage)</span>
6001
6002 This REQUIRED Printer attribute identifies the natural language(s)
6003 that the Printer object and contained Job objects support in
6004 attributes with attribute syntax 'text' and 'name'. The natural
6005 language(s) supported depends on implementation and/or configuration.
6006 Unlike charsets, IPP objects MUST accept requests with any natural
6007 language or any Natural Language Override whether the natural
6008 language is supported or not.
6009
6010 If a Printer object supports a natural language, it means that for
6011 any of the attributes for which the Printer or Job object generates
6012 messages, i.e., for the "job-state-message" and "printer-state-
6013 message" attributes and Operation Messages (see <a href="#section-3.1.5">Section 3.1.5</a>) in
6014 operation responses, the Printer and Job objects MUST be able to
6015 generate messages in any of the Printer's supported natural
6016 languages. See <a href="#section-3.1.4">section 3.1.4</a> for the specification of 'text' and '
6017 name' attributes in operation requests and responses.
6018
6019 Note: A Printer object that supports multiple natural languages,
6020 often has separate catalogs of messages, one for each natural
6021 language supported.
6022
6023 <span class="h4"><a class="selflink" id="section-4.4.18" href="#section-4.4.18">4.4.18</a> document-format-default (mimeMediaType)</span>
6024
6025 This REQUIRED Printer attribute identifies the document format that
6026 the Printer object has been configured to assume if the client does
6027 not supply a "document-format" operation attribute in any of the
6028 operation requests that supply document data. The standard values
6029 for this attribute are Internet Media types (sometimes called MIME
6030 types). For further details see the description of the '
6031 mimeMediaType' attribute syntax in <a href="#section-4.1.9">Section 4.1.9</a>.
6032
6033 <span class="h4"><a class="selflink" id="section-4.4.19" href="#section-4.4.19">4.4.19</a> document-format-supported (1setOf mimeMediaType)</span>
6034
6035 This REQUIRED Printer attribute identifies the set of document
6036 formats that the Printer object and contained Job objects can
6037 support. For further details see the description of the '
6038 mimeMediaType' attribute syntax in <a href="#section-4.1.9">Section 4.1.9</a>.
6039
6040 <span class="h4"><a class="selflink" id="section-4.4.20" href="#section-4.4.20">4.4.20</a> printer-is-accepting-jobs (boolean)</span>
6041
6042
6043
6044 <span class="grey">deBry, et al. Experimental [Page 108]</span></pre>
6045 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-109" ></span>
6046 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6047
6048
6049 This REQUIRED Printer attribute indicates whether the printer is
6050 currently able to accept jobs, i.e., is accepting Print-Job, Print-
6051 URI, and Create-Job requests. If the value is 'true', the printer is
6052 accepting jobs. If the value is 'false', the Printer object is
6053 currently rejecting any jobs submitted to it. In this case, the
6054 Printer object returns the 'server-error-not-accepting-jobs' status
6055 code.
6056
6057 Note: This value is independent of the "printer-state" and "printer-
6058 state-reasons" attributes because its value does not affect the
6059 current job; rather it affects future jobs. This attribute may cause
6060 the Printer to reject jobs when the "printer-state" is 'idle' or it
6061 may cause the Printer object to accepts jobs when the "printer-state"
6062 is 'stopped'.
6063
6064 <span class="h4"><a class="selflink" id="section-4.4.21" href="#section-4.4.21">4.4.21</a> queued-job-count (integer(0:MAX))</span>
6065
6066 This RECOMMENDED Printer attribute contains a count of the number of
6067 jobs that are either 'pending', 'processing', 'pending-held', or '
6068 processing-stopped' and is set by the Printer object.
6069
6070 <span class="h4"><a class="selflink" id="section-4.4.22" href="#section-4.4.22">4.4.22</a> printer-message-from-operator (text(127))</span>
6071
6072 This Printer attribute provides a message from an operator, system
6073 administrator or "intelligent" process to indicate to the end user
6074 information or status of the printer, such as why it is unavailable
6075 or when it is expected to be available.
6076
6077 <span class="h4"><a class="selflink" id="section-4.4.23" href="#section-4.4.23">4.4.23</a> color-supported (boolean)</span>
6078
6079 This Printer attribute identifies whether the device is capable of
6080 any type of color printing at all, including highlight color. All
6081 document instructions having to do with color are embedded within the
6082 document PDL (none are external IPP attributes in IPP/1.0).
6083
6084 Note: end-users are able to determine the nature and details of the
6085 color support by querying the "printer-more-info-manufacturer"
6086 Printer attribute.
6087
6088 <span class="h4"><a class="selflink" id="section-4.4.24" href="#section-4.4.24">4.4.24</a> reference-uri-schemes-supported (1setOf uriScheme)</span>
6089
6090 This Printer attribute specifies which URI schemes are supported for
6091 use in the "document-uri" operation attribute of the Print-URI or
6092 Send-URI operation. If a Printer object supports these optional
6093 operations, it MUST support the "reference-uri-schemes-supported"
6094 Printer attribute with at least the following schemed URI value:
6095
6096 'ftp': The Printer object will use an FTP 'get' operation as
6097
6098
6099
6100 <span class="grey">deBry, et al. Experimental [Page 109]</span></pre>
6101 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-110" ></span>
6102 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6103
6104
6105 defined in <a href="./rfc2228">RFC 2228</a> [<a href="./rfc2228" title="&quot;FTP Security Extensions&quot;">RFC2228</a>] using FTP URLs as defined by
6106 [<a href="./rfc2396" title="&quot;Uniform Resource Identifiers (URI): Generic Syntax&quot;">RFC2396</a>] and[RFC2316].
6107
6108 The Printer object MAY OPTIONALLY support other URI schemes (see
6109 <a href="#section-4.1.6">section 4.1.6</a>).
6110
6111 <span class="h4"><a class="selflink" id="section-4.4.25" href="#section-4.4.25">4.4.25</a> pdl-override-supported (type2 keyword)</span>
6112
6113 This REQUIRED Printer attribute expresses the ability for a
6114 particular Printer implementation to either attempt to override
6115 document data instructions with IPP attributes or not.
6116
6117 This attribute takes on the following values:
6118
6119 - 'attempted': This value indicates that the Printer object
6120 attempts to make the IPP attribute values take precedence over
6121 embedded instructions in the document data, however there is no
6122 guarantee.
6123
6124 - 'not-attempted': This value indicates that the Printer object
6125 makes no attempt to make the IPP attribute values take precedence
6126 over embedded instructions in the document data.
6127
6128 <a href="#section-15">Section 15</a> contains a full description of how this attribute
6129 interacts with and affects other IPP attributes, especially the
6130 "ipp-attribute-fidelity" attribute.
6131
6132 <span class="h4"><a class="selflink" id="section-4.4.26" href="#section-4.4.26">4.4.26</a> printer-up-time (integer(1:MAX))</span>
6133
6134 This REQUIRED Printer attribute indicates the amount of time (in
6135 seconds) that this instance of this Printer implementation has been
6136 up and running. This value is used to populate the Job attributes
6137 "time-at-creation", "time-at-processing", and "time-at-completed".
6138 These time values are all measured in seconds and all have meaning
6139 only relative to this attribute, "printer-up-time". The value is a
6140 monotonically increasing value starting from 1 when the Printer
6141 object is started-up (initialized, booted, etc.).
6142
6143 If the Printer object goes down at some value 'n', and comes back up,
6144 the implementation MAY:
6145
6146 1. Know how long it has been down, and resume at some value greater
6147 than 'n', or
6148 2. Restart from 1.
6149
6150 In the first case, the Printer SHOULD not tweak any existing related
6151 Job attributes ("time-at-creation", "time-at-processing", and "time-
6152 at-completed"). In the second case, the Printer object SHOULD reset
6153
6154
6155
6156 <span class="grey">deBry, et al. Experimental [Page 110]</span></pre>
6157 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-111" ></span>
6158 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6159
6160
6161 those attributes to 0. If a client queries a time-related Job
6162 attribute and finds the value to be 0, the client MUST assume that
6163 the Job was submitted in some life other than the Printer's current
6164 life.
6165
6166 <span class="h4"><a class="selflink" id="section-4.4.27" href="#section-4.4.27">4.4.27</a> printer-current-time (dateTime)</span>
6167
6168 This Printer attribute indicates the current absolute wall-clock
6169 time. If an implementation supports this attribute, then a client
6170 could calculate the absolute wall-clock time each Job's "time-at-
6171 creation", "time-at-processing", and "time-at-completed" attributes
6172 by using both "printer-up-time" and this attribute, "printer-
6173 current-time". If an implementation does not support this attribute,
6174 a client can only calculate the relative time of certain events based
6175 on the REQUIRED "printer-up-time" attribute.
6176
6177 <span class="h4"><a class="selflink" id="section-4.4.28" href="#section-4.4.28">4.4.28</a> multiple-operation-time-out (integer(1:MAX))</span>
6178
6179 This Printer attributes identifies the minimum time (in seconds) that
6180 the Printer object waits for additional Send-Document or Send-URI
6181 operations to follow a still-open multi-document Job object before
6182 taking any recovery actions, such as the ones indicated in <a href="#section-3.3.1">section</a>
6183 <a href="#section-3.3.1">3.3.1</a>.
6184
6185 It is RECOMMENDED that vendors supply a value for this attribute that
6186 is between 60 and 240 seconds. An implementation MAY allow a system
6187 administrator to set this attribute. If so, the system administrator
6188 MAY be able to set values outside this range.
6189
6190 <span class="h4"><a class="selflink" id="section-4.4.29" href="#section-4.4.29">4.4.29</a> compression-supported (1setOf type3 keyword)</span>
6191
6192 This Printer attribute identifies the set of supported compression
6193 algorithms for document data. Compression only applies to the
6194 document data; compression does not apply to the encoding of the IPP
6195 operation itself. The supported values are used to validate the
6196 client supplied "compression" operation attributes in Print-Job,
6197 Send-Document, and Send-URI requests.
6198
6199 Standard values are :
6200
6201 'none': no compression is used.
6202 'deflate': ZIP public domain inflate/deflate) compression
6203 technology
6204 'gzip' GNU zip compression technology described in <a href="./rfc1952">RFC 1952</a>
6205 [<a href="./rfc1952" title="&quot;GZIP file format specification version 4.3&quot;">RFC1952</a>].
6206 'compress': UNIX compression technology
6207
6208 <span class="h4"><a class="selflink" id="section-4.4.30" href="#section-4.4.30">4.4.30</a> job-k-octets-supported (rangeOfInteger(0:MAX))</span>
6209
6210
6211
6212 <span class="grey">deBry, et al. Experimental [Page 111]</span></pre>
6213 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-112" ></span>
6214 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6215
6216
6217 This Printer attribute specifies the upper and lower bounds of total
6218 sizes of jobs in K octets, i.e., in units of 1024 octets. The
6219 supported values are used to validate the client supplied "job-k-
6220 octets" operation attributes in create requests. The corresponding
6221 job description attribute "job-k-octets" is defined in <a href="#section-4.3.17">section</a>
6222 <a href="#section-4.3.17">4.3.17</a>.
6223
6224 4.4.31 job-impressions-supported (rangeOfInteger(0:MAX))
6225
6226 This Printer attribute specifies the upper and lower bounds for the
6227 number of impressions per job. The supported values are used to
6228 validate the client supplied "job-impressions" operation attributes
6229 in create requests. The corresponding job description attribute
6230 "job-impressions" is defined in <a href="#section-4.3.18">section 4.3.18</a>.
6231
6232 <span class="h4"><a class="selflink" id="section-4.4.32" href="#section-4.4.32">4.4.32</a> job-media-sheets-supported (rangeOfInteger(0:MAX))</span>
6233
6234 This Printer attribute specifies the upper and lower bounds for the
6235 number of media sheets per job. The supported values are used to
6236 validate the client supplied "job-media-sheets" operation attributes
6237 in create requests. The corresponding Job attribute "job-media-
6238 sheets" is defined in <a href="#section-4.3.19">section 4.3.19</a>.
6239
6240 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Conformance</span>
6241
6242 This section describes conformance issues and requirements. This
6243 document introduces model entities such as objects, operations,
6244 attributes, attribute syntaxes, and attribute values. These
6245 conformance sections describe the conformance requirements which
6246 apply to these model entities.
6247
6248 <span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a> Client Conformance Requirements</span>
6249
6250 A conforming client MUST support all REQUIRED operations as defined
6251 in this document. For each attribute included in an operation
6252 request, a conforming client MUST supply a value whose type and value
6253 syntax conforms to the requirements of the Model document as
6254 specified in Sections <a href="#section-3">3</a> and <a href="#section-4">4</a>. A conforming client MAY supply any
6255 registered extensions and/or private extensions in an operation
6256 request, as long as they meet the requirements in <a href="#section-6">Section 6</a>.
6257
6258 Otherwise, there are no conformance requirements placed on the user
6259 interfaces provided by IPP clients or their applications. For
6260 example, one application might not allow an end user to submit
6261 multiple documents per job, while another does. One application
6262 might first query a Printer object in order to supply a graphical
6263 user interface (GUI) dialogue box with supported and default values
6264 whereas a different implementation might not.
6265
6266
6267
6268 <span class="grey">deBry, et al. Experimental [Page 112]</span></pre>
6269 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-113" ></span>
6270 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6271
6272
6273 When sending a request, an IPP client NEED NOT supply any attributes
6274 that are indicated as OPTIONALLY supplied by the client.
6275
6276 A client MUST be able to accept any of the attribute syntaxes defined
6277 in <a href="#section-4.1">Section 4.1</a>, including their full range, that may be returned to
6278 it in a response from a Printer object. In particular for each
6279 attribute that the client supports whose attribute syntax is 'text',
6280 the client MUST accept and process both the 'textWithoutLanguage' and
6281 'textWithLanguage' forms. Similarly, for each attribute that the
6282 client supports whose attribute syntax is 'name', the client MUST
6283 accept and process both the 'nameWithoutLanguage' and '
6284 nameWithLanguage' forms. For presentation purposes, truncation of
6285 long attribute values is not recommended. A recommended approach
6286 would be for the client implementation to allow the user to scroll
6287 through long attribute values.
6288
6289 A query response may contain attribute groups, attributes, and values
6290 that the client does not expect. Therefore, a client implementation
6291 MUST gracefully handle such responses and not refuse to inter-operate
6292 with a conforming Printer that is returning extended registered or
6293 private attributes and/or attribute values that conform to <a href="#section-6">Section 6</a>.
6294 Clients may choose to ignore any parameters, attributes, or values
6295 that they do not understand.
6296
6297 <span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a> IPP Object Conformance Requirements</span>
6298
6299 This section specifies the conformance requirements for conforming
6300 implementations with respect to objects, operations, and attributes.
6301
6302 <span class="h4"><a class="selflink" id="section-5.2.1" href="#section-5.2.1">5.2.1</a> Objects</span>
6303
6304 Conforming implementations MUST implement all of the model objects as
6305 defined in this specification in the indicated sections:
6306
6307 <a href="#section-2.1">Section 2.1</a> - Printer Object
6308 <a href="#section-2.2">Section 2.2</a> - Job Object
6309
6310 <span class="h4"><a class="selflink" id="section-5.2.2" href="#section-5.2.2">5.2.2</a> Operations</span>
6311
6312 Conforming IPP object implementations MUST implement all of the
6313 REQUIRED model operations, including REQUIRED responses, as defined
6314 in this specification in the indicated sections:
6315
6316 For a Printer object:
6317 Print-Job (<a href="#section-3.2.1">section 3.2.1</a>) REQUIRED
6318 Print-URI (<a href="#section-3.2.2">section 3.2.2</a>) OPTIONAL
6319 Validate-Job (<a href="#section-3.2.3">section 3.2.3</a>) REQUIRED
6320 Create-Job (<a href="#section-3.2.4">section 3.2.4</a>) OPTIONAL
6321
6322
6323
6324 <span class="grey">deBry, et al. Experimental [Page 113]</span></pre>
6325 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-114" ></span>
6326 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6327
6328
6329 Get-Printer-Attributes (<a href="#section-3.2.5">section 3.2.5</a>) REQUIRED
6330 Get-Jobs (<a href="#section-3.2.6">section 3.2.6</a>) REQUIRED
6331
6332 For a Job object:
6333 Send-Document (<a href="#section-3.3.1">section 3.3.1</a>) OPTIONAL
6334 Send-URI (<a href="#section-3.3.2">section 3.3.2</a>) OPTIONAL
6335 Cancel-Job (<a href="#section-3.3.3">section 3.3.3</a>) REQUIRED
6336 Get-Job-Attributes (<a href="#section-3.3.4">section 3.3.4</a>) REQUIRED
6337
6338 Conforming IPP objects MUST support all REQUIRED operation attributes
6339 and all values of such attributes if so indicated in the description.
6340 Conforming IPP objects MUST ignore all unsupported or unknown
6341 operation attributes or operation attribute groups received in a
6342 request, but MUST reject a request that contains a supported
6343 operation attribute that contains an unsupported value.
6344
6345 The following section on object attributes specifies the support
6346 required for object attributes.
6347
6348 <span class="h4"><a class="selflink" id="section-5.2.3" href="#section-5.2.3">5.2.3</a> IPP Object Attributes</span>
6349
6350 Conforming IPP objects MUST support all of the REQUIRED object
6351 attributes, as defined in this specification in the indicated
6352 sections.
6353
6354 If an object supports an attribute, it MUST support only those values
6355 specified in this document or through the extension mechanism
6356 described in <a href="#section-5.2.4">section 5.2.4</a>. It MAY support any non-empty subset of
6357 these values. That is, it MUST support at least one of the specified
6358 values and at most all of them.
6359
6360 <span class="h4"><a class="selflink" id="section-5.2.4" href="#section-5.2.4">5.2.4</a> Extensions</span>
6361
6362 A conforming IPP object MAY support registered extensions and private
6363 extensions, as long as they meet the requirements specified in
6364 <a href="#section-6">Section 6</a>.
6365
6366 For each attribute included in an operation response, a conforming
6367 IPP object MUST return a value whose type and value syntax conforms
6368 to the requirement of the Model document as specified in Sections <a href="#section-3">3</a>
6369 and 4.
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380 <span class="grey">deBry, et al. Experimental [Page 114]</span></pre>
6381 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-115" ></span>
6382 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6383
6384
6385 <span class="h4"><a class="selflink" id="section-5.2.5" href="#section-5.2.5">5.2.5</a> Attribute Syntaxes</span>
6386
6387 An IPP object MUST be able to accept any of the attribute syntaxes
6388 defined in <a href="#section-4.1">Section 4.1</a>, including their full range, in any operation
6389 in which a client may supply attributes or the system administrator
6390 may configure attributes (by means outside the scope of IPP/1.0). In
6391 particular for each attribute that the IPP object supports whose
6392 attribute syntax is 'text', the IPP object MUST accept and process
6393 both the 'textWithoutLanguage' and 'textWithLanguage' forms.
6394 Similarly, for each attribute that the IPP object supports whose
6395 attribute syntax is 'name', the IPP object MUST accept and process
6396 both the 'nameWithoutLanguage' and 'nameWithLanguage' forms.
6397 Furthermore, an IPP object MUST return attributes to the client in
6398 operation responses that conform to the syntax specified in <a href="#section-4.1">Section</a>
6399 <a href="#section-4.1">4.1</a>, including their full range if supplied previously by a client.
6400
6401 <span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a> Charset and Natural Language Requirements</span>
6402
6403 All clients and IPP objects MUST support the 'utf-8' charset as
6404 defined in <a href="#section-4.1.7">section 4.1.7</a>.
6405
6406 IPP objects MUST be able to accept any client request which correctly
6407 uses the "attributes-natural-language" operation attribute or the
6408 Natural Language Override mechanism on any individual attribute
6409 whether or not the natural language is supported by the IPP object.
6410 If an IPP object supports a natural language, then it MUST be able to
6411 translate (perhaps by table lookup) all generated 'text' or 'name'
6412 attribute values into one of the supported languages (see <a href="#section-3.1.4">section</a>
6413 <a href="#section-3.1.4">3.1.4</a>). That is, the IPP object that supports a natural language
6414 NEED NOT be a general purpose translator of any arbitrary 'text' or '
6415 name' value supplied by the client into that natural language.
6416 However, the object MUST be able to translate (automatically
6417 generate) any of its own attribute values and messages into that
6418 natural language.
6419
6420 <span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a> Security Conformance Requirements</span>
6421
6422 Conforming IPP Printer objects MAY support Secure Socket Layer
6423 Version 3 (SSL3) [<a href="#ref-SSL" title="Version 3">SSL</a>] access, support access without SSL3 or support
6424 both means of access.
6425
6426 Conforming IPP clients SHOULD support SSL3 access and non-SSL3
6427 access. Note: This client requirement to support both means that
6428 conforming IPP clients will be able to inter-operate with any IPP
6429 Printer object.
6430
6431
6432
6433
6434
6435
6436 <span class="grey">deBry, et al. Experimental [Page 115]</span></pre>
6437 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-116" ></span>
6438 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6439
6440
6441 For a detailed discussion of security considerations and the IPP
6442 application security profile required for SSL3 support, see <a href="#section-8">section</a>
6443 <a href="#section-8">8</a>.
6444
6445 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations (registered and private extensions)</span>
6446
6447 This section describes how IPP can be extended to allow the following
6448 registered and private extensions to IPP:
6449
6450 1. keyword attribute values
6451 2. enum attribute values
6452 3. attributes
6453 4. attribute syntaxes
6454 5. operations
6455 6. attribute groups
6456 7. status codes
6457
6458 Extensions registered for use with IPP/1.0 are OPTIONAL for client
6459 and IPP object conformance to the IPP/1.0 Model specification.
6460
6461 These extension procedures are aligned with the guidelines as set
6462 forth by the IESG [<a href="./rfc2434" title="">RFC2434</a>]. <a href="#section-11">Section 11</a> describes how to propose new
6463 registrations for consideration. IANA will reject registration
6464 proposals that leave out required information or do not follow the
6465 appropriate format described in <a href="#section-11">Section 11</a>. IPP/1.0 may also be
6466 extended by an appropriate RFC that specifies any of the above
6467 extensions.
6468
6469 <span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a> Typed 'keyword' and 'enum' Extensions</span>
6470
6471 IPP allows for 'keyword' and 'enum' extensions (see sections <a href="#section-4.1.2.3">4.1.2.3</a>
6472 and 4.1.4). This document uses prefixes to the 'keyword' and 'enum'
6473 basic attribute syntax type in order to communicate extra information
6474 to the reader through its name. This extra information is not
6475 represented in the protocol because it is unimportant to a client or
6476 Printer object. The list below describes the prefixes and their
6477 meaning.
6478
6479 "type1": The IPP specification must be revised to add a new
6480 keyword or a new enum. No private keywords or enums are
6481 allowed.
6482
6483 "type2": Implementers can, at any time, add new keyword or enum
6484 values by proposing the complete specification to IANA:
6485
6486 [email protected]
6487
6488
6489
6490
6491
6492 <span class="grey">deBry, et al. Experimental [Page 116]</span></pre>
6493 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-117" ></span>
6494 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6495
6496
6497 IANA will forward the registration proposal to the IPP
6498 Designated Expert who will review the proposal with a mailing
6499 list that the Designated Expert keeps for this purpose.
6500 Initially, that list will be the mailing list used by the IPP
6501 WG:
6502
6503 [email protected]
6504
6505 even after the IPP WG is disbanded as permitted by [<a href="./rfc2434" title="">RFC2434</a>].
6506 The IPP Designated Expert is appointed by the IESG Area Director
6507 responsible for IPP, according to [<a href="./rfc2434" title="">RFC2434</a>].
6508
6509 When a type2 keyword or enum is approved, the IPP Designated
6510 Expert becomes the point of contact for any future maintenance
6511 that might be required for that registration.
6512
6513 "type3": Implementers can, at any time, add new keyword and enum
6514 values by submitting the complete specification to IANA as for
6515 type2 who will forward the proposal to the IPP Designated
6516 Expert. While no additional technical review is required, the
6517 IPP Designated Expert may, at his/her discretion, forward the
6518 proposal to the same mailing list as for type2 registrations for
6519 advice and comment.
6520
6521 When a type3 keyword or enum is approved by the IPP Designated
6522 Expert, the original proposer becomes the point of contact for
6523 any future maintenance that might be required for that
6524 registration.
6525
6526 For type2 and type3 keywords, the proposer includes the name of the
6527 keyword in the registration proposal and the name is part of the
6528 technical review.
6529
6530 After type2 and type3 enums specifications are approved, the IPP
6531 Designated Expert in consultation with IANA assigns the next
6532 available enum number for each enum value.
6533
6534 IANA will publish approved type2 and type3 keyword and enum
6535 attributes value registration specifications in:
6536
6537 ftp.isi.edu/iana/assignments/ipp/attribute-values/xxx/yyy.txt
6538
6539 where xxx is the attribute name that specifies the initial values and
6540 yyy.txt is a descriptive file name that contains one or more enums or
6541 keywords approved at the same time. For example, if several
6542 additional enums for stapling are approved for use with the
6543
6544
6545
6546
6547
6548 <span class="grey">deBry, et al. Experimental [Page 117]</span></pre>
6549 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-118" ></span>
6550 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6551
6552
6553 "finishings" attribute (and "finishings-default" and "finishings-
6554 supported" attributes), IANA will publish the additional values in
6555 the file:
6556
6557 ftp.isi.edu/iana/assignments/ipp/attribute-
6558 values/finishings/stapling.txt
6559
6560 Note: Some attributes are defined to be: 'type3 keywords' | 'name'
6561 which allows for attribute values to be extended by a site
6562 administrator with administrator defined names. Such names are not
6563 registered with IANA.
6564
6565 By definition, each of the three types above assert some sort of
6566 registry or review process in order for extensions to be considered
6567 valid. Each higher numbered level (1, 2, 3) tends to be decreasingly
6568 less stringent than the previous level. Therefore, any typeN value
6569 MAY be registered using a process for some typeM where M is less than
6570 N, however such registration is NOT REQUIRED. For example, a type3
6571 value MAY be registered in a type 1 manner (by being included in a
6572 future version of an IPP specification), however, it is NOT REQUIRED.
6573
6574 This specification defines keyword and enum values for all of the
6575 above types, including type3 keywords.
6576
6577 For private (unregistered) keyword extensions, implementers SHOULD
6578 use keywords with a suitable distinguishing prefix, such as "xxx-"
6579 where xxx is the (lowercase) fully qualified company name registered
6580 with IANA for use in domain names [<a href="./rfc1035" title="&quot;DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION&quot;">RFC1035</a>]. For example, if the
6581 company XYZ Corp. had obtained the domain name "XYZ.com", then a
6582 private keyword 'abc' would be: 'xyz.com-abc'.
6583
6584 Note: <a href="./rfc1035">RFC 1035</a> [<a href="./rfc1035" title="&quot;DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION&quot;">RFC1035</a>] indicates that while upper and lower case
6585 letters are allowed in domain names, no significance is attached to
6586 the case. That is, two names with the same spelling but different
6587 case are to be treated as if identical. Also, the labels in a domain
6588 name must follow the rules for ARPANET host names: They must start
6589 with a letter, end with a letter or digit, and have as interior
6590 characters only letters, digits, and hyphen. Labels must be 63
6591 characters or less. Labels are separated by the "." character.
6592
6593 For private (unregistered) enum extension, implementers MUST use
6594 values in the reserved integer range which is 2**30 to 2**31-1.
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604 <span class="grey">deBry, et al. Experimental [Page 118]</span></pre>
6605 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-119" ></span>
6606 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6607
6608
6609 <span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a> Attribute Extensibility</span>
6610
6611 Attribute names are type2 keywords. Therefore, new attributes may be
6612 registered and have the same status as attributes in this document by
6613 following the type2 extension rules. For private (unregistered)
6614 attribute extensions, implementers SHOULD use keywords with a
6615 suitable distinguishing prefix as described in <a href="#section-6.1">Section 6.1</a>.
6616
6617 IANA will publish approved attribute registration specifications as
6618 separate files:
6619
6620 ftp.isi.edu/iana/assignments/ipp/attributes/xxx-yyy.txt
6621
6622 where "xxx-yyy" is the new attribute name.
6623
6624 If a new Printer object attribute is defined and its values can be
6625 affected by a specific document format, its specification needs to
6626 contain the following sentence:
6627
6628 "The value of this attribute returned in a Get-Printer-Attributes
6629 response MAY depend on the "document-format" attribute supplied
6630 (see <a href="#section-3.2.5.1">Section 3.2.5.1</a>)."
6631
6632 If the specification does not, then its value in the Get-Printer-
6633 Attributes response MUST NOT depend on the "document-format" supplied
6634 in the request. When a new Job Template attribute is registered, the
6635 value of the Printer attributes MAY vary with "document-format"
6636 supplied in the request without the specification having to indicate
6637 so.
6638
6639 <span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a> Attribute Syntax Extensibility</span>
6640
6641 Attribute syntaxes are like type2 enums. Therefore, new attribute
6642 syntaxes may be registered and have the same status as attribute
6643 syntaxes in this document by following the type2 extension rules
6644 described in <a href="#section-6.1">Section 6.1</a>. The value codes that identify each of the
6645 attribute syntaxes are assigned in the Encoding and Transport
6646 specification [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>], including a designated range for private,
6647 experimental use.
6648
6649 For attribute syntaxes, the IPP Designated Expert in consultation
6650 with IANA assigns the next attribute syntax code in the appropriate
6651 range as specified in [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]. IANA will publish approved
6652 attribute syntax registration specifications as separate files:
6653
6654 ftp.isi.edu/iana/assignments/ipp/attribute-syntaxes/xxx-yyy.txt
6655
6656 where 'xxx-yyy' is the new attribute syntax name.
6657
6658
6659
6660 <span class="grey">deBry, et al. Experimental [Page 119]</span></pre>
6661 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-120" ></span>
6662 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6663
6664
6665 <span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a> Operation Extensibility</span>
6666
6667 Operations may also be registered following the type2 procedures
6668 described in <a href="#section-6.1">Section 6.1</a>, though major new operations will usually be
6669 done by a new standards track RFC that augments this document. For
6670 private (unregistered) operation extensions, implementers MUST use
6671 the range for the "operation-id" in requests specified in <a href="#section-4.4.13">Section</a>
6672 <a href="#section-4.4.13">4.4.13</a> "operations-supported" Printer attribute.
6673
6674 For operations, the IPP Designated Expert in consultation with IANA
6675 assigns the next operation-id code as specified in <a href="#section-4.4.13">Section 4.4.13</a>.
6676 IANA will publish approved operation registration specifications as
6677 separate files:
6678
6679 ftp.isi.edu/iana/assignments/ipp/operations/Xxx-Yyy.txt
6680
6681 where "Xxx-Yyy" is the new operation name.
6682
6683 <span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a> Attribute Groups</span>
6684
6685 Attribute groups passed in requests and responses may be registered
6686 following the type2 procedures described in <a href="#section-6.1">Section 6.1</a>. The tags
6687 that identify each of the attribute groups are assigned in [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>].
6688
6689 For attribute groups, the IPP Designated Expert in consultation with
6690 IANA assigns the next attribute group tag code in the appropriate
6691 range as specified in [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]. IANA will publish approved
6692 attribute group registration specifications as separate files:
6693
6694 ftp.isi.edu/iana/assignments/ipp/attribute-group-tags/xxx-yyy-
6695 tag.txt
6696
6697 where 'xxx-yyy-tag' is the new attribute group tag name.
6698
6699 <span class="h3"><a class="selflink" id="section-6.6" href="#section-6.6">6.6</a> Status Code Extensibility</span>
6700
6701 Operation status codes may also be registered following the type2
6702 procedures described in <a href="#section-6.1">Section 6.1</a>. The values for status codes are
6703 allocated in ranges as specified in <a href="#section-13">Section 13</a> for each status code
6704 class:
6705
6706 "informational" - Request received, continuing process
6707 "successful" - The action was successfully received, understood,
6708 and accepted
6709 "redirection" - Further action must be taken in order to complete
6710 the request
6711 "client-error" - The request contains bad syntax or cannot be
6712 fulfilled
6713
6714
6715
6716 <span class="grey">deBry, et al. Experimental [Page 120]</span></pre>
6717 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-121" ></span>
6718 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6719
6720
6721 "server-error" - The IPP object failed to fulfill an apparently
6722 valid request
6723
6724 For private (unregistered) operation status code extensions,
6725 implementers MUST use the top of each range as specified in <a href="#section-13">Section</a>
6726 <a href="#section-13">13</a>.
6727
6728 For operation status codes, the IPP Designated Expert in consultation
6729 with IANA assigns the next status code in the appropriate class range
6730 as specified in <a href="#section-13">Section 13</a>. IANA will publish approved status code
6731 registration specifications as separate files:
6732
6733 ftp.isi.edu/iana/assignments/ipp/status-codes/xxx-yyy.txt
6734
6735 where "xxx-yyy" is the new operation status code keyword.
6736
6737 <span class="h3"><a class="selflink" id="section-6.7" href="#section-6.7">6.7</a> Registration of MIME types/sub-types for document-formats</span>
6738
6739 The "document-format" attribute's syntax is 'mimeMediaType'. This
6740 means that valid values are Internet Media Types (see <a href="#section-4.1.9">Section 4.1.9</a>).
6741 <a href="./rfc2045">RFC 2045</a> [<a href="./rfc2045" title="&quot; Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies&quot;">RFC2045</a>] defines the syntax for valid Internet media types.
6742 IANA is the registry for all Internet media types.
6743
6744 <span class="h3"><a class="selflink" id="section-6.8" href="#section-6.8">6.8</a> Registration of charsets for use in 'charset' attribute values</span>
6745
6746 The "attributes-charset" attribute's syntax is 'charset'. This means
6747 that valid values are charsets names. When a charset in the IANA
6748 registry has more than one name (alias), the name labeled as
6749 "(preferred MIME name)", if present, MUST be used (see <a href="#section-4.1.7">Section</a>
6750 <a href="#section-4.1.7">4.1.7</a>). IANA is the registry for charsets following the procedures
6751 of [<a href="./rfc2278" title="&quot;IANA Charset Registration Procedures&quot;">RFC2278</a>].
6752
6753 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Internationalization Considerations</span>
6754
6755 Some of the attributes have values that are text strings and names
6756 which are intended for human understanding rather than machine
6757 understanding (see the 'text' and 'name' attribute syntaxes in
6758 Sections <a href="#section-4.1.1">4.1.1</a> and <a href="#section-4.1.2">4.1.2</a>).
6759
6760 In each operation request, the client
6761
6762 - identifies the charset and natural language of the request which
6763 affects each supplied 'text' and 'name' attribute value, and
6764 - requests the charset and natural language for attributes returned
6765 by the IPP object in operation responses (as described in <a href="#section-3.1.4.1">Section</a>
6766 <a href="#section-3.1.4.1">3.1.4.1</a>).
6767
6768
6769
6770
6771
6772 <span class="grey">deBry, et al. Experimental [Page 121]</span></pre>
6773 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-122" ></span>
6774 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6775
6776
6777 In addition, the client MAY separately and individually identify the
6778 Natural Language Override of a supplied 'text' or 'name' attribute
6779 using the 'textWithLanguage' and 'nameWithLanguage' technique
6780 described <a href="#section-4.1.1.2">section 4.1.1.2</a> and 4.1.2.2 respectively.
6781
6782 All IPP objects MUST support the UTF-8 [<a href="./rfc2279" title="&quot;UTF-8, a transformation format of ISO 10646&quot;">RFC2279</a>] charset in all '
6783 text' and 'name' attributes supported. If an IPP object supports
6784 more than the UTF-8 charset, the object MUST convert between them in
6785 order to return the requested charset to the client according to
6786 <a href="#section-3.1.4.2">Section 3.1.4.2</a>. If an IPP object supports more than one natural
6787 language, the object SHOULD return 'text' and 'name' values in the
6788 natural language requested where those values are generated by the
6789 Printer (see <a href="#section-3.1.4.1">Section 3.1.4.1</a>).
6790
6791 For Printers that support multiple charsets and/or multiple natural
6792 languages in 'text' and 'name' attributes, different jobs may have
6793 been submitted in differing charsets and/or natural languages. All
6794 responses MUST be returned in the charset requested by the client.
6795 However, the Get-Jobs operation uses the 'textWithLanguage' and '
6796 nameWithLanguage' mechanism to identify the differing natural
6797 languages with each job attribute returned.
6798
6799 The Printer object also has configured charset and natural language
6800 attributes. The client can query the Printer object to determine
6801 the list of charsets and natural languages supported by the Printer
6802 object and what the Printer object's configured values are. See the
6803 "charset-configured", "charset-supported", "natural-language-
6804 configured", and "generated-natural-language-supported" Printer
6805 description attributes for more details.
6806
6807 The "charset-supported" attributed identifies the supported charsets.
6808 If a charset is supported, the IPP object MUST be capable of
6809 converting to and from that charset into any other supported charset.
6810 In many cases, an IPP object will support only one charset and it
6811 MUST be the UTF-8 charset.
6812
6813 The "charset-configured" attribute identifies the one supported
6814 charset which is the native charset given the current configuration
6815 of the IPP object (administrator defined).
6816
6817 The "generated-natural-language-supported" attribute identifies the
6818 set of supported natural languages for generated messages; it is not
6819 related to the set of natural languages that must be accepted for
6820 client supplied 'text' and 'name' attributes. For client supplied '
6821 text' and 'name' attributes, an IPP object MUST accept ALL supplied
6822 natural languages. Just because a Printer object is currently
6823
6824
6825
6826
6827
6828 <span class="grey">deBry, et al. Experimental [Page 122]</span></pre>
6829 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-123" ></span>
6830 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6831
6832
6833 configured to support 'en-us' natural language does not mean that the
6834 Printer object should reject a job if the client supplies a job name
6835 that is in 'fr-ca'.
6836
6837 The "natural-language-configured" attribute identifies the one
6838 supported natural language for generated messages which is the native
6839 natural language given the current configuration of the IPP object
6840 (administrator defined).
6841
6842 Attributes of type 'text' and 'name' are populated from different
6843 sources. These attributes can be categorized into following groups
6844 (depending on the source of the attribute):
6845
6846 1. Some attributes are supplied by the client (e.g., the client
6847 supplied "job-name", "document-name", and "requesting-user-name"
6848 operation attributes along with the corresponding Job object's
6849 "job-name" and "job-originating-user-name" attributes). The IPP
6850 object MUST accept these attributes in any natural language no
6851 matter what the set of supported languages for generated
6852 messages
6853 2. Some attributes are supplied by the system administrator (e.g.,
6854 the Printer object's "printer-name" and "printer-location"
6855 attributes). These too can be in any natural language. If the
6856 natural language for these attributes is different than what a
6857 client requests, then they must be reported using the Natural
6858 Language Override mechanism.
6859 3. Some attributes are supplied by the device manufacturer (e.g.,
6860 the Printer object's "printer-make-and-model" attribute). These
6861 too can be in any natural language. If the natural language for
6862 these attributes is different than what a client requests, then
6863 they must be reported using the Natural Language Override
6864 mechanism.
6865 4. Some attributes are supplied by the operator (e.g., the Job
6866 object's "job-message-from-operator" attribute). These too can
6867 be in any natural language. If the natural language for these
6868 attributes is different than what a client requests, then they
6869 must be reported using the Natural Language Override mechanism.
6870 5. Some attributes are generated by the IPP object (e.g., the Job
6871 object's "job-state-message" attribute, the Printer object's
6872 "printer-state-message" attribute, and the "status-message"
6873 operation attribute). These attributes can only be in one of
6874 the "generated-natural-language-supported" natural languages.
6875 If a client requests some natural language for these attributes
6876 other than one of the supported values, the IPP object SHOULD
6877 respond using the value of the "natural-language-configured"
6878 attribute (using the Natural Language Override mechanism if
6879 needed).
6880
6881
6882
6883
6884 <span class="grey">deBry, et al. Experimental [Page 123]</span></pre>
6885 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-124" ></span>
6886 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6887
6888
6889 The 'text' and 'name' attributes specified in this version of this
6890 document (additional ones will be registered according to the
6891 procedures in <a href="#section-6">Section 6</a>) are:
6892
6893 Attributes Source
6894 -------------------------- ----------
6895 Operation Attributes
6896 job-name (name) client
6897 document-name (name) client
6898 requesting-user-name (name) client
6899 status-message Job or Printer object
6900
6901 Job Template Attributes:
6902 job-hold-until) client matches administrator-configured
6903 (keyword | name
6904 job-hold-until-default client matches administrator-configured
6905 (keyword | name)
6906 job-hold-until-supported client matches administrator-configured
6907 (keyword | name)
6908 job-sheets client matches administrator-configured
6909 (keyword | name)
6910 job-sheets-default client matches administrator-configured
6911 (keyword | name)
6912 job-sheets-supported client matches administrator-configured
6913 (keyword | name)
6914 media client matches administrator-configured
6915 (keyword | name)
6916 media-default client matches administrator-configured
6917 (keyword | name)
6918 media-supported client matches administrator-configured
6919 (keyword | name)
6920 media-ready client matches administrator-configured
6921 (keyword | name)
6922
6923 Job Description Attributes:
6924 job-name (name) client or Printer object
6925 job-originating-user-name (name) Printer object
6926 job-state-message (text) Job or Printer object
6927 output-device-assigned (name(127)) administrator
6928 job-message-from-operator (text(127)) operator
6929
6930 Printer Description Attributes:
6931 printer-name (name(127)) administrator
6932 printer-location (text(127)) administrator
6933 printer-info (text(127)) administrator
6934 printer-make-and-model (text(127)) administrator or manufacturer
6935 printer-state-message (text) Printer object
6936 printer-message-from-operator (text(127)) operator
6937
6938
6939
6940 <span class="grey">deBry, et al. Experimental [Page 124]</span></pre>
6941 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-125" ></span>
6942 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6943
6944
6945 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Security Considerations</span>
6946
6947 Some IPP objects MAY be deployed over protocol stacks that support
6948 Secure Socket Layer Version 3 (SSL3) [<a href="#ref-SSL" title="Version 3">SSL</a>]. Note: SSL3 is not an
6949 IETF standards track specification. Other IPP objects MAY be
6950 deployed over protocol stacks that do not support SSL3. Some IPP
6951 objects MAY be deployed over both types of protocol stacks. Those
6952 IPP objects that support SSL3, are capable of supporting mutual
6953 authentication as well as privacy of messages via multiple encryption
6954 schemes. An important point about security related information for
6955 SSL3 access to an IPP object, is that the security-related parameters
6956 (authentication, encryption keys, etc.) are "out-of-band" to the
6957 actual IPP protocol.
6958
6959 An IPP object that does not support SSL3 MAY elect to support a
6960 transport layer that provides other security mechanisms. For
6961 example, in a mapping of IPP over HTTP/1.1 [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>], if the IPP
6962 object does not support SSL3, HTTP still allows for client
6963 authentication using Digest Access Authentication (DAA) [<a href="./rfc2069" title="&quot;An Extension to HTTP: Digest Access Authentication&quot;">RFC2069</a>].
6964
6965 It is difficult to anticipate the security risks that might exist in
6966 any given IPP environment. For example, if IPP is used within a given
6967 corporation over a private network, the risks of exposing document
6968 data may be low enough that the corporation will choose not to use
6969 encryption on that data. However, if the connection between the
6970 client and the IPP object is over a public network, the client may
6971 wish to protect the content of the information during transmission
6972 through the network with encryption.
6973
6974 Furthermore, the value of the information being printed may vary from
6975 one IPP environment to the next. Printing payroll checks, for
6976 example, would have a different value than printing public
6977 information from a file. There is also the possibly of denial-of-
6978 service attacks, but denial-of-service attacks against printing
6979 resources are not well understood and there is no published
6980 precedents regarding this scenario.
6981
6982 Once the authenticated identity of the requester has been supplied to
6983 the IPP object, the object uses that identity to enforce any
6984 authorization policy that might be in place. For example, one site's
6985 policy might be that only the job owner is allowed to cancel a job.
6986 The details and mechanisms to set up a particular access control
6987 policy are not part of IPP/1.0, and must be established via some
6988 other type of administrative or access control framework. However,
6989 there are operation status codes that allow an IPP server to return
6990 information back to a client about any potential access control
6991 violations for an IPP object.
6992
6993
6994
6995
6996 <span class="grey">deBry, et al. Experimental [Page 125]</span></pre>
6997 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-126" ></span>
6998 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
6999
7000
7001 During a create operation, the client's identity is recorded in the
7002 Job object in an implementation-defined attribute. This information
7003 can be used to verify a client's identity for subsequent operations
7004 on that Job object in order to enforce any access control policy that
7005 might be in effect. See <a href="#section-8.3">section 8.3</a> below for more details.
7006
7007 Since the security levels or the specific threats that any given IPP
7008 system administrator may be concerned with cannot be anticipated, IPP
7009 MUST be capable of operating with different security mechanisms and
7010 security policies as required by the individual installation.
7011 Security policies might vary from very strong, to very weak, to none
7012 at all, and corresponding security mechanisms will be required. SSL3
7013 supports the type of negotiated levels of security required by most,
7014 if not all, potential IPP environments. IPP environments that require
7015 no security can elect to deploy IPP objects that do not utilize the
7016 optional SSL3 security mechanisms.
7017
7018 <span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a> Security Scenarios</span>
7019
7020 The following sections describe specific security attacks for IPP
7021 environments. Where examples are provided they should be considered
7022 illustrative of the environment and not an exhaustive set. Not all of
7023 these environments will necessarily be addressed in initial
7024 implementations of IPP.
7025
7026 <span class="h4"><a class="selflink" id="section-8.1.1" href="#section-8.1.1">8.1.1</a> Client and Server in the Same Security Domain</span>
7027
7028 This environment is typical of internal networks where traditional
7029 office workers print the output of personal productivity applications
7030 on shared work-group printers, or where batch applications print
7031 their output on large production printers. Although the identity of
7032 the user may be trusted in this environment, a user might want to
7033 protect the content of a document against such attacks as
7034 eavesdropping, replaying or tampering.
7035
7036 <span class="h4"><a class="selflink" id="section-8.1.2" href="#section-8.1.2">8.1.2</a> Client and Server in Different Security Domains</span>
7037
7038 Examples of this environment include printing a document created by
7039 the client on a publicly available printer, such as at a commercial
7040 print shop; or printing a document remotely on a business associate's
7041 printer. This latter operation is functionally equivalent to sending
7042 the document to the business associate as a facsimile. Printing
7043 sensitive information on a Printer in a different security domain
7044 requires strong security measures. In this environment authentication
7045 of the printer is required as well as protection against unauthorized
7046 use of print resources. Since the document crosses security domains,
7047
7048
7049
7050
7051
7052 <span class="grey">deBry, et al. Experimental [Page 126]</span></pre>
7053 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-127" ></span>
7054 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7055
7056
7057 protection against eavesdropping and document tampering are also
7058 required. It will also be important in this environment to protect
7059 Printers against "spamming" and malicious document content.
7060
7061 <span class="h4"><a class="selflink" id="section-8.1.3" href="#section-8.1.3">8.1.3</a> Print by Reference</span>
7062
7063 When the document is not stored on the client, printing can be done
7064 by reference. That is, the print request can contain a reference, or
7065 pointer, to the document instead of the actual document itself.
7066 Standard methods currently do not exist for remote entities to
7067 "assume" the credentials of a client for forwarding requests to a 3rd
7068 party. It is anticipated that Print-By-Reference will be used to
7069 access "public" documents and that sophisticated methods for
7070 authenticating "proxies" will not be specified for version 1 of IPP.
7071
7072 <span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a> URIs for SSL3 and non-SSL3 Access</span>
7073
7074 As described earlier, an IPP object can support SSL3 access, non-SSL3
7075 access, or both. The "printer-uri-supported" attribute contains the
7076 Printer object's URI(s). Its companion attribute, "uri-security-
7077 supported", identifies the security mechanism used for each URI
7078 listed in the "printer-uri-supported" attribute. For each Printer
7079 operation request, a client MUST supply only one URI in the
7080 "printer-uri" operation attribute. In other words, even though the
7081 Printer supports more than one URI, the client only interacts with
7082 the Printer object using one if its URIs. This duality is not needed
7083 for Job objects, since the Printer objects is the factory for Job
7084 objects, and the Printer object will generate the correct URI for new
7085 Job objects depending on the Printer object's security configuration.
7086
7087 <span class="h3"><a class="selflink" id="section-8.3" href="#section-8.3">8.3</a> The "requesting-user-name" (name(MAX)) Operation Attribute</span>
7088
7089 Each operation MUST specify the user who is performing the operation
7090 in both of the following two ways:
7091
7092 1) via the REQUIRED "requesting-user-name" operation attribute that
7093 a client SHOULD supply in all operations. The client MUST obtain
7094 the value for this attribute from an environmental or network
7095 login name for the user, rather than allowing the user to supply
7096 any value. If the client does not supply a value for
7097 "requesting-user-name", the printer MUST assume that the client
7098 is supplying some anonymous name, such as "anonymous".
7099 2) via an authentication mechanism of the underlying transport
7100 which may be configured to give no authentication information.
7101
7102
7103
7104
7105
7106
7107
7108 <span class="grey">deBry, et al. Experimental [Page 127]</span></pre>
7109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-128" ></span>
7110 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7111
7112
7113 There are six cases to consider:
7114
7115 a) the authentication mechanism gives no information, and the
7116 client doesn't specify "requesting-user-name".
7117 b) the authentication mechanism gives no information, but the
7118 client specifies "requesting-user-name".
7119 c) the authentication mechanism specifies a user which has no human
7120 readable representation, and the client doesn't specify
7121 "requesting-user-name".
7122 d) the authentication mechanism specifies a user which has no human
7123 readable representation, but the client specifies "requesting-
7124 user-name".
7125 e) the authentication mechanism specifies a user which has a human
7126 readable representation. The Printer object ignores the
7127 "requesting-user-name".
7128 f) the authentication mechanism specifies a user who is trusted and
7129 whose name means that the value of the "requesting-user-name",
7130 which MUST be present, is treated as the authenticated name.
7131
7132 Note: Case "f" is intended for a tightly coupled gateway and server
7133 to work together so that the "user" name is able to be that of the
7134 gateway client and not that of the gateway. Because most, if not
7135 all, system vendors will initially implement IPP via a gateway into
7136 their existing print system, this mechanism is necessary unless the
7137 authentication mechanism allows a gateway (client) to act on behalf
7138 of some other client.
7139
7140 The user-name has two forms:
7141
7142 - one that is human readable: it is held in the REQUIRED "job-
7143 originating-user-name" Job Description attribute which is set
7144 during the job creation operations. It is used for presentation
7145 only, such as returning in queries or printing on start sheets
7146 - one for authorization: it is held in an undefined (by IPP) Job
7147 object attribute which is set by the job creation operation. It
7148 is used to authorize other operations, such as Send-Document,
7149 Send-URI, Cancel-Job, to determine the user when the "my-jobs"
7150 attribute is specified with Get-Jobs, and to limit what
7151 attributes and values to return with Get-Job-Attributes and Get-
7152 Jobs.
7153
7154 The human readable user name:
7155
7156 - is the value of the "requesting-user-name" for cases b, d and f.
7157 - comes from the authentication mechanism for case e
7158 - is some anonymous name, such as "anonymous" for cases a and c.
7159
7160 The user name used for authorization:
7161
7162
7163
7164 <span class="grey">deBry, et al. Experimental [Page 128]</span></pre>
7165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-129" ></span>
7166 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7167
7168
7169 - is the value of the "requesting-user-name" for cases b and f.
7170 - comes from the authentication mechanism for cases c, d and e
7171 - is some anonymous name, such as "anonymous" for case a.
7172
7173 The essence of these rules for resolving conflicting sources of
7174 user-names is that a printer implementation is free to pick either
7175 source as long as it achieves consistent results. That is, if a user
7176 uses the same path for a series of requests, the requests MUST appear
7177 to come from the same user from the standpoint of both the human-
7178 readable user name and the user name for authorization. This rule
7179 MUST continue to apply even if a request could be authenticated by
7180 two or more mechanisms. It doesn't matter which of several
7181 authentication mechanisms a Printer uses as long as it achieves
7182 consistent results. If a client uses more than one authentication
7183 mechanism, it is recommended that an administrator make all
7184 credentials resolve to the same user and user-name as much as
7185 possible.
7186
7187 <span class="h3"><a class="selflink" id="section-8.4" href="#section-8.4">8.4</a> Restricted Queries</span>
7188
7189 In many IPP operations, a client supplies a list of attributes to be
7190 returned in the response. For security reasons, an IPP object may be
7191 configured not to return all attributes (or all values) that a client
7192 requests. The job attributes returned MAY depend on whether the
7193 requesting user is the same as the user that submitted the job. The
7194 IPP object MAY even return none of the requested attributes. In such
7195 cases, the status returned is the same as if the object had returned
7196 all requested attributes. The client cannot tell by such a response
7197 whether the requested attribute was present or absent on the object.
7198
7199 <span class="h3"><a class="selflink" id="section-8.5" href="#section-8.5">8.5</a> Queries on jobs submitted using non-IPP protocols</span>
7200
7201 If the device that an IPP Printer is representing is able to accept
7202 jobs using other job submission protocols in addition to IPP, it is
7203 RECOMMENDED that such an implementation at least allow such "foreign"
7204 jobs to be queried using Get-Jobs returning "job-id" and "job-uri" as
7205 'unknown'. Such an implementation NEED NOT support all of the same
7206 IPP job attributes as for IPP jobs. The IPP object returns the '
7207 unknown' out-of-band value for any requested attribute of a foreign
7208 job that is supported for IPP jobs, but not for foreign jobs.
7209
7210 It is further RECOMMENDED, that the IPP Printer generate "job-id" and
7211 "job-uri" values for such "foreign jobs", if possible, so that they
7212 may be targets of other IPP operations, such as Get-Job-Attributes
7213 and Cancel-Job. Such an implementation also needs to deal with the
7214 problem of authentication of such foreign jobs. One approach would
7215 be to treat all such foreign jobs as belonging to users other than
7216 the user of the IPP client. Another approach would be for the
7217
7218
7219
7220 <span class="grey">deBry, et al. Experimental [Page 129]</span></pre>
7221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-130" ></span>
7222 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7223
7224
7225 foreign job to belong to 'anonymous'. Only if the IPP client has
7226 been authenticated as an operator or administrator of the IPP Printer
7227 object, could the foreign jobs be queried by an IPP request.
7228 Alternatively, if the security policy is to allow users to query
7229 other users' jobs, then the foreign jobs would also be visible to an
7230 end-user IPP client using Get-Jobs and Get-Job-Attributes.
7231
7232 <span class="h3"><a class="selflink" id="section-8.6" href="#section-8.6">8.6</a> IPP Security Application Profile for SSL3</span>
7233
7234 The IPP application profile for SSL3 follows the "Secure Socket
7235 Layer" requirement as documented in the SSL3 specification [<a href="#ref-SSL" title="Version 3">SSL</a>].
7236 For interoperability, the SSL3 cipher suites are:
7237
7238 SSL_RSA_WITH_RC4_128_MD5
7239 SSL_RSA_WITH_3DES_EDE_CBC_SHA
7240 SSL_RSA_WITH_DES_CBC_SHA
7241 SSL_RSA_EXPORT_WITH_RC4_40_MD5
7242 SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5
7243 SSL_RSA_WITH_NULL_MD5
7244
7245 Client implementations MUST NOT assume any other cipher suites are
7246 supported by an IPP Printer object.
7247
7248 If a conforming IPP object supports SSL3, it MUST implement and
7249 support the cipher suites listed above and MAY support additional
7250 cipher suites.
7251
7252 A conforming IPP client SHOULD support SSL3 including the cipher
7253 suites listed above. A conforming IPP client MAY support additional
7254 cipher suites.
7255
7256 It is possible that due to certain government export restrictions
7257 some non-compliant versions of this extension could be deployed.
7258 Implementations wishing to inter-operate with such non-compliant
7259 versions MAY offer the SSL_RSA_EXPORT_WITH_RC4_40_MD5 and
7260 SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5 mechanisms. However, since 40 bit
7261 ciphers are known to be vulnerable to attack by current technology,
7262 any client which actives a 40 bit cipher MUST NOT indicate to the
7263 user that the connection is completely secure from eavesdropping.
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276 <span class="grey">deBry, et al. Experimental [Page 130]</span></pre>
7277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-131" ></span>
7278 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7279
7280
7281 <span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. References</span>
7282
7283 [<a id="ref-ASCII">ASCII</a>] Coded Character Set - 7-bit American Standard Code for
7284 Information Interchange (ASCII), ANSI X3.4-1986. This
7285 standard is the specification of the US-ASCII charset.
7286
7287 [<a id="ref-HTPP">HTPP</a>] J. Barnett, K. Carter, R. DeBry, "Initial Draft -
7288 Hypertext Printing Protocol - HTPP/1.0", October 1996.
7289 <a href="ftp://ftp.pwg.org/pub/pwg/ipp/historic/htpp/overview.ps.gz">ftp://ftp.pwg.org/pub/pwg/ipp/historic/htpp/</a>
7290 <a href="ftp://ftp.pwg.org/pub/pwg/ipp/historic/htpp/overview.ps.gz">overview.ps.gz</a>
7291
7292 [<a id="ref-IANA-CS">IANA-CS</a>] IANA Registry of Coded Character Sets:
7293 <a href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">ftp://ftp.isi.edu/in-notes/iana/assignments/character-</a>
7294 <a href="ftp://ftp.isi.edu/in-notes/iana/assignments/character-sets">sets</a>
7295
7296 [<a id="ref-IANA-MT">IANA-MT</a>] IANA Registry of Media Types: <a href="ftp://ftp.isi.edu/in-notes/iana/assignments/media-types/">ftp://ftp.isi.edu/in-</a>
7297 <a href="ftp://ftp.isi.edu/in-notes/iana/assignments/media-types/">notes/iana/assignments/media-types/</a>
7298
7299 [<a id="ref-ipp-iig">ipp-iig</a>] Hastings, T. and C. Manros, "Internet Printing
7300 Protocol/1.0: Implementer's Guide", Work in Progress.
7301
7302 [<a id="ref-ISO10646-1">ISO10646-1</a>] ISO/IEC 10646-1:1993, "Information technology --
7303 Universal Multiple-Octet Coded Character Set (UCS) -
7304 Part 1: Architecture and Basic Multilingual Plane,
7305 JTC1/SC2."
7306
7307 [<a id="ref-ISO8859-1">ISO8859-1</a>] ISO/IEC 8859-1:1987, "Information technology -- 8-bit
7308 One-Byte Coded Character Set - Part 1: Latin Alphabet Nr
7309 1", 1987, JTC1/SC2.
7310
7311 [<a id="ref-ISO10175">ISO10175</a>] ISO/IEC 10175 Document Printing Application (DPA), June
7312 1996.
7313
7314 [<a id="ref-LDPA">LDPA</a>] T. Hastings, S. Isaacson, M. MacKay, C. Manros, D. Taylor, P.
7315 Zehler, "LDPA - Lightweight Document Printing
7316 Application", October 1996,
7317 <a href="ftp://ftp.pwg.org/pub/pwg/ipp/historic/ldpa/ldpa8.pdf.gz">ftp://ftp.pwg.org/pub/pwg/ipp/historic/ldpa/ldpa8.pdf.gz</a>
7318
7319 [<a id="ref-P1387.4">P1387.4</a>] Kirk, M. (Editor), POSIX System Administration - Part 4:
7320 Printing Interfaces, POSIX 1387.4 D8, 1994.
7321
7322 [<a id="ref-PSIS">PSIS</a>] Herriot, R. (editor), X/Open A Printing System
7323 Interoperability Specification (PSIS), August 1995.
7324
7325 [<a id="ref-PWG">PWG</a>] Printer Working Group, <a href="http://www.pwg.org">http://www.pwg.org</a>.
7326
7327 [<a id="ref-RFC1035">RFC1035</a>] Mockapetris, P., "DOMAIN NAMES - IMPLEMENTATION AND
7328 SPECIFICATION", STD 13, <a href="./rfc1035">RFC 1035</a>, November 1987.
7329
7330
7331
7332 <span class="grey">deBry, et al. Experimental [Page 131]</span></pre>
7333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-132" ></span>
7334 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7335
7336
7337 [<a id="ref-RFC1759">RFC1759</a>] Smith, R., Wright, F., Hastings, T., Zilles, S. and J.
7338 Gyllenskog, "Printer MIB", <a href="./rfc1759">RFC 1759</a>, March 1995.
7339
7340 [<a id="ref-RFC1766">RFC1766</a>] Alvestrand, H., "Tags for the Identification of
7341 Languages", <a href="./rfc1766">RFC 1766</a>, March 1995.
7342
7343 [<a id="ref-RFC1179">RFC1179</a>] McLaughlin, L. (Editor), "Line Printer Daemon Protocol",
7344 <a href="./rfc1179">RFC 1179</a>, August 1990.
7345
7346 [<a id="ref-RFC1952">RFC1952</a>] Deutsch, P., "GZIP file format specification version
7347 4.3", <a href="./rfc1952">RFC 1952</a>, May 1996.
7348
7349 [<a id="ref-RFC2045">RFC2045</a>] Freed, N. and N. Borenstein, " Multipurpose Internet
7350 Mail Extensions (MIME) Part One: Format of Internet
7351 Message Bodies", <a href="./rfc2045">RFC 2045</a>, November 1996.
7352
7353 [<a id="ref-RFC2046">RFC2046</a>] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
7354 Extensions (MIME) Part Two: Media Types", <a href="./rfc2046">RFC 2046</a>,
7355 November 1996.
7356
7357 [<a id="ref-RFC2048">RFC2048</a>] Freed, N., Klensin, J. and J. Postel, "Multipurpose
7358 Internet Mail Extension (MIME) Part Four: Registration
7359 Procedures", <a href="./rfc2048">RFC 2048</a>, November 1996.
7360
7361 [<a id="ref-RFC2068">RFC2068</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H. AND T.
7362 Berners-Lee, "Hypertext Transfer Protocol - HTTP/1.1",
7363 <a href="./rfc2068">RFC 2068</a>, January 1997.
7364
7365 [<a id="ref-RFC2069">RFC2069</a>] Franks, J., Hallam-Baker, P., Hostetler, J., Leach, P.,
7366 Luotonen, A., Sink, E. and L. Stewart, "An Extension to
7367 HTTP: Digest Access Authentication", <a href="./rfc2069">RFC 2069</a>, January
7368 1997.
7369
7370 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
7371 Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
7372
7373 [<a id="ref-RFC2228">RFC2228</a>] Horowitz, M. and S. Lunt, "FTP Security Extensions", <a href="./rfc2228">RFC</a>
7374 <a href="./rfc2228">2228</a>, October 1997.
7375
7376 [<a id="ref-RFC2277">RFC2277</a>] Alvestrand, H., "IETF Policy on Character Sets and
7377 Languages" <a href="./rfc2277">RFC 2277</a>, January 1998.
7378
7379 [<a id="ref-RFC2278">RFC2278</a>] Freed, N. and J. Postel: "IANA Charset Registration
7380 Procedures", <a href="https://www.rfc-editor.org/bcp/bcp19">BCP 19</a>, <a href="./rfc2278">RFC 2278</a>, January 1998.
7381
7382 [<a id="ref-RFC2279">RFC2279</a>] Yergeau, F., "UTF-8, a transformation format of ISO
7383 10646", <a href="./rfc2279">RFC 2279</a>, January 1998.
7384
7385
7386
7387
7388 <span class="grey">deBry, et al. Experimental [Page 132]</span></pre>
7389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-133" ></span>
7390 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7391
7392
7393 [<a id="ref-RFC2316">RFC2316</a>] Bellovin, S., "Report of the IAB Security Architecture
7394 Workshop", <a href="./rfc2316">RFC 2316</a>, April 1998.
7395
7396 [<a id="ref-RFC2396">RFC2396</a>] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform
7397 Resource Identifiers (URI): Generic Syntax", <a href="./rfc2396">RFC 2396</a>,
7398 August 1998.
7399
7400 [<a id="ref-RFC2434">RFC2434</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an
7401 IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc2434">RFC 2434</a>,
7402 October 1998.
7403
7404 [<a id="ref-RFC2565">RFC2565</a>] Herriot, R., Butler, S., Moore, P. and R. Tuner
7405 "Internet Printing Protocol/1.0: Encoding and
7406 Transport", <a href="./rfc2565">RFC 2565</a>, April 1999.
7407
7408 [<a id="ref-RFC2567">RFC2567</a>] Wright, D., "Design Goals for an Internet Printing
7409 Protocol", <a href="./rfc2567">RFC 2567</a>, April 1999.
7410
7411 [<a id="ref-RFC2568">RFC2568</a>] Zilles, S., "Rationale for the Structure and Model and
7412 Protocol for the Internet Printing Protocol", <a href="./rfc2568">RFC 2568</a>,
7413 April 1999.
7414
7415 [<a id="ref-RFC2569">RFC2569</a>] Herriot, R., Hastings, T., Jacobs, N. and J. Martin,
7416 "Mapping between LPD and IPP Protocols", <a href="./rfc2569">RFC 2569</a>, April
7417 1999.
7418
7419 [<a id="ref-RFC2579">RFC2579</a>] McCloghrie, K., Perkins, D. and J. Schoenwaelder,
7420 "Textual Conventions for SMIv2", STD 58, <a href="./rfc2579">RFC 2579</a>, April
7421 1999.
7422
7423 [<a id="ref-SSL">SSL</a>] Netscape, The SSL Protocol, Version 3, (Text version
7424 3.02), November 1996.
7425
7426 [<a id="ref-SWP">SWP</a>] P. Moore, B. Jahromi, S. Butler, "Simple Web Printing
7427 SWP/1.0", May 7, 1997,
7428 <a href="ftp://ftp.pwg.org/pub/pwg/ipp/new_PRO/swp9705.pdf">ftp://ftp.pwg.org/pub/pwg/ipp/new_PRO/swp9705.pdf</a>
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444 <span class="grey">deBry, et al. Experimental [Page 133]</span></pre>
7445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-134" ></span>
7446 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7447
7448
7449 <span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Authors' Addresses</span>
7450
7451 Scott A. Isaacson (Editor)
7452 Novell, Inc.
7453 122 E 1700 S
7454 Provo, UT 84606
7455
7456 Phone: 801-861-7366
7457 Fax: 801-861-2517
7458 EMail: [email protected]
7459
7460
7461 Tom Hastings
7462 Xerox Corporation
7463 737 Hawaii St.
7464 El Segundo, CA 90245
7465
7466 Phone: 310-333-6413
7467 Fax: 310-333-5514
7468 EMail: [email protected]
7469
7470
7471 Robert Herriot
7472 Xerox Corporation
7473 3400 Hillview Ave., Bldg #1
7474 Palo Alto, CA 94304
7475
7476 Phone: 650-813-7696
7477 Fax: 650-813-6860
7478 EMail: [email protected]
7479
7480
7481 Roger deBry
7482 Utah Valley State College
7483 Orem, UT 84058
7484
7485 Phone: (801) 222-8000
7486 EMail: [email protected]
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500 <span class="grey">deBry, et al. Experimental [Page 134]</span></pre>
7501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-135" ></span>
7502 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7503
7504
7505 Patrick Powell
7506 Astart Technologies
7507 9475 Chesapeake Dr., Suite D
7508 San Diego, CA 95123
7509
7510 Phone: (619) 874-6543
7511 Fax: (619) 279-8424
7512 EMail: [email protected]
7513
7514 IPP Mailing List: [email protected]
7515 IPP Mailing List Subscription: [email protected]
7516 IPP Web Page: <a href="http://www.pwg.org/ipp/">http://www.pwg.org/ipp/</a>
7517
7518 Implementers of this specification are encouraged to join IPP Mailing
7519 List in order to participate in any discussions of clarification
7520 issues and review of registration proposals for additional attributes
7521 and values.
7522
7523 Other Participants:
7524
7525 Chuck Adams - Tektronix
7526 Jeff Barnett - IBM
7527 Ron Bergman - Dataproducts Corp.
7528 Sylvan Butler - HP
7529 Keith Carter - IBM Corporation
7530 Jeff Copeland - QMS
7531 Andy Davidson - Tektronix
7532 Mabry Dozier - QMS
7533 Lee Farrell - Canon Information Systems
7534 Steve Gebert - IBM
7535 Babek Jahromi - Microsoft
7536 David Kellerman - Northlake Software
7537 Rick Landau - Digital
7538 Greg LeClair - Epson
7539 Harry Lewis - IBM
7540 Pete Loya - HP
7541 Ray Lutz - Cognisys
7542 Mike MacKay - Novell, Inc.
7543 Daniel Manchala - Xerox
7544 Carl-Uno Manros - Xerox
7545 Jay Martin - Underscore
7546 Larry Masinter - Xerox
7547 Stan McConnell - Xerox
7548 Ira McDonald - High North Inc.
7549 Paul Moore - Microsoft
7550 Tetsuya Morita - Ricoh
7551 Yuichi Niwa - Ricoh
7552 Pat Nogay - IBM
7553
7554
7555
7556 <span class="grey">deBry, et al. Experimental [Page 135]</span></pre>
7557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-136" ></span>
7558 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7559
7560
7561 Ron Norton - Printronics
7562 Bob Pentecost - HP
7563 Rob Rhoads - Intel
7564 Xavier Riley - Xerox
7565 David Roach - Unisys
7566 Stuart Rowley - Kyocera
7567 Hiroyuki Sato - Canon
7568 Bob Setterbo - Adobe
7569 Devon Taylor - Novell, Inc.
7570 Mike Timperman - Lexmark
7571 Randy Turner - Sharp
7572 Atsushi Yuki - Kyocera
7573 Rick Yardumian - Xerox
7574 Lloyd Young - Lexmark
7575 Bill Wagner - DPI
7576 Jim Walker - DAZEL
7577 Chris Wellens - Interworking Labs
7578 Rob Whittle - Novell, Inc.
7579 Don Wright - Lexmark
7580 Peter Zehler - Xerox
7581 Steve Zilles - Adobe
7582
7583 <span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. Formats for IPP Registration Proposals</span>
7584
7585 In order to propose an IPP extension for registration, the proposer
7586 must submit an application to IANA by email to "[email protected]" or by
7587 filling out the appropriate form on the IANA web pages
7588 (<a href="http://www.iana.org">http://www.iana.org</a>). This section specifies the required
7589 information and the formats for proposing registrations of extensions
7590 to IPP as provided in <a href="#section-6">Section 6</a> for:
7591
7592 1. type2 'keyword' attribute values
7593 2. type3 'keyword' attribute values
7594 3. type2 'enum' attribute values
7595 4. type3 'enum' attribute values
7596 5. attributes
7597 6. attribute syntaxes
7598 7. operations
7599 8. status codes
7600
7601 <span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.1</a> Type2 keyword attribute values registration</span>
7602
7603 Type of registration: type2 keyword attribute value
7604 Name of attribute to which this keyword specification is to be added:
7605 Proposed keyword name of this keyword value:
7606 Specification of this keyword value (follow the style of IPP Model
7607 <a href="#section-4.1.2.3">Section 4.1.2.3</a>):
7608 Name of proposer:
7609
7610
7611
7612 <span class="grey">deBry, et al. Experimental [Page 136]</span></pre>
7613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-137" ></span>
7614 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7615
7616
7617 Address of proposer:
7618 Email address of proposer:
7619
7620 Note: For type2 keywords, the Designated Expert will be the point of
7621 contact for the approved registration specification, if any
7622 maintenance of the registration specification is needed.
7623
7624 <span class="h3"><a class="selflink" id="section-11.2" href="#section-11.2">11.2</a> Type3 keyword attribute values registration</span>
7625
7626 Type of registration: type3 keyword attribute value
7627 Name of attribute to which this keyword specification is to be added:
7628 Proposed keyword name of this keyword value:
7629 Specification of this keyword value (follow the style of IPP Model
7630 <a href="#section-4.1.2.3">Section 4.1.2.3</a>):
7631 Name of proposer:
7632 Address of proposer:
7633 Email address of proposer:
7634
7635 Note: For type3 keywords, the proposer will be the point of contact
7636 for the approved registration specification, if any maintenance of
7637 the registration specification is needed.
7638
7639 <span class="h3"><a class="selflink" id="section-11.3" href="#section-11.3">11.3</a> Type2 enum attribute values registration</span>
7640
7641 Type of registration: type2 enum attribute value
7642 Name of attribute to which this enum specification is to be added:
7643 Keyword symbolic name of this enum value:
7644 Numeric value (to be assigned by the IPP Designated Expert in
7645 consultation with IANA):
7646 Specification of this enum value (follow the style of IPP Model
7647 <a href="#section-4.1.4">Section 4.1.4</a>):
7648 Name of proposer:
7649 Address of proposer:
7650 Email address of proposer:
7651
7652 Note: For type2 enums, the Designated Expert will be the point of
7653 contact for the approved registration specification, if any
7654 maintenance of the registration specification is needed.
7655
7656 <span class="h3"><a class="selflink" id="section-11.4" href="#section-11.4">11.4</a> Type3 enum attribute values registration</span>
7657
7658 Type of registration: type3 enum attribute value
7659 Name of attribute to which this enum specification is to be added:
7660 Keyword symbolic name of this enum value:
7661 Numeric value (to be assigned by the IPP Designated Expert in
7662 consultation with IANA):
7663 Specification of this enum value (follow the style of IPP Model
7664 <a href="#section-4.1.4">Section 4.1.4</a>):
7665
7666
7667
7668 <span class="grey">deBry, et al. Experimental [Page 137]</span></pre>
7669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-138" ></span>
7670 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7671
7672
7673 Name of proposer:
7674 Address of proposer:
7675 Email address of proposer:
7676
7677 Note: For type3 enums, the proposer will be the point of contact for
7678 the approved registration specification, if any maintenance of the
7679 registration specification is needed.
7680
7681 <span class="h3"><a class="selflink" id="section-11.5" href="#section-11.5">11.5</a> Attribute registration</span>
7682
7683 Type of registration: attribute
7684 Proposed keyword name of this attribute:
7685 Types of attribute (Operation, Job Template, Job Description,
7686 Printer Description):
7687 Operations to be used with if the attribute is an operation
7688 attribute:
7689 Object (Job, Printer, etc. if bound to an object):
7690 Attribute syntax(es) (include 1setOf and range as in <a href="#section-4.2">Section 4.2</a>):
7691 If attribute syntax is 'keyword' or 'enum', is it type2 or type3:
7692 If this is a Printer attribute, MAY the value returned depend on
7693 "document-format" (See <a href="#section-6.2">Section 6.2</a>):
7694 If this is a Job Template attribute, how does its specification
7695 depend on the value of the "multiple-document-handling" attribute:
7696 Specification of this attribute (follow the style of IPP Model
7697 <a href="#section-4.2">Section 4.2</a>):
7698 Name of proposer:
7699 Address of proposer:
7700 Email address of proposer:
7701
7702 Note: For attributes, the IPP Designated Expert will be the point of
7703 contact for the approved registration specification, if any
7704 maintenance of the registration specification is needed.
7705
7706 <span class="h3"><a class="selflink" id="section-11.6" href="#section-11.6">11.6</a> Attribute Syntax registration</span>
7707
7708 Type of registration: attribute syntax
7709 Proposed name of this attribute syntax:
7710 Type of attribute syntax (integer, octetString, character-string,
7711 see [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]):
7712 Numeric value (to be assigned by the IPP Designated Expert in
7713 consultation with IANA):
7714 Specification of this attribute (follow the style of IPP Model
7715 <a href="#section-4.1">Section 4.1</a>):
7716 Name of proposer:
7717 Address of proposer:
7718 Email address of proposer:
7719
7720
7721
7722
7723
7724 <span class="grey">deBry, et al. Experimental [Page 138]</span></pre>
7725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-139" ></span>
7726 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7727
7728
7729 Note: For attribute syntaxes, the IPP Designated Expert will be the
7730 point of contact for the approved registration specification, if any
7731 maintenance of the registration specification is needed.
7732
7733 <span class="h3"><a class="selflink" id="section-11.7" href="#section-11.7">11.7</a> Operation registration</span>
7734
7735 Type of registration: operation
7736 Proposed name of this operation:
7737 Numeric operation-id value (to be assigned by the IPP Designated
7738 Expert in consultation with IANA):
7739 Object Target (Job, Printer, etc. that operation is upon):
7740 Specification of this attribute (follow the style of IPP Model
7741 <a href="#section-3">Section 3</a>):
7742 Name of proposer:
7743 Address of proposer:
7744 Email address of proposer:
7745
7746 Note: For operations, the IPP Designated Expert will be the point of
7747 contact for the approved registration specification, if any
7748 maintenance of the registration specification is needed.
7749
7750 <span class="h3"><a class="selflink" id="section-11.8" href="#section-11.8">11.8</a> Attribute Group registration</span>
7751
7752 Type of registration: attribute group
7753 Proposed name of this attribute group:
7754 Numeric tag according to [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] (to be assigned by the IPP
7755 Designated Expert in consultation with IANA):
7756 Operation requests and group number for each operation in which the
7757 attribute group occurs:
7758 Operation responses and group number for each operation in which the
7759 attribute group occurs:
7760 Specification of this attribute group (follow the style of IPP Model
7761 <a href="#section-3">Section 3</a>):
7762 Name of proposer:
7763 Address of proposer:
7764 Email address of proposer:
7765
7766 Note: For attribute groups, the IPP Designated Expert will be the
7767 point of contact for the approved registration specification, if any
7768 maintenance of the registration specification is needed.
7769
7770 <span class="h3"><a class="selflink" id="section-11.9" href="#section-11.9">11.9</a> Status code registration</span>
7771
7772 Type of registration: status code
7773 Keyword symbolic name of this status code value:
7774 Numeric value (to be assigned by the IPP Designated Expert in
7775 consultation with IANA):
7776 Operations that this status code may be used with:
7777
7778
7779
7780 <span class="grey">deBry, et al. Experimental [Page 139]</span></pre>
7781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-140" ></span>
7782 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7783
7784
7785 Specification of this status code (follow the style of IPP Model
7786 <a href="#section-14">Section 14</a> APPENDIX B: Status Codes and Suggested Status Code
7787 Messages):
7788 Name of proposer:
7789 Address of proposer:
7790 Email address of proposer:
7791
7792 Note: For status codes, the Designated Expert will be the point of
7793 contact for the approved registration specification, if any
7794 maintenance of the registration specification is needed.
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836 <span class="grey">deBry, et al. Experimental [Page 140]</span></pre>
7837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-141" ></span>
7838 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7839
7840
7841 <span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. APPENDIX A: Terminology</span>
7842
7843 This specification uses the terminology defined in this section.
7844
7845 <span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a> Conformance Terminology</span>
7846
7847 The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT",
7848 "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
7849 interpreted as described in <a href="./rfc2119">RFC 2119</a> [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>].
7850
7851 <span class="h4"><a class="selflink" id="section-12.1.1" href="#section-12.1.1">12.1.1</a> NEED NOT</span>
7852
7853 This term is not included in <a href="./rfc2119">RFC 2119</a>. The verb "NEED NOT" indicates
7854 an action that the subject of the sentence does not have to implement
7855 in order to claim conformance to the standard. The verb "NEED NOT"
7856 is used instead of "MAY NOT" since "MAY NOT" sounds like a
7857 prohibition.
7858
7859 <span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a> Model Terminology</span>
7860
7861 <span class="h4"><a class="selflink" id="section-12.2.1" href="#section-12.2.1">12.2.1</a> Keyword</span>
7862
7863 Keywords are used within this document as identifiers of semantic
7864 entities within the abstract model (see <a href="#section-4.1.2.3">section 4.1.2.3</a>). Attribute
7865 names, some attribute values, attribute syntaxes, and attribute group
7866 names are represented as keywords.
7867
7868 <span class="h4"><a class="selflink" id="section-12.2.2" href="#section-12.2.2">12.2.2</a> Attributes</span>
7869
7870 An attribute is an item of information that is associated with an
7871 instance of an IPP object. An attribute consists of an attribute
7872 name and one or more attribute values. Each attribute has a specific
7873 attribute syntax. All object attributes are defined in <a href="#section-4">section 4</a> and
7874 all operation attributes are defined in <a href="#section-3">section 3</a>.
7875
7876 Job Template Attributes are described in <a href="#section-4.2">section 4.2</a>. The client
7877 optionally supplies Job Template attributes in a create request
7878 (operation requests that create Job objects). The Printer object has
7879 associated attributes which define supported and default values for
7880 the Printer.
7881
7882 <span class="h5"><a class="selflink" id="section-12.2.2.1" href="#section-12.2.2.1">12.2.2.1</a> Attribute Name</span>
7883
7884 Each attribute is uniquely identified in this document by its
7885 attribute name. An attribute name is a keyword. The keyword
7886 attribute name is given in the section header describing that
7887
7888
7889
7890
7891
7892 <span class="grey">deBry, et al. Experimental [Page 141]</span></pre>
7893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-142" ></span>
7894 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7895
7896
7897 attribute. In running text in this document, attribute names are
7898 indicated inside double quotation marks (") where the quotation marks
7899 are not part of the keyword itself.
7900
7901 <span class="h5"><a class="selflink" id="section-12.2.2.2" href="#section-12.2.2.2">12.2.2.2</a> Attribute Group Name</span>
7902
7903 Related attributes are grouped into named groups. The name of the
7904 group is a keyword. The group name may be used in place of naming
7905 all the attributes in the group explicitly. Attribute groups are
7906 defined in <a href="#section-3">section 3</a>.
7907
7908 <span class="h5"><a class="selflink" id="section-12.2.2.3" href="#section-12.2.2.3">12.2.2.3</a> Attribute Value</span>
7909
7910 Each attribute has one or more values. Attribute values are
7911 represented in the syntax type specified for that attribute. In
7912 running text in this document, attribute values are indicated inside
7913 single quotation marks ('), whether their attribute syntax is
7914 keyword, integer, text, etc. where the quotation marks are not part
7915 of the value itself.
7916
7917 <span class="h5"><a class="selflink" id="section-12.2.2.4" href="#section-12.2.2.4">12.2.2.4</a> Attribute Syntax</span>
7918
7919 Each attribute is defined using an explicit syntax type. In this
7920 document, each syntax type is defined as a keyword with specific
7921 meaning. The Encoding and Transport document [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>] indicates the
7922 actual "on-the-wire" encoding rules for each syntax type. Attribute
7923 syntax types are defined in <a href="#section-4.1">section 4.1</a>.
7924
7925 <span class="h4"><a class="selflink" id="section-12.2.3" href="#section-12.2.3">12.2.3</a> Supports</span>
7926
7927 By definition, a Printer object supports an attribute only if that
7928 Printer object responds with the corresponding attribute populated
7929 with some value(s) in a response to a query for that attribute. A
7930 Printer object supports an attribute value if the value is one of the
7931 Printer object's "supported values" attributes. The device behind a
7932 Printer object may exhibit a behavior that corresponds to some IPP
7933 attribute, but if the Printer object, when queried for that
7934 attribute, doesn't respond with the attribute, then as far as IPP is
7935 concerned, that implementation does not support that feature. If the
7936 Printer object's "xxx-supported" attribute is not populated with a
7937 particular value (even if that value is a legal value for that
7938 attribute), then that Printer object does not support that particular
7939 value.
7940
7941 A conforming implementation MUST support all REQUIRED attributes.
7942 However, even for REQUIRED attributes, conformance to IPP does not
7943 mandate that all implementations support all possible values
7944 representing all possible job processing behaviors and features. For
7945
7946
7947
7948 <span class="grey">deBry, et al. Experimental [Page 142]</span></pre>
7949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-143" ></span>
7950 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
7951
7952
7953 example, if a given instance of a Printer supports only certain
7954 document formats, then that Printer responds with the "document-
7955 format-supported" attribute populated with a set of values, possibly
7956 only one, taken from the entire set of possible values defined for
7957 that attribute. This limited set of values represents the Printer's
7958 set of supported document formats. Supporting an attribute and some
7959 set of values for that attribute enables IPP end users to be aware of
7960 and make use of those features associated with that attribute and
7961 those values. If an implementation chooses to not support an
7962 attribute or some specific value, then IPP end users would have no
7963 ability to make use of that feature within the context of IPP itself.
7964 However, due to existing practice and legacy systems which are not
7965 IPP aware, there might be some other mechanism outside the scope of
7966 IPP to control or request the "unsupported" feature (such as embedded
7967 instructions within the document data itself).
7968
7969 For example, consider the "finishings-supported" attribute.
7970
7971 1) If a Printer object is not physically capable of stapling, the
7972 "finishings-supported" attribute MUST NOT be populated with the
7973 value of 'staple'.
7974 2) A Printer object is physically capable of stapling, however an
7975 implementation chooses not to support stapling in the IPP
7976 "finishings" attribute. In this case, 'staple' MUST NOT be a
7977 value in the "finishings-supported" Printer object attribute.
7978 Without support for the value 'staple', an IPP end user would
7979 have no means within the protocol itself to request that a Job
7980 be stapled. However, an existing document data formatter might
7981 be able to request that the document be stapled directly with an
7982 embedded instruction within the document data. In this case,
7983 the IPP implementation does not "support" stapling, however the
7984 end user is still able to have some control over the stapling of
7985 the completed job.
7986 3) A Printer object is physically capable of stapling, and an
7987 implementation chooses to support stapling in the IPP
7988 "finishings" attribute. In this case, 'staple' MUST be a value
7989 in the "finishings-supported" Printer object attribute. Doing
7990 so, would enable end users to be aware of and make use of the
7991 stapling feature using IPP attributes.
7992
7993 Even though support for Job Template attributes by a Printer object
7994 is OPTIONAL, it is RECOMMENDED that if the device behind a Printer
7995 object is capable of realizing any feature or function that
7996 corresponds to an IPP attribute and some associated value, then that
7997 implementation SHOULD support that IPP attribute and value.
7998
7999
8000
8001
8002
8003
8004 <span class="grey">deBry, et al. Experimental [Page 143]</span></pre>
8005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-144" ></span>
8006 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8007
8008
8009 The set of values in any of the supported value attributes is set
8010 (populated) by some administrative process or automatic sensing
8011 mechanism that is outside the scope of IPP. For administrative
8012 policy and control reasons, an administrator may choose to make only
8013 a subset of possible values visible to the end user. In this case,
8014 the real output device behind the IPP Printer abstraction may be
8015 capable of a certain feature, however an administrator is specifying
8016 that access to that feature not be exposed to the end user through
8017 the IPP protocol. Also, since a Printer object may represent a
8018 logical print device (not just a physical device) the actual process
8019 for supporting a value is undefined and left up to the
8020 implementation. However, if a Printer object supports a value, some
8021 manual human action may be needed to realize the semantic action
8022 associated with the value, but no end user action is required.
8023
8024 For example, if one of the values in the "finishings-supported"
8025 attribute is 'staple', the actual process might be an automatic
8026 staple action by a physical device controlled by some command sent to
8027 the device. Or, the actual process of stapling might be a manual
8028 action by an operator at an operator attended Printer object.
8029
8030 For another example of how supported attributes function, consider a
8031 system administrator who desires to control all print jobs so that no
8032 job sheets are printed in order to conserve paper. To force no job
8033 sheets, the system administrator sets the only supported value for
8034 the "job-sheets-supported" attribute to 'none'. In this case, if a
8035 client requests anything except 'none', the create request is
8036 rejected or the "job-sheets" value is ignored (depending on the value
8037 of "ipp-attribute-fidelity"). To force the use of job start/end
8038 sheets on all jobs, the administrator does not include the value '
8039 none' in the "job-sheets-supported" attribute. In this case, if a
8040 client requests 'none', the create request is rejected or the "job-
8041 sheets" value is ignored (again depending on the value of "ipp-
8042 attribute-fidelity").
8043
8044 <span class="h4"><a class="selflink" id="section-12.2.4" href="#section-12.2.4">12.2.4</a> print-stream page</span>
8045
8046 A "print-stream page" is a page according to the definition of pages
8047 in the language used to express the document data.
8048
8049 <span class="h4"><a class="selflink" id="section-12.2.5" href="#section-12.2.5">12.2.5</a> impression</span>
8050
8051 An "impression" is the image (possibly many print-stream pages in
8052 different configurations) imposed onto a single media page.
8053
8054
8055
8056
8057
8058
8059
8060 <span class="grey">deBry, et al. Experimental [Page 144]</span></pre>
8061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-145" ></span>
8062 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8063
8064
8065 <span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. APPENDIX B: </span>Status Codes and Suggested Status Code Messages
8066
8067 This section defines status code enum keywords and values that are
8068 used to provide semantic information on the results of an operation
8069 request. Each operation response MUST include a status code. The
8070 response MAY also contain a status message that provides a short
8071 textual description of the status. The status code is intended for
8072 use by automata, and the status message is intended for the human end
8073 user. Since the status message is an OPTIONAL component of the
8074 operation response, an IPP application (i.e., a browser, GUI, print
8075 driver or gateway) is NOT REQUIRED to examine or display the status
8076 message, since it MAY not be returned to the application.
8077
8078 The prefix of the status keyword defines the class of response as
8079 follows:
8080
8081 "informational" - Request received, continuing process
8082 "successful" - The action was successfully received, understood,
8083 and accepted
8084 "redirection" - Further action must be taken in order to complete
8085 the request
8086 "client-error" - The request contains bad syntax or cannot be
8087 fulfilled
8088 "server-error" - The IPP object failed to fulfill an apparently
8089 valid request
8090
8091 As with type2 enums, IPP status codes are extensible. IPP clients
8092 are NOT REQUIRED to understand the meaning of all registered status
8093 codes, though such understanding is obviously desirable. However,
8094 IPP clients MUST understand the class of any status code, as
8095 indicated by the prefix, and treat any unrecognized response as being
8096 equivalent to the first status code of that class, with the exception
8097 that an unrecognized response MUST NOT be cached. For example, if an
8098 unrecognized status code of "client-error-xxx-yyy" is received by the
8099 client, it can safely assume that there was something wrong with its
8100 request and treat the response as if it had received a "client-
8101 error-bad-request" status code. In such cases, IPP applications
8102 SHOULD present the OPTIONAL message (if present) to the end user
8103 since the message is likely to contain human readable information
8104 which will help to explain the unusual status. The name of the enum
8105 is the suggested status message for US English.
8106
8107 The status code values range from 0x0000 to 0x7FFF. The value ranges
8108 for each status code class are as follows:
8109
8110 "successful" - 0x0000 to 0x00FF
8111 "informational" - 0x0100 to 0x01FF
8112 "redirection" - 0x0200 to 0x02FF
8113
8114
8115
8116 <span class="grey">deBry, et al. Experimental [Page 145]</span></pre>
8117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-146" ></span>
8118 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8119
8120
8121 "client-error" - 0x0400 to 0x04FF
8122 "server-error" - 0x0500 to 0x05FF
8123
8124 The top half (128 values) of each range (0x0n40 to 0x0nFF, for n = 0
8125 to 5) is reserved for private use within each status code class.
8126 Values 0x0600 to 0x7FFF are reserved for future assignment and MUST
8127 NOT be used.
8128
8129 <span class="h3"><a class="selflink" id="section-13.1" href="#section-13.1">13.1</a> Status Codes</span>
8130
8131 Each status code is described below. <a href="#section-13.1.5.9">Section 13.1.5.9</a> contains a
8132 table that indicates which status codes apply to which operations.
8133 The Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>] describe the suggested steps for
8134 processing IPP attributes for all operations, including returning
8135 status codes.
8136
8137 <span class="h4"><a class="selflink" id="section-13.1.1" href="#section-13.1.1">13.1.1</a> Informational</span>
8138
8139 This class of status code indicates a provisional response and is to
8140 be used for informational purposes only.
8141
8142 There are no status codes defined in IPP/1.0 for this class of status
8143 code.
8144
8145 <span class="h4"><a class="selflink" id="section-13.1.2" href="#section-13.1.2">13.1.2</a> Successful Status Codes</span>
8146
8147 This class of status code indicates that the client's request was
8148 successfully received, understood, and accepted.
8149
8150 <span class="h5"><a class="selflink" id="section-13.1.2.1" href="#section-13.1.2.1">13.1.2.1</a> successful-ok (0x0000)</span>
8151
8152 The request has succeeded and no request attributes were substituted
8153 or ignored. In the case of a response to a create request, the '
8154 successful-ok' status code indicates that the request was
8155 successfully received and validated, and that the Job object has been
8156 created; it does not indicate that the job has been processed. The
8157 transition of the Job object into the 'completed' state is the only
8158 indicator that the job has been printed.
8159
8160 <span class="h5"><a class="selflink" id="section-13.1.2.2" href="#section-13.1.2.2">13.1.2.2</a> successful-ok-ignored-or-substituted-attributes (0x0001)</span>
8161
8162 The request has succeeded, but some supplied (1) attributes were
8163 ignored or (2) unsupported values were substituted with supported
8164 values or were ignored in order to perform the operation without
8165 rejecting it. Unsupported attributes, attribute syntaxes, or values
8166 MUST be returned in the Unsupported Attributes group of the response
8167 for all operations. There is an exception to this rule for the query
8168 operations: Get-Printer-Attributes, Get-Jobs, and Get-Job-Attributes
8169
8170
8171
8172 <span class="grey">deBry, et al. Experimental [Page 146]</span></pre>
8173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-147" ></span>
8174 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8175
8176
8177 for the "requested-attributes" operation attribute only. When the
8178 supplied values of the "requested-attributes" operation attribute are
8179 requesting attributes that are not supported, the IPP object MAY, but
8180 is NOT REQUIRED to, return the "requested-attributes" attribute in
8181 the Unsupported Attribute response group (with the unsupported values
8182 only). See <a href="#section-3.2.1.2">section 3.2.1.2</a>.
8183
8184 <span class="h5"><a class="selflink" id="section-13.1.2.3" href="#section-13.1.2.3">13.1.2.3</a> successful-ok-conflicting-attributes (0x0002)</span>
8185
8186 The request has succeeded, but some supplied attribute values
8187 conflicted with the values of other supplied attributes. These
8188 conflicting values were either (1) substituted with (supported)
8189 values or (2) the attributes were removed in order to process the job
8190 without rejecting it. Attributes or values which conflict with other
8191 attributes and have been substituted or ignored MUST be returned in
8192 the Unsupported Attributes group of the response for all operations
8193 as supplied by the client. See <a href="#section-3.2.1.2">section 3.2.1.2</a>.
8194
8195 <span class="h4"><a class="selflink" id="section-13.1.3" href="#section-13.1.3">13.1.3</a> Redirection Status Codes</span>
8196
8197 This class of status code indicates that further action needs to be
8198 taken to fulfill the request.
8199
8200 There are no status codes defined in IPP/1.0 for this class of status
8201 code.
8202
8203 <span class="h4"><a class="selflink" id="section-13.1.4" href="#section-13.1.4">13.1.4</a> Client Error Status Codes</span>
8204
8205 This class of status code is intended for cases in which the client
8206 seems to have erred. The IPP object SHOULD return a message
8207 containing an explanation of the error situation and whether it is a
8208 temporary or permanent condition.
8209
8210 <span class="h5"><a class="selflink" id="section-13.1.4.1" href="#section-13.1.4.1">13.1.4.1</a> client-error-bad-request (0x0400)</span>
8211
8212 The request could not be understood by the IPP object due to
8213 malformed syntax (such as the value of a fixed length attribute whose
8214 length does not match the prescribed length for that attribute - see
8215 the Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>] ). The IPP application SHOULD NOT
8216 repeat the request without modifications.
8217
8218 <span class="h5"><a class="selflink" id="section-13.1.4.2" href="#section-13.1.4.2">13.1.4.2</a> client-error-forbidden (0x0401)</span>
8219
8220 The IPP object understood the request, but is refusing to fulfill it.
8221 Additional authentication information or authorization credentials
8222 will not help and the request SHOULD NOT be repeated. This status
8223
8224
8225
8226
8227
8228 <span class="grey">deBry, et al. Experimental [Page 147]</span></pre>
8229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-148" ></span>
8230 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8231
8232
8233 code is commonly used when the IPP object does not wish to reveal
8234 exactly why the request has been refused or when no other response is
8235 applicable.
8236
8237 <span class="h5"><a class="selflink" id="section-13.1.4.3" href="#section-13.1.4.3">13.1.4.3</a> client-error-not-authenticated (0x0402)</span>
8238
8239 The request requires user authentication. The IPP client may repeat
8240 the request with suitable authentication information. If the request
8241 already included authentication information, then this status code
8242 indicates that authorization has been refused for those credentials.
8243 If this response contains the same challenge as the prior response,
8244 and the user agent has already attempted authentication at least
8245 once, then the response message may contain relevant diagnostic
8246 information. This status codes reveals more information than
8247 "client-error-forbidden".
8248
8249 <span class="h5"><a class="selflink" id="section-13.1.4.4" href="#section-13.1.4.4">13.1.4.4</a> client-error-not-authorized (0x0403)</span>
8250
8251 The requester is not authorized to perform the request. Additional
8252 authentication information or authorization credentials will not help
8253 and the request SHOULD NOT be repeated. This status code is used
8254 when the IPP object wishes to reveal that the authentication
8255 information is understandable, however, the requester is explicitly
8256 not authorized to perform the request. This status codes reveals
8257 more information than "client-error-forbidden" and "client-error-
8258 not-authenticated".
8259
8260 <span class="h5"><a class="selflink" id="section-13.1.4.5" href="#section-13.1.4.5">13.1.4.5</a> client-error-not-possible (0x0404)</span>
8261
8262 This status code is used when the request is for something that can
8263 not happen. For example, there might be a request to cancel a job
8264 that has already been canceled or aborted by the system. The IPP
8265 client SHOULD NOT repeat the request.
8266
8267 <span class="h5"><a class="selflink" id="section-13.1.4.6" href="#section-13.1.4.6">13.1.4.6</a> client-error-timeout (0x0405)</span>
8268
8269 The client did not produce a request within the time that the IPP
8270 object was prepared to wait. For example, a client issued a Create-
8271 Job operation and then, after a long period of time, issued a Send-
8272 Document operation and this error status code was returned in
8273 response to the Send-Document request (see <a href="#section-3.3.1">section 3.3.1</a>). The IPP
8274 object might have been forced to clean up resources that had been
8275 held for the waiting additional Documents. The IPP object was forced
8276 to close the Job since the client took too long. The client SHOULD
8277 NOT repeat the request without modifications.
8278
8279
8280
8281
8282
8283
8284 <span class="grey">deBry, et al. Experimental [Page 148]</span></pre>
8285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-149" ></span>
8286 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8287
8288
8289 <span class="h5"><a class="selflink" id="section-13.1.4.7" href="#section-13.1.4.7">13.1.4.7</a> client-error-not-found (0x0406)</span>
8290
8291 The IPP object has not found anything matching the request URI. No
8292 indication is given of whether the condition is temporary or
8293 permanent. For example, a client with an old reference to a Job (a
8294 URI) tries to cancel the Job, however in the mean time the Job might
8295 have been completed and all record of it at the Printer has been
8296 deleted. This status code, 'client-error-not-found' is returned
8297 indicating that the referenced Job can not be found. This error
8298 status code is also used when a client supplies a URI as a reference
8299 to the document data in either a Print-URI or Send-URI operation, but
8300 the document can not be found.
8301
8302 In practice, an IPP application should avoid a not found situation by
8303 first querying and presenting a list of valid Printer URIs and Job
8304 URIs to the end-user.
8305
8306 <span class="h5"><a class="selflink" id="section-13.1.4.8" href="#section-13.1.4.8">13.1.4.8</a> client-error-gone (0x0407)</span>
8307
8308 The requested object is no longer available and no forwarding address
8309 is known. This condition should be considered permanent. Clients
8310 with link editing capabilities should delete references to the
8311 request URI after user approval. If the IPP object does not know or
8312 has no facility to determine, whether or not the condition is
8313 permanent, the status code "client-error-not-found" should be used
8314 instead.
8315
8316 This response is primarily intended to assist the task of maintenance
8317 by notifying the recipient that the resource is intentionally
8318 unavailable and that the IPP object administrator desires that remote
8319 links to that resource be removed. It is not necessary to mark all
8320 permanently unavailable resources as "gone" or to keep the mark for
8321 any length of time -- that is left to the discretion of the IPP
8322 object administrator.
8323
8324 <span class="h5"><a class="selflink" id="section-13.1.4.9" href="#section-13.1.4.9">13.1.4.9</a> client-error-request-entity-too-large (0x0408)</span>
8325
8326 The IPP object is refusing to process a request because the request
8327 entity is larger than the IPP object is willing or able to process.
8328 An IPP Printer returns this status code when it limits the size of
8329 print jobs and it receives a print job that exceeds that limit or
8330 when the attributes are so many that their encoding causes the
8331 request entity to exceed IPP object capacity.
8332
8333
8334
8335
8336
8337
8338
8339
8340 <span class="grey">deBry, et al. Experimental [Page 149]</span></pre>
8341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-150" ></span>
8342 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8343
8344
8345 <span class="h5"><a class="selflink" id="section-13.1.4.10" href="#section-13.1.4.10">13.1.4.10</a> client-error-request-value-too-long (0x0409)</span>
8346
8347 The IPP object is refusing to service the request because one or more
8348 of the client-supplied attributes has a variable length value that is
8349 longer than the maximum length specified for that attribute. The IPP
8350 object might not have sufficient resources (memory, buffers, etc.) to
8351 process (even temporarily), interpret, and/or ignore a value larger
8352 than the maximum length. Another use of this error code is when the
8353 IPP object supports the processing of a large value that is less than
8354 the maximum length, but during the processing of the request as a
8355 whole, the object may pass the value onto some other system component
8356 which is not able to accept the large value. For more details, see
8357 the Implementer's Guide [<a href="#ref-ipp-iig" title="&quot;Internet Printing Protocol/1.0: Implementer's Guide&quot;">ipp-iig</a>] .
8358
8359 Note: For attribute values that are URIs, this rare condition is
8360 only likely to occur when a client has improperly submitted a request
8361 with long query information (e.g. an IPP application allows an end-
8362 user to enter an invalid URI), when the client has descended into a
8363 URI "black hole" of redirection (e.g., a redirected URI prefix that
8364 points to a suffix of itself), or when the IPP object is under attack
8365 by a client attempting to exploit security holes present in some IPP
8366 objects using fixed-length buffers for reading or manipulating the
8367 Request-URI.
8368
8369 <span class="h5"><a class="selflink" id="section-13.1.4.11" href="#section-13.1.4.11">13.1.4.11</a> client-error-document-format-not-supported (0x040A)</span>
8370
8371 The IPP object is refusing to service the request because the
8372 document data is in a format, as specified in the "document-format"
8373 operation attribute, that is not supported by the Printer object.
8374 This error is returned independent of the client-supplied "ipp-
8375 attribute-fidelity". The Printer object MUST return this status
8376 code, even if there are other attributes that are not supported as
8377 well, since this error is a bigger problem than with Job Template
8378 attributes.
8379
8380 <span class="h5"><a class="selflink" id="section-13.1.4.12" href="#section-13.1.4.12">13.1.4.12</a> client-error-attributes-or-values-not-supported (0x040B)</span>
8381
8382 In a create request, if the Printer object does not support one or
8383 more attributes, attribute syntaxes, or attribute values supplied in
8384 the request and the client supplied the "ipp-attributes-fidelity"
8385 operation attribute with the 'true' value, the Printer object MUST
8386 return this status code. For example, if the request indicates '
8387 iso-a4' media, but that media type is not supported by the Printer
8388 object. Or, if the client supplies an optional attribute and the
8389 attribute itself is not even supported by the Printer. If the "ipp-
8390 attribute-fidelity" attribute is 'false', the Printer MUST ignore or
8391 substitute values for unsupported attributes and values rather than
8392 reject the request and return this status code.
8393
8394
8395
8396 <span class="grey">deBry, et al. Experimental [Page 150]</span></pre>
8397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-151" ></span>
8398 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8399
8400
8401 For any operation where a client requests attributes (such as a Get-
8402 Jobs, Get-Printer-Attributes, or Get-Job-Attributes operation), if
8403 the IPP object does not support one or more of the requested
8404 attributes, the IPP object simply ignores the unsupported requested
8405 attributes and processes the request as if they had not been
8406 supplied, rather than returning this status code. In this case, the
8407 IPP object MUST return the 'successful-ok-ignored-or-substituted-
8408 attributes' status code and MAY return the unsupported attributes as
8409 values of the "requested-attributes" in the Unsupported Attributes
8410 Group (see <a href="#section-13.1.2.2">section 13.1.2.2</a>).
8411
8412 <span class="h5"><a class="selflink" id="section-13.1.4.13" href="#section-13.1.4.13">13.1.4.13</a> client-error-uri-scheme-not-supported (0x040C)</span>
8413
8414 The type of the client supplied URI in a Print-URI or a Send-URI
8415 operation is not supported.
8416
8417 <span class="h5"><a class="selflink" id="section-13.1.4.14" href="#section-13.1.4.14">13.1.4.14</a> client-error-charset-not-supported (0x040D)</span>
8418
8419 For any operation, if the IPP Printer does not support the charset
8420 supplied by the client in the "attributes-charset" operation
8421 attribute, the Printer MUST reject the operation and return this
8422 status and any 'text' or 'name' attributes using the 'utf-8' charset
8423 (see <a href="#section-3.1.4.1">Section 3.1.4.1</a>).
8424
8425 <span class="h5"><a class="selflink" id="section-13.1.4.15" href="#section-13.1.4.15">13.1.4.15</a> client-error-conflicting-attributes (0x040E)</span>
8426
8427 The request is rejected because some attribute values conflicted with
8428 the values of other attributes which this specification does not
8429 permit to be substituted or ignored.
8430
8431 <span class="h4"><a class="selflink" id="section-13.1.5" href="#section-13.1.5">13.1.5</a> Server Error Status Codes</span>
8432
8433 This class of status codes indicates cases in which the IPP object is
8434 aware that it has erred or is incapable of performing the request.
8435 The IPP object SHOULD include a message containing an explanation of
8436 the error situation, and whether it is a temporary or permanent
8437 condition.
8438
8439 <span class="h5"><a class="selflink" id="section-13.1.5.1" href="#section-13.1.5.1">13.1.5.1</a> server-error-internal-error (0x0500)</span>
8440
8441 The IPP object encountered an unexpected condition that prevented it
8442 from fulfilling the request. This error status code differs from
8443 "server-error-temporary-error" in that it implies a more permanent
8444 type of internal error. It also differs from "server-error-device-
8445 error" in that it implies an unexpected condition (unlike a paper-jam
8446 or out-of-toner problem which is undesirable but expected). This
8447 error status code indicates that probably some knowledgeable human
8448 intervention is required.
8449
8450
8451
8452 <span class="grey">deBry, et al. Experimental [Page 151]</span></pre>
8453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-152" ></span>
8454 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8455
8456
8457 <span class="h5"><a class="selflink" id="section-13.1.5.2" href="#section-13.1.5.2">13.1.5.2</a> server-error-operation-not-supported (0x0501)</span>
8458
8459 The IPP object does not support the functionality required to fulfill
8460 the request. This is the appropriate response when the IPP object
8461 does not recognize an operation or is not capable of supporting it.
8462
8463 <span class="h5"><a class="selflink" id="section-13.1.5.3" href="#section-13.1.5.3">13.1.5.3</a> server-error-service-unavailable (0x0502)</span>
8464
8465 The IPP object is currently unable to handle the request due to a
8466 temporary overloading or maintenance of the IPP object. The
8467 implication is that this is a temporary condition which will be
8468 alleviated after some delay. If known, the length of the delay may be
8469 indicated in the message. If no delay is given, the IPP application
8470 should handle the response as it would for a "server-error-
8471 temporary-error" response. If the condition is more permanent, the
8472 error status codes "client-error-gone" or "client-error-not-found"
8473 could be used.
8474
8475 <span class="h5"><a class="selflink" id="section-13.1.5.4" href="#section-13.1.5.4">13.1.5.4</a> server-error-version-not-supported (0x0503)</span>
8476
8477 The IPP object does not support, or refuses to support, the IPP
8478 protocol version that was used in the request message. The IPP
8479 object is indicating that it is unable or unwilling to complete the
8480 request using the same version as supplied in the request other than
8481 with this error message. The response should contain a Message
8482 describing why that version is not supported and what other versions
8483 are supported by that IPP object.
8484
8485 A conforming IPP/1.0 client MUST specify the valid version ('1.0') on
8486 each request. A conforming IPP/1.0 object MUST NOT return this
8487 status code to a conforming IPP/1.0 client. An IPP object MUST
8488 return this status code to a non-conforming IPP client. The response
8489 MUST identify in the "version-number" operation attribute the closest
8490 version number that the IPP object does support.
8491
8492 <span class="h5"><a class="selflink" id="section-13.1.5.5" href="#section-13.1.5.5">13.1.5.5</a> server-error-device-error (0x0504)</span>
8493
8494 A printer error, such as a paper jam, occurs while the IPP object
8495 processes a Print or Send operation. The response contains the true
8496 Job Status (the values of the "job-state" and "job-state-reasons"
8497 attributes). Additional information can be returned in the optional
8498 "job-state-message" attribute value or in the OPTIONAL status message
8499 that describes the error in more detail. This error status code is
8500 only returned in situations where the Printer is unable to accept the
8501 create request because of such a device error. For example, if the
8502 Printer is unable to spool, and can only accept one job at a time,
8503 the reason it might reject a create request is that the printer
8504 currently has a paper jam. In many cases however, where the Printer
8505
8506
8507
8508 <span class="grey">deBry, et al. Experimental [Page 152]</span></pre>
8509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-153" ></span>
8510 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8511
8512
8513 object can accept the request even though the Printer has some error
8514 condition, the 'successful-ok' status code will be returned. In such
8515 a case, the client would look at the returned Job Object Attributes
8516 or later query the Printer to determine its state and state reasons.
8517
8518 <span class="h5"><a class="selflink" id="section-13.1.5.6" href="#section-13.1.5.6">13.1.5.6</a> server-error-temporary-error (0x0505)</span>
8519
8520 A temporary error such as a buffer full write error, a memory
8521 overflow (i.e. the document data exceeds the memory of the Printer),
8522 or a disk full condition, occurs while the IPP Printer processes an
8523 operation. The client MAY try the unmodified request again at some
8524 later point in time with an expectation that the temporary internal
8525 error condition may have been cleared. Alternatively, as an
8526 implementation option, a Printer object MAY delay the response until
8527 the temporary condition is cleared so that no error is returned.
8528
8529 <span class="h5"><a class="selflink" id="section-13.1.5.7" href="#section-13.1.5.7">13.1.5.7</a> server-error-not-accepting-jobs (0x0506)</span>
8530
8531 A temporary error indicating that the Printer is not currently
8532 accepting jobs, because the administrator has set the value of the
8533 Printer's "printer-is-not-accepting-jobs" attribute to 'false' (by
8534 means outside of IPP/1.0).
8535
8536 <span class="h5"><a class="selflink" id="section-13.1.5.8" href="#section-13.1.5.8">13.1.5.8</a> server-error-busy (0x0507)</span>
8537
8538 A temporary error indicating that the Printer is too busy processing
8539 jobs and/or other requests. The client SHOULD try the unmodified
8540 request again at some later point in time with an expectation that
8541 the temporary busy condition will have been cleared.
8542
8543 <span class="h5"><a class="selflink" id="section-13.1.5.9" href="#section-13.1.5.9">13.1.5.9</a> server-error-job-canceled (0x0508)</span>
8544
8545 An error indicating that the job has been canceled by an operator or
8546 the system while the client was transmitting the data to the IPP
8547 Printer. If a job-id and job-uri had been created, then they are
8548 returned in the Print-Job, Send-Document, or Send-URI response as
8549 usual; otherwise, no job-id and job-uri are returned in the response.
8550
8551 <span class="h3"><a class="selflink" id="section-13.2" href="#section-13.2">13.2</a> Status Codes for IPP Operations</span>
8552
8553 PJ = Print-Job, PU = Print-URI, CJ = Create-Job, SD = Send-Document
8554 SU = Send-URI, V = Validate-Job, GA = Get-Job-Attributes and
8555 Get-Printer-Attributes, GJ = Get-Jobs, C = Cancel-Job
8556
8557
8558
8559
8560
8561
8562
8563
8564 <span class="grey">deBry, et al. Experimental [Page 153]</span></pre>
8565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-154" ></span>
8566 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8567
8568
8569 IPP Operations
8570 IPP Status Keyword PJ PU CJ SD SU V GA GJ C
8571 ------------------ -- -- -- -- -- - -- -- -
8572 successful-ok x x x x x x x x x
8573 successful-ok-ignored-or-substituted- x x x x x x x x x
8574 attributes
8575 successful-ok-conflicting-attributes x x x x x x x x x
8576 client-error-bad-request x x x x x x x x x
8577 client-error-forbidden x x x x x x x x x
8578 client-error-not-authenticated x x x x x x x x x
8579 client-error-not-authorized x x x x x x x x x
8580 client-error-not-possible x x x x x x x x x
8581 client-error-timeout x x
8582 client-error-not-found x x x x x x x x x
8583 client-error-gone x x x x x x x x x
8584 client-error-request-entity-too-large x x x x x x x x x
8585 client-error-request-value-too-long x x x x x x x x x
8586 client-error-document-format-not- x x x x x x
8587 supported
8588 client-error-attributes-or-values-not- x x x x x x x x x
8589 supported
8590 client-error-uri-scheme-not-supported x x
8591 client-error-charset-not-supported x x x x x x x x x
8592 client-error-conflicting-attributes x x x x x x x x x
8593 server-error-internal-error x x x x x x x x x
8594 server-error-operation-not-supported x x x x
8595 server-error-service-unavailable x x x x x x x x x
8596 server-error-version-not-supported x x x x x x x x x
8597 server-error-device-error x x x x x
8598 server-error-temporary-error x x x x x
8599 server-error-not-accepting-jobs x x x x
8600 server-error-busy x x x x x x x x x
8601 server-error-job-canceled x x
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620 <span class="grey">deBry, et al. Experimental [Page 154]</span></pre>
8621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-155" ></span>
8622 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8623
8624
8625 <span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. APPENDIX C: </span>"media" keyword values
8626
8627 Standard keyword values are taken from several sources.
8628
8629 Standard values are defined (taken from DPA[ISO10175] and the Printer
8630 MIB[RFC1759]):
8631
8632 'default': The default medium for the output device
8633 'iso-a4-white': Specifies the ISO A4 white medium
8634 'iso-a4-colored': Specifies the ISO A4 colored medium
8635 'iso-a4-transparent' Specifies the ISO A4 transparent medium
8636 'iso-a3-white': Specifies the ISO A3 white medium
8637 'iso-a3-colored': Specifies the ISO A3 colored medium
8638 'iso-a5-white': Specifies the ISO A5 white medium
8639 'iso-a5-colored': Specifies the ISO A5 colored medium
8640 'iso-b4-white': Specifies the ISO B4 white medium
8641 'iso-b4-colored': Specifies the ISO B4 colored medium
8642 'iso-b5-white': Specifies the ISO B5 white medium
8643 'iso-b5-colored': Specifies the ISO B5 colored medium
8644 'jis-b4-white': Specifies the JIS B4 white medium
8645 'jis-b4-colored': Specifies the JIS B4 colored medium
8646 'jis-b5-white': Specifies the JIS B5 white medium
8647 'jis-b5-colored': Specifies the JIS B5 colored medium
8648
8649 The following standard values are defined for North American media:
8650
8651 'na-letter-white': Specifies the North American letter white medium
8652 'na-letter-colored': Specifies the North American letter colored
8653 medium
8654 'na-letter-transparent': Specifies the North American letter
8655 transparent medium
8656 'na-legal-white': Specifies the North American legal white medium
8657 'na-legal-colored': Specifies the North American legal colored
8658 medium
8659
8660 The following standard values are defined for envelopes:
8661
8662 'iso-b4-envelope': Specifies the ISO B4 envelope medium
8663 'iso-b5-envelope': Specifies the ISO B5 envelope medium
8664 'iso-c3-envelope': Specifies the ISO C3 envelope medium
8665 'iso-c4-envelope': Specifies the ISO C4 envelope medium
8666 'iso-c5-envelope': Specifies the ISO C5 envelope medium
8667 'iso-c6-envelope': Specifies the ISO C6 envelope medium
8668 'iso-designated-long-envelope': Specifies the ISO Designated Long
8669 envelope medium
8670 'na-10x13-envelope': Specifies the North American 10x13 envelope
8671 medium
8672
8673
8674
8675
8676 <span class="grey">deBry, et al. Experimental [Page 155]</span></pre>
8677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-156" ></span>
8678 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8679
8680
8681 'na-9x12-envelope': Specifies the North American 9x12 envelope
8682 medium
8683 'monarch-envelope': Specifies the Monarch envelope
8684 'na-number-10-envelope': Specifies the North American number 10
8685 business envelope medium
8686 'na-7x9-envelope': Specifies the North American 7x9 inch envelope
8687 'na-9x11-envelope': Specifies the North American 9x11 inch envelope
8688 'na-10x14-envelope': Specifies the North American 10x14 inch
8689 envelope
8690 'na-number-9-envelope': Specifies the North American number 9
8691 business envelope
8692 'na-6x9-envelope': Specifies the North American 6x9 inch envelope
8693 'na-10x15-envelope': Specifies the North American 10x15 inch
8694 envelope
8695
8696 The following standard values are defined for the less commonly used
8697 media (white-only):
8698
8699 'executive-white': Specifies the white executive medium
8700 'folio-white': Specifies the folio white medium
8701 'invoice-white': Specifies the white invoice medium
8702 'ledger-white': Specifies the white ledger medium
8703 'quarto-white': Specified the white quarto medium
8704 'iso-a0-white': Specifies the ISO A0 white medium
8705 'iso-a1-white': Specifies the ISO A1 white medium
8706 'iso-a2-white': Specifies the ISO A2 white medium
8707 'iso-a6-white': Specifies the ISO A6 white medium
8708 'iso-a7-white': Specifies the ISO A7 white medium
8709 'iso-a8-white': Specifies the ISO A8 white medium
8710 'iso-a9-white': Specifies the ISO A9 white medium
8711 'iso-10-white': Specifies the ISO A10 white medium
8712 'iso-b0-white': Specifies the ISO B0 white medium
8713 'iso-b1-white': Specifies the ISO B1 white medium
8714 'iso-b2-white': Specifies the ISO B2 white medium
8715 'iso-b3-white': Specifies the ISO B3 white medium
8716 'iso-b6-white': Specifies the ISO B6 white medium
8717 'iso-b7-white': Specifies the ISO B7 white medium
8718 'iso-b8-white': Specifies the ISO B8 white medium
8719 'iso-b9-white': Specifies the ISO B9 white medium
8720 'iso-b10-white': Specifies the ISO B10 white medium
8721 'jis-b0-white': Specifies the JIS B0 white medium
8722 'jis-b1-white': Specifies the JIS B1 white medium
8723 'jis-b2-white': Specifies the JIS B2 white medium
8724 'jis-b3-white': Specifies the JIS B3 white medium
8725 'jis-b6-white': Specifies the JIS B6 white medium
8726 'jis-b7-white': Specifies the JIS B7 white medium
8727
8728
8729
8730
8731
8732 <span class="grey">deBry, et al. Experimental [Page 156]</span></pre>
8733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-157" ></span>
8734 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8735
8736
8737 'jis-b8-white': Specifies the JIS B8 white medium
8738 'jis-b9-white': Specifies the JIS B9 white medium
8739 'jis-b10-white': Specifies the JIS B10 white medium
8740
8741
8742 The following standard values are defined for engineering media:
8743
8744 'a': Specifies the engineering A size medium
8745 'b': Specifies the engineering B size medium
8746 'c': Specifies the engineering C size medium
8747 'd': Specifies the engineering D size medium
8748 'e': Specifies the engineering E size medium
8749
8750
8751 The following standard values are defined for input-trays (from ISO
8752 DPA and the Printer MIB):
8753
8754 'top': The top input tray in the printer.
8755 'middle': The middle input tray in the printer.
8756 'bottom': The bottom input tray in the printer.
8757 'envelope': The envelope input tray in the printer.
8758 'manual': The manual feed input tray in the printer.
8759 'large-capacity': The large capacity input tray in the printer.
8760 'main': The main input tray
8761 'side': The side input tray
8762
8763
8764 The following standard values are defined for media sizes (from ISO
8765 DPA):
8766
8767 'iso-a0': Specifies the ISO A0 size: 841 mm by 1189 mm as defined
8768 in ISO 216
8769 'iso-a1': Specifies the ISO A1 size: 594 mm by 841 mm as defined in
8770 ISO 216
8771 'iso-a2': Specifies the ISO A2 size: 420 mm by 594 mm as defined in
8772 ISO 216
8773 'iso-a3': Specifies the ISO A3 size: 297 mm by 420 mm as defined in
8774 ISO 216
8775 'iso-a4': Specifies the ISO A4 size: 210 mm by 297 mm as defined in
8776 ISO 216
8777 'iso-a5': Specifies the ISO A5 size: 148 mm by 210 mm as defined in
8778 ISO 216
8779 'iso-a6': Specifies the ISO A6 size: 105 mm by 148 mm as defined in
8780 ISO 216
8781 'iso-a7': Specifies the ISO A7 size: 74 mm by 105 mm as defined in
8782 ISO 216
8783 'iso-a8': Specifies the ISO A8 size: 52 mm by 74 mm as defined in
8784 ISO 216
8785
8786
8787
8788 <span class="grey">deBry, et al. Experimental [Page 157]</span></pre>
8789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-158" ></span>
8790 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8791
8792
8793 'iso-a9': Specifies the ISO A9 size: 37 mm by 52 mm as defined in
8794 ISO 216
8795 'iso-a10': Specifies the ISO A10 size: 26 mm by 37 mm as defined in
8796 ISO 216
8797 'iso-b0': Specifies the ISO B0 size: 1000 mm by 1414 mm as defined
8798 in ISO 216
8799 'iso-b1': Specifies the ISO B1 size: 707 mm by 1000 mm as defined
8800 in ISO 216
8801 'iso-b2': Specifies the ISO B2 size: 500 mm by 707 mm as defined in
8802 ISO 216
8803 'iso-b3': Specifies the ISO B3 size: 353 mm by 500 mm as defined in
8804 ISO 216
8805 'iso-b4': Specifies the ISO B4 size: 250 mm by 353 mm as defined in
8806 ISO 216
8807 'iso-b5': Specifies the ISO B5 size: 176 mm by 250 mm as defined in
8808 ISO 216
8809 'iso-b6': Specifies the ISO B6 size: 125 mm by 176 mm as defined in
8810 ISO 216
8811 'iso-b7': Specifies the ISO B7 size: 88 mm by 125 mm as defined in
8812 ISO 216
8813 'iso-b8': Specifies the ISO B8 size: 62 mm by 88 mm as defined in
8814 ISO 216
8815 'iso-b9': Specifies the ISO B9 size: 44 mm by 62 mm as defined in
8816 ISO 216
8817 'iso-b10': Specifies the ISO B10 size: 31 mm by 44 mm as defined in
8818 ISO 216
8819 'na-letter': Specifies the North American letter size: 8.5 inches by
8820 11 inches
8821 'na-legal': Specifies the North American legal size: 8.5 inches by
8822 14 inches
8823 'executive': Specifies the executive size (7.25 X 10.5 in)
8824 'folio': Specifies the folio size (8.5 X 13 in)
8825 'invoice': Specifies the invoice size (5.5 X 8.5 in)
8826 'ledger': Specifies the ledger size (11 X 17 in)
8827 'quarto': Specifies the quarto size (8.5 X 10.83 in)
8828 'iso-c3': Specifies the ISO C3 size: 324 mm by 458 mm as defined in
8829 ISO 269
8830 'iso-c4': Specifies the ISO C4 size: 229 mm by 324 mm as defined in
8831 ISO 269
8832 'iso-c5': Specifies the ISO C5 size: 162 mm by 229 mm as defined in
8833 ISO 269
8834 'iso-c6': Specifies the ISO C6 size: 114 mm by 162 mm as defined in
8835 ISO 269
8836 'iso-designated-long': Specifies the ISO Designated Long size: 110
8837 mm by 220 mm as defined in ISO 269
8838 'na-10x13-envelope': Specifies the North American 10x13 size: 10
8839 inches by 13 inches
8840
8841
8842
8843
8844 <span class="grey">deBry, et al. Experimental [Page 158]</span></pre>
8845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-159" ></span>
8846 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8847
8848
8849 'na-9x12-envelope': Specifies the North American 9x12 size: 9
8850 inches by 12 inches
8851 'na-number-10-envelope': Specifies the North American number 10
8852 business envelope size: 4.125 inches by 9.5 inches
8853 'na-7x9-envelope': Specifies the North American 7x9 inch envelope
8854 size
8855 'na-9x11-envelope': Specifies the North American 9x11 inch envelope
8856 size
8857 'na-10x14-envelope': Specifies the North American 10x14 inch
8858 envelope size
8859 'na-number-9-envelope': Specifies the North American number 9
8860 business envelope size
8861 'na-6x9-envelope': Specifies the North American 6x9 envelope size
8862 'na-10x15-envelope': Specifies the North American 10x15 envelope
8863 size
8864 'monarch-envelope': Specifies the Monarch envelope size (3.87 x 7.5
8865 in)
8866 'jis-b0': Specifies the JIS B0 size: 1030mm x 1456mm
8867 'jis-b1': Specifies the JIS B1 size: 728mm x 1030mm
8868 'jis-b2': Specifies the JIS B2 size: 515mm x 728mm
8869 'jis-b3': Specifies the JIS B3 size: 364mm x 515mm
8870 'jis-b4': Specifies the JIS B4 size: 257mm x 364mm
8871 'jis-b5': Specifies the JIS B5 size: 182mm x 257mm
8872 'jis-b6': Specifies the JIS B6 size: 128mm x 182mm
8873 'jis-b7': Specifies the JIS B7 size: 91mm x 128mm
8874 'jis-b8': Specifies the JIS B8 size: 64mm x 91mm
8875 'jis-b9': Specifies the JIS B9 size: 45mm x 64mm
8876 'jis-b10': Specifies the JIS B10 size: 32mm x 45mm
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900 <span class="grey">deBry, et al. Experimental [Page 159]</span></pre>
8901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-160" ></span>
8902 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8903
8904
8905 <span class="h2"><a class="selflink" id="section-15" href="#section-15">15</a>. APPENDIX D: Processing IPP Attributes</span>
8906
8907 When submitting a print job to a Printer object, the IPP model allows
8908 a client to supply operation and Job Template attributes along with
8909 the document data. These Job Template attributes in the create
8910 request affect the rendering, production and finishing of the
8911 documents in the job. Similar types of instructions may also be
8912 contained in the document to be printed, that is, embedded within the
8913 print data itself. In addition, the Printer has a set of attributes
8914 that describe what rendering and finishing options which are
8915 supported by that Printer. This model, which allows for flexibility
8916 and power, also introduces the potential that at job submission time,
8917 these client-supplied attributes may conflict with either:
8918
8919 - what the implementation is capable of realizing (i.e., what the
8920 Printer supports), as well as
8921 - the instructions embedded within the print data itself.
8922
8923 The following sections describe how these two types of conflicts are
8924 handled in the IPP model.
8925
8926 <span class="h3"><a class="selflink" id="section-15.1" href="#section-15.1">15.1</a> Fidelity</span>
8927
8928 If there is a conflict between what the client requests and what a
8929 Printer object supports, the client may request one of two possible
8930 conflict handling mechanisms:
8931
8932 1) either reject the job since the job can not be processed exactly
8933 as specified, or
8934 2) allow the Printer to make any changes necessary to proceed with
8935 processing the Job the best it can.
8936
8937 In the first case the client is indicating to the Printer object:
8938 "Print the job exactly as specified with no exceptions, and if that
8939 can't be done, don't even bother printing the job at all." In the
8940 second case, the client is indicating to the Printer object: "It is
8941 more important to make sure the job is printed rather than be
8942 processed exactly as specified; just make sure the job is printed
8943 even if client supplied attributes need to be changed or ignored."
8944
8945 The IPP model accounts for this situation by introducing an "ipp-
8946 attribute-fidelity" attribute.
8947
8948 In a create request, "ipp-attribute-fidelity" is a boolean operation
8949 attribute that is OPTIONALLY supplied by the client. The value '
8950 true' indicates that total fidelity to client supplied Job Template
8951 attributes and values is required. The client is requesting that the
8952 Job be printed exactly as specified, and if that is not possible then
8953
8954
8955
8956 <span class="grey">deBry, et al. Experimental [Page 160]</span></pre>
8957 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-161" ></span>
8958 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
8959
8960
8961 the job MUST be rejected rather than processed incorrectly. The
8962 value 'false' indicates that a reasonable attempt to print the Job is
8963 acceptable. If a Printer does not support some of the client
8964 supplied Job Template attributes or values, the Printer MUST ignore
8965 them or substitute any supported value for unsupported values,
8966 respectively. The Printer may choose to substitute the default value
8967 associated with that attribute, or use some other supported value
8968 that is similar to the unsupported requested value. For example, if
8969 a client supplies a "media" value of 'na-letter', the Printer may
8970 choose to substitute 'iso-a4' rather than a default value of '
8971 envelope'. If the client does not supply the "ipp-attribute-fidelity"
8972 attribute, the Printer assumes a value of 'false'.
8973
8974 Each Printer implementation MUST support both types of "fidelity"
8975 printing (that is whether the client supplies a value of 'true' or '
8976 false'):
8977
8978 - If the client supplies 'false' or does not supply the attribute,
8979 the Printer object MUST always accept the request by ignoring
8980 unsupported Job Template attributes and by substituting
8981 unsupported values of supported Job Template attributes with
8982 supported values.
8983 - If the client supplies 'true', the Printer object MUST reject the
8984 request if the client supplies unsupported Job Template
8985 attributes.
8986
8987 Since a client can always query a Printer to find out exactly what is
8988 and is not supported, "ipp-attribute-fidelity" set to 'false' is
8989 useful when:
8990
8991 1) The End-User uses a command line interface to request attributes
8992 that might not be supported.
8993 2) In a GUI context, if the End User expects the job might be moved
8994 to another printer and prefers a sub-optimal result to nothing
8995 at all.
8996 3) The End User just wants something reasonable in lieu of nothing
8997 at all.
8998
8999 <span class="h3"><a class="selflink" id="section-15.2" href="#section-15.2">15.2</a> Page Description Language (PDL) Override</span>
9000
9001 If there is a conflict between the value of an IPP Job Template
9002 attribute and a corresponding instruction in the document data, the
9003 value of the IPP attribute SHOULD take precedence over the document
9004 instruction. Consider the case where a previously formatted file of
9005 document data is sent to an IPP Printer. In this case, if the client
9006 supplies any attributes at job submission time, the client desires
9007 that those attributes override the embedded instructions. Consider
9008 the case were a previously formatted document has embedded in it
9009
9010
9011
9012 <span class="grey">deBry, et al. Experimental [Page 161]</span></pre>
9013 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-162" ></span>
9014 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9015
9016
9017 commands to load 'iso-a4' media. However, the document is passed to
9018 an end user that only has access to a printer with 'na-letter' media
9019 loaded. That end user most likely wants to submit that document to
9020 an IPP Printer with the "media" Job Template attribute set to 'na-
9021 letter'. The job submission attribute should take precedence over
9022 the embedded PDL instruction. However, until companies that supply
9023 document data interpreters allow a way for external IPP attributes to
9024 take precedence over embedded job production instructions, a Printer
9025 might not be able to support the semantics that IPP attributes
9026 override the embedded instructions.
9027
9028 The IPP model accounts for this situation by introducing a "pdl-
9029 override-supported" attribute that describes the Printer objects
9030 capabilities to override instructions embedded in the PDL data
9031 stream. The value of the "pdl-override-supported" attribute is
9032 configured by means outside IPP/1.0.
9033
9034 This REQUIRED Printer attribute takes on the following values:
9035
9036 - 'attempted': This value indicates that the Printer object
9037 attempts to make the IPP attribute values take precedence over
9038 embedded instructions in the document data, however there is no
9039 guarantee.
9040 - 'not-attempted': This value indicates that the Printer object
9041 makes no attempt to make the IPP attribute values take precedence
9042 over embedded instructions in the document data.
9043
9044 At job processing time, an implementation that supports the value of
9045 'attempted' might do one of several different actions:
9046
9047 1) Generate an output device specific command sequence to realize
9048 the feature represented by the IPP attribute value.
9049 2) Parse the document data itself and replace the conflicting
9050 embedded instruction with a new embedded instruction that
9051 matches the intent of the IPP attribute value.
9052 3) Indicate to the Printer that external supplied attributes take
9053 precedence over embedded instructions and then pass the external
9054 IPP attribute values to the document data interpreter.
9055 4) Anything else that allows for the semantics that IPP attributes
9056 override embedded document data instructions.
9057
9058 Since 'attempted' does not offer any type of guarantee, even though a
9059 given Printer object might not do a very "good" job of attempting to
9060 ensure that IPP attributes take a higher precedence over instructions
9061 embedded in the document data, it would still be a conforming
9062 implementation.
9063
9064
9065
9066
9067
9068 <span class="grey">deBry, et al. Experimental [Page 162]</span></pre>
9069 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-163" ></span>
9070 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9071
9072
9073 At job processing time, an implementation that supports the value of
9074 'not-attempted' might do one of the following actions:
9075
9076 1) Simply pre-pend the document data with the PDL instruction that
9077 corresponds to the client-supplied PDL attribute, such that if
9078 the document data also has the same PDL instruction, it will
9079 override what the Printer object pre-pended. In other words,
9080 this implementation is using the same implementation semantics
9081 for the client-supplied IPP attributes as for the Printer object
9082 defaults.
9083 2) Parse the document data and replace the conflicting embedded
9084 instruction with a new embedded instruction that approximates,
9085 but does not match, the semantic intent of the IPP attribute
9086 value.
9087
9088 Note: The "ipp-attribute-fidelity" attribute applies to the
9089 Printer's ability to either accept or reject other unsupported Job
9090 Template attributes. In other words, if "ipp-attribute-fidelity" is
9091 set to 'true', a Job is accepted if and only if the client supplied
9092 Job Template attributes and values are supported by the Printer.
9093 Whether these attributes actually affect the processing of the Job
9094 when the document data contains embedded instructions depends on the
9095 ability of the Printer to override the instructions embedded in the
9096 document data with the semantics of the IPP attributes. If the
9097 document data attributes can be overridden ("pdl-override-supported"
9098 set to 'attempted'), the Printer makes an attempt to use the IPP
9099 attributes when processing the Job. If the document data attributes
9100 can not be overridden ("pdl-override-supported" set to 'not-
9101 attempted'), the Printer makes no attempt to override the embedded
9102 document data instructions with the IPP attributes when processing
9103 the Job, and hence, the IPP attributes may fail to affect the Job
9104 processing and output when the corresponding instruction is embedded
9105 in the document data.
9106
9107 <span class="h3"><a class="selflink" id="section-15.3" href="#section-15.3">15.3</a> Using Job Template Attributes During Document Processing.</span>
9108
9109 The Printer object uses some of the Job object's Job Template
9110 attributes during the processing of the document data associated with
9111 that job. These include, but are not limited to, "orientation",
9112 "number-up", "sides", "media", and "copies". The processing of each
9113 document in a Job Object MUST follow the steps below. These steps are
9114 intended only to identify when and how attributes are to be used in
9115 processing document data and any alternative steps that accomplishes
9116 the same effect can be used to implement this specification.
9117
9118 1. Using the client supplied "document-format" attribute or some
9119 form of document format detection algorithm (if the value of
9120 "document- format" is not specific enough), determine whether or
9121
9122
9123
9124 <span class="grey">deBry, et al. Experimental [Page 163]</span></pre>
9125 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-164" ></span>
9126 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9127
9128
9129 not the document data has already been formatted for printing.
9130 If the document data has been formatted, then go to step 2.
9131 Otherwise, the document data MUST be formatted. The formatting
9132 detection algorithm is implementation defined and is not
9133 specified by this specification. The formatting of the document
9134 data uses the "orientation-requested" attribute to determine how
9135 the formatted print data should be placed on a print-stream
9136 page, see <a href="#section-4.2.10">section 4.2.10</a> for the details.
9137
9138 2. The document data is in the form of a print-stream in a known
9139 media type. The "page-ranges" attribute is used to select, as
9140 specified in <a href="#section-4.2.7">section 4.2.7</a>, a sub-sequence of the pages in the
9141 print-stream that are to be processed and images.
9142
9143 3. The input to this step is a sequence of print-stream pages. This
9144 step is controlled by the "number-up" attribute. If the value of
9145 "number-up" is N, then during the processing of the print-stream
9146 pages, each N print-stream pages are positioned, as specified in
9147 <a href="#section-4.2.9">section 4.2.9</a>, to create a single impression. If a given
9148 document does not have N more print-stream pages, then the
9149 completion of the impression is controlled by the "multiple-
9150 document-handling" attribute as described in <a href="#section-4.2.4">section 4.2.4</a>; when
9151 the value of this attribute is 'single-document' or 'single-
9152 document-new-sheet', the print-stream pages of document data
9153 from subsequent documents is used to complete the impression.
9154
9155 The size(scaling), position(translation) and rotation of the
9156 print-stream pages on the impression is implementation defined.
9157 Note that during this process the print-stream pages may be
9158 rendered to a form suitable for placing on the impression; this
9159 rendering is controlled by the values of the "printer-
9160 resolution" and "print- quality" attributes as described in
9161 sections <a href="#section-4.2.12">4.2.12</a> and <a href="#section-4.2.13">4.2.13</a>. In the case N=1, the impression is
9162 nearly the same as the print-stream page; the differences would
9163 only be in the size, position and rotation of the print-stream
9164 page and/or any decoration, such as a frame to the page, that is
9165 added by the implementation.
9166
9167 4. The collection of impressions is placed, in sequence, onto sides
9168 of the media sheets. This placement is controlled by the "sides"
9169 attribute and the orientation of the print-stream page, as
9170 described in <a href="#section-4.2.8">section 4.2.8</a>. The orientation of the print-stream
9171 pages affects the orientation of the impression; for example, if
9172 "number-up" equals 2, then, typically, two portrait print-stream
9173 pages become one landscape impression. Note that the placement
9174 of impressions onto media sheets is also controlled by the
9175 "multiple-document-handling" attribute as described in <a href="#section-4.2.4">section</a>
9176 <a href="#section-4.2.4">4.2.4</a>.
9177
9178
9179
9180 <span class="grey">deBry, et al. Experimental [Page 164]</span></pre>
9181 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-165" ></span>
9182 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9183
9184
9185 5. The "copies" and "multiple-document-handling" attributes are
9186 used to determine how many copies of each media instance are
9187 created and in what order. See sections <a href="#section-4.2.5">4.2.5</a> and <a href="#section-4.2.4">4.2.4</a> for the
9188 details.
9189
9190 6. When the correct number of copies are created, the media
9191 instances are finished according to the values of the
9192 "finishings" attribute as described in 4.2.6. Note that
9193 sometimes finishing operations may require manual intervention
9194 to perform the finishing operations on the copies, especially
9195 uncollated copies. This specification allows any or all of the
9196 processing steps to be performed automatically or manually at
9197 the discretion of the Printer object.
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236 <span class="grey">deBry, et al. Experimental [Page 165]</span></pre>
9237 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-166" ></span>
9238 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9239
9240
9241 <span class="h2"><a class="selflink" id="section-16" href="#section-16">16</a>. APPENDIX E: Generic Directory Schema</span>
9242
9243 This section defines a generic schema for an entry in a directory
9244 service. A directory service is a means by which service users can
9245 locate service providers. In IPP environments, this means that IPP
9246 Printers can be registered (either automatically or with the help of
9247 an administrator) as entries of type printer in the directory using
9248 an implementation specific mechanism such as entry attributes, entry
9249 type fields, specific branches, etc. IPP clients can search or
9250 browse for entries of type printer. Clients use the directory
9251 service to find entries based on naming, organizational contexts, or
9252 filtered searches on attribute values of entries. For example, a
9253 client can find all printers in the "Local Department" context.
9254 Authentication and authorization are also often part of a directory
9255 service so that an administrator can place limits on end users so
9256 that they are only allowed to find entries to which they have certain
9257 access rights. IPP itself does not require any specific directory
9258 service protocol or provider.
9259
9260 Note: Some directory implementations allow for the notion of
9261 "aliasing". That is, one directory entry object can appear as
9262 multiple directory entry object with different names for each object.
9263 In each case, each alias refers to the same directory entry object
9264 which refers to a single IPP Printer object.
9265
9266 The generic schema is a subset of IPP Printer Job Template and
9267 Printer Description attributes (sections <a href="#section-4.2">4.2</a> and <a href="#section-4.4">4.4</a>). These
9268 attributes are identified as either RECOMMENDED or OPTIONAL for the
9269 directory entry itself. This conformance labeling is NOT the same
9270 conformance labeling applied to the attributes of IPP Printers
9271 objects. The conformance labeling in this Appendix is intended to
9272 apply to directory templates and to IPP Printer implementations that
9273 subscribe by adding one or more entries to a directory. RECOMMENDED
9274 attributes SHOULD be associated with each directory entry. OPTIONAL
9275 attributes MAY be associated with the directory entry (if known or
9276 supported). In addition, all directory entry attributes SHOULD
9277 reflect the current attribute values for the corresponding Printer
9278 object.
9279
9280 The names of attributes in directory schema and entries SHOULD be the
9281 same as the IPP Printer attribute names as shown.
9282
9283 In order to bridge between the directory service and the IPP Printer
9284 object, one of the RECOMMENDED directory entry attributes is the
9285 Printer object's "printer-uri-supported" attribute. The IPP client
9286 queries the "printer-uri-supported" attribute in the directory entry
9287
9288
9289
9290
9291
9292 <span class="grey">deBry, et al. Experimental [Page 166]</span></pre>
9293 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-167" ></span>
9294 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9295
9296
9297 and then addresses the IPP Printer object using one of its URIs. The
9298 "uri-security-supported" attribute identifies the protocol (if any)
9299 used to secure a channel.
9300
9301 The following attributes define the generic schema for directory
9302 entries of type PRINTER:
9303
9304 printer-uri-supported RECOMMENDED <a href="#section-4.4.1">Section 4.4.1</a>
9305 uri-security-supported RECOMMENDED <a href="#section-4.4.2">Section 4.4.2</a>
9306 printer-name RECOMMENDED <a href="#section-4.4.3">Section 4.4.3</a>
9307 printer-location RECOMMENDED <a href="#section-4.4.4">Section 4.4.4</a>
9308 printer-info OPTIONAL <a href="#section-4.4.5">Section 4.4.5</a>
9309 printer-more-info OPTIONAL <a href="#section-4.4.6">Section 4.4.6</a>
9310 printer-make-and-model RECOMMENDED <a href="#section-4.4.8">Section 4.4.8</a>
9311 charset-supported OPTIONAL <a href="#section-4.4.15">Section 4.4.15</a>
9312 generated-natural-language-
9313 supported OPTIONAL <a href="#section-4.4.17">Section 4.4.17</a>
9314 document-format-supported RECOMMENDED <a href="#section-4.4.19">Section 4.4.19</a>
9315 color-supported RECOMMENDED <a href="#section-4.4.23">Section 4.4.23</a>
9316 finishings-supported OPTIONAL <a href="#section-4.2.6">Section 4.2.6</a>
9317 number-up-supported OPTIONAL <a href="#section-4.2.7">Section 4.2.7</a>
9318 sides-supported RECOMMENDED <a href="#section-4.2.8">Section 4.2.8</a>
9319 media-supported RECOMMENDED <a href="#section-4.2.11">Section 4.2.11</a>
9320 printer-resolution-supported OPTIONAL <a href="#section-4.2.12">Section 4.2.12</a>
9321 print-quality-supported OPTIONAL <a href="#section-4.2.13">Section 4.2.13</a>
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348 <span class="grey">deBry, et al. Experimental [Page 167]</span></pre>
9349 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-168" ></span>
9350 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9351
9352
9353 <span class="h2"><a class="selflink" id="section-17" href="#section-17">17</a>. APPENDIX F: </span>Change History for the IPP Model and Semantics document
9354
9355 The following substantive changes and major clarifications have been
9356 made to this document from the June 30, 1998 version based on the
9357 interoperability testing that took place September 23-25 1998 and
9358 subsequent mailing list and meeting discussions. They are listed in
9359 the order of occurrence in the document. These changes are the ones
9360 that might affect implementations. Clarifications that are unlikely
9361 to affect implementations are not listed. The issue numbers refer to
9362 the IPP Issues List which is available in the following directory:
9363
9364 <a href="ftp://ftp.pwg.org/pub/pwg/ipp/approved-clarifications/">ftp://ftp.pwg.org/pub/pwg/ipp/approved-clarifications/</a>
9365
9366 Section Description
9367
9368 global Replaced TLS references with SSL3 references as agreed with
9369 our Area Director on 11/12/1998.
9370
9371 global Removed the indications that some of these IPP documents
9372 are informational, since the intent is now to publish all
9373 IPP/1.0 documents as informational as agreed with our Area
9374 Director on 11/12/1998.
9375
9376 3.1.2, Clarify that the IPP object SHOULD NOT validate the
9377 16.3.3 range of the request-id being 1 to 2**31-1, but accepts
9378 [now ipp- and returns any value. Clients MUST still keep in the
9379 iig] range 1 to 2**31 though. If the request is terminated
9380 before the complete "request-id" is received, the IPP
9381 object rejects the request and returns a response with a
9382 "request-id" of 0 (Issue 1.36).
9383
9384 3.1.4.1, Clarified that when a client submits a request in a
9385 13.1.4.14 charset that is not supported, the IPP object SHOULD
9386 return any 'text' or 'name' attributes in the 'utf-8'
9387 charset, if it returns any, since clients and IPP
9388 objects MUST support 'utf-8'. (Issue 1.19)
9389
9390 3.1.4.1 Clarified <a href="#section-3.1.4.1">Section 3.1.4.1</a> Request Operation Attributes
9391 that a client MAY use the attribute level natural
9392 language override (text/nameWithLanguage) redundantly in
9393 a request. (Issue 1.46)
9394
9395 3.1.4.2 Clarified <a href="#section-3.1.4.2">Section 3.1.4.2</a> Response Operation Attributes
9396 that an IPP object MAY use the attribute level natural
9397 language override (text/nameWithLanguage) redundantly in
9398 a response. (Issue 1.46)
9399
9400
9401
9402
9403
9404 <span class="grey">deBry, et al. Experimental [Page 168]</span></pre>
9405 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-169" ></span>
9406 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9407
9408
9409 3.1.6 Clarified <a href="#section-3.1.6">section 3.1.6</a>: If the Printer object supports
9410 the "status-message" operation attribute, it NEED NOT
9411 return a status message for the following error status
9412 codes: 'client-error-bad-request', 'client-error-
9413 charset-not-supported', 'server-error-internal-error',
9414 'server-error-operation-not-supported', and 'server-
9415 error-version-not-supported'.
9416
9417 3.2.1.1 Clarified that if a client is not supplying any Job
9418 Template attributes in a request, the client SHOULD omit
9419 Group 2 rather than sending an empty group. However, a
9420 Printer object MUST be able to accept an empty group.
9421 This makes [<a href="./rfc2566">RFC2566</a>] agree with [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]. (Issue 1.16)
9422
9423 3.2.1.2, Clarified that if an IPP object is not returning any
9424 3.2.5.2, Unsupported Attributes in a response, the IPP object
9425 3.2.6.2, SHOULD omit Group 2 rather than sending an empty group.
9426 3.3.1.2, However, a client MUST be able to accept an empty group.
9427 3.3.3.2, This makes [<a href="./rfc2566">RFC2566</a>] agree with [<a href="./rfc2565" title="&quot;Internet Printing Protocol/1.0: Encoding and Transport&quot;">RFC2565</a>]. (Issue 1.17)
9428 3.3.4.2
9429
9430 3.2.1.2, Clarified that an IPP object MUST treat an unsupported
9431 13.1.2.2, attribute syntax supplied in a request in the same way
9432 13.1.4.12 as an unsupported value. The IPP object MUST return the
9433 attribute, the attribute syntax, and the value in the
9434 Unsupported Attributes group. (Issue 1.26)
9435
9436 3.2.5.2, Clarified for Get-Printer-Attributes, Get-Jobs, and Get-
9437 3.2.6.2, Job-Attributes that an IPP object MUST return
9438 3.3.4.2, 'successful-ok-ignored-or-substituted-attributes' (0x1),
9439
9440 13.1.2.1, rather than 'successful-ok' (0x0), when a client
9441 13.1.2.2, supplies unsupported attributes as values of the
9442 13.1.4.12 'requested-attributes' operation attribute. (Issue
9443 1.24)
9444 Also clarified that the response NEED NOT contain the
9445 "requested-attributes" operation attribute with any
9446 supplied values (attribute keywords) that were requested
9447 by the client but are not supported by the IPP object.
9448 (Issue 1.18)
9449
9450 3.2.6.2 Deleted the job-level natural language override (NLO)
9451 4.1.1.2 from <a href="#section-3.2.6.2">Section 3.2.6.2</a> Get-Jobs Response so that all
9452 4.3.24 operation responses are the same with respect to NLO.
9453 (Issue 1.47)
9454
9455
9456
9457
9458
9459
9460 <span class="grey">deBry, et al. Experimental [Page 169]</span></pre>
9461 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-170" ></span>
9462 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9463
9464
9465 3.3.1 Clarified that an IPP Printer that supports the Create-
9466 Job operation MUST handle the situation when a client
9467 does not supply Send-Document or Send-URI operations
9468 within a one- to four-minute time period. Also
9469 clarified that a client MUST send documents in a multi-
9470 document job without undue or unbounded delay. (Issue
9471 1.28)
9472
9473 3.3.3 Clarified that the IPP object MUST reject a Cancel-Job
9474 request if the job is in 'completed', 'canceled', or
9475 'aborted' job states. (Issue 1.12)
9476
9477 4.1.2.3 Added this new sub-section: it specifies that
9478 nameWithoutLanguage plus the implicit natural language
9479 matches nameWithLanguage, if the values and natural
9480 languages are the same. Also added that keyword never
9481 matches nameWithLanguage or nameWithoutLanguage.
9482 Clarified that if both have countries, that the
9483 countries SHOULD match as well. If either do not, then
9484 the country field SHOULD be ignored. (Issues 1.33 and
9485 1.34)
9486
9487 4.1.5 Clarified regarding the case-insensitivity of URLs to
9488 refer only to the RFCs that define them. (Issue 1.10)
9489
9490 4.1.11 Clarified that 'boolean' is not a full-sized integer.
9491 (Issue 1.38)
9492
9493 4.1.15 Clarified that 'resolution' is not three full-sized
9494 integers. (Issue 1.20)
9495
9496 4.2.* Clarified that standard values are keywords or enums,
9497 not names. (Issue 1.49).
9498
9499 4.2.4 Added the 'single-document-new-sheet' value to <a href="#section-4.2.4">Section</a>
9500 <a href="#section-4.2.4">4.2.4</a> multiple-document-handling. (Issue 1.54)
9501
9502 4.4.18, Clarified that the "document-format-default" and
9503 4.4.19 "document-format-supported" Printer Description
9504 attributes are REQUIRED to agree with the table. (Issue
9505 1.4)
9506
9507 4.4.21 Changed "queued-job-count" from OPTIONAL to RECOMMENDED.
9508 (Issue 1.14)
9509
9510
9511
9512
9513
9514
9515
9516 <span class="grey">deBry, et al. Experimental [Page 170]</span></pre>
9517 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-171" ></span>
9518 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9519
9520
9521 4.4.28 Clarified that the implementation supplied value for the
9522 "multiple-operation-time-out" attribute SHOULD be
9523 between 30 and 240 seconds, though the implementation
9524 MAY allow the administrator to set values, and MAY allow
9525 values outside this range. (Issue 1.28)
9526
9527 5.1, Clarified Client Conformance that if a client supports
9528 5.2.5 an attribute of 'text' attribute syntax, that it MUST
9529 support both the textWithoutLanguage and the
9530 textWithLanguage forms. Same for 'name' attribute
9531 syntax. Same for an IPP object (Issue 1.48)
9532
9533 6.5, Added new section to allow Attribute Groups to be
9534 12.8 registered as extensions for being passed in operation
9535 requests and responses. (Issue 1.25)
9536
9537 7. Updated the table of text and name attributes to agree
9538 with <a href="#section-4.2">Section 4.2</a>.
9539
9540 8.5 Added a new section RECOMMENDING that the Get-Jobs
9541 SHOULD return non-IPP jobs whether or not assigning them
9542 a job-id and job-uri. Also RECOMMENDED generating, if
9543 possible, job-id and job-uri and supporting other IPP
9544 operations on foreign jobs as an implementer option.
9545 (Issue 1.32)
9546
9547 9. Updated document references.
9548
9549 13.1.4.14 Clarified 'client-error-charset-not-supported' that
9550 'utf-8' must be used for any 'text' or 'name' attributes
9551 returned in the error response (Issue 1.19).
9552
9553 13.1.5.9 Added a new error code 'server-error-job-canceled'
9554 (0x0508) to be returned if a job is canceled by another
9555 client or aborted by the IPP object while the first
9556 client is still sending the document data. (Issue 1.29)
9557
9558 15.3, Moved these sections recommending operation processing
9559 15.4 steps to the new Implementer's Guide (informational).
9560 There indicated that all of the error checks are not
9561 required, so an IPP object MAY be forgiving and accept
9562 non-conforming requests. However, a conforming client
9563 MUST supply requests that would pass all of the error
9564 checks indicated. (Issue 1.21)
9565
9566
9567
9568
9569
9570
9571
9572 <span class="grey">deBry, et al. Experimental [Page 171]</span></pre>
9573 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-172" ></span>
9574 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9575
9576
9577 16 Changed directory schema attributes from REQUIRED to
9578 RECOMMENDED. Changed some of the OPTIONAL to
9579 RECOMMENDED to agree with the SLP template. Changed the
9580 "charset-supported" and "natural-language-supported"
9581 from REQUIRED to OPTIONAL. Recommended that the names
9582 be the same in a directory entry as the IPP attribute
9583 names. (Issue 1.53)
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628 <span class="grey">deBry, et al. Experimental [Page 172]</span></pre>
9629 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-173" ></span>
9630 <span class="grey"><a href="./rfc2566">RFC 2566</a> IPP/1.0: Model and Semantics April 1999</span>
9631
9632
9633 <span class="h2"><a class="selflink" id="section-18" href="#section-18">18</a>. Full Copyright Statement</span>
9634
9635 Copyright (C) The Internet Society (1999). All Rights Reserved.
9636
9637 This document and translations of it may be copied and furnished to
9638 others, and derivative works that comment on or otherwise explain it
9639 or assist in its implementation may be prepared, copied, published
9640 and distributed, in whole or in part, without restriction of any
9641 kind, provided that the above copyright notice and this paragraph are
9642 included on all such copies and derivative works. However, this
9643 document itself may not be modified in any way, such as by removing
9644 the copyright notice or references to the Internet Society or other
9645 Internet organizations, except as needed for the purpose of
9646 developing Internet standards in which case the procedures for
9647 copyrights defined in the Internet Standards process must be
9648 followed, or as required to translate it into languages other than
9649 English.
9650
9651 The limited permissions granted above are perpetual and will not be
9652 revoked by the Internet Society or its successors or assigns.
9653
9654 This document and the information contained herein is provided on an
9655 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
9656 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
9657 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
9658 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
9659 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684 deBry, et al. Experimental [Page 173]
9685 </pre>