idnits 2.17.1 draft-ietf-ipp-model-v11-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** Missing expiration date. The document expiration date should appear on the first and last page. ** The document seems to lack a 1id_guidelines paragraph about Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document is more than 15 pages and seems to lack a Table of Contents. == No 'Intended status' indicated for this document; assuming Proposed Standard == The page length should not exceed 58 lines per page, but there was 165 longer pages, the longest (page 60) being 69 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The abstract seems to contain references ([IPP-PRO], [IPP-RAT], [IPP-IIG], [IPP-REQ], [IPPLPD]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. == There are 7 instances of lines with non-RFC2606-compliant FQDNs in the document. == There are 61 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords -- however, there's a paragraph with a matching beginning. Boilerplate error? RFC 2119 keyword, line 73: '...sion 1.0. A few OPTIONAL operator ope...' RFC 2119 keyword, line 450: '...d terms, such as MUST, MUST NOT, REQUI...' RFC 2119 keyword, line 451: '... SHOULD NOT, MAY, NEED NOT, a...' RFC 2119 keyword, line 490: '...additional OPTIONAL operator operation...' RFC 2119 keyword, line 570: '...the Job object's OPTIONAL Hold-Job, Re...' (688 more instances...) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 212 has weird spacing: '...(1setOf type2...' == Line 665 has weird spacing: '...any indicate...' == Line 897 has weird spacing: '... object which...' == Line 1486 has weird spacing: '...client to ide...' == Line 1495 has weird spacing: '...support versi...' == (15 more instances...) -- The exact meaning of the all-uppercase expression 'NOT REQUIRED' is not defined in RFC 2119. If it is intended as a requirements expression, it should be rewritten using one of the combinations defined in RFC 2119; otherwise it should not be all-uppercase. == Using lowercase 'not' together with uppercase 'MUST', 'SHALL', 'SHOULD', or 'RECOMMENDED' is not an accepted usage according to RFC 2119. Please use uppercase 'NOT' together with RFC 2119 keywords (if that is what you mean). Found 'SHOULD not' in this paragraph: In the first case, the Printer SHOULD not tweak any existing related Job attributes ("time-at-creation", "time-at-processing", and "time-at-completed"). In the second case, the Printer object SHOULD reset those attributes to 0. If a client queries a time-related Job attribute and == The expression 'MAY NOT', while looking like RFC 2119 requirements text, is not defined in RFC 2119, and should not be used. Consider using 'MUST NOT' instead (if that is what you mean). Found 'MAY NOT' in this paragraph: This term is not included in RFC 2119. The verb "NEED NOT" indicates an action that the subject of the sentence does not have to implement in order to claim conformance to the standard. The verb "NEED NOT" is used instead of "MAY NOT" since "MAY NOT" sounds like a prohibition. -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (February 17, 1998) is 9564 days in the past. Is this intentional? -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Missing reference section? 'RFC2026' on line 7030 looks like a reference -- Missing reference section? 'IPP-REQ' on line 6972 looks like a reference -- Missing reference section? 'IPP-RAT' on line 6967 looks like a reference -- Missing reference section? 'IPP-PRO' on line 8742 looks like a reference -- Missing reference section? 'IPP-IIG' on line 7874 looks like a reference -- Missing reference section? 'IPP LPD' on line 6947 looks like a reference -- Missing reference section? 'IPP-LPD' on line 421 looks like a reference -- Missing reference section? 'RFC2119' on line 7454 looks like a reference -- Missing reference section? 'HTPP' on line 6918 looks like a reference -- Missing reference section? 'ISO10175' on line 8132 looks like a reference -- Missing reference section? 'LDPA' on line 6990 looks like a reference -- Missing reference section? 'PSIS' on line 7000 looks like a reference -- Missing reference section? 'RFC1179' on line 7010 looks like a reference -- Missing reference section? 'SWP' on line 7098 looks like a reference -- Missing reference section? 'RFC2396' on line 7088 looks like a reference -- Missing reference section? 'TLS' on line 773 looks like a reference -- Missing reference section? 'RFC2279' on line 7080 looks like a reference -- Missing reference section? 'IANA-CS' on line 6930 looks like a reference -- Missing reference section? 'IPP-MOD' on line 1510 looks like a reference -- Missing reference section? 'RFC1759' on line 8133 looks like a reference -- Missing reference section? 'RFC1766' on line 7018 looks like a reference -- Missing reference section? 'ASCII' on line 6909 looks like a reference -- Missing reference section? 'IANA-MT' on line 6934 looks like a reference -- Missing reference section? 'RFC2046' on line 7041 looks like a reference -- Missing reference section? 'RFC2278' on line 7076 looks like a reference -- Missing reference section? 'RFC2045' on line 7034 looks like a reference -- Missing reference section? 'ISO8859-1' on line 6981 looks like a reference -- Missing reference section? 'RFC2048' on line 7046 looks like a reference -- Missing reference section? '52' on line 3762 looks like a reference -- Missing reference section? '56' on line 3762 looks like a reference -- Missing reference section? 'RFC1903' on line 7022 looks like a reference -- Missing reference section? 'SSL' on line 7092 looks like a reference -- Missing reference section? 'RFC2246' on line 7068 looks like a reference -- Missing reference section? 'RFC2228' on line 7064 looks like a reference -- Missing reference section? 'RFC2316' on line 7084 looks like a reference -- Missing reference section? 'RFC1952' on line 7026 looks like a reference -- Missing reference section? 'IANA-CON' on line 6923 looks like a reference -- Missing reference section? 'RFC1035' on line 7006 looks like a reference -- Missing reference section? 'RFC2069' on line 7055 looks like a reference -- Missing reference section? 'BCP-11' on line 6914 looks like a reference -- Missing reference section? 'ISO10646-1' on line 6976 looks like a reference -- Missing reference section? 'PWG' on line 7003 looks like a reference -- Missing reference section? 'RFC2068' on line 7051 looks like a reference -- Missing reference section? 'RFC2277' on line 7072 looks like a reference Summary: 7 errors (**), 0 flaws (~~), 13 warnings (==), 48 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 INTERNET-DRAFT 3 draft-ietf-ipp-model-v11-00.txt 4 R. deBry 5 IBM Corporation 6 T. Hastings (editor) 7 Xerox Corporation 8 R. Herriot 9 Xerox Corporation 10 S. Isaacson 11 Novell, Inc. 12 P. Powell 13 Astart Technologies 14 February 17, 1998 16 Internet Printing Protocol/1.1: Model and Semantics 18 Copyright (C) The Internet Society (1999). All Rights Reserved. 20 Status of this Memo 22 This document is an Internet-Draft and is in full conformance with all 23 provisions of Section 10 of [RFC2026]. Internet-Drafts are working 24 documents of the Internet Engineering Task Force (IETF), its areas, and 25 its working groups. Note that other groups may also distribute working 26 documents as Internet-Drafts. 28 Internet-Drafts are draft documents valid for a maximum of six months 29 and may be updated, replaced, or obsoleted by other documents at any 30 time. It is inappropriate to use Internet-Drafts as reference material 31 or to cite them other than as "work in progress". 33 The list of current Internet-Drafts can be accessed at 34 http://www.ietf.org/ietf/1id-abstracts.txt 36 The list of Internet-Draft Shadow Directories can be accessed as 37 http://www.ietf.org/shadow.html. 39 Abstract 41 This document is one of a set of documents, which together describe all 42 aspects of a new Internet Printing Protocol (IPP). IPP is an 43 application level protocol that can be used for distributed printing 44 using Internet tools and technologies. This document describes a 45 simplified model consisting of abstract objects, their attributes, and 46 their operations that is independent of encoding and transport. The 47 model consists of a Printer and a Job object. A Job optionally supports 48 multiple documents. IPP 1.1 semantics allow end-users and operators to 49 query printer capabilities, submit print jobs, inquire about the status 50 of print jobs and printers, cancel, hold, release, and restart print 51 jobs. IPP 1.1 semantics allow operators to pause, resume, and purge 52 (jobs from) Printer objects. This document also addresses security, 53 internationalization, and directory issues. 55 The full set of IPP documents includes: 57 Expires August 17, 1999 58 Design Goals for an Internet Printing Protocol [IPP-REQ] 59 Rationale for the Structure and Model and Protocol for the Internet 60 Printing Protocol [IPP-RAT] 61 Internet Printing Protocol/1.1: Model and Semantics (this document) 62 Internet Printing Protocol/1.1: Encoding and Transport [IPP-PRO] 63 Internet Printing Protocol/1.1: Implementer's Guide [IPP-IIG] 64 Mapping between LPD and IPP Protocols [IPP LPD] 66 The "Design Goals for an Internet Printing Protocol" document takes a 67 broad look at distributed printing functionality, and it enumerates 68 real-life scenarios that help to clarify the features that need to be 69 included in a printing protocol for the Internet. It identifies 70 requirements for three types of users: end users, operators, and 71 administrators. It calls out a subset of end user requirements that are 72 satisfied in IPP/1.0. Operator and administrator requirements are out 73 of scope for version 1.0. A few OPTIONAL operator operations have been 74 added to IPP/1.1. 76 The "Rationale for the Structure and Model and Protocol for the Internet 77 Printing Protocol" document describes IPP from a high level view, 78 defines a roadmap for the various documents that form the suite of IPP 79 specifications, and gives background and rationale for the IETF working 80 group's major decisions. 82 The "Internet Printing Protocol/1.1: Encoding and Transport" document is 83 a formal mapping of the abstract operations and attributes defined in 84 the model document onto HTTP/1.1. It defines the encoding rules for a 85 new Internet MIME media type called "application/ipp". This document 86 also defines the rules for transporting over HTTP a message body whose 87 Content-Type is .application/ipp.. This document defines a new scheme 88 named .ipp. for identifying IPP printers and jobs. Finally, this 89 document defines rules for supporting IPP/1.0 clients. 91 The "Internet Printing Protocol/1.1: Implementer's Guide" document gives 92 insight and advice to implementers of IPP clients and IPP objects. It 93 is intended to help them understand IPP/1.1 and some of the 94 considerations that may assist them in the design of their client and/or 95 IPP object implementations. For example, a typical order of processing 96 requests is given, including error checking. Motivation for some of the 97 specification decisions is also included. 99 The "Mapping between LPD and IPP Protocols" document gives some advice 100 to implementers of gateways between IPP and LPD (Line Printer Daemon) 101 implementations. 103 Expires August 17, 1999 104 Table of Contents 106 1. Introduction.....................................................9 107 1.1 Simplified Printing Model.....................................10 109 2. IPP Objects.....................................................12 110 2.1 Printer Object................................................13 111 2.2 Job Object....................................................14 112 2.3 Object Relationships..........................................15 113 2.4 Object Identity...............................................16 115 3. IPP Operations..................................................18 116 3.1 Common Semantics..............................................19 117 3.1.1 Required Parameters........................................19 118 3.1.2 Operation IDs and Request IDs..............................20 119 3.1.3 Attributes.................................................20 120 3.1.4 Character Set and Natural Language Operation Attributes....22 121 3.1.4.1 Request Operation Attributes..........................22 122 3.1.4.2 Response Operation Attributes.........................26 123 3.1.5 Operation Targets..........................................27 124 3.1.6 Operation Status Codes and Messages........................28 125 3.1.7 Versions...................................................29 126 3.1.8 Job Creation Operations....................................30 127 3.2 Printer Operations............................................32 128 3.2.1 Print-Job Operation........................................32 129 3.2.1.1 Print-Job Request.....................................32 130 3.2.1.2 Print-Job Response....................................36 131 3.2.2 Print-URI Operation........................................39 132 3.2.3 Validate-Job Operation.....................................39 133 3.2.4 Create-Job Operation.......................................39 134 3.2.5 Get-Printer-Attributes Operation...........................40 135 3.2.5.1 Get-Printer-Attributes Request........................40 136 3.2.5.2 Get-Printer-Attributes Response.......................42 137 3.2.6 Get-Jobs Operation.........................................43 138 3.2.6.1 Get-Jobs Request......................................43 139 3.2.6.2 Get-Jobs Response.....................................45 140 3.2.7 Pause-Printer Operation....................................46 141 3.2.7.1 Pause-Printer Request.................................47 142 3.2.7.2 Pause-Printer Response................................48 143 3.2.8 Resume-Printer Operation...................................48 144 3.2.9 Purge-Jobs Operation.......................................49 145 3.3 Job Operations................................................49 146 3.3.1 Send-Document Operation....................................50 147 3.3.1.1 Send-Document Request.................................51 148 3.3.1.2 Send-Document Response................................52 149 3.3.2 Send-URI Operation.........................................53 150 3.3.3 Cancel-Job Operation.......................................53 151 3.3.3.1 Cancel-Job Request....................................53 152 3.3.3.2 Cancel-Job Response...................................54 153 3.3.4 Get-Job-Attributes Operation...............................55 154 3.3.4.1 Get-Job-Attributes Request............................55 155 3.3.4.2 Get-Job-Attributes Response...........................56 156 3.3.5 Hold-Job Operation.........................................57 158 Expires August 17, 1999 159 3.3.5.1 Hold-Job Request......................................58 160 3.3.5.2 Hold-Job Response.....................................59 161 3.3.6 Release-Job Operation......................................59 162 3.3.7 Restart-Job Operation......................................60 163 3.3.7.1 Restart-Job Request...................................61 164 3.3.7.2 Restart-Job Response..................................62 166 4. Object Attributes...............................................62 167 4.1 Attribute Syntaxes............................................62 168 4.1.1 'text'.....................................................63 169 4.1.1.1 'textWithoutLanguage'.................................64 170 4.1.1.2 'textWithLanguage'....................................64 171 4.1.2 'name'.....................................................65 172 4.1.2.1 'nameWithoutLanguage'.................................66 173 4.1.2.2 'nameWithLanguage'....................................66 174 4.1.2.3 Matching 'name' attribute values......................66 175 4.1.3 'keyword'..................................................67 176 4.1.4 'enum'.....................................................67 177 4.1.5 'uri'......................................................68 178 4.1.6 'uriScheme'................................................68 179 4.1.7 'charset'..................................................69 180 4.1.8 'naturalLanguage'..........................................69 181 4.1.9 'mimeMediaType'............................................70 182 4.1.10 'octetString'.........................................71 183 4.1.11 'boolean'.............................................71 184 4.1.12 'integer'.............................................71 185 4.1.13 'rangeOfInteger'......................................71 186 4.1.14 'dateTime'............................................72 187 4.1.15 'resolution'..........................................72 188 4.1.16 '1setOf X'...........................................72 189 4.2 Job Template Attributes.......................................72 190 4.2.1 job-priority (integer(1:100))..............................76 191 4.2.2 job-hold-until (type3 keyword | name (MAX))................77 192 4.2.3 job-sheets (type3 keyword | name(MAX)).....................77 193 4.2.4 multiple-document-handling (type2 keyword).................78 194 4.2.5 copies (integer(1:MAX))....................................79 195 4.2.6 finishings (1setOf type2 enum).............................79 196 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))................81 197 4.2.8 sides (type2 keyword)......................................82 198 4.2.9 number-up (integer(1:MAX)).................................83 199 4.2.10 orientation-requested (type2 enum)....................83 200 4.2.11 media (type3 keyword | name(MAX)).....................84 201 4.2.12 printer-resolution (resolution).......................85 202 4.2.13 print-quality (type2 enum)............................85 203 4.3 Job Description Attributes....................................86 204 4.3.1 job-uri (uri)..............................................88 205 4.3.2 job-id (integer(1:MAX))....................................88 206 4.3.3 job-printer-uri (uri)......................................88 207 4.3.4 job-more-info (uri)........................................89 208 4.3.5 job-name (name(MAX)).......................................89 209 4.3.6 job-originating-user-name (name(MAX))......................89 210 4.3.7 job-state (type1 enum).....................................89 211 4.3.7.1 Partitioning of Job States............................92 212 4.3.8 job-state-reasons (1setOf type2 keyword)..................93 214 Expires August 17, 1999 215 4.3.9 job-state-message (text(MAX))..............................95 216 4.3.10 number-of-documents (integer(0:MAX))..................95 217 4.3.11 output-device-assigned (name(127))....................96 218 4.3.12 time-at-creation (integer(0:MAX)).....................96 219 4.3.13 time-at-processing (integer(0:MAX))...................96 220 4.3.14 time-at-completed (integer(0:MAX))....................96 221 4.3.15 number-of-intervening-jobs (integer(0:MAX))...........96 222 4.3.16 job-message-from-operator (text(127)).................96 223 4.3.17 job-k-octets (integer(0:MAX)).........................97 224 4.3.18 job-impressions (integer(0:MAX))......................97 225 4.3.19 job-media-sheets (integer(0:MAX)).....................98 226 4.3.20 job-k-octets-processed (integer(0:MAX))...............98 227 4.3.21 job-impressions-completed (integer(0:MAX))............98 228 4.3.22 job-media-sheets-completed (integer(0:MAX))...........99 229 4.3.23 attributes-charset (charset)..........................99 230 4.3.24 attributes-natural-language (naturalLanguage).........99 231 4.4 Printer Description Attributes................................99 232 4.4.1 printer-uri-supported (1setOf uri)........................101 233 4.4.2 uri-security-supported (1setOf type2 keyword).............101 234 4.4.3 printer-name (name(127))..................................102 235 4.4.4 printer-location (text(127))..............................103 236 4.4.5 printer-info (text(127))..................................103 237 4.4.6 printer-more-info (uri)...................................103 238 4.4.7 printer-driver-installer (uri)............................103 239 4.4.8 printer-make-and-model (text(127))........................103 240 4.4.9 printer-more-info-manufacturer (uri)......................103 241 4.4.10 printer-state (type1 enum)...........................104 242 4.4.11 printer-state-reasons (1setOf type2 keyword).........105 243 4.4.12 printer-state-message (text(MAX))....................107 244 4.4.13 operations-supported (1setOf type2 enum).............107 245 4.4.14 charset-configured (charset).........................108 246 4.4.15 charset-supported (1setOf charset)...................108 247 4.4.16 natural-language-configured (naturalLanguage)........109 248 4.4.17 generated-natural-language-supported (1setOf 249 naturalLanguage)................................................109 250 4.4.18 document-format-default (mimeMediaType)..............109 251 4.4.19 document-format-supported (1setOf mimeMediaType).....110 252 4.4.20 printer-is-accepting-jobs (boolean)..................110 253 4.4.21 queued-job-count (integer(0:MAX))....................110 254 4.4.22 printer-message-from-operator (text(127))............110 255 4.4.23 color-supported (boolean)............................110 256 4.4.24 reference-uri-schemes-supported (1setOf uriScheme)...110 257 4.4.25 pdl-override-supported (type2 keyword)...............111 258 4.4.26 printer-up-time (integer(1:MAX)).....................111 259 4.4.27 printer-current-time (dateTime)......................112 260 4.4.28 multiple-operation-time-out (integer(1:MAX)).........112 261 4.4.29 compression-supported (1setOf type3 keyword).........112 262 4.4.30 job-k-octets-supported (rangeOfInteger(0:MAX)).......112 263 4.4.31 job-impressions-supported (rangeOfInteger(0:MAX))....113 264 4.4.32 job-media-sheets-supported (rangeOfInteger(0:MAX))...113 265 4.4.33 pages-per-minute (integer(0:MAX))....................113 266 4.4.34 pages-per-minute-color (integer(0:MAX))..............113 268 5. Conformance....................................................114 270 Expires August 17, 1999 271 5.1 Client Conformance Requirements..............................114 272 5.2 IPP Object Conformance Requirements..........................115 273 5.2.1 Objects...................................................115 274 5.2.2 Operations................................................115 275 5.2.3 IPP Object Attributes.....................................116 276 5.2.4 Versions..................................................107 277 5.2.5 Extensions................................................116 278 5.2.6 Attribute Syntaxes........................................116 279 5.3 Charset and Natural Language Requirements....................116 280 5.4 Security Conformance Requirements............................117 282 6. IANA Considerations (registered and private extensions)........117 283 6.1 Typed 'keyword' and 'enum' Extensions........................118 284 6.2 Attribute Extensibility......................................120 285 6.3 Attribute Syntax Extensibility...............................120 286 6.4 Operation Extensibility......................................121 287 6.5 Attribute Groups.............................................121 288 6.6 Status Code Extensibility....................................121 289 6.7 Registration of MIME types/sub-types for document-formats....122 290 6.8 Registration of charsets for use in 'charset' attribute values122 292 7. Internationalization Considerations............................122 294 8. Security Considerations........................................125 295 8.1 Security Scenarios...........................................126 296 8.1.1 Client and Server in the Same Security Domain.............126 297 8.1.2 Client and Server in Different Security Domains...........127 298 8.1.3 Print by Reference........................................127 299 8.2 URIs for TLS and non-TLS Access..............................127 300 8.3 The "requesting-user-name" (name(MAX)) Operation Attribute...127 301 8.4 Restricted Queries...........................................129 302 8.5 Operations performed by operators and system administrators..129 303 8.6 Queries on jobs submitted using non-IPP protocols............129 304 8.7 IPP Security Application Profile for TLS.....................130 306 9. References.....................................................130 308 10.Notices.......................................................134 310 11.Author's Address..............................................135 312 12.Formats for IPP Registration Proposals........................137 313 12.1.....................Type2 keyword attribute values registration 314 137 315 12.2.....................Type3 keyword attribute values registration 316 137 317 12.3........................Type2 enum attribute values registration 318 137 319 12.4........................Type3 enum attribute values registration 320 138 321 12.5..........................................Attribute registration 322 138 323 12.6...................................Attribute Syntax registration 324 139 326 Expires August 17, 1999 328 12.7..........................................Operation registration 329 139 330 12.8....................................Attribute Group registration 331 139 332 12.9........................................Status code registration 333 140 335 13.APPENDIX A: Terminology.......................................140 336 13.1.........................................Conformance Terminology 337 140 338 13.1.1 NEED NOT.............................................140 339 13.2...............................................Model Terminology 340 140 341 13.2.1 Keyword..............................................140 342 13.2.2 Attributes...........................................140 343 13.2.2.1 Attribute Name.......................................141 344 13.2.2.2 Attribute Group Name.................................141 345 13.2.2.3 Attribute Value......................................141 346 13.2.2.4 Attribute Syntax.....................................141 347 13.2.3 Supports.............................................141 348 13.2.4 print-stream page....................................143 349 13.2.5 impression...........................................143 351 14.APPENDIX B: Status Codes and Suggested Status Code Messages..143 352 14.1....................................................Status Codes 353 144 354 14.1.1 Informational........................................145 355 14.1.2 Successful Status Codes..............................145 356 14.1.2.1 successful-ok (0x0000)...............................145 357 14.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001)145 358 14.1.2.3 successful-ok-conflicting-attributes (0x0002)........145 359 14.1.3 Redirection Status Codes.............................146 360 14.1.4 Client Error Status Codes............................146 361 14.1.4.1 client-error-bad-request (0x0400)....................146 362 14.1.4.2 client-error-forbidden (0x0401)......................146 363 14.1.4.3 client-error-not-authenticated (0x0402)..............146 364 14.1.4.4 client-error-not-authorized (0x0403).................146 365 14.1.4.5 client-error-not-possible (0x0404)...................147 366 14.1.4.6 client-error-timeout (0x0405)........................147 367 14.1.4.7 client-error-not-found (0x0406)......................147 368 14.1.4.8 client-error-gone (0x0407)...........................147 369 14.1.4.9 client-error-request-entity-too-large (0x0408).......148 370 14.1.4.10client-error-request-value-too-long (0x0409).........148 371 14.1.4.11client-error-document-format-not-supported (0x040A)..148 372 14.1.4.12client-error-attributes-or-values-not-supported (0x040B)148 373 14.1.4.13client-error-uri-scheme-not-supported (0x040C).......149 374 14.1.4.14client-error-charset-not-supported (0x040D)..........149 375 14.1.4.15client-error-conflicting-attributes (0x040E).........149 376 14.1.5 Server Error Status Codes............................149 377 14.1.5.1 server-error-internal-error (0x0500).................149 378 14.1.5.2 server-error-operation-not-supported (0x0501)........150 379 14.1.5.3 server-error-service-unavailable (0x0502)............150 380 14.1.5.4 server-error-version-not-supported (0x0503)..........150 381 14.1.5.5 server-error-device-error (0x0504)...................150 383 Expires August 17, 1999 384 14.1.5.6 server-error-temporary-error (0x0505)................151 385 14.1.5.7 server-error-not-accepting-jobs (0x0506).............151 386 14.1.5.8 server-error-busy (0x0507)...........................151 387 14.1.5.9 server-error-job-canceled (0x0508)...................151 388 14.2.................................Status Codes for IPP Operations 389 152 391 15.APPENDIX C: "media" keyword values...........................153 393 16.APPENDIX D: Processing IPP Attributes.........................158 394 16.1........................................................Fidelity 395 158 396 16.2........................Page Description Language (PDL) Override 397 159 398 16.3.......Using Job Template Attributes During Document Processing. 399 161 401 17.APPENDIX E: Generic Directory Schema..........................162 403 18.APPENDIX F: Differences between the IPP/1.0 and IPP/1.1 "Model and 404 Semantics" Specifications.........................................164 406 Expires August 17, 1999 407 1. Introduction 409 The Internet Printing Protocol (IPP) is an application level protocol 410 that can be used for distributed printing using Internet tools and 411 technologies. IPP version 1.1 (IPP/1.1) focuses only on end user 412 functionality. This document is just one of a suite of documents that 413 fully define IPP. The full set of IPP documents includes: 415 Design Goals for an Internet Printing Protocol [IPP-REQ] 416 Rationale for the Structure and Model and Protocol for the Internet 417 Printing Protocol [IPP-RAT] 418 Internet Printing Protocol/1.1: Model and Semantics (this document) 419 Internet Printing Protocol/1.1: Encoding and Transport [IPP-PRO] 420 Internet Printing Protocol/1.1: Implementer's Guide [IPP-IIG] 421 Mapping between LPD and IPP Protocols [IPP-LPD] 423 Anyone reading these documents for the first time is strongly encouraged 424 to read the IPP documents in the above order. 426 This document is laid out as follows: 428 - The rest of Section 1 is an introduction to the IPP simplified 429 model for distributed printing. 430 - Section 2 introduces the object types covered in the model with 431 their basic behaviors, attributes, and interactions. 432 - Section 3 defines the operations included in IPP/1.1. IPP 433 operations are synchronous, therefore, for each operation, there is 434 a both request and a response. 435 - Section 4 defines the attributes (and their syntaxes) that are used 436 in the model. 437 - Sections 5 - 6 summarizes the implementation conformance 438 requirements for objects that support the protocol and IANA 439 considerations, respectively. 440 - Sections 7 - 12 cover the Internationalization and Security 441 considerations as well as References, Intellectual Property Notice, 442 Copyright Notice, Author contact information, and Formats for 443 Registration Proposals. 444 - Sections 13 - 15 are appendices that cover Terminology, Status 445 Codes and Messages, and "media" keyword values. 447 Note: This document uses terms such as "attributes", 448 "keywords", and "support". These terms have special meaning 449 and are defined in the model terminology section 13.2. 450 Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, 451 SHOULD NOT, MAY, NEED NOT, and OPTIONAL, have special meaning 452 relating to conformance. These terms are defined in section 453 13.1 on conformance terminology, most of which is taken from 454 RFC 2119 [RFC2119]. 456 - Section 16 is an appendix that helps to clarify the effects of 457 interactions between related attributes and their values. 458 - Section 17 is an appendix that enumerates the subset of Printer 459 attributes that form a generic directory schema. These attributes 460 are useful when registering a Printer so that a client can find the 461 Printer not just by name, but by filtered searches as well. 463 Expires August 17, 1999 465 - Section 18 is an appendix summarizing the additions and changes 466 from the IPP/1.0 "Model and Semantics" specification [IPP-MOD1.0] 467 to make this IPP/1.1 document. 469 1.1 Simplified Printing Model 471 In order to achieve its goal of realizing a workable printing protocol 472 for the Internet, the Internet Printing Protocol (IPP) is based on a 473 simplified printing model that abstracts the many components of real 474 world printing solutions. The Internet is a distributed computing 475 environment where requesters of print services (clients, applications, 476 printer drivers, etc.) cooperate and interact with print service 477 providers. This model and semantics document describes a simple, 478 abstract model for IPP even though the underlying configurations may be 479 complex "n-tier" client/server systems. An important simplifying step 480 in the IPP model is to expose only the key objects and interfaces 481 required for printing. The model described in this model document does 482 not include features, interfaces, and relationships that are beyond the 483 scope of the first version of IPP (IPP/1.1). IPP/1.1 incorporates many 484 of the relevant ideas and lessons learned from other specification and 485 development efforts [HTPP] [ISO10175] [LDPA] [P1387.4] [PSIS] [RFC1179] 486 [SWP]. IPP is heavily influenced by the printing model introduced in 487 the Document Printing Application (DPA) [ISO10175] standard. Although 488 DPA specifies both end user and administrative features, IPP version 1.1 489 (IPP/1.1) focuses primarily on end user functionality with a few 490 additional OPTIONAL operator operations. 492 The IPP/1.1 model encapsulates the important components of distributed 493 printing into two object types: 495 - Printer (Section 2.1) 496 - Job (Section 2.2) 498 Each object type has an associated set of operations (see section 3) and 499 attributes (see section 3.3.5). 501 It is important, however, to understand that in real system 502 implementations (which lie underneath the abstracted IPP/1.1 model), 503 there are other components of a print service which are not explicitly 504 defined in the IPP/1.1 model. The following figure illustrates where 505 IPP/1.1 fits with respect to these other components. 507 Expires August 17, 1999 508 +--------------+ 509 | Application | 510 o +. . . . . . . | 511 \|/ | Spooler | 512 / \ +. . . . . . . | +---------+ 513 End-User | Print Driver |---| File | 514 +-----------+ +-----+ +------+-------+ +----+----+ 515 | Browser | | GUI | | | 516 +-----+-----+ +--+--+ | | 517 | | | | 518 | +---+------------+---+ | 519 N D S | | IPP Client |------------+ 520 O I E | +---------+----------+ 521 T R C | | 522 I E U | 523 F C R -------------- Transport ------------------ 524 I T I 525 C O T | --+ 526 A R Y +--------+--------+ | 527 T Y | IPP Server | | 528 I +--------+--------+ | 529 O | | 530 N +-----------------+ | IPP Printer 531 | Print Service | | 532 +-----------------+ | 533 | --+ 534 +-----------------+ 535 | Output Device(s)| 536 +-----------------+ 538 An IPP Printer object encapsulates the functions normally associated 539 with physical output devices along with the spooling, scheduling and 540 multiple device management functions often associated with a print 541 server. Printer objects are optionally registered as entries in a 542 directory where end users find and select them based on some sort of 543 filtered and context based searching mechanism (see section 17). The 544 directory is used to store relatively static information about the 545 Printer, allowing end users to search for and find Printers that match 546 their search criteria, for example: name, context, printer capabilities, 547 etc. The more dynamic information, such as state, currently loaded and 548 ready media, number of jobs at the Printer, errors, warnings, and so 549 forth, is directly associated with the Printer object itself rather than 550 with the entry in the directory which only represents the Printer 551 object. 553 IPP clients implement the IPP protocol on the client side and give end 554 users (or programs running on behalf of end users) the ability to query 555 Printer objects and submit and manage print jobs. An IPP server is just 556 that part of the Printer object that implements the server-side 557 protocol. The rest of the Printer object implements (or gateways into) 558 the application semantics of the print service itself. The Printer 560 Expires August 17, 1999 561 objects may be embedded in an output device or may be implemented on a 562 host on the network that communicates with an output device. 564 When a job is submitted to the Printer object and the Printer object 565 validates the attributes in the submission request, the Printer object 566 creates a new Job object. The end user then interacts with this new Job 567 object to query its status and monitor the progress of the job. An end 568 user can also cancel their print jobs by using the Job object's Cancel- 569 Job operation. An end-user can also hold, release, and restart their 570 print jobs using the Job object's OPTIONAL Hold-Job, Release-Job, and 571 Restart-Job operations, if implemented. 573 A privileged operator or administrator of a Printer object can cancel, 574 hold, release, and restart any user's job using the REQUIRED Cancel-Job 575 and the OPTIONAL Hold-Job, Release-Job, and Restart-Job operations. In 576 additional privileged operator or administrator of a Printer object can 577 pause, resume, or purge (jobs from) a Printer object using the OPTIONAL 578 Pause-Printer, Resume-Printer, and Purge-Jobs operations, if 579 implemented. 581 The notification service is out of scope for this IPP/1.1 specification, 582 but using such a notification service, the end user is able to register 583 for and receive Printer specific and Job specific events. An end user 584 can query the status of Printer objects and can follow the progress of 585 Job objects by polling using the Get-Printer-Attributes, Get-Jobs, and 586 Get-Job-Attributes operations. 588 2. IPP Objects 590 The IPP/1.1 model introduces objects of type Printer and Job. Each type 591 of object models relevant aspects of a real-world entity such as a real 592 printer or real print job. Each object type is defined as a set of 593 possible attributes that may be supported by instances of that object 594 type. For each object (instance), the actual set of supported 595 attributes and values describe a specific implementation. The object's 596 attributes and values describe its state, capabilities, realizable 597 features, job processing functions, and default behaviors and 598 characteristics. For example, the Printer object type is defined as a 599 set of attributes that each Printer object potentially supports. In the 600 same manner, the Job object type is defined as a set of attributes that 601 are potentially supported by each Job object. 603 Each attribute included in the set of attributes defining an object type 604 is labeled as: 606 - "REQUIRED": each object MUST support the attribute. 607 - "OPTIONAL": each object MAY support the attribute. 609 There is no such similar labeling of attribute values. However, if an 610 implementation supports an attribute, it MUST support at least one of 611 the possible values for that attribute. 613 Expires August 17, 1999 614 2.1 Printer Object 616 The major component of the IPP/1.1 model is the Printer object. A 617 Printer object implements the server-side of the IPP/1.1 protocol. 618 Using the protocol, end users may query the attributes of the Printer 619 object and submit print jobs to the Printer object. The actual 620 implementation components behind the Printer abstraction may take on 621 different forms and different configurations. However, the model 622 abstraction allows the details of the configuration of real components 623 to remain opaque to the end user. Section 3 describes each of the 624 Printer operations in detail. 626 The capabilities and state of a Printer object are described by its 627 attributes. Printer attributes are divided into two groups: 629 - "job-template" attributes: These attributes describe supported job 630 processing capabilities and defaults for the Printer object. (See 631 section 4.2) 632 - "printer-description" attributes: These attributes describe the 633 Printer object's identification, state, location, references to 634 other sources of information about the Printer object, etc. (see 635 section 4.4) 637 Since a Printer object is an abstraction of a generic document output 638 device and print service provider, a Printer object could be used to 639 represent any real or virtual device with semantics consistent with the 640 Printer object, such as a fax device, an imager, or even a CD writer. 642 Some examples of configurations supporting a Printer object include: 644 1) An output device with no spooling capabilities 645 2) An output device with a built-in spooler 646 3) A print server supporting IPP with one or more associated output 647 devices 648 3a) The associated output devices may or may not be capable of 649 spooling jobs 650 3b) The associated output devices may or may not support IPP 652 The following figures show some examples of how Printer objects can be 653 realized on top of various distributed printing configurations. The 654 embedded case below represents configurations 1 and 2. The hosted and 655 fan-out figures below represent configurations 3a and 3b. 657 Expires August 17, 1999 658 Legend: 660 ##### indicates a Printer object which is 661 either embedded in an output device or is 662 hosted in a server. The Printer object 663 might or might not be capable of queuing/spooling. 665 any indicates any network protocol or direct 666 connect, including IPP 668 embedded printer: 669 output device 670 +---------------+ 671 O +--------+ | ########### | 672 /|\ | client |------------IPP------------># Printer # | 673 / \ +--------+ | # Object # | 674 | ########### | 675 +---------------+ 677 hosted printer: 678 +---------------+ 679 O +--------+ ########### | | 680 /|\ | client |--IPP--># Printer #-any->| output device | 681 / \ +--------+ # Object # | | 682 ########### +---------------+ 684 +---------------+ 685 fan out: | | 686 +-->| output device | 687 any/ | | 688 O +--------+ ########### / +---------------+ 689 /|\ | client |-IPP-># Printer #--* 690 / \ +--------+ # Object # \ +---------------+ 691 ########### any\ | | 692 +-->| output device | 693 | | 694 +---------------+ 696 2.2 Job Object 698 A Job object is used to model a print job. A Job object contains 699 documents. The information required to create a Job object is sent in a 700 create request from the end user via an IPP Client to the Printer 701 object. The Printer object validates the create request, and if the 702 Printer object accepts the request, the Printer object creates the new 703 Job object. Section 3 describes each of the Job operations in detail. 705 Expires August 17, 1999 706 The characteristics and state of a Job object are described by its 707 attributes. Job attributes are grouped into two groups as follows: 709 - "job-template" attributes: These attributes can be supplied by the 710 client or end user and include job processing instructions which 711 are intended to override any Printer object defaults and/or 712 instructions embedded within the document data. (See section 4.2) 713 - "job-description" attributes: These attributes describe the Job 714 object's identification, state, size, etc. The client supplies some 715 of these attributes, and the Printer object generates others. (See 716 section 4.3) 718 An implementation MUST support at least one document per Job object. An 719 implementation MAY support multiple documents per Job object. A 720 document is either: 722 - a stream of document data in a format supported by the Printer 723 object (typically a Page Description Language - PDL), or 724 - a reference to such a stream of document data 726 In IPP/1.1, a document is not modeled as an IPP object, therefore it has 727 no object identifier or associated attributes. All job processing 728 instructions are modeled as Job object attributes. These attributes are 729 called Job Template attributes and they apply equally to all documents 730 within a Job object. 732 2.3 Object Relationships 734 IPP objects have relationships that are maintained persistently along 735 with the persistent storage of the object attributes. 737 A Printer object can represent either one or more physical output 738 devices or a logical device which "processes" jobs but never actually 739 uses a physical output device to put marks on paper. Examples of 740 logical devices include a Web page publisher or a gateway into an online 741 document archive or repository. A Printer object contains zero or more 742 Job objects. 744 A Job object is contained by exactly one Printer object, however the 745 identical document data associated with a Job object could be sent to 746 either the same or a different Printer object. In this case, a second 747 Job object would be created which would be almost identical to the first 748 Job object, however it would have new (different) Job object identifiers 749 (see section 2.4). 751 A Job object is either empty (before any documents have been added) or 752 contains one or more documents. If the contained document is a stream 753 of document data, that stream can be contained in only one document. 754 However, there can be identical copies of the stream in other documents 755 in the same or different Job objects. If the contained document is just 756 a reference to a stream of document data, other documents (in the same 757 or different Job object(s)) may contain the same reference. 759 Expires August 17, 1999 760 2.4 Object Identity 762 All Printer and Job objects are identified by a Uniform Resource 763 Identifier (URI) [RFC2396] so that they can be persistently and 764 unambiguously referenced. The notion of a URI is a useful concept, 765 however, until the notion of URI is more stable (i.e., defined more 766 completely and deployed more widely), it is expected that the URIs used 767 for IPP objects will actually be URLs [RFC2396]. Since every URL is a 768 specialized form of a URI, even though the more generic term URI is used 769 throughout the rest of this document, its usage is intended to cover the 770 more specific notion of URL as well. 772 An administrator configures Printer objects to either support or not 773 support authentication and/or message privacy using TLS [TLS] (the 774 mechanism for security configuration is outside the scope of this 775 IPP/1.1 document). In some situations, both types of connections (both 776 authenticated and unauthenticated) can be established using a single 777 communication channel that has some sort of negotiation mechanism. In 778 other situations, multiple communication channels are used, one for each 779 type of security configuration. Section 8 provides a full description 780 of all security considerations and configurations. 782 If a Printer object supports more than one communication channel, some 783 or all of those channels might support and/or require different security 784 mechanisms. In such cases, an administrator could expose the 785 simultaneous support for these multiple communication channels as 786 multiple URIs for a single Printer object where each URI represents one 787 of the communication channels to the Printer object. To support this 788 flexibility, the IPP Printer object type defines a multi-valued 789 identification attribute called the "printer-uri-supported" attribute. 790 It MUST contain at least one URI. It MAY contain more than one URI. 791 That is, every Printer object will have at least one URI that identifies 792 at least one communication channel to the Printer object, but it may 793 have more than one URI where each URI identifies a different 794 communication channel to the Printer object. The "printer-uri- 795 supported" attribute has a companion attribute, the "uri-security- 796 supported" attribute, that has the same cardinality as "printer-uri- 797 supported". The purpose of the "uri-security-supported" attribute is to 798 indicate the security mechanisms (if any) used for each URI listed in 799 "printer-uri-supported". These two attributes are fully described in 800 sections 4.4.1 and 4.4.2. 802 When a job is submitted to the Printer object via a create request, the 803 client supplies only a single Printer object URI. The client supplied 804 Printer object URI MUST be one of the values in the "printer-uri- 805 supported" Printer attribute. 807 Note: IPP/1.1 does not specify how the client obtains the client 808 supplied URI, but it is RECOMMENDED that a Printer object be registered 809 as an entry in a directory service. End-users and programs can then 810 interrogate the directory searching for Printers. Section 17 defines a 811 generic schema for Printer object entries in the directory service and 812 describes how the entry acts as a bridge to the actual IPP Printer 814 Expires August 17, 1999 815 object. The entry in the directory that represents the IPP Printer 816 object includes the possibly many URIs for that Printer object as values 817 in one its attributes. 819 When a client submits a create request to the Printer object, the 820 Printer object validates the request and creates a new Job object. The 821 Printer object assigns the new Job object a URI which is stored in the 822 "job-uri" Job attribute. This URI is then used by clients as the target 823 for subsequent Job operations. The Printer object generates a Job URI 824 based on its configured security policy and the URI used by the client 825 in the create request. 827 For example, consider a Printer object that supports both a 828 communication channel secured by the use of SSL3 (using HTTP over SSL3 829 with an "https" schemed URI) and another open communication channel that 830 is not secured with SSL3 (using a simple "http" schemed URI). If a 831 client were to submit a job using the secure URI, the Printer object 832 would assign the new Job object a secure URI as well. If a client were 833 to submit a job using the open-channel URI, the Printer would assign the 834 new Job object an open-channel URI. 836 In addition, the Printer object also populates the Job object's "job- 837 printer-uri" attribute. This is a reference back to the Printer object 838 that created the Job object. If a client only has access to a Job 839 object's "job-uri" identifier, the client can query the Job's "job- 840 printer-uri" attribute in order to determine which Printer object 841 created the Job object. If the Printer object supports more than one 842 URI, the Printer object picks the one URI supplied by the client when 843 creating the job to build the value for and to populate the Job's "job- 844 printer-uri" attribute. 846 Allowing Job objects to have URIs allows for flexibility and 847 scalability. For example, in some implementations, the Printer object 848 might create Jobs that are processed in the same local environment as 849 the Printer object itself. In this case, the Job URI might just be a 850 composition of the Printer's URI and some unique component for the Job 851 object, such as the unique 32-bit positive integer mentioned later in 852 this paragraph. In other implementations, the Printer object might be a 853 central clearing-house for validating all Job object creation requests, 854 but the Job object itself might be created in some environment that is 855 remote from the Printer object. In this case, the Job object's URI may 856 have no physical-location relationship at all to the Printer object's 857 URI. Again, the fact that Job objects have URIs allows for flexibility 858 and scalability, however, many existing printing systems have local 859 models or interface constraints that force print jobs to be identified 860 using only a 32-bit positive integer rather than an independent URI. 861 This numeric Job ID is only unique within the context of the Printer 862 object to which the create request was originally submitted. Therefore, 863 in order to allow both types of client access to IPP Job objects (either 864 by Job URI or by numeric Job ID), when the Printer object successfully 865 processes a create request and creates a new Job object, the Printer 866 object MUST generate both a Job URI and a Job ID. The Job ID (stored in 867 the "job-id" attribute) only has meaning in the context of the Printer 868 object to which the create request was originally submitted. This 870 Expires August 17, 1999 871 requirement to support both Job URIs and Job IDs allows all types of 872 clients to access Printer objects and Job objects no matter the local 873 constraints imposed on the client implementation. 875 In addition to identifiers, Printer objects and Job objects have names 876 ("printer-name" and "job-name"). An object name NEED NOT be unique 877 across all instances of all objects. A Printer object's name is chosen 878 and set by an administrator through some mechanism outside the scope of 879 this IPP/1.1 document. A Job object's name is optionally chosen and 880 supplied by the IPP client submitting the job. If the client does not 881 supply a Job object name, the Printer object generates a name for the 882 new Job object. In all cases, the name only has local meaning. 884 To summarize: 886 - Each Printer object is identified with one or more URIs. The 887 Printer's "printer-uri-supported" attribute contains the URI(s). 888 - The Printer object's "uri-security-supported" attribute identifies 889 the communication channel security protocols that may or may not 890 have been configured for the various Printer object URIs (e.g., 891 'tls' or 'none'). 892 - Each Job object is identified with a Job URI. The Job's "job-uri" 893 attribute contains the URI. 894 - Each Job object is also identified with Job ID which is a 32-bit, 895 positive integer. The Job's "job-id" attribute contains the Job 896 ID. The Job ID is only unique within the context of the Printer 897 object which created the Job object. 898 - Each Job object has a "job-printer-uri" attribute which contains 899 the URI of the Printer object that was used to create the Job 900 object. This attribute is used to determine the Printer object 901 that created a Job object when given only the URI for the Job 902 object. This linkage is necessary to determine the languages, 903 charsets, and operations which are supported on that Job (the basis 904 for such support comes from the creating Printer object). 905 - Each Printer object has a name (which is not necessarily unique). 906 The administrator chooses and sets this name through some mechanism 907 outside the scope of this IPP/1.1 document. The Printer object's 908 "printer-name" attribute contains the name. 909 - Each Job object has a name (which is not necessarily unique). The 910 client optionally supplies this name in the create request. If the 911 client does not supply this name, the Printer object generates a 912 name for the Job object. The Job object's "job-name" attribute 913 contains the name. 915 3. IPP Operations 917 IPP objects support operations. An operation consists of a request and 918 a response. When a client communicates with an IPP object, the client 919 issues an operation request to the URI for that object. Operation 920 requests and responses have parameters that identify the operation. 921 Operations also have attributes that affect the run-time characteristics 922 of the operation (the intended target, localization information, etc.). 923 These operation-specific attributes are called operation attributes (as 925 Expires August 17, 1999 926 compared to object attributes such as Printer object attributes or Job 927 object attributes). Each request carries along with it any operation 928 attributes, object attributes, and/or document data required to perform 929 the operation. Each request requires a response from the object. Each 930 response indicates success or failure of the operation with a status 931 code as a response parameter. The response contains any operation 932 attributes, object attributes, and/or status messages generated during 933 the execution of the operation request. 935 This section describes the semantics of the IPP operations, both 936 requests and responses, in terms of the parameters, attributes, and 937 other data associated with each operation. 939 The IPP/1.1 Printer operations are: 941 Print-Job (section 3.2.1) 942 Print-URI (section 3.2.2) 943 Validate-Job (section 3.2.3) 944 Create-Job (section 3.2.4) 945 Get-Printer-Attributes (section 3.2.5) 946 Get-Jobs (section 3.2.6) 947 Pause-Printer (section 3.3.5) 948 Resume-Printer (section 3.3.6) 949 Purge-Jobs (section 3.3.7) 951 The Job operations are: 953 Send-Document (section 3.3.1) 954 Send-URI (section 3.3.2) 955 Cancel-Job (section 3.3.3) 956 Get-Job-Attributes (section 3.3.4) 957 Hold-Job (section 3.3.5) 958 Release-Job (section 3.3.6) 959 Restart-Job (section 3.3.7) 961 The Send-Document and Send-URI Job operations are used to add a new 962 document to an existing multi-document Job object created using the 963 Create-Job operation. 965 3.1 Common Semantics 967 All IPP operations require some common parameters and operation 968 attributes. These common elements and their semantic characteristics 969 are defined and described in more detail in the following sections. 971 3.1.1 Required Parameters 973 Every operation request contains the following REQUIRED parameters: 975 - a "version-number", 976 - an "operation-id", 977 - a "request-id", and 978 - the attributes that are REQUIRED for that type of request. 980 Expires August 17, 1999 982 Every operation response contains the following REQUIRED parameters: 984 - a "version-number", 985 - a "status-code", 986 - the "request-id" that was supplied in the corresponding request, 987 and 988 - the attributes that are REQUIRED for that type of response. 990 The "Encoding and Transport document [IPP-PRO] defines special rules for 991 the encoding of these parameters. All other operation elements are 992 represented using the more generic encoding rules for attributes and 993 groups of attributes. 995 3.1.2 Operation IDs and Request IDs 997 Each IPP operation request includes an identifying "operation-id" value. 998 Valid values are defined in the "operations-supported" Printer attribute 999 section (see section 4.4.13). The client specifies which operation is 1000 being requested by supplying the correct "operation-id" value. 1002 In addition, every invocation of an operation is identified by a 1003 "request-id" value. For each request, the client chooses the "request- 1004 id" which MUST be an integer (possibly unique depending on client 1005 requirements) in the range from 1 to 2**31 - 1 (inclusive). This 1006 "request-id" allows clients to manage multiple outstanding requests. The 1007 receiving IPP object copies all 32-bits of the client-supplied "request- 1008 id" attribute into the response so that the client can match the 1009 response with the correct outstanding request, even if the "request-id" 1010 is out of range. If the request is terminated before the complete 1011 "request-id" is received, the IPP object rejects the request and returns 1012 a response with a "request-id" of 0. 1014 Note: In some cases, the transport protocol underneath IPP might be a 1015 connection oriented protocol that would make it impossible for a client 1016 to receive responses in any order other than the order in which the 1017 corresponding requests were sent. In such cases, the "request-id" 1018 attribute would not be essential for correct protocol operation. 1019 However, in other mappings, the operation responses can come back in any 1020 order. In these cases, the "request-id" would be essential. 1022 3.1.3 Attributes 1024 Operation requests and responses are both composed of groups of 1025 attributes and/or document data. The attributes groups are: 1027 - Operation Attributes: These attributes are passed in the operation 1028 and affect the IPP object's behavior while processing the operation 1029 request and may affect other attributes or groups of attributes. 1030 Some operation attributes describe the document data associated 1031 with the print job and are associated with new Job objects, however 1032 most operation attributes do not persist beyond the life of the 1033 operation. The description of each operation attribute includes 1034 conformance statements indicating which operation attributes are 1035 REQUIRED and which are OPTIONAL for an IPP object to support and 1037 Expires August 17, 1999 1038 which attributes a client MUST supply in a request and an IPP 1039 object MUST supply in a response. 1040 - Job Template Attributes: These attributes affect the processing of 1041 a job. A client OPTIONALLY supplies Job Template Attributes in a 1042 create request, and the receiving object MUST be prepared to 1043 receive all supported attributes. The Job object can later be 1044 queried to find out what Job Template attributes were originally 1045 requested in the create request, and such attributes are returned 1046 in the response as Job Object Attributes. The Printer object can 1047 be queried about its Job Template attributes to find out what type 1048 of job processing capabilities are supported and/or what the 1049 default job processing behaviors are, though such attributes are 1050 returned in the response as Printer Object Attributes. The "ipp- 1051 attribute-fidelity" operation attribute affects processing of all 1052 client-supplied Job Template attributes (see sections 3.2.1.2 and 1053 16 for a full description of "ipp-attribute-fidelity" and its 1054 relationship to other attributes). 1055 - Job Object Attributes: These attributes are returned in response to 1056 a query operation directed at a Job object. 1057 - Printer Object Attributes: These attributes are returned in 1058 response to a query operation directed at a Printer object. 1059 - Unsupported Attributes: In a create request, the client supplies a 1060 set of Operation and Job Template attributes. If any of these 1061 attributes or their values is unsupported by the Printer object, 1062 the Printer object returns the set of unsupported attributes in the 1063 response. Sections 3.2.1.2 and 16 give a full description of how 1064 Job Template attributes supplied by the client in a create request 1065 are processed by the Printer object and how unsupported attributes 1066 are returned to the client. Because of extensibility, any IPP 1067 object might receive a request that contains new or unknown 1068 attributes or values for which it has no support. In such cases, 1069 the IPP object processes what it can and returns the unsupported 1070 attributes in the response. 1072 Later in this section, each operation is formally defined by identifying 1073 the allowed and expected groups of attributes for each request and 1074 response. The model identifies a specific order for each group in each 1075 request or response, but the attributes within each group may be in any 1076 order, unless specified otherwise. 1078 Each attribute specification includes the attribute's name followed by 1079 the name of its attribute syntax(es) in parenthesizes. In addition, 1080 each 'integer' attribute is followed by the allowed range in 1081 parentheses, (m:n), for values of that attribute. Each 'text' or 'name' 1082 attribute is followed by the maximum size in octets in parentheses, 1083 (size), for values of that attribute. For more details on attribute 1084 syntax notation, see the descriptions of these attributes syntaxes in 1085 section 4.1. 1087 Note: Document data included in the operation is not strictly an 1088 attribute, but it is treated as a special attribute group for ordering 1089 purposes. The only operations that support supplying the document data 1091 Expires August 17, 1999 1092 within an operation request are Print-Job and Send-Document. There are 1093 no operation responses that include document data. 1095 Note: Some operations are REQUIRED for IPP objects to support; the 1096 others are OPTIONAL (see section 5.2.2). Therefore, before using an 1097 OPTIONAL operation, a client SHOULD first use the REQUIRED Get-Printer- 1098 Attributes operation to query the Printer's "operations-supported" 1099 attribute in order to determine which OPTIONAL Printer and Job 1100 operations are actually supported. The client SHOULD NOT use an 1101 OPTIONAL operation that is not supported. When an IPP object receives a 1102 request to perform an operation it does not support, it returns the 1103 'server-error-operation-not-supported' status code (see section 1104 14.1.5.2). An IPP object is non-conformant if it does not support a 1105 REQUIRED operation. 1107 3.1.4 Character Set and Natural Language Operation Attributes 1109 Some Job and Printer attributes have values that are text strings and 1110 names intended for human understanding rather than machine understanding 1111 (see the 'text' and 'name' attribute syntax descriptions in section 1112 4.1). The following sections describe two special Operation Attributes 1113 called "attributes-charset" and "attributes-natural-language". These 1114 attributes are always part of the Operation Attributes group. For most 1115 attribute groups, the order of the attributes within the group is not 1116 important. However, for these two attributes within the Operation 1117 Attributes group, the order is critical. The "attributes-charset" 1118 attribute MUST be the first attribute in the group and the "attributes- 1119 natural-language" attribute MUST be the second attribute in the group. 1120 In other words, these attributes MUST be supplied in every IPP request 1121 and response, they MUST come first in the group, and MUST come in the 1122 specified order. For job creation operations, the IPP Printer 1123 implementation saves these two attributes with the new Job object as Job 1124 Description attributes. For the sake of brevity in this document, these 1125 operation attribute descriptions are not repeated with every operation 1126 request and response, but have a reference back to this section instead. 1128 3.1.4.1 Request Operation Attributes 1130 The client MUST supply and the Printer object MUST support the following 1131 REQUIRED operation attributes in every IPP/1.1 operation request: 1133 "attributes-charset" (charset): 1134 This operation attribute identifies the charset (coded character 1135 set and encoding method) used by any 'text' and 'name' attributes 1136 that the client is supplying in this request. It also identifies 1137 the charset that the Printer object MUST use (if supported) for all 1138 'text' and 'name' attributes and status messages that the Printer 1139 object returns in the response to this request. See Sections 4.1.1 1140 and 4.1.2 for the specification of the 'text' and 'name' attribute 1141 syntaxes. 1143 All clients and IPP objects MUST support the 'utf-8' charset 1144 [RFC2279] and MAY support additional charsets provided that they 1146 Expires August 17, 1999 1147 are registered with IANA [IANA-CS]. If the Printer object does not 1148 support the client supplied charset value, the Printer object MUST 1149 reject the request, set the "attributes-charset" to 'utf-8' in the 1150 response, and return the 'client-error-charset-not-supported' 1151 status code and any 'text' or 'name' attributes using the 'utf-8' 1152 charset. The Printer object MUST indicate the charset(s) supported 1153 as the values of the "charset-supported" Printer attribute (see 1154 Section 4.4.15), so that the client can query to determine which 1155 charset(s) are supported. 1157 Note to client implementers: Since IPP objects are only required to 1158 support the 'utf-8' charset, in order to maximize interoperability 1159 with multiple IPP object implementations, a client may want to 1160 supply 'utf-8' in the "attributes-charset" operation attribute, 1161 even though the client is only passing and able to present a 1162 simpler charset, such as US-ASCII or ISO-8859-1. Then the client 1163 will have to filter out (or charset convert) those characters that 1164 are returned in the response that it cannot present to its user. 1165 On the other hand, if both the client and the IPP objects also 1166 support a charset in common besides utf-8, the client may want to 1167 use that charset in order to avoid charset conversion or data loss. 1169 See the 'charset' attribute syntax description in Section 4.1.7 for 1170 the syntax and semantic interpretation of the values of this 1171 attribute and for example values. 1173 "attributes-natural-language" (naturalLanguage): 1174 This operation attribute identifies the natural language used by 1175 any 'text' and 'name' attributes that the client is supplying in 1176 this request. This attribute also identifies the natural language 1177 that the Printer object SHOULD use for all 'text' and 'name' 1178 attributes and status messages that the Printer object returns in 1179 the response to this request. 1181 There are no REQUIRED natural languages required for the Printer 1182 object to support. However, the Printer object's "generated- 1183 natural-language-supported" attribute identifies the natural 1184 languages supported by the Printer object and any contained Job 1185 objects for all text strings generated by the IPP object. A client 1186 MAY query this attribute to determine which natural language(s) are 1187 supported for generated messages. 1189 For any of the attributes for which the Printer object generates 1190 text, i.e., for the "job-state-message", "printer-state-message", 1191 and status messages (see Section 3.1.6), the Printer object MUST be 1192 able to generate these text strings in any of its supported natural 1193 languages. If the client requests a natural language that is not 1194 supported, the Printer object MUST return these generated messages 1195 in the Printer's configured natural language as specified by the 1196 Printer's "natural-language-configured" attribute" (see Section 1197 4.4.16). 1199 For other 'text' and 'name' attributes supplied by the client, 1200 authentication system, operator, system administrator, or 1202 Expires August 17, 1999 1203 manufacturer (i.e., for "job-originating-user-name", "printer-name" 1204 (name), "printer-location" (text), "printer-info" (text), and 1205 "printer-make-and-model" (text)), the Printer object is only 1206 required to support the configured natural language of the Printer 1207 identified by the Printer object's "natural-language-configured" 1208 attribute, though support of additional natural languages for these 1209 attributes is permitted. 1211 For any 'text' or 'name' attribute in the request that is in a 1212 different natural language than the value supplied in the 1213 "attributes-natural-language" operation attribute, the client MUST 1214 use the Natural Language Override mechanism (see sections 4.1.1.2 1215 and 4.1.2.2) for each such attribute value supplied. The client 1216 MAY use the Natural Language Override mechanism redundantly, i.e., 1217 use it even when the value is in the same natural language as the 1218 value supplied in the "attributes-natural-language" operation 1219 attribute of the request. 1221 The IPP object MUST accept any natural language and any Natural 1222 Language Override, whether the IPP object supports that natural 1223 language or not (and independent of the value of the "ipp- 1224 attribute-fidelity" Operation attribute). That is the IPP object 1225 accepts all client supplied values no matter what the values are in 1226 the Printer object's "generated-natural-language-supported" 1227 attribute. That attribute, "generated-natural-language-supported", 1228 only applies to generated messages, not client supplied messages. 1229 The IPP object MUST remember that natural language for all client- 1230 supplied attributes, and when returning those attributes in 1231 response to a query, the IPP object MUST indicate that natural 1232 language. 1234 Each value whose attribute syntax type is .text. or .name. (see 1235 sections 4.1.1 and 4.1.2) has an Associated Natural-Language. This 1236 document does not specify how this association is stored in a 1237 Printer or Job object. When such a value is encoded in a request 1238 or response, the natural language is either implicit or explicit: 1240 @ In the implicit case, the value contains only the text/name 1241 value, and the language is specified by the .attributes- 1242 natural-language. operation attribute in the request or 1243 response (see sections 4.1.1.1 textWithoutLanguage and 1244 4.1.2.1 nameWithoutLanguage). 1246 @ In the explicit case (also known as the Natural-Language 1247 Override case), the value contains both the language and 1248 the text/name value (see sections 4.1.1.2 textWithLanguage 1249 and 4.1.2.2 nameWithLanguage). 1251 For example, the "job-name" attribute MAY be supplied by the client 1252 in a create request. The text value for this attribute will be in 1253 the natural language identified by the "attribute-natural-language" 1254 attribute, or if different, as identified by the Natural Language 1255 Override mechanism. If supplied, the IPP object will use the value 1256 of the "job-name" attribute to populate the Job object's "job-name" 1258 Expires August 17, 1999 1259 attribute. Whenever any client queries the Job object's "job-name" 1260 attribute, the IPP object returns the attribute as stored and uses 1261 the Natural Language Override mechanism to specify the natural 1262 language, if it is different from that reported in the "attributes- 1263 natural-language" operation attribute of the response. The IPP 1264 object MAY use the Natural Language Override mechanism redundantly, 1265 i.e., use it even when the value is in the same natural language 1266 as the value supplied in the "attributes-natural-language" 1267 operation attribute of the response. 1269 An IPP object MUST NOT reject a request based on a supplied natural 1270 language in an "attributes-natural-language" Operation attribute or 1271 in any attribute that uses the Natural Language Override. 1273 See the 'naturalLanguage' attribute syntax description in section 1274 4.1.8 for the syntax and semantic interpretation of the values of 1275 this attribute and for example values. 1277 Clients SHOULD NOT supply 'text' or 'name' attributes that use an 1278 illegal combination of natural language and charset. For example, 1279 suppose a Printer object supports charsets 'utf-8', 'iso-8859-1', and 1280 'iso-8859-7'. Suppose also, that it supports natural languages 'en' 1281 (English), 'fr' (French), and 'el' (Greek). Although the Printer object 1282 supports the charset 'iso-8859-1' and natural language 'el', it probably 1283 does not support the combination of Greek text strings using the 'iso- 1284 8859-1' charset. The Printer object handles this apparent 1285 incompatibility differently depending on the context in which it occurs: 1287 - In a create request: If the client supplies a text or name 1288 attribute (for example, the "job-name" operation attribute) that 1289 uses an apparently incompatible combination, it is a client choice 1290 that does not affect the Printer object or its correct operation. 1291 Therefore, the Printer object simply accepts the client supplied 1292 value, stores it with the Job object, and responds back with the 1293 same combination whenever the client (or any client) queries for 1294 that attribute. 1295 -In a query-type operation, like Get-Printer-Attributes: If the 1296 client requests an apparently incompatible combination, the Printer 1297 object responds (as described in section 3.1.4.2) using the 1298 Printer's configured natural language rather than the natural 1299 language requested by the client. 1301 In either case, the Printer object does not reject the request because 1302 of the apparent incompatibility. The potential incompatible combination 1303 of charset and natural language can occur either at the global operation 1304 level or at the Natural Language Override attribute-by-attribute level. 1305 In addition, since the response always includes explicit charset and 1306 natural language information, there is never any question or ambiguity 1307 in how the client interprets the response. 1309 Expires August 17, 1999 1310 3.1.4.2 Response Operation Attributes 1312 The Printer object MUST supply and the client MUST support the following 1313 REQUIRED operation attributes in every IPP/1.1 operation response: 1315 "attributes-charset" (charset): 1316 This operation attribute identifies the charset used by any 'text' 1317 and 'name' attributes that the Printer object is returning in this 1318 response. The value in this response MUST be the same value as the 1319 "attributes-charset" operation attribute supplied by the client in 1320 the request. If this is not possible (i.e., the charset requested 1321 is not supported), the request would have been rejected. See 1322 "attributes-charset" described in Section 3.1.4.1 above. 1324 If the Printer object supports more than just the 'utf-8' charset, 1325 the Printer object MUST be able to code convert between each of the 1326 charsets supported on a highest fidelity possible basis in order to 1327 return the 'text' and 'name' attributes in the charset requested by 1328 the client. However, some information loss MAY occur during the 1329 charset conversion depending on the charsets involved. For 1330 example, the Printer object may convert from a UTF-8 'a' to a US- 1331 ASCII 'a' (with no loss of information), from an ISO Latin 1 1332 CAPITAL LETTER A WITH ACUTE ACCENT to US-ASCII 'A' (losing the 1333 accent), or from a UTF-8 Japanese Kanji character to some ISO Latin 1334 1 error character indication such as '?', decimal code equivalent, 1335 or to the absence of a character, depending on implementation. 1337 Note: Whether an implementation that supports more than one charset 1338 stores the data in the charset supplied by the client or code 1339 converts to one of the other supported charsets, depends on 1340 implementation. The strategy should try to minimize loss of 1341 information during code conversion. On each response, such an 1342 implementation converts from its internal charset to that 1343 requested. 1345 "attributes-natural-language" (naturalLanguage): 1346 This operation attribute identifies the natural language used by 1347 any 'text' and 'name' attributes that the IPP object is returning 1348 in this response. Unlike the "attributes-charset" operation 1349 attribute, the IPP object NEED NOT return the same value as that 1350 supplied by the client in the request. The IPP object MAY return 1351 the natural language of the Job object or the Printer's configured 1352 natural language as identified by the Printer object's "natural- 1353 language-configured" attribute, rather than the natural language 1354 supplied by the client. For any 'text' or 'name' attribute or 1355 status message in the response that is in a different natural 1356 language than the value returned in the "attributes-natural- 1357 language" operation attribute, the IPP object MUST use the Natural 1358 Language Override mechanism (see sections 4.1.1.2 and 4.1.2.2) on 1359 each attribute value returned. The IPP object MAY use the Natural 1360 Language Override mechanism redundantly, i.e., use it even when the 1361 value is in the same natural language as the value supplied in the 1362 "attributes-natural-language" operation attribute of the response. 1364 Expires August 17, 1999 1366 3.1.5 Operation Targets 1368 All IPP operations are directed at IPP objects. For Printer operations, 1369 the operation is always directed at a Printer object using one of its 1370 URIs (i.e., one of the values in the Printer object's "printer-uri- 1371 supported" attribute). Even if the Printer object supports more than 1372 one URI, the client supplies only one URI as the target of the 1373 operation. The client identifies the target object by supplying the 1374 correct URI in the "printer-uri (uri)" operation attribute. 1376 For Job operations, the operation is directed at either: 1378 - The Job object itself using the Job object's URI. In this case, 1379 the client identifies the target object by supplying the correct 1380 URI in the "job-uri (uri)" operation attribute. 1381 - The Printer object that created the Job object using both the 1382 Printer objects URI and the Job object's Job ID. Since the Printer 1383 object that created the Job object generated the Job ID, it MUST be 1384 able to correctly associate the client supplied Job ID with the 1385 correct Job object. The client supplies the Printer object's URI 1386 in the "printer-uri (uri)" operation attribute and the Job object's 1387 Job ID in the "job-id (integer(1:MAX))" operation attribute. 1389 If the operation is directed at the Job object directly using the Job 1390 object's URI, the client MUST NOT include the redundant "job-id" 1391 operation attribute. 1393 The operation target attributes are REQUIRED operation attributes that 1394 MUST be included in every operation request. Like the charset and 1395 natural language attributes (see section 3.1.4), the operation target 1396 attributes are specially ordered operation attributes. In all cases, 1397 the operation target attributes immediately follow the "attributes- 1398 charset" and "attributes-natural-language" attributes within the 1399 operation attribute group, however the specific ordering rules are: 1401 - In the case where there is only one operation target attribute 1402 (i.e., either only the "printer-uri" attribute or only the "job- 1403 uri" attribute), that attribute MUST be the third attribute in the 1404 operation attributes group. 1405 - In the case where Job operations use two operation target 1406 attributes (i.e., the "printer-uri" and "job-id" attributes), the 1407 "printer-uri" attribute MUST be the third attribute and the "job- 1408 id" attribute MUST be the fourth attribute. 1410 In all cases, the target URIs contained within the body of IPP operation 1411 requests and responses must be in absolute format rather than relative 1412 format (a relative URL identifies a resource with the scope of the HTTP 1413 server, but does not include scheme, host or port). 1415 The following rules apply to the use of port numbers in URIs that 1416 identify IPP objects: 1418 1. If the URI scheme allows the port number to be explicitly included 1419 in the URI string, and a port number is specified within the URI, 1421 Expires August 17, 1999 1422 then that port number MUST be used by the client to contact the IPP 1423 object. 1425 2. If the URI scheme allows the port number to be explicitly included 1426 in the URI string, and a port number is not specified within the 1427 URI, then default port number implied by that URI scheme MUST be 1428 used by the client to contact the IPP object. 1430 3. If the URI scheme does not allow an explicit port number to be 1431 specified within the URI, then the default port number implied by 1432 that URI MUST be used by the client to contact the IPP object. 1434 Note: The IPP "Encoding and Transport document [IPP-PRO] shows a mapping 1435 of IPP onto HTTP/1.1 and defines a new default port number for using IPP 1436 over HTTP/1.1. 1438 3.1.6 Operation Status Codes and Messages 1440 Every operation response includes a REQUIRED "status-code" parameter and 1441 an OPTIONAL "status-message" operation attribute. The "status-code" 1442 provides information on the processing of a request. A "status-message" 1443 attribute provides a short textual description of the status of the 1444 operation. The status code is intended for use by automata, and the 1445 status message is intended for the human end user. If a response does 1446 include a "status-message" attribute, an IPP client NEED NOT examine or 1447 display the message, however it SHOULD do so in some implementation 1448 specific manner. 1450 The "status-code" value is a numeric value that has semantic meaning. 1451 The "status-code" syntax is similar to a "type2 enum" (see section 4.1 1452 on "Attribute Syntaxes") except that values can range only from 0x0000 1453 to 0x7FFF. Section 14 describes the status codes, assigns the numeric 1454 values, and suggests a corresponding status message for each status 1455 code. The "status-message" attribute's syntax is "text(255)". A client 1456 implementation of IPP SHOULD convert status code values into any 1457 localized message that has semantic meaning to the end user. 1459 If the Printer object supports the "status-message" operation attribute, 1460 the Printer object MUST be able to generate this message in any of the 1461 natural languages identified by the Printer object's "generated-natural- 1462 language-supported" attribute (see the "attributes-natural-language" 1463 operation attribute specified in section 3.1.4.1). As described in 1464 section 3.1.4.1 for any returned 'text' attribute, if there is a choice 1465 for generating this message, the Printer object uses the natural 1466 language indicated by the value of the "attributes-natural-language" in 1467 the client request if supported, otherwise the Printer object uses the 1468 value in the Printer object's own "natural-language-configured" 1469 attribute. If the Printer object supports the "status-message" 1470 operation attribute, it SHOULD use the REQUIRED 'utf-8' charset to 1471 return a status message for the following error status codes (see 1472 section 14): 'client-error-bad-request', 'client-error-charset-not- 1473 supported', 'server-error-internal-error', 'server-error-operation-not- 1474 supported', and 'server-error-version-not-supported'. In this case, it 1476 Expires August 17, 1999 1477 MUST set the value of the "attributes-charset" operation attribute to 1478 'utf-8' in the error response. 1480 3.1.7 Versions 1482 Each operation request and response carries with it a "version-number" 1483 parameter. Each value of the "version-number" is in the form "X.Y" 1484 where X is the major version number and Y is the minor version number. 1485 By including a version number in the client request, it allows the 1486 client to identify which version of IPP it is interested in using. If 1487 the IPP object does not support that version, the object responds with a 1488 status code of 'server-error-version-not-supported' along with the 1489 closest version number that is supported (see section 14.1.5.4). 1491 There is no version negotiation per se. However, if after receiving a 1492 'server-error-version-not-supported' status code from an IPP object, 1493 there is nothing that prevents a client from trying again with a 1494 different version number. In order to conform to IPP/1.1, an IPP object 1495 implementations MUST support versions '1.1' and 1.0. 1497 There is only one notion of "version number" that covers both IPP Model 1498 and IPP Protocol changes. Thus the version number MUST change when 1499 introducing a new version of the Model and Semantics document [IPP-MOD] 1500 or a new version of the "Encoding and Transport" document [IPP-PRO]. 1502 Changes to the major version number indicate structural or syntactic 1503 changes that make it impossible for older version of IPP clients and 1504 Printer objects to correctly parse and process the new or changed 1505 attributes, operations and responses. If the major version number 1506 changes, the minor version numbers is set to zero. As an example, 1507 adding the "ipp-attribute-fidelity" attribute (if it had not been part 1508 of version '1.1'), would have required a change to the major version 1509 number. Items that might affect the changing of the major version 1510 number include any changes to the Model and Semantics document [IPP-MOD] 1511 or the "Encoding and Transport" document [IPP-PRO] itself, such as: 1513 - reordering of ordered attributes or attribute sets 1514 - changes to the syntax of existing attributes 1515 - changing Operation or Job Template attributes from OPTIONAL to 1516 REQUIRED and vice versa 1517 - adding REQUIRED (for an IPP object to support) operation attributes 1518 - adding REQUIRED (for an IPP object to support) operation attribute 1519 groups 1520 - adding values to existing operation attributes 1521 - adding REQUIRED operations 1523 Changes to the minor version number indicate the addition of new 1524 features, attributes and attribute values that may not be understood by 1525 all IPP objects, but which can be ignored if not understood. Items that 1526 might affect the changing of the minor version number include any 1527 changes to the model objects and attributes but not the encoding and 1528 transport rules [IPP-PRO] (except adding attribute syntaxes). Examples 1529 of such changes are: 1531 Expires August 17, 1999 1532 - grouping all extensions not included in a previous version into a 1533 new version 1534 - adding new attribute values 1535 - adding new object attributes 1536 - adding OPTIONAL (for an IPP object to support) operation attributes 1537 (i.e., those attributes that an IPP object can ignore without 1538 confusing clients) 1539 - adding OPTIONAL (for an IPP object to support) operation attribute 1540 groups (i.e., those attributes that an IPP object can ignore 1541 without confusing clients) 1542 - adding new attribute syntaxes 1543 - adding OPTIONAL operations 1544 - changing Job Description attributes or Printer Description 1545 attributes from OPTIONAL to REQUIRED or vice versa. 1547 The encoding of the "version-number" MUST NOT change over any version 1548 number (either major or minor). This rule guarantees that all future 1549 versions will be backwards compatible with all previous versions (at 1550 least for checking the "version-number"). In addition, any protocol 1551 elements (attributes, error codes, tags, etc.) that are not carried 1552 forward from one version to the next are deprecated so that they can 1553 never be reused with new semantics. 1555 Implementations that support a certain major version NEED NOT support 1556 ALL previous versions. As each new major version is defined (through 1557 the release of a new specification), that major version will specify 1558 which previous major versions MUST be supported in compliant 1559 implementations. 1561 3.1.8 Job Creation Operations 1563 In order to "submit a print job" and create a new Job object, a client 1564 issues a create request. A create request is any one of following three 1565 operation requests: 1567 - The Print-Job Request: A client that wants to submit a print job 1568 with only a single document uses the Print-Job operation. The 1569 operation allows for the client to "push" the document data to the 1570 Printer object by including the document data in the request 1571 itself. 1573 - The Print-URI Request: A client that wants to submit a print job 1574 with only a single document (where the Printer object "pulls" the 1575 document data instead of the client "pushing" the data to the 1576 Printer object) uses the Print-URI operation. In this case, the 1577 client includes in the request only a URI reference to the document 1578 data (not the document data itself). 1580 - The Create-Job Request: A client that wants to submit a print job 1581 with multiple documents uses the Create-Job operation. This 1582 operation is followed by an arbitrary number of Send-Document 1583 and/or Send-URI operations (each creating another document for the 1584 newly create Job object). The Send-Document operation includes the 1586 Expires August 17, 1999 1587 document data in the request (the client "pushes" the document data 1588 to the printer), and the Send-URI operation includes only a URI 1589 reference to the document data in the request (the Printer "pulls" 1590 the document data from the referenced location). The last Send- 1591 Document or Send-URI request for a given Job object includes a 1592 "last-document" operation attribute set to 'true' indicating that 1593 this is the last request. 1595 Throughout this model specification, the term "create request" is used 1596 to refer to any of these three operation requests. 1598 A Create-Job operation followed by only one Send-Document operation is 1599 semantically equivalent to a Print-Job operation, however, for 1600 performance reasons, the client SHOULD use the Print-Job operation for 1601 all single document jobs. Also, Print-Job is a REQUIRED operation (all 1602 implementations MUST support it) whereas Create-Job is an OPTIONAL 1603 operation, hence some implementations might not support it. 1605 Job submission time is the point in time when a client issues a create 1606 request. The initial state of every Job object is the 'pending' or 1607 'pending-held' state. Later, the Printer object begins processing the 1608 print job. At this point in time, the Job object's state moves to 1609 'processing'. This is known as job processing time. There are 1610 validation checks that must be done at job submission time and others 1611 that must be performed at job processing time. 1613 At job submission time and at the time a Validate-Job operation is 1614 received, the Printer MUST do the following: 1616 1. Process the client supplied attributes and either accept or reject 1617 the request 1618 2. Validate the syntax of and support for the scheme of any client 1619 supplied URI 1621 At job submission time the Printer object MUST validate whether or not 1622 the supplied attributes, attribute syntaxes, and values are supported by 1623 matching them with the Printer object's corresponding "xxx-supported" 1624 attributes. See section 3.2.1.2 for details. [IPP-IIG] presents 1625 suggested steps for an IPP object to either accept or reject any request 1626 and additional steps for processing create requests. 1628 At job submission time the Printer object NEED NOT perform the 1629 validation checks reserved for job processing time such as: 1631 1. Validating the document data 1632 2. Validating the actual contents of any client supplied URI (resolve 1633 the reference and follow the link to the document data) 1635 At job submission time, these additional job processing time validation 1636 checks are essentially useless, since they require actually parsing and 1637 interpreting the document data, are not guaranteed to be 100% accurate, 1638 and MUST be done, yet again, at job processing time. Also, in the case 1639 of a URI, checking for availability at job submission time does not 1641 Expires August 17, 1999 1642 guarantee availability at job processing time. In addition, at job 1643 processing time, the Printer object might discover any of the following 1644 conditions that were not detectable at job submission time: 1646 - runtime errors in the document data, 1647 - nested document data that is in an unsupported format, 1648 - the URI reference is no longer valid (i.e., the server hosting the 1649 document might be down), or 1650 - any other job processing error 1652 At job processing time, since the Printer object has already responded 1653 with a successful status code in the response to the create request, if 1654 the Printer object detects an error, the Printer object is unable to 1655 inform the end user of the error with an operation status code. In 1656 this case, the Printer, depending on the error, can set the "job-state", 1657 "job-state-reasons", or "job-state-message" attributes to the 1658 appropriate value(s) so that later queries can report the correct job 1659 status. 1661 Note: Asynchronous notification of events is outside the scope of this 1662 IPP/1.1 document. 1664 3.2 Printer Operations 1666 All Printer operations are directed at Printer objects. A client MUST 1667 always supply the "printer-uri" operation attribute in order to identify 1668 the correct target of the operation. 1670 3.2.1 Print-Job Operation 1672 This REQUIRED operation allows a client to submit a print job with only 1673 one document and supply the document data (rather than just a reference 1674 to the data). See Section 16 for the suggested steps for processing 1675 create operations and their Operation and Job Template attributes. 1677 3.2.1.1 Print-Job Request 1679 The following groups of attributes are supplied as part of the Print-Job 1680 Request: 1682 Group 1: Operation Attributes 1684 Natural Language and Character Set: 1685 The "attributes-charset" and "attributes-natural-language" 1686 attributes as described in section 3.1.4.1. The Printer object 1687 MUST copy these values to the corresponding Job Description 1688 attributes described in sections 4.3.23 and 4.3.24. 1690 Target: 1691 The "printer-uri" (uri) operation attribute which is the target for 1692 this operation as described in section 3.1.5. 1694 Expires August 17, 1999 1696 Requesting User Name: 1697 The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied 1698 by the client as described in section 8.3. 1700 "job-name" (name(MAX)): 1701 The client OPTIONALLY supplies this attribute. The Printer object 1702 MUST support this attribute. It contains the client supplied Job 1703 name. If this attribute is supplied by the client, its value is 1704 used for the "job-name" attribute of the newly created Job object. 1705 The client MAY automatically include any information that will help 1706 the end-user distinguish amongst his/her jobs, such as the name of 1707 the application program along with information from the document, 1708 such as the document name, document subject, or source file name. 1709 If this attribute is not supplied by the client, the Printer 1710 generates a name to use in the "job-name" attribute of the newly 1711 created Job object (see Section 4.3.5). 1713 "ipp-attribute-fidelity" (boolean): 1714 The client OPTIONALLY supplies this attribute. The Printer object 1715 MUST support this attribute. The value 'true' indicates that total 1716 fidelity to client supplied Job Template attributes and values is 1717 required, else the Printer object MUST reject the Print-Job 1718 request. The value 'false' indicates that a reasonable attempt to 1719 print the Job object is acceptable and the Printer object MUST 1720 accept the Print-job request. If not supplied, the Printer object 1721 assumes the value is 'false'. All Printer objects MUST support 1722 both types of job processing. See section 16 for a full 1723 description of "ipp-attribute-fidelity" and its relationship to 1724 other attributes, especially the Printer object's "pdl-override- 1725 supported" attribute. 1727 "document-name" (name(MAX)): 1728 The client OPTIONALLY supplies this attribute. The Printer object 1729 MUST support this attribute. It contains the client supplied 1730 document name. The document name MAY be different than the Job 1731 name. Typically, the client software automatically supplies the 1732 document name on behalf of the end user by using a file name or an 1733 application generated name. If this attribute is supplied, its 1734 value can be used in a manner defined by each implementation. 1735 Examples include: printed along with the Job (job start sheet, page 1736 adornments, etc.), used by accounting or resource tracking 1737 management tools, or even stored along with the document as a 1738 document level attribute. IPP/1.1 does not support the concept of 1739 document level attributes. 1741 "document-format" (mimeMediaType) : 1742 The client OPTIONALLY supplies this attribute. The Printer object 1743 MUST support this attribute. The value of this attribute 1744 identifies the format of the supplied document data. If the client 1745 does not supply this attribute, the Printer object assumes that the 1746 document data is in the format defined by the Printer object's 1747 "document-format-default" attribute. If the client supplies this 1748 attribute, but the value is not supported by the Printer object, 1749 i.e., the value is not one of the values of the Printer object's 1751 Expires August 17, 1999 1752 "document-format-supported" attribute, the Printer object MUST 1753 reject the request and return the 'client-error-document-format- 1754 not-supported' status code. 1756 "document-natural-language" (naturalLanguage): 1757 The client OPTIONALLY supplies this attribute. The Printer object 1758 OPTIONALLY supports this attribute. This attribute specifies the 1759 natural language of the document for those document-formats that 1760 require a specification of the natural language in order to image 1761 the document unambiguously. There are no particular values required 1762 for the Printer object to support. 1764 "compression" (type3 keyword) 1765 The client OPTIONALLY supplies this attribute. The Printer object 1766 OPTIONALLY supports this attribute and the "compression-supported" 1767 attribute (see section 4.4.29). The client supplied "compression" 1768 operation attribute identifies the compression algorithm used on 1769 the document data. If the client omits this attribute, the Printer 1770 object MUST assume that the data is not compressed. If the client 1771 supplies the attribute and the Printer object supports the 1772 attribute, the Printer object uses the corresponding decompression 1773 algorithm on the document data. If the client supplies this 1774 attribute, but the value is not supported by the Printer object, 1775 i.e., the value is not one of the values of the Printer object's 1776 "compression-supported" attribute, the Printer object MUST copy the 1777 attribute and its value to the Unsupported Attributes response 1778 group, reject the request, and return the 'client-error-attributes- 1779 or-values-not-supported' status code. If the client supplies this 1780 attribute, but this attribute is not supported by the Printer 1781 object, i.e., the "compression-supported" attribute is not one of 1782 the Printer's Printer Description attributes, the Printer object 1783 MUST copy the attribute to the Unsupported Attributes response 1784 group changing the value to the out-of-band 'unsupported' value 1785 (see section 4.1), reject the request, and return the 'client- 1786 error-attributes-or-values-not-supported' status code. See section 1787 3.2.1.2 for returning unsupported attributes and values. 1789 "job-k-octets" (integer(0:MAX)) 1790 The client OPTIONALLY supplies this attribute. The Printer object 1791 OPTIONALLY supports this attribute and the "job-k-octets-supported" 1792 attribute (see section 4.4.30). The client supplied "job-k-octets" 1793 operation attribute identifies the total size of the document(s) in 1794 K octets being submitted (see section 4.3.17 for the complete 1795 semantics). If the client supplies the attribute and the Printer 1796 object supports the attribute, the value of the attribute is used 1797 to populate the Job object's "job-k-octets" Job Description 1798 attribute. 1800 Note: For this attribute and the following two attributes ("job- 1801 impressions", and "job-media-sheets"), if the client supplies the 1802 attribute, but the Printer object does not support the attribute, 1803 the Printer object ignores the client-supplied value. If the 1804 client supplies the attribute and the Printer supports the 1805 attribute, and the value is within the range of the corresponding 1807 Expires August 17, 1999 1808 Printer object's "xxx-supported" attribute, the Printer object MUST 1809 use the value to populate the Job object's "xxx" attribute. If the 1810 client supplies the attribute and the Printer supports the 1811 attribute, but the value is outside the range of the corresponding 1812 Printer object's "xxx-supported" attribute, the Printer object MUST 1813 copy the attribute and its value to the Unsupported Attributes 1814 response group, reject the request, and return the 'client-error- 1815 attributes-or-values-not-supported' status code. If the client 1816 does not supply the attribute, the Printer object MAY choose to 1817 populate the corresponding Job object attribute depending on 1818 whether the Printer object supports the attribute and is able to 1819 calculate or discern the correct value. 1821 "job-impressions" (integer(0:MAX)) 1822 The client OPTIONALLY supplies this attribute. The Printer object 1823 OPTIONALLY supports this attribute and the "job-impressions- 1824 supported" attribute (see section 4.4.31). The client supplied 1825 "job-impressions" operation attribute identifies the total size in 1826 number of impressions of the document(s) being submitted (see 1827 section 4.3.18 for the complete semantics). 1829 See note under "job-k-octets". 1831 "job-media-sheets" (integer(0:MAX)) 1832 The client OPTIONALLY supplies this attribute. The Printer object 1833 OPTIONALLY supports this attribute and the "job-media-sheets- 1834 supported" attribute (see section 4.4.32). The client supplied 1835 "job-media-sheets" operation attribute identifies the total number 1836 of media sheets to be produced for this job (see section 4.3.19 for 1837 the complete semantics). 1839 See note under "job-k-octets". 1841 Group 2: Job Template Attributes 1843 The client OPTIONALLY supplies a set of Job Template attributes as 1844 defined in section 4.2. If the client is not supplying any Job 1845 Template attributes in the request, the client SHOULD omit Group 2 1846 rather than sending an empty group. However, a Printer object MUST 1847 be able to accept an empty group. 1849 Group 3: Document Content 1851 The client MUST supply the document data to be processed. 1853 Note: In addition to the MANDATORY parameters required for every 1854 operation request, the simplest Print-Job Request consists of just the 1855 "attributes-charset" and "attributes-natural-language" operation 1856 attributes; the "printer-uri" target operation attribute; the Document 1857 Content and nothing else. In this simple case, the Printer object: 1859 - creates a new Job object (the Job object contains a single 1860 document), 1862 Expires August 17, 1999 1864 - stores a generated Job name in the "job-name" attribute in the 1865 natural language and charset requested (see Section 3.1.4.1) (if 1866 those are supported, otherwise using the Printer object's default 1867 natural language and charset), and 1868 - at job processing time, uses its corresponding default value 1869 attributes for the supported Job Template attributes that were not 1870 supplied by the client as IPP attribute or embedded instructions in 1871 the document data. 1873 3.2.1.2 Print-Job Response 1875 The Printer object MUST return to the client the following sets of 1876 attributes as part of the Print-Job Response: 1878 Group 1: Operation Attributes 1880 Status Message: 1881 In addition to the REQUIRED status code returned in every response, 1882 the response OPTIONALLY includes a "status-message" (text) 1883 operation attribute as described in sections 14 and 3.1.6. If the 1884 client supplies unsupported or conflicting Job Template attributes 1885 or values, the Printer object MUST reject or accept the Print-Job 1886 request depending on the whether the client supplied a 'true' or 1887 'false' value for the "ipp-attribute-fidelity" operation attribute. 1888 See the Implementer's Guide [IPP-IIG] for a complete description of 1889 the suggested steps for processing a create request. 1891 Natural Language and Character Set: 1892 The "attributes-charset" and "attributes-natural-language" 1893 attributes as described in section 3.1.4.2. 1895 Group 2: Unsupported Attributes 1897 This is a set of Operation and Job Template attributes supplied by 1898 the client (in the request) that are not supported by the Printer 1899 object or that conflict with one another (see the Implementer's 1900 Guide [IPP-IIG]). If the Printer object is not returning any 1901 Unsupported Attributes in the response, the Printer object SHOULD 1902 omit Group 2 rather than sending an empty group. However, a client 1903 MUST be able to accept an empty group. 1905 Unsupported attributes fall into three categories: 1907 1. The Printer object does not support the supplied attribute (no 1908 matter what the attribute syntax or value). 1909 2. The Printer object does support the attribute, but does not 1910 support some or all of the particular attribute syntaxes or 1911 values supplied by the client (i.e., the Printer object does 1912 not have those attribute syntaxes or values in its 1913 corresponding "xxx-supported" attribute). 1914 3. The Printer object does support the attributes and values 1915 supplied, but the particular values are in conflict with one 1917 Expires August 17, 1999 1918 another, because they violate a constraint, such as not being 1919 able to staple transparencies. 1921 In the case of an unsupported attribute name, the Printer object 1922 returns the client-supplied attribute with a substituted "out-of- 1923 band" value of 'unsupported' indicating no support for the 1924 attribute itself (see the beginning of section 4.1). 1926 In the case of a supported attribute with one or more unsupported 1927 attribute syntaxes or values, the Printer object simply returns the 1928 client-supplied attribute with the unsupported attribute syntaxes 1929 or values as supplied by the client. This indicates support for 1930 the attribute, but no support for that particular attribute syntax 1931 or value. If the client supplies a multi-valued attribute with 1932 more than one value and the Printer object supports the attribute 1933 but only supports a subset of the client-supplied attribute 1934 syntaxes or values, the Printer object MUST return only those 1935 attribute syntaxes or values that are unsupported. 1937 In the case of two (or more) supported attribute values that are in 1938 conflict with one another (although each is supported 1939 independently, the values conflict when requested together within 1940 the same job), the Printer object MUST return all the values that 1941 it ignores or substitutes to resolve the conflict, but not any of 1942 the values that it is still using. The choice for exactly how to 1943 resolve the conflict is implementation dependent. See The 1944 Implementer's Guide [IPP-IIG] for an example. 1946 In these three cases, the value of the "ipp-attribute-fidelity" 1947 supplied by the client does not affect what the Printer object 1948 returns. The value of "ipp-attribute-fidelity" only affects 1949 whether the Print-Job operation is accepted or rejected. If the 1950 job is accepted, the client may query the job using the Get-Job- 1951 Attributes operation requesting the unsupported attributes that 1952 were returned in the create response to see which attributes were 1953 ignored (not stored on the Job object) and which attributes were 1954 stored with other (substituted) values. 1956 Group 3: Job Object Attributes 1958 "job-uri" (uri): 1959 The Printer object MUST return the Job object's URI by returning 1960 the contents of the REQUIRED "job-uri" Job object attribute. The 1961 client uses the Job object's URI when directing operations at the 1962 Job object. The Printer object always uses its configured security 1963 policy when creating the new URI. However, if the Printer object 1964 supports more than one URI, the Printer object also uses 1965 information about which URI was used in the Print-Job Request to 1966 generated the new URI so that the new URI references the correct 1967 access channel. In other words, if the Print-Job Request comes in 1968 over a secure channel, the Printer object MUST generate a Job URI 1969 that uses the secure channel as well. 1971 Expires August 17, 1999 1973 "job-id" (integer(1:MAX)): 1974 The Printer object MUST return the Job object's Job ID by returning 1975 the REQUIRED "job-id" Job object attribute. The client uses this 1976 "job-id" attribute in conjunction with the "printer-uri" attribute 1977 used in the Print-Job Request when directing Job operations at the 1978 Printer object. 1980 "job-state": 1981 The Printer object MUST return the Job object's REQUIRED "job- 1982 state" attribute. The value of this attribute (along with the value 1983 of the next attribute "job-state-reasons") is taken from a 1984 "snapshot" of the new Job object at some meaningful point in time 1985 (implementation defined) between when the Printer object receives 1986 the Print-Job Request and when the Printer object returns the 1987 response. 1989 "job-state-reasons": 1990 The Printer object OPTIONALLY returns the Job object's OPTIONAL 1991 "job-state-reasons" attribute. If the Printer object supports this 1992 attribute then it MUST be returned in the response. If this 1993 attribute is not returned in the response, the client can assume 1994 that the "job-state-reasons" attribute is not supported and will 1995 not be returned in a subsequent Job object query. 1997 "job-state-message": 1998 The Printer object OPTIONALLY returns the Job object's OPTIONAL 1999 "job-state-message" attribute. If the Printer object supports this 2000 attribute then it MUST be returned in the response. If this 2001 attribute is not returned in the response, the client can assume 2002 that the "job-state-message" attribute is not supported and will 2003 not be returned in a subsequent Job object query. 2005 "number-of-intervening-jobs": 2006 The Printer object OPTIONALLY returns the Job object's OPTIONAL 2007 "number-of-intervening-jobs" attribute. If the Printer object 2008 supports this attribute then it MUST be returned in the response. 2009 If this attribute is not returned in the response, the client can 2010 assume that the "number-of-intervening-jobs" attribute is not 2011 supported and will not be returned in a subsequent Job object 2012 query. 2014 Note: Since any printer state information which affects a job's 2015 state is reflected in the "job-state" and "job-state-reasons" 2016 attributes, it is sufficient to return only these attributes and no 2017 specific printer status attributes. 2019 Note: In addition to the MANDATORY parameters required for every 2020 operation response, the simplest response consists of the just the 2021 "attributes-charset" and "attributes-natural-language" operation 2022 attributes and the "job-uri", "job-id", and "job-state" Job Object 2023 Attributes. In this simplest case, the status code is "successful-ok" 2024 and there is no "status-message" operation attribute. 2026 Expires August 17, 1999 2027 3.2.2 Print-URI Operation 2029 This OPTIONAL operation is identical to the Print-Job operation (section 2030 3.2.1) except that a client supplies a URI reference to the document 2031 data using the "document-uri" (uri) operation attribute (in Group 1) 2032 rather than including the document data itself. Before returning the 2033 response, the Printer MUST validate that the Printer supports the 2034 retrieval method (e.g., http, ftp, etc.) implied by the URI, and MUST 2035 check for valid URI syntax. If the client-supplied URI scheme is not 2036 supported, i.e. the value is not in the Printer object's "referenced- 2037 uri-scheme-supported" attribute, the Printer object MUST reject the 2038 request and return the 'client-error-uri-scheme-not-supported' status 2039 code. See The Implementer's Guide [IPP-IIG] for suggested additional 2040 checks. The Printer NEED NOT follow the reference and validate the 2041 contents of the reference. 2043 If the Printer object supports this operation, it MUST support the 2044 "reference-uri-schemes-supported" Printer attribute (see section 2045 4.4.24). 2047 It is up to the IPP object to interpret the URI and subsequently "pull" 2048 the document from the source referenced by the URI string. 2050 3.2.3 Validate-Job Operation 2052 This REQUIRED operation is similar to the Print-Job operation (section 2053 3.2.1) except that a client supplies no document data and the Printer 2054 allocates no resources (i.e., it does not create a new Job object). 2055 This operation is used only to verify capabilities of a printer object 2056 against whatever attributes are supplied by the client in the Validate- 2057 Job request. By using the Validate-Job operation a client can validate 2058 that an identical Print-Job operation (with the document data) would be 2059 accepted. The Validate-Job operation also performs the same security 2060 negotiation as the Print-Job operation (see section 8), so that a client 2061 can check that the client and Printer object security requirements can 2062 be met before performing a Print-Job operation. 2064 Note: The Validate-Job operation does not accept a "document-uri" 2065 attribute in order to allow a client to check that the same Print-URI 2066 operation will be accepted, since the client doesn't send the data with 2067 the Print-URI operation. The client SHOULD just issue the Print-URI 2068 request. 2070 The Printer object returns the same status codes, Operation Attributes 2071 (Group 1) and Unsupported Attributes (Group 2) as the Print-Job 2072 operation. However, no Job Object Attributes (Group 3) are returned, 2073 since no Job object is created. 2075 3.2.4 Create-Job Operation 2077 This OPTIONAL operation is similar to the Print-Job operation (section 2078 3.2.1) except that in the Create-Job request, a client does not supply 2079 document data or any reference to document data. Also, the client does 2081 Expires August 17, 1999 2082 not supply any of the "document-name", "document-format", "compression", 2083 or "document-natural-language" operation attributes. This operation is 2084 followed by one or more Send-Document or Send-URI operations. In each 2085 of those operation requests, the client OPTIONALLY supplies the 2086 "document-name", "document-format", and "document-natural-language" 2087 attributes for each document in the multi-document Job object. 2089 If a Printer object supports the Create-Job operation, it MUST also 2090 support the Send-Document operation and also MAY support the Send-URI 2091 operation. 2093 If the Printer object supports this operation, it MUST support the 2094 "multiple-operation-time-out" Printer attribute (see section 4.4.28). 2096 3.2.5 Get-Printer-Attributes Operation 2098 This REQUIRED operation allows a client to request the values of the 2099 attributes of a Printer object. In the request, the client supplies 2100 the set of Printer attribute names and/or attribute group names in which 2101 the requester is interested. In the response, the Printer object 2102 returns a corresponding attribute set with the appropriate attribute 2103 values filled in. 2105 For Printer objects, the possible names of attribute groups are: 2107 - 'job-template': all of the Job Template attributes that apply to a 2108 Printer object (the last two columns of the table in Section 4.2). 2109 - 'printer-description': the attributes specified in Section 4.4. 2110 - 'all': the special group 'all' that includes all supported 2111 attributes. 2113 Since a client MAY request specific attributes or named groups, there is 2114 a potential that there is some overlap. For example, if a client 2115 requests, 'printer-name' and 'all', the client is actually requesting 2116 the "printer-name" attribute twice: once by naming it explicitly, and 2117 once by inclusion in the 'all' group. In such cases, the Printer object 2118 NEED NOT return each attribute only once in the response even if it is 2119 requested multiple times. The client SHOULD NOT request the same 2120 attribute in multiple ways. 2122 It is NOT REQUIRED that a Printer object support all attributes 2123 belonging to a group (since some attributes are OPTIONAL). However, it 2124 is REQUIRED that each Printer object support all group names. 2126 3.2.5.1 Get-Printer-Attributes Request 2128 The following sets of attributes are part of the Get-Printer-Attributes 2129 Request: 2131 Group 1: Operation Attributes 2133 Expires August 17, 1999 2134 Natural Language and Character Set: 2135 The "attributes-charset" and "attributes-natural-language" 2136 attributes as described in section 3.1.4.1. 2138 Target: 2139 The "printer-uri" (uri) operation attribute which is the target for 2140 this operation as described in section 3.1.5. 2142 Requesting User Name: 2143 The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied 2144 by the client as described in section 8.3. 2146 "requested-attributes" (1setOf keyword) : 2147 The client OPTIONALLY supplies a set of attribute names and/or 2148 attribute group names in whose values the requester is interested. 2149 The Printer object MUST support this attribute. If the client 2150 omits this attribute, the Printer MUST respond as if this attribute 2151 had been supplied with a value of 'all'. 2153 "document-format" (mimeMediaType) : 2154 The client OPTIONALLY supplies this attribute. The Printer object 2155 MUST support this attribute. This attribute is useful for a 2156 Printer object to determine the set of supported attribute values 2157 that relate to the requested document format. The Printer object 2158 MUST return the attributes and values that it uses to validate a 2159 job on a create or Validate-Job operation in which this document 2160 format is supplied. The Printer object SHOULD return only (1) those 2161 attributes that are supported for the specified format and (2) the 2162 attribute values that are supported for the specified document 2163 format. By specifying the document format, the client can get the 2164 Printer object to eliminate the attributes and values that are not 2165 supported for a specific document format. For example, a Printer 2166 object might have multiple interpreters to support both 2167 'application/postscript' (for PostScript) and 'text/plain' (for 2168 text) documents. However, for only one of those interpreters might 2169 the Printer object be able to support "number-up" with values of 2170 '1', '2', and '4'. For the other interpreter it might be able to 2171 only support "number-up" with a value of '1'. Thus a client can use 2172 the Get-Printer-Attributes operation to obtain the attributes and 2173 values that will be used to accept/reject a create job operation. 2175 If the Printer object does not distinguish between different sets 2176 of supported values for each different document format when 2177 validating jobs in the create and Validate-Job operations, it MUST 2178 NOT distinguish between different document formats in the Get- 2179 Printer-Attributes operation. If the Printer object does 2180 distinguish between different sets of supported values for each 2181 different document format specified by the client, this 2182 specialization applies only to the following Printer object 2183 attributes: 2185 - Printer attributes that are Job Template attributes ("xxx- 2186 default" "xxx-supported", and "xxx-ready" in the Table in 2187 Section 4.2), 2189 Expires August 17, 1999 2191 - "pdl-override-supported", 2192 - "compression-supported", 2193 - "job-k-octets-supported", 2194 - "job-impressions-supported, 2195 - "job-media-sheets-supported" 2196 - "printer-driver-installer", 2197 - "color-supported", and 2198 - "reference-uri-schemes-supported" 2200 The values of all other Printer object attributes (including 2201 "document-format-supported") remain invariant with respect to the 2202 client supplied document format (except for new Printer description 2203 attribute as registered according to section 6.2). 2205 If the client omits this "document-format" operation attribute, the 2206 Printer object MUST respond as if the attribute had been supplied 2207 with the value of the Printer object's "document-format-default" 2208 attribute. It is recommended that the client always supply a value 2209 for "document-format", since the Printer object's "document-format- 2210 default" may be 'application/octet-stream', in which case the 2211 returned attributes and values are for the union of the document 2212 formats that the Printer can automatically sense. For more 2213 details, see the description of the 'mimeMediaType' attribute 2214 syntax in section 4.1.9. 2216 If the client supplies a value for the "document-format" Operation 2217 attribute that is not supported by the Printer, i.e., is not among 2218 the values of the Printer object's "document-format-supported" 2219 attribute, the Printer object MUST reject the operation and return 2220 the 'client-error-document-format-not-supported' status code. 2222 3.2.5.2 Get-Printer-Attributes Response 2224 The Printer object returns the following sets of attributes as part of 2225 the Get-Printer-Attributes Response: 2227 Group 1: Operation Attributes 2229 Status Message: 2230 In addition to the REQUIRED status code returned in every response, 2231 the response OPTIONALLY includes a "status-message" (text) 2232 operation attribute as described in section 3.1.6. 2234 Natural Language and Character Set: 2235 The "attributes-charset" and "attributes-natural-language" 2236 attributes as described in section 3.1.4.2. 2238 Group 2: Unsupported Attributes 2240 This is a set of Operation attributes supplied by the client (in 2241 the request) that are not supported by the Printer object or that 2242 conflict with one another (see sections 3.2.1.2 and 16). The 2243 response NEED NOT contain the "requested-attributes" operation 2245 Expires August 17, 1999 2246 attribute with any supplied values (attribute keywords) that were 2247 requested by the client but are not supported by the IPP object. 2248 If the Printer object is not returning any Unsupported Attributes 2249 in the response, the Printer object SHOULD omit Group 2 rather than 2250 sending an empty group. However, a client MUST be able to accept 2251 an empty group. 2253 Group 3: Printer Object Attributes 2255 This is the set of requested attributes and their current values. 2256 The Printer object ignores (does not respond with) any requested 2257 attribute which is not supported. The Printer object MAY respond 2258 with a subset of the supported attributes and values, depending on 2259 the security policy in force. However, the Printer object MUST 2260 respond with the 'unknown' value for any supported attribute 2261 (including all REQUIRED attributes) for which the Printer object 2262 does not know the value. Also the Printer object MUST respond with 2263 the 'no-value' for any supported attribute (including all REQUIRED 2264 attributes) for which the system administrator has not configured a 2265 value. See the description of the "out-of-band" values in the 2266 beginning of Section 4.1. 2268 3.2.6 Get-Jobs Operation 2270 This REQUIRED operation allows a client to retrieve the list of Job 2271 objects belonging to the target Printer object. The client may also 2272 supply a list of Job attribute names and/or attribute group names. A 2273 group of Job object attributes will be returned for each Job object that 2274 is returned. 2276 This operation is similar to the Get-Job-Attributes operation, except 2277 that this Get-Jobs operation returns attributes from possibly more than 2278 one object (see the description of Job attribute group names in section 2279 3.3.4). 2281 3.2.6.1 Get-Jobs Request 2283 The client submits the Get-Jobs request to a Printer object. 2285 The following groups of attributes are part of the Get-Jobs Request: 2287 Group 1: Operation Attributes 2289 Natural Language and Character Set: 2290 The "attributes-charset" and "attributes-natural-language" 2291 attributes as described in section 3.1.4.1. 2293 Target: 2294 The "printer-uri" (uri) operation attribute which is the target for 2295 this operation as described in section 3.1.5. 2297 Expires August 17, 1999 2299 Requesting User Name: 2300 The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied 2301 by the client as described in section 8.3. 2303 "limit" (integer(1:MAX)): 2304 The client OPTIONALLY supplies this attribute. The Printer object 2305 MUST support this attribute. It is an integer value that indicates 2306 a limit to the number of Job objects returned. The limit is a 2307 "stateless limit" in that if the value supplied by the client is 2308 'N', then only the first 'N' jobs are returned in the Get-Jobs 2309 Response. There is no mechanism to allow for the next 'M' jobs 2310 after the first 'N' jobs. If the client does not supply this 2311 attribute, the Printer object responds with all applicable jobs. 2313 "requested-attributes" (1setOf keyword): 2314 The client OPTIONALLY supplies this attribute. The Printer object 2315 MUST support this attribute. It is a set of Job attribute names 2316 and/or attribute groups names in whose values the requester is 2317 interested. This set of attributes is returned for each Job object 2318 that is returned. The allowed attribute group names are the same 2319 as those defined in the Get-Job-Attributes operation in section 2320 3.3.4. If the client does not supply this attribute, the Printer 2321 MUST respond as if the client had supplied this attribute with two 2322 values: 'job-uri' and 'job-id'. 2324 "which-jobs" (keyword): 2325 The client OPTIONALLY supplies this attribute. The Printer object 2326 MUST support this attribute. It indicates which Job objects MUST 2327 be returned by the Printer object. The values for this attribute 2328 are: 2330 'completed': This includes any Job object whose state is 2331 'completed', 'canceled', or 'aborted'. 2332 'not-completed': This includes any Job object whose state is 2333 'pending', 'processing', 'processing-stopped', or 'pending- 2334 held'. 2336 A Printer object MUST support both values. However, if the 2337 implementation does not keep jobs in the 'completed', 'canceled', 2338 and 'aborted' states, then it returns no jobs when the 'completed' 2339 value is supplied. 2341 If a client supplies some other value, the Printer object MUST copy 2342 the attribute and the unsupported value to the Unsupported 2343 Attributes response group, reject the request, and return the 2344 'client-error-attributes-or-values-not-supported' status code. 2346 If the client does not supply this attribute, the Printer object 2347 MUST respond as if the client had supplied the attribute with a 2348 value of 'not-completed'. 2350 "my-jobs" (boolean): 2351 The client OPTIONALLY supplies this attribute. The Printer object 2352 MUST support this attribute. It indicates whether all jobs or just 2354 Expires August 17, 1999 2355 the jobs submitted by the requesting user of this request MUST be 2356 returned by the Printer object. If the client does not supply this 2357 attribute, the Printer object MUST respond as if the client had 2358 supplied the attribute with a value of 'false', i.e., all jobs. 2359 The means for authenticating the requesting user and matching the 2360 jobs is described in section 8. 2362 3.2.6.2 Get-Jobs Response 2364 The Printer object returns all of the Job objects that match the 2365 criteria as defined by the attribute values supplied by the client in 2366 the request. It is possible that no Job objects are returned since 2367 there may literally be no Job objects at the Printer, or there may be no 2368 Job objects that match the criteria supplied by the client. If the 2369 client requests any Job attributes at all, there is a set of Job Object 2370 Attributes returned for each Job object. 2372 Group 1: Operation Attributes 2374 Status Message: 2375 In addition to the REQUIRED status code returned in every response, 2376 the response OPTIONALLY includes a "status-message" (text) 2377 operation attribute as described in sections 14 and 3.1.6. 2379 Natural Language and Character Set: 2380 The "attributes-charset" and "attributes-natural-language" 2381 attributes as described in section 3.1.4.2. 2383 Group 2: Unsupported Attributes 2385 This is a set of Operation attributes supplied by the client (in 2386 the request) that are not supported by the Printer object or that 2387 conflict with one another (see sections 3.2.1.2 and the 2388 Implementer's Guide [IPP-IIG]). The response NEED NOT contain the 2389 "requested-attributes" operation attribute with any supplied values 2390 (attribute keywords) that were requested by the client but are not 2391 supported by the IPP object. If the Printer object is not 2392 returning any Unsupported Attributes in the response, the Printer 2393 object SHOULD omit Group 2 rather than sending an empty group. 2394 However, a client MUST be able to accept an empty group. 2396 Groups 3 to N: Job Object Attributes 2398 The Printer object responds with one set of Job Object Attributes 2399 for each returned Job object. The Printer object ignores (does not 2400 respond with) any requested attribute or value which is not 2401 supported or which is restricted by the security policy in force, 2402 including whether the requesting user is the user that submitted 2403 the job (job originating user) or not (see section 8). However, 2404 the Printer object MUST respond with the 'unknown' value for any 2405 supported attribute (including all REQUIRED attributes) for which 2406 the Printer object does not know the value, unless it would violate 2407 the security policy. See the description of the "out-of-band" 2408 values in the beginning of Section 4.1. 2410 Expires August 17, 1999 2411 Jobs are returned in the following order: 2413 - If the client requests all 'completed' Jobs (Jobs in the 2414 'completed', 'aborted', or 'canceled' states), then the Jobs 2415 are returned newest to oldest (with respect to actual 2416 completion time) 2417 - If the client requests all 'not-completed' Jobs (Jobs in the 2418 'pending', 'processing', 'pending-held', and 'processing- 2419 stopped' states), then Jobs are returned in relative 2420 chronological order of expected time to complete (based on 2421 whatever scheduling algorithm is configured for the Printer 2422 object). 2424 3.2.7 Pause-Printer Operation 2426 This OPTIONAL operation allows a client to stop the Printer object from 2427 scheduling jobs on all its devices. Depending on implementation, the 2428 Pause-Printer operation MAY also stop the Printer from processing the 2429 current job or jobs. Any job that is currently being printed is either 2430 stopped as soon as the implementation permits or is completed, depending 2431 on implementation. The Printer object MUST still accept create 2432 operations to create new jobs, but MUST prevent any jobs from entering 2433 the 'processing' state. 2435 If the Pause-Printer operation is supported, then the Resume-Printer 2436 operation MUST be supported, and vice-versa. 2438 The IPP Printer stops the current job(s) on its device(s) that were in 2439 the 'processing' or 'processing-stopped' states as soon as the 2440 implementation permits. If the implementation supports the "printer- 2441 state-reasons" attribute and the devices will take appreciable time to 2442 stop, the IPP Printer adds the 'moving-to-paused' value to the Printer 2443 object's "printer-state-reasons" attribute (see section 4.4.11). When 2444 the device(s) have all stopped, the IPP Printer transitions the Printer 2445 object to the 'stopped' state, removes the 'moving-to-paused' value, if 2446 present, and adds the 'paused' value to the Printer object's "printer- 2447 state-reasons" attribute. 2449 When the current job(s) complete that were in the 'processing' state, 2450 the IPP Printer transitions them to the 'completed' state. When the 2451 current job(s) stop in mid processing that were in the 'processing' 2452 state, the IPP Printer transitions them to the 'processing-stopped' 2453 state and, if the "job-state-reasons" attribute is supported, adds the 2454 'printer-stopped' value to the job's "job-state-reasons" attribute. 2456 Note: for any jobs that are 'pending' or 'pending-held', the 'printer- 2457 stopped' value of the jobs' "job-state-reasons" attribute also applies. 2458 However, the IPP Printer NEED NOT update those jobs' "job-state-reasons" 2459 attributes and only need return the 'printer-stopped' value when those 2460 jobs are queried (so-called "lazy evaluation"). 2462 Expires August 17, 1999 2463 Whether the Pause-Printer operation affects jobs that were submitted to 2464 the device from other sources than the IPP Printer object in the same 2465 way that the Pause-Printer operation affects jobs that were submitted to 2466 the IPP Printer object using IPP, depends on implementation, i.e., on 2467 whether the IPP protocol is being used as a universal management 2468 protocol or just to manage IPP jobs, respectively. 2470 The IPP Printer MUST accept the request in any state and transition the 2471 Printer to the indicated new "printer-state" before returning as 2472 follows: 2474 Current New "printer IPP Printer's response status 2475 "printer- "printer- -state- code and action: 2476 state" state" reasons" 2478 'idle' 'stopped' 'paused' 'successful-ok' 2480 'processin 'processin 'moving- OPTION 1: 'successful-ok'; 2481 g' g' to- Later, when all output has 2482 paused' stopped, the "printer-state" 2483 becomes 'stopped', and the 2484 'paused' value replaces the 2485 'moving-to-paused' value in the 2486 "printer-state-reasons" 2487 attribute 2489 'processin 'stopped' 'paused' OPTION 2: 'successful-ok'; 2490 g' all device output stopped 2491 immediately 2493 'stopped' 'stopped' 'paused' 'successful-ok' 2495 Access Rights: The requesting user must be an operator or administrator 2496 of the Printer object. Otherwise, the IPP Printer MUST reject the 2497 operation and return: 'client-error-forbidden', 'client-error-not- 2498 authenticated', or 'client-error-not-authorized' as appropriate. 2500 3.2.7.1 Pause-Printer Request 2502 The following groups of attributes are part of the Pause-Printer 2503 Request: 2505 Group 1: Operation Attributes 2507 Natural Language and Character Set: 2508 The "attributes-charset" and "attributes-natural-language" 2509 attributes as described in section 3.1.4.1. 2511 Target: 2512 The "printer-uri" (uri) operation attribute which is the target for 2513 this operation as described in section 3.1.5. 2515 Requesting User Name: 2516 The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied 2517 by the client as described in section 8.3. 2519 Expires August 17, 1999 2521 3.2.7.2 Pause-Printer Response 2523 The following groups of attributes are part of the Pause-Printer 2524 Response: 2526 Group 1: Operation Attributes 2528 Status Message: 2529 In addition to the REQUIRED status code returned in every response, 2530 the response OPTIONALLY includes a "status-message" (text) 2531 operation attribute as described in section 3.1.6. 2533 Natural Language and Character Set: 2534 The "attributes-charset" and "attributes-natural-language" 2535 attributes as described in section 3.1.4.2. 2537 Group 2: Unsupported Attributes 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 that 2541 conflict with one another (see sections 3.2.1.2 and 16). 2543 3.2.8 Resume-Printer Operation 2545 This operation allows a client to resume the Printer object scheduling 2546 jobs on all its devices. If the Printer object supports the "printer- 2547 state-reasons" attribute, it MUST remove the 'paused' and 'moving-to- 2548 paused' values from the Printer object's "printer-state-reasons" 2549 attribute, if present. If there are no other reasons to keep a device 2550 paused (such as media-jam), the IPP Printer transitions itself to the 2551 'processing' or 'idle' states, depending on whether there are jobs to be 2552 processed or not, respectively, and the device(s) resume processing 2553 jobs. 2555 If the Pause-Printer operation is supported, then the Resume-Printer 2556 operation MUST be supported, and vice-versa. 2558 The IPP Printer removes the 'printer-stopped' value from any job's "job- 2559 state-reasons" attributes contained in that Printer. 2561 The IPP Printer MUST accept the request in any state, transition the 2562 Printer object to the indicated new state as follows: 2564 Current New "printer- IPP Printer's response status code 2565 "printer- state" and action: 2566 state" 2568 'idle' 'idle' 'successful-ok' 2570 'processing 'processing' 'successful-ok' 2571 ' 2573 'stopped' 'processing' 'successful-ok'; 2574 when there are jobs to be 2575 processed 2577 'stopped' 'idle' 'successful-ok'; 2578 when there are no jobs to be 2580 Expires August 17, 1999 2582 Current New "printer- IPP Printer's response status code 2583 "printer- state" and action: 2584 state" 2586 processed. 2588 Access Rights: The requesting user must be an operator or administrator 2589 of the Printer object. Otherwise, the IPP Printer MUST reject the 2590 operation and return: 'client-error-forbidden', 'client-error-not- 2591 authenticated', or 'client-error-not-authorized' as appropriate. 2593 The Resume-Printer Request and Resume-Printer Response have the same 2594 attribute groups and attributes as the Pause-Printer operation (see 2595 sections 3.2.7.1 and 3.2.7.2). 2597 3.2.9 Purge-Jobs Operation 2599 This OPTIONAL operation allows a client to remove all jobs from an IPP 2600 Printer object, regardless of their job states, including jobs in the 2601 Printer object's Job History (see Section 4.3.7.1). After a Purge-Jobs 2602 operation has been performed, a Printer object MUST return no jobs in 2603 subsequent Get-Job-Attributes and Get-Jobs responses (until new jobs are 2604 submitted). 2606 Whether the Purge-Jobs (and Get-Jobs) operation affects jobs that were 2607 submitted to the device from other sources than the IPP Printer object 2608 in the same way that the Purge-Jobs operation affects jobs that were 2609 submitted to the IPP Printer object using IPP, depends on 2610 implementation, i.e., on whether the IPP protocol is being used as a 2611 universal management protocol or just to manage IPP jobs, respectively. 2613 Note: if an operator wants to cancel all jobs without clearing out the 2614 Job History, the operator uses the Cancel-Job operation on each job 2615 instead of using the Purge-Job operation. 2617 The Printer object MUST accept this operation in any state and 2618 transition the Printer object to the 'idle' state. 2620 Access Rights: The requesting user must be an operator or administrator 2621 of the Printer object. Otherwise, the IPP object MUST reject the 2622 operation and return: client-error-forbidden, client-error-not- 2623 authenticated, and client-error-not-authorized as appropriate. 2625 The Purge-Jobs Request and Purge-Jobs Response have the same attribute 2626 groups and attributes as the Pause-Printer operation (see sections 2627 3.2.7.1 and 3.2.7.2). 2629 3.3 Job Operations 2631 All Job operations are directed at Job objects. A client MUST always 2632 supply some means of identifying the Job object in order to identify the 2633 correct target of the operation. That job identification MAY either be 2634 a single Job URI or a combination of a Printer URI with a Job ID. The 2636 Expires August 17, 1999 2637 IPP object implementation MUST support both forms of identification for 2638 every job. 2640 3.3.1 Send-Document Operation 2642 This OPTIONAL operation allows a client to create a multi-document Job 2643 object that is initially "empty" (contains no documents). In the 2644 Create-Job response, the Printer object returns the Job object's URI 2645 (the "job-uri" attribute) and the Job object's 32-bit identifier (the 2646 "job-id" attribute). For each new document that the client desires to 2647 add, the client uses a Send-Document operation. Each Send-Document 2648 Request contains the entire stream of document data for one document. 2650 Since the Create-Job and the send operations (Send-Document or Send-URI 2651 operations) that follow could occur over an arbitrarily long period of 2652 time for a particular job, a client MUST send another send operation 2653 within an IPP Printer defined minimum time interval after the receipt of 2654 the previous request for the job. If a Printer object supports multiple 2655 document jobs, the Printer object MUST support the "multiple-operation- 2656 time-out" attribute (see section 4.4.28). This attribute indicates the 2657 minimum number of seconds the Printer object will wait for the next send 2658 operation before taking some recovery action. 2660 An IPP object MUST recover from an errant client that does not supply a 2661 send operation, sometime after the minimum time interval specified by 2662 the Printer object's "multiple-operation-time-out" attribute. Such 2663 recovery MAY include any of the following or other recovery actions: 2665 1. Assume that the Job is an invalid job, start the process of 2666 changing the job state to 'aborted', add the 'aborted-by-system' 2667 value to the job's "job-state-reasons" attribute (see section 2668 4.3.8), if supported, and clean up all resources associated with 2669 the Job. In this case, if another send operation is finally 2670 received, the Printer responds with an "client-error-not-possible" 2671 or "client-error-not-found" depending on whether or not the Job 2672 object is still around when the send operation finally arrives. 2673 2. Assume that the last send operation received was in fact the last 2674 document (as if the "last-document" flag had been set to 'true'), 2675 close the Job object, and proceed to process it (i.e., move the 2676 Job's state to 'pending'). 2677 3. Assume that the last send operation received was in fact the last 2678 document, close the Job, but move it to the 'pending-held' and add 2679 the 'submission-interrupted' value to the job's "job-state-reasons" 2680 attribute (see section 4.3.8), if supported. This action allows 2681 the user or an operator to determine whether to continue processing 2682 the Job by moving it back to the 'pending' state using the Release- 2683 Job operation (see section 3.3.6) or to cancel the job using the 2684 Cancel-Job operation (see section 3.3.3). 2686 Each implementation is free to decide the "best" action to take 2687 depending on local policy, whether any documents have been added, 2688 whether the implementation spools jobs or not, and/or any other piece 2689 of information available to it. If the choice is to abort the Job 2691 Expires August 17, 1999 2692 object, it is possible that the Job object may already have been 2693 processed to the point that some media sheet pages have been printed. 2695 3.3.1.1 Send-Document Request 2697 The following attribute sets are part of the Send-Document Request: 2699 Group 1: Operation Attributes 2701 Natural Language and Character Set: 2702 The "attributes-charset" and "attributes-natural-language" 2703 attributes as described in section 3.1.4.1. 2705 Target: 2706 Either (1) the "printer-uri" (uri) plus "job-id" (integer(1:MAX))or 2707 (2) the "job-uri" (uri) operation attribute(s) which define the 2708 target for this operation as described in section 3.1.5. 2710 Requesting User Name: 2711 The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied 2712 by the client as described in section 8.3. 2714 "document-name" (name(MAX)): 2715 The client OPTIONALLY supplies this attribute. The Printer object 2716 MUST support this attribute. It contains the client supplied 2717 document name. The document name MAY be different than the Job 2718 name. It might be helpful, but NEED NOT be unique across multiple 2719 documents in the same Job. Typically, the client software 2720 automatically supplies the document name on behalf of the end user 2721 by using a file name or an application generated name. See the 2722 description of the "document-name" operation attribute in the 2723 Print-Job Request (section 3.2.1.1) for more information about this 2724 attribute. 2726 "document-format" (mimeMediaType) : 2727 The client OPTIONALLY supplies this attribute. The Printer object 2728 MUST support this attribute. The value of this attribute 2729 identifies the format of the supplied document data. If the client 2730 does not supply this attribute, the Printer object assumes that the 2731 document data is in the format defined by the Printer object's 2732 "document-format-default" attribute. If the client supplies this 2733 attribute, but the value is not supported by the Printer object, 2734 i.e., the value is not one of the values of the Printer object's 2735 "document-format-supported" attribute, the Printer object MUST 2736 reject the request and return the 'client-error-document-format- 2737 not-supported' status code. 2739 "document-natural-language" (naturalLanguage): 2740 The client OPTIONALLY supplies this attribute. The Printer object 2741 OPTIONALLY supports this attribute. This attribute specifies the 2742 natural language of the document for those document-formats that 2743 require a specification of the natural language in order to image 2744 the document unambiguously. There are no particular values 2745 required for the Printer object to support. 2747 Expires August 17, 1999 2749 "compression" (type3 keyword) 2750 The client OPTIONALLY supplies this attribute. The Printer object 2751 OPTIONALLY supports this attribute and the "compression-supported" 2752 attribute (see section 4.4.29). The client supplied "compression" 2753 operation attribute identifies the compression algorithm used on 2754 the document data. If the client omits this attribute, the Printer 2755 object MUST assume that the data is not compressed. If the client 2756 supplies the attribute and the Printer object supports the 2757 attribute, the Printer object MUST use the corresponding 2758 decompression algorithm on the document data. If the client 2759 supplies this attribute, but the value is not supported by the 2760 Printer object, i.e., the value is not one of the values of the 2761 Printer object's "compression-supported" attribute, the Printer 2762 object MUST copy the attribute and its value to the Unsupported 2763 Attributes response group, reject the request, and return the 2764 'client-error-attributes-or-values-not-supported' status code. 2766 "last-document" (boolean): 2767 The client MUST supply this attribute. The Printer object MUST 2768 support this attribute. It is a boolean flag that is set to 'true' 2769 if this is the last document for the Job, 'false' otherwise. 2771 Group 2: Document Content 2773 The client MUST supply the document data if the "last-document" 2774 flag is set to 'false'. However, since a client might not know 2775 that the previous document sent with a Send-Document (or Send-URI) 2776 operation was the last document (i.e., the "last-document" 2777 attribute was set to 'false'), it is legal to send a Send-Document 2778 request with no document data where the "last-document" flag is set 2779 to 'true'. Such a request MUST NOT increment the value of the Job 2780 object's "number-of-documents" attribute, since no real document 2781 was added to the job. 2783 3.3.1.2 Send-Document Response 2785 The following sets of attributes are part of the Send-Document Response: 2787 Group 1: Operation Attributes 2789 Status Message: 2790 In addition to the REQUIRED status code returned in every response, 2791 the response OPTIONALLY includes a "status-message" (text) 2792 operation attribute as described in sections 14 and 3.1.6. 2794 Natural Language and Character Set: 2795 The "attributes-charset" and "attributes-natural-language" 2796 attributes as described in section 3.1.4.2. 2798 Group 2: Unsupported Attributes 2800 This is a set of Operation attributes supplied by the client (in 2801 the request) that are not supported by the Printer object or that 2803 Expires August 17, 1999 2804 conflict with one another (see sections 3.2.1.2 and the 2805 Implementer's Guide [IPP-IIG]). If the Printer object is not 2806 returning any Unsupported Attributes in the response, the Printer 2807 object SHOULD omit Group 2 rather than sending an empty group. 2808 However, a client MUST be able to accept an empty group. 2810 Group 3: Job Object Attributes 2812 This is the same set of attributes as described in the Print-Job 2813 response (see section 3.2.1.2). 2815 3.3.2 Send-URI Operation 2817 This OPTIONAL operation is identical to the Send-Document operation (see 2818 section 3.3.1) except that a client MUST supply a URI reference 2819 ("document-uri" operation attribute) rather than the document data 2820 itself. If a Printer object supports this operation, clients can use 2821 both Send-URI or Send-Document operations to add new documents to an 2822 existing multi-document Job object. However, if a client needs to 2823 indicate that the previous Send-URI or Send-Document was the last 2824 document, the client MUST use the Send-Document operation with no 2825 document data and the "last-document" flag set to 'true' (rather than 2826 using a Send-URI operation with no "document-uri" operation attribute). 2828 If a Printer object supports this operation, it MUST also support the 2829 Print-URI operation (see section 3.2.2). 2831 The Printer object MUST validate the syntax and URI scheme of the 2832 supplied URI before returning a response, just as in the Print-URI 2833 operation. 2835 3.3.3 Cancel-Job Operation 2837 This REQUIRED operation allows a client to cancel a Print Job from the 2838 time the job is created up to the time it is completed, canceled, or 2839 aborted. Since a Job might already be printing by the time a Cancel-Job 2840 is received, some media sheet pages might be printed before the job is 2841 actually terminated. 2843 3.3.3.1 Cancel-Job Request 2845 The following groups of attributes are part of the Cancel-Job Request: 2847 Group 1: Operation Attributes 2849 Natural Language and Character Set: 2850 The "attributes-charset" and "attributes-natural-language" 2851 attributes as described in section 3.1.4.1. 2853 Target: 2854 Either (1) the "printer-uri" (uri) plus "job-id" 2855 (integer(1:MAX))or (2) the "job-uri" (uri) operation attribute(s) 2857 Expires August 17, 1999 2858 which define the target for this operation as described in section 2859 3.1.5. 2861 Requesting User Name: 2862 The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied 2863 by the client as described in section 8.3. 2865 "message" (text(127)): 2866 The client OPTIONALLY supplies this attribute. The Printer object 2867 OPTIONALLY supports this attribute. It is a message to the 2868 operator. This "message" attribute is not the same as the "job- 2869 message-from-operator" attribute. That attribute is used to report 2870 a message from the operator to the end user that queries that 2871 attribute. This "message" operation attribute is used to send a 2872 message from the client to the operator along with the operation 2873 request. It is an implementation decision of how or where to 2874 display this message to the operator (if at all). 2876 3.3.3.2 Cancel-Job Response 2878 The following sets of attributes are part of the Cancel-Job Response: 2880 Group 1: Operation Attributes 2882 Status Message: 2883 In addition to the REQUIRED status code returned in every response, 2884 the response OPTIONALLY includes a "status-message" (text) 2885 operation attribute as described in sections 14 and 3.1.6. 2887 If the job is already in the 'completed', 'aborted', or 'canceled' 2888 state, or the 'process-to-stop-point' value is set in the Job's 2889 "job-state-reasons" attribute, the Printer object MUST reject the 2890 request and return the 'client-error-not-possible' error status 2891 code. 2893 Natural Language and Character Set: 2894 The "attributes-charset" and "attributes-natural-language" 2895 attributes as described in section 3.1.4.2. 2897 Group 2: Unsupported Attributes 2899 This is a set of Operation attributes supplied by the client (in 2900 the request) that are not supported by the Printer object or that 2901 conflict with one another (see section 3.2.1.2 and the 2902 Implementer's Guide [IPP-IIG]). If the Printer object is not 2903 returning any Unsupported Attributes in the response, the Printer 2904 object SHOULD omit Group 2 rather than sending an empty group. 2905 However, a client MUST be able to accept an empty group. 2907 Once a successful response has been sent, the implementation guarantees 2908 that the Job will eventually end up in the 'canceled' state. Between the 2909 time of the Cancel-Job operation is accepted and when the job enters the 2911 Expires August 17, 1999 2912 'canceled' job-state (see section 4.3.7), the "job-state-reasons" 2913 attribute SHOULD contain the ' processing-to-stop-point ' value which 2914 indicates to later queries that although the Job might still be 2915 'processing', it will eventually end up in the 'canceled' state, not the 2916 'completed' state. 2918 3.3.4 Get-Job-Attributes Operation 2920 This REQUIRED operation allows a client to request the values of 2921 attributes of a Job object and it is almost identical to the Get- 2922 Printer-Attributes operation (see section 3.2.5). The only differences 2923 are that the operation is directed at a Job object rather than a Printer 2924 object, there is no "document-format" operation attribute used when 2925 querying a Job object, and the returned attribute group is a set of Job 2926 object attributes rather than a set of Printer object attributes. 2928 For Jobs, the possible names of attribute groups are: 2930 - 'job-template': all of the Job Template attributes that apply to a 2931 Job object (the first column of the table in Section 4.2). 2932 - 'job-description': all of the Job Description attributes specified 2933 in Section 4.3. 2934 - 'all': the special group 'all' that includes all supported 2935 attributes. 2937 Since a client MAY request specific attributes or named groups, there is 2938 a potential that there is some overlap. For example, if a client 2939 requests, 'job-name' and 'job-description', the client is actually 2940 requesting the "job-name" attribute once by naming it explicitly, and 2941 once by inclusion in the 'job-description' group. In such cases, the 2942 Printer object NEED NOT return the attribute only once in the response 2943 even if it is requested multiple times. The client SHOULD NOT request 2944 the same attribute in multiple ways. 2946 It is NOT REQUIRED that a Job object support all attributes belonging to 2947 a group (since some attributes are OPTIONAL). However it is REQUIRED 2948 that each Job object support all group names. 2950 3.3.4.1 Get-Job-Attributes Request 2952 The following groups of attributes are part of the Get-Job-Attributes 2953 Request when the request is directed at a Job object: 2955 Group 1: Operation Attributes 2957 Natural Language and Character Set: 2958 The "attributes-charset" and "attributes-natural-language" 2959 attributes as described in section 3.1.4.1. 2961 Target: 2962 Either (1) the "printer-uri" (uri) plus "job-id" (integer(1:MAX)) 2963 or (2) the "job-uri" (uri) operation attribute(s) which define the 2964 target for this operation as described in section 3.1.5. 2966 Expires August 17, 1999 2968 Requesting User Name: 2969 The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied 2970 by the client as described in section 8.3. 2972 "requested-attributes" (1setOf keyword) : 2973 The client OPTIONALLY supplies this attribute. The IPP object MUST 2974 support this attribute. It is a set of attribute names and/or 2975 attribute group names in whose values the requester is interested. 2976 If the client omits this attribute, the IPP object MUST respond as 2977 if this attribute had been supplied with a value of 'all'. 2979 3.3.4.2 Get-Job-Attributes Response 2981 The Printer object returns the following sets of attributes as part of 2982 the Get-Job-Attributes Response: 2984 Group 1: Operation Attributes 2986 Status Message: 2987 In addition to the REQUIRED status code returned in every response, 2988 the response OPTIONALLY includes a "status-message" (text) 2989 operation attribute as described in sections 14 and 3.1.6. 2991 Natural Language and Character Set: 2992 The "attributes-charset" and "attributes-natural-language" 2993 attributes as described in section 3.1.4.2. The "attributes- 2994 natural-language" MAY be the natural language of the Job object, 2995 rather than the one requested. 2997 Group 2: Unsupported Attributes 2999 This is a set of Operation attributes supplied by the client (in 3000 the request) that are not supported by the Printer object or that 3001 conflict with one another (see sections 3.2.1.2 and the 3002 Implementer's Guide [IPP-IIG]). The response NEED NOT contain the 3003 "requested-attributes" operation attribute with any supplied values 3004 (attribute keywords) that were requested by the client but are not 3005 supported by the IPP object. If the Printer object is not 3006 returning any Unsupported Attributes in the response, the Printer 3007 object SHOULD omit Group 2 rather than sending an empty group. 3008 However, a client MUST be able to accept an empty group. 3010 Group 3: Job Object Attributes 3012 This is the set of requested attributes and their current values. 3013 The IPP object ignores (does not respond with) any requested 3014 attribute or value which is not supported or which is restricted by 3015 the security policy in force, including whether the requesting user 3016 is the user that submitted the job (job originating user) or not 3017 (see section 8). However, the IPP object MUST respond with the 3018 'unknown' value for any supported attribute (including all REQUIRED 3020 Expires August 17, 1999 3021 attributes) for which the IPP object does not know the value, 3022 unless it would violate the security policy. See the description 3023 of the "out-of-band" values in the beginning of Section 4.1. 3025 3.3.5 Hold-Job Operation 3027 This OPTIONAL operation allows a client to hold a pending job in the 3028 queue so that it is not eligible for scheduling. If the Hold-Job 3029 operation is supported, then the Release-Job operation MUST be 3030 supported, and vice-versa. The OPTIONAL "job-hold-until" operation 3031 attribute allows a client to specify whether to hold the job 3032 indefinitely or until a specified time period, if supported. 3034 The IPP object MUST accept or reject the request based on the job's 3035 current state and transition the job to the indicated new state as 3036 follows: 3038 Current "job- New "job- IPP object's response status 3039 state" state" code and action: 3041 'pending' 'pending- 'successful-ok' See Note 1 3042 held' 3044 'pending' 'pending' 'successful-ok' See Note 2 3046 'pending- 'pending- 'successful-ok' See Note 1 3047 held' held' 3049 'pending- 'pending' 'successful-ok' See Note 2 3050 held' 3052 'processing' 'processing' 'client-error-not-possible' 3054 'processing- 'processing- 'client-error-not-possible' 3055 stopped' stopped' 3057 'completed' 'completed' 'client-error-not-possible' 3059 'canceled' 'canceled' 'client-error-not-possible' 3061 'aborted' 'aborted' 'client-error-not-possible' 3063 Note 1: If the OPTIONAL "job-state-reasons" attribute is supported and 3064 if the implementation supports multiple reasons for a job to be in the 3065 'pending-held' state, the IPP object MUST add the 'job-hold-until- 3066 specified' value to the job's "job-state-reasons" attribute. 3068 Note 2: If the IPP object supports the "job-hold-until" operation 3069 attribute, but the specified time period has already started (or is the 3070 'no-hold' value) and there are no other reasons to hold the job, the IPP 3071 object MUST make the job be a candidate for processing immediately (see 3072 Section 4.2.2) by putting the job in the 'pending' state. 3074 Note: In order to keep the Hold-Job operation simple, such a request is 3075 rejected when the job is in the 'processing' or 'processing-stopped' 3076 states. If an operation is needed to hold jobs while in these states, 3077 it will be added as an additional operation, rather than overloading the 3078 Hold-Job operation. Then it is clear to clients by querying the Printer 3079 object's "operations-supported" (see Section 4.4.13) and the Job 3080 object's "job-state" (see Section 4.3.7) attributes which operations are 3081 possible. 3083 Expires August 17, 1999 3084 Access Rights: The requesting user must either be the submitter of the 3085 job or an operator or administrator of the Printer object (see Section 3086 1). Otherwise, the IPP object MUST reject the operation and return: 3087 'client-error-forbidden', 'client-error-not-authenticated', or 'client- 3088 error-not-authorized' as appropriate. 3090 3.3.5.1 Hold-Job Request 3092 The groups and operation attributes are the same as for a Cancel-Job 3093 request (see section 3.3.3.1), with the addition of the following Group 3094 1 Operation attribute: 3096 "job-hold-until" (type3 keyword | name(MAX)): 3097 The client OPTIONALLY supplies this Operation attribute. The IPP 3098 object MUST support this operation attribute in a Hold-Job request, 3099 if it supports the "job-hold-until" Job template attribute in 3100 create operations. See section 4.2.2. The IPP object SHOULD 3101 support the "job-hold-until" Job Template attribute for use in job 3102 create operations with at least the 'indefinite' value, if it 3103 supports the Hold-Job operation. Otherwise, a client cannot create 3104 a job and hold it immediately (without picking some supported time 3105 period in the future). 3107 If supplied and supported as specified in the Printer's "job-hold- 3108 until-supported" attribute, the IPP object copies the supplied 3109 operation attribute to the Job object, replacing the job's previous 3110 "job-hold-until" attribute, if present, and makes the job a 3111 candidate for scheduling during the supplied named time period. 3113 If supplied, but either the "job-hold-until" Operation attribute 3114 itself or the value supplied is not supported, the IPP object 3115 accepts the request, returns the unsupported attribute or value in 3116 the Unsupported Attributes Group according to section 3.2.1.2, 3117 returns the 'successful-ok-ignored-or-substituted-attributes, and 3118 holds the job indefinitely until a client performs a subsequent 3119 Release-Job operation. 3121 If the client (1) supplies a value that specifies a time period 3122 that has already started or the 'no-hold' value (meaning don't hold 3123 the job) and (2) the IPP object supports the "job-hold-until" 3124 operation attribute and there are no other reasons to hold the job, 3125 the IPP object MUST accept the operation and make the job be a 3126 candidate for processing immediately (see Section 4.2.2). 3128 If the client does not supply a "job-hold-until" Operation 3129 attribute in the request, the IPP object MUST populate the job 3130 object with a "job-hold-until" attribute with the 'indefinite' 3131 value (if IPP object supports the "job-hold-until" attribute) and 3132 hold the job indefinitely, until a client performs a Release-Job 3133 operation. 3135 Expires August 17, 1999 3137 3.3.5.2 Hold-Job Response 3139 The groups and attributes are the same as for a Cancel-Job response (see 3140 section 3.3.3.2). 3142 3.3.6 Release-Job Operation 3144 This OPTIONAL operation allows a client to release a previously held job 3145 so that it is again eligible for scheduling. If the Hold-Job operation 3146 is supported, then the Release-Job operation MUST be supported, and 3147 vice-versa. 3149 This operation removes the "job-hold-until" job attribute, if present, 3150 from the job object that had been supplied in the create or most recent 3151 Hold-Job or Restart-Job operation and remove its effect on the job. If 3152 the OPTIONAL "job-state-reasons" attribute is supported, the IPP object 3153 MUST remove the 'job-hold-until-specified' value from the job's "job- 3154 state-reasons" attribute, if present. See section 4.3.8. 3156 The IPP object MUST accept or reject the request based on the job's 3157 current state and transition the job to the indicated new state as 3158 follows: 3160 Current "job- New "job- IPP object's response status 3161 state" state" code and action: 3163 'pending' 'pending' 'successful-ok' No effect on 3164 the job. 3166 'pending- 'pending- 'successful-ok' See Note 1 3167 held' held' 3169 'pending- 'pending' 'successful-ok' 3170 held' 3172 'processing' 'processing' 'successful-ok' No effect on 3173 the job. 3175 'processing- 'processing- 'successful-ok' No effect on 3176 stopped' stopped' the job. 3178 'completed' 'completed' 'client-error-not-possible' 3180 'canceled' 'canceled' 'client-error-not-possible' 3182 'aborted' 'aborted' 'client-error-not-possible' 3184 Note 1: If there are other reasons to keep the job in the 'pending- 3185 held' state, such as 'resources-are-not-ready', the job remains in the 3186 'pending-held' state. Thus the 'pending-held' state is not just for 3187 jobs that have the 'job-hold-until' applied to them, but are for any 3188 reason to keep the job from being a candidate for scheduling and 3189 processing, such as 'resources-are-not-ready'. See the "job-hold-until" 3190 attribute (section 4.2.2). 3192 Access Rights: The requesting user must either be the submitter of the 3193 job or an operator or administrator of the Printer object. Otherwise, 3194 the IPP object MUST reject the operation and return: 'client-error- 3195 forbidden', 'client-error-not-authenticated', or 'client-error-not- 3196 authorized' as appropriate. 3198 Expires August 17, 1999 3199 The Release-Job Request and Release-Job Response have the same attribute 3200 groups and attributes as the Cancel-Job operation (see section 3.3.3.1 3201 and 3.3.3.2). 3203 3.3.7 Restart-Job Operation 3205 This OPTIONAL operation allows a client to restart a job that is 3206 retained in the queue after processing has completed (see section 3207 4.3.7.1). 3209 The job is moved to the 'pending' job state and restarts at the 3210 beginning on the same IPP Printer object with the same attribute values. 3211 The Job Description attributes that accumulate job progress, such as 3212 "job-impressions-completed", "job-media-sheets-completed", and "job-k- 3213 octets-processed", MUST be reset to 0 so that they give an accurate 3214 record of the job from its restart point. The job object MUST continue 3215 to use the same "job-uri" and "job-id" attribute values. 3217 Note: If in the future an operation is needed that does not reset the 3218 job progress attributes, then a new operation will be defined which 3219 makes a copy of the job, assigns a new "job-uri" and "job-id" to the 3220 copy and resets the job progress attributes in the new copy only. 3222 The IPP object MUST accept or reject the request based on the job's 3223 current state, transition the job to the indicated new state as follows: 3225 Current "job- New "job- IPP object's response status 3226 state" state" code and action: 3228 'pending' 'pending' 'client-error-not-possible'. 3230 'pending- 'pending- 'client-error-not-possible'. 3231 held' held' 3233 'processing' 'processing' 'client-error-not-possible'. 3235 'processing- 3236 stopped' 3238 'completed' 'pending' 'successful-ok' - job is started 3239 over. 3241 'completed' 'completed' 'client-error-not-possible' - 3242 see Note 1 3244 'canceled' 'pending' 'successful-ok' - job is started 3245 over. 3247 'canceled' 'canceled' 'client-error-not-possible' - 3248 see Note 1 3250 'aborted' 'pending' 'successful-ok' - job is started 3251 over. 3253 'aborted' 'aborted' 'client-error-not-possible' - 3254 see Note 1 3256 Expires August 17, 1999 3258 Note 1: If the Job Retention Period has expired for the job in this 3259 state, then the IPP object rejects the operation. See section 4.3.7.1. 3261 Note: In order to prevent a user from inadvertently restarting a job in 3262 the middle, the Restart-Job request is rejected when the job is in the 3263 'processing' or 'processing-stopped' states. If in the future an 3264 operation is needed to hold or restart jobs while in these states, it 3265 will be added as an additional operation, rather than overloading the 3266 Restart-Job operation, so that it is clear that the user intended that 3267 the current job not be completed. 3269 Access Rights: The requesting user must either be the submitter of the 3270 job or an operator or administrator of the Printer object. Otherwise, 3271 the IPP object MUST reject the operation and return: 'client-error- 3272 forbidden', 'client-error-not-authenticated', or 'client-error-not- 3273 authorized' as appropriate. 3275 3.3.7.1 Restart-Job Request 3277 The groups and attributes are the same as for a Cancel-Job request (see 3278 section 3.3.3.1), with the addition of the following Group 1 Operation 3279 attribute: 3281 "job-hold-until" (type3 keyword | name(MAX)): 3282 The client OPTIONALLY supplies this attribute. The IPP object MUST 3283 support this Operation attribute in a Restart-Job request, if it 3284 supports the "job-hold-until" Job Template attribute in create 3285 operations. See section 4.2.2. Otherwise, the IPP object NEED NOT 3286 support the "job-hold-until" Operation attribute in a Restart-Job 3287 request. 3289 If supplied and supported as specified in the Printer's "job-hold- 3290 until-supported" attribute, the IPP object copies the supplied 3291 Operation attribute to the Job object, replacing the job's previous 3292 "job-hold-until" attribute, if present, and makes the job a 3293 candidate for scheduling during the supplied named time period. 3294 See section 4.2.2. 3296 If supplied, but the value is not supported, the IPP object accepts 3297 the request, returns the unsupported attribute or value in the 3298 Unsupported Attributes Group according to section 3.2.1.2, returns 3299 the 'successful-ok-ignored-or-substituted-attributes' status code, 3300 and holds the job indefinitely until a client performs a subsequent 3301 Release-Job operation. 3303 If supplied, but the "job-hold-until" Operation attribute itself is 3304 not supported, the IPP object accepts the request, returns the 3305 unsupported attribute with the out-of-band 'unsupported' value in 3306 the Unsupported Attributes Group according to section 3.2.1.2, 3307 returns the 'successful-ok-ignored-or-substituted-attributes' 3308 status code, and restarts the job, i.e., ignores the "job-hold- 3309 until" attribute. 3311 Expires August 17, 1999 3312 If the client (1) supplies a value that specifies a time period 3313 that has already started or the 'no-hold' value (meaning don't hold 3314 the job) and (2) the IPP object supports the "job-hold-until" 3315 operation attribute and there are no other reasons to hold the job, 3316 the IPP object makes the job a candidate for processing immediately 3317 (see Section 4.2.2). 3319 If the client does not supply a "job-hold-until" operation 3320 attribute in the request, the IPP object removes the "job-hold- 3321 until" attribute, if present, from the job. If there are no other 3322 reasons to hold the job, the Restart-Job operation makes the job a 3323 candidate for processing immediately (see Section 4.2.2). 3325 3.3.7.2 Restart-Job Response 3327 The groups and attributes are the same as for a Cancel-Job response (see 3328 section 3.3.3.2). 3330 Note: In the future an OPTIONAL Modify-Job operation may be specified 3331 that allows the client to modify other attributes before releasing the 3332 restarted job. 3334 4. Object Attributes 3336 This section describes the attributes with their corresponding attribute 3337 syntaxes and values that are part of the IPP model. The sections below 3338 show the objects and their associated attributes which are included 3339 within the scope of this protocol. Many of these attributes are derived 3340 from other relevant specifications: 3342 - Document Printing Application (DPA) [ISO10175] 3343 - RFC 1759 Printer MIB [RFC1759] 3345 Each attribute is uniquely identified in this document using a "keyword" 3346 (see section 13.2.1) which is the name of the attribute. The keyword is 3347 included in the section header describing that attribute. 3349 Note: Not only are keywords used to identify attributes, but one of the 3350 attribute syntaxes described below is "keyword" so that some attributes 3351 have keyword values. Therefore, these attributes are defined as having 3352 an attribute syntax that is a set of keywords. 3354 4.1 Attribute Syntaxes 3356 This section defines the basic attribute syntax types that all clients 3357 and IPP objects MUST be able to accept in responses and accept in 3358 requests, respectively. Each attribute description in sections 3 and 3359 3.3.5 includes the name of attribute syntax(es) in the heading (in 3360 parentheses). A conforming implementation of an attribute MUST include 3362 Expires August 17, 1999 3363 the semantics of the attribute syntax(es) so identified. Section 6.3 3364 describes how the protocol can be extended with new attribute syntaxes. 3366 The attribute syntaxes are specified in the following sub-sections, 3367 where the sub-section heading is the keyword name of the attribute 3368 syntax inside the single quotes. In operation requests and responses 3369 each attribute value MUST be represented as one of the attribute 3370 syntaxes specified in the sub-section heading for the attribute. In 3371 addition, the value of an attribute in a response (but not in a request) 3372 MAY be one of the "out-of-band" values. Standard "out-of-band" values 3373 are: 3375 'unknown': The attribute is supported by the IPP object, but the 3376 value is unknown to the IPP object for some reason. 3377 'unsupported': The attribute is unsupported by the IPP object. This 3378 value MUST be returned only as the value of an attribute in the 3379 Unsupported Attributes Group. 3380 'no-value': The attribute is supported by the Printer object, but the 3381 administrator has not yet configured a value. 3383 The "Encoding and Transport" specification [IPP-PRO] defines mechanisms 3384 for passing "out-of-band" values. All attributes in a request MUST have 3385 one or more values as defined in Sections 4.2 to 4.4. Thus clients MUST 3386 NOT supply attributes with "out-of-band" values. All attributes in a 3387 response MUST have one or more values as defined in Sections 4.2 to 4.4 3388 or a single "out-of-band" value. 3390 Most attributes are defined to have a single attribute syntax. However, 3391 a few attributes (e.g., "job-sheet", "media", "job-hold-until") are 3392 defined to have several attribute syntaxes, depending on the value. 3393 These multiple attribute syntaxes are separated by the "|" character in 3394 the sub-section heading to indicate the choice. Since each value MUST 3395 be tagged as to its attribute syntax in the protocol, a single-valued 3396 attribute instance may have any one of its attribute syntaxes and a 3397 multi-valued attribute instance may have a mixture of its defined 3398 attribute syntaxes. 3400 4.1.1 'text' 3402 A text attribute is an attribute whose value is a sequence of zero or 3403 more characters encoded in a maximum of 1023 ('MAX') octets. MAX is the 3404 maximum length for each value of any text attribute. However, if an 3405 attribute will always contain values whose maximum length is much less 3406 than MAX, the definition of that attribute will include a qualifier that 3407 defines the maximum length for values of that attribute. For example: 3408 the "printer-location" attribute is specified as "printer-location 3409 (text(127))". In this case, text values for "printer-location" MUST NOT 3410 exceed 127 octets; if supplied with a longer text string via some 3411 external interface (other than the protocol), implementations are free 3412 to truncate to this shorter length limitation. 3414 Expires August 17, 1999 3415 In this specification, all text attributes are defined using the 'text' 3416 syntax. However, 'text' is used only for brevity; the formal 3417 interpretation of 'text' is: 'textWithoutLanguage | textWithLanguage'. 3418 That is, for any attribute defined in this specification using the 3419 'text' attribute syntax, all IPP objects and clients MUST support both 3420 the 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes. 3421 However, in actual usage and protocol execution, objects and clients 3422 accept and return only one of the two syntax per attribute. The syntax 3423 'text' never appears "on-the-wire". 3425 Both 'textWithoutLanguage' and 'textWithLanguage' are needed to support 3426 the real world needs of interoperability between sites and systems that 3427 use different natural languages as the basis for human communication. 3428 Generally, one natural language applies to all text attributes in a 3429 given request or response. The language is indicated by the "attributes- 3430 natural-language" operation attribute defined in section 3.1.4 or 3431 "attributes-natural-language" job attribute defined in section 4.3.24, 3432 and there is no need to identify the natural language for each text 3433 string on a value-by-value basis. In these cases, the attribute syntax 3434 'textWithoutLanguage' is used for text attributes. In other cases, the 3435 client needs to supply or the Printer object needs to return a text 3436 value in a natural language that is different from the rest of the text 3437 values in the request or response. In these cases, the client or 3438 Printer object uses the attribute syntax 'textWithLanguage' for text 3439 attributes (this is the Natural Language Override mechanism described in 3440 section 3.1.4). 3442 The 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes are 3443 described in more detail in the following sections. 3445 4.1.1.1 'textWithoutLanguage' 3447 The 'textWithoutLanguage' syntax indicates a value that is sequence of 3448 zero or more characters. Text strings are encoded using the rules of 3449 some charset. The Printer object MUST support the UTF-8 charset 3450 [RFC2279] and MAY support additional charsets to represent 'text' 3451 values, provided that the charsets are registered with IANA [IANA-CS]. 3452 See Section 4.1.7 for the specification of the 'charset' attribute 3453 syntax, including restricted semantics and examples of charsets. 3455 4.1.1.2 'textWithLanguage' 3457 The 'textWithLanguage' attribute syntax is a compound attribute syntax 3458 consisting of two parts: a 'textWithoutLanguage' part plus an additional 3459 'naturalLanguage' (see section 4.1.8) part that overrides the natural 3460 language in force. The 'naturalLanguage' part explicitly identifies the 3461 natural language that applies to the text part of that value and that 3462 value alone. For any give text attribute, the 'textWithoutLanguage' 3463 part is limited to the maximum length defined for that attribute, but 3464 the 'naturalLanguage' part is always limited to 63 octets. Using the 3465 'textWithLanguage' attribute syntax rather than the normal 3466 'textWithoutLanguage' syntax is the so-called Natural Language Override 3467 mechanism and MUST be supported by all IPP objects and clients. 3469 Expires August 17, 1999 3470 If the attribute is multi-valued (1setOf text), then the 3471 'textWithLanguage' attribute syntax MUST be used to explicitly specify 3472 each attribute value whose natural language needs to be overridden. 3473 Other values in a multi-valued 'text' attribute in a request or a 3474 response revert to the natural language of the operation attribute. 3476 In a create request, the Printer object MUST accept and store with the 3477 Job object any natural language in the "attributes-natural-language" 3478 operation attribute, whether the Printer object supports that natural 3479 language or not. Furthermore, the Printer object MUST accept and store 3480 any 'textWithLanguage' attribute value, whether the Printer object 3481 supports that natural language or not. These requirements are 3482 independent of the value of the "ipp-attribute-fidelity" operation 3483 attribute that the client MAY supply. 3485 Example: If the client supplies the "attributes-natural-language" 3486 operation attribute with the value: 'en' indicating English, but the 3487 value of the "job-name" attribute is in French, the client MUST use the 3488 'textWithLanguage' attribute syntax with the following two values: 3490 'fr': Natural Language Override indicating French 3491 'Rapport Mensuel': the job name in French 3493 See the "Encoding and Transport" document [IPP-PRO] for a detailed 3494 example of the 'textWithLanguage' attribute syntax. 3496 4.1.2 'name' 3498 This syntax type is used for user-friendly strings, such as a Printer 3499 name, that, for humans, are more meaningful than identifiers. Names are 3500 never translated from one natural language to another. The 'name' 3501 attribute syntax is essentially the same as 'text', including the 3502 REQUIRED support of UTF-8 except that the sequence of characters is 3503 limited so that its encoded form MUST NOT exceed 255 (MAX) octets. 3505 Also like 'text', 'name' is really an abbreviated notation for either 3506 'nameWithoutLanguage' or 'nameWithLanguage'. That is, all IPP objects 3507 and clients MUST support both the 'nameWithoutLanguage' and 3508 'nameWithLanguage' attribute syntaxes. However, in actual usage and 3509 protocol execution, objects and clients accept and return only one of 3510 the two syntax per attribute. The syntax 'name' never appears "on-the- 3511 wire". 3513 Note: Only the 'text' and 'name' attribute syntaxes permit the Natural 3514 Language Override mechanism. 3516 Some attributes are defined as 'type3 keyword | name'. These attributes 3517 support values that are either type3 keywords or names. This dual- 3518 syntax mechanism enables a site administrator to extend these attributes 3519 to legally include values that are locally defined by the site 3520 administrator. Such names are not registered with IANA. 3522 Expires August 17, 1999 3523 4.1.2.1 'nameWithoutLanguage' 3525 The nameWithoutLanguage' syntax indicates a value that is sequence of 3526 zero or more characters so that its encoded form does not exceed MAX 3527 octets. 3529 4.1.2.2 'nameWithLanguage' 3531 The 'nameWithLanguage' attribute syntax is a compound attribute syntax 3532 consisting of two parts: a 'nameWithoutLanguage' part plus an additional 3533 'naturalLanguage' (see section 4.1.8) part that overrides the natural 3534 language in force. The 'naturalLanguage' part explicitly identifies the 3535 natural language that applies to that name value and that name value 3536 alone. 3538 The 'nameWithLanguage' attribute syntax behaves the same as the 3539 'textWithLanguage' syntax. If a name is in a language that is different 3540 than the rest of the object or operation, then this 'nameWithLanguage' 3541 syntax is used rather than the generic 'nameWithoutLanguage' syntax. 3543 Example: If the client supplies the "attributes-natural-language" 3544 operation attribute with the value: 'en' indicating English, but the 3545 "printer-name" attribute is in German, the client MUST use the 3546 'nameWithLanguage' attribute syntax as follows: 3548 'de': Natural Language Override indicating German 3549 'Farbdrucker': the Printer name in German 3551 4.1.2.3 Matching 'name' attribute values 3553 For purposes of matching two 'name' attribute values for equality, such 3554 as in job validation (where a client-supplied value for attribute "xxx" 3555 is checked to see if the value is among the values of the Printer 3556 object's corresponding "xxx-supported" attribute), the following match 3557 rules apply: 3559 1. 'keyword' values never match 'name' values. 3561 2. 'name' (nameWithoutLanguage and nameWithLanguage) values match 3562 if (1) the name parts match and (2) the Associated Natural-Language 3563 parts (see section 3.1.4.1) match. The matching rules are: 3565 a. the name parts match if the two names are identical 3566 character by character, except it is RECOMMENDED that case be 3567 ignored. For example: 'Ajax-letter-head-white' MUST match 3568 'Ajax-letter-head-white' and SHOULD match 'ajax-letter-head- 3569 white' and 'AJAX-LETTER-HEAD-WHITE'. 3571 b. the Associated Natural-Language parts match if the shorter 3572 of the two meets the syntactic requirements of RFC 1766 3573 [RFC1766] and matches byte for byte with the longer. For 3574 example, 'en' matches 'en', 'en-us' and 'en-gb', but matches 3575 neither 'fr' nor 'e'. 3577 Expires August 17, 1999 3579 4.1.3 'keyword' 3581 The 'keyword' attribute syntax is a sequence of characters, length: 1 to 3582 255, containing only the US-ASCII [ASCII] encoded values for lowercase 3583 letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot ("."), and 3584 underscore ("_"). The first character MUST be a lowercase letter. 3585 Furthermore, keywords MUST be in U.S. English. 3587 This syntax type is used for enumerating semantic identifiers of 3588 entities in the abstract protocol, i.e., entities identified in this 3589 document. Keywords are used as attribute names or values of attributes. 3590 Unlike 'text' and 'name' attribute values, 'keyword' values MUST NOT use 3591 the Natural Language Override mechanism, since they MUST always be US- 3592 ASCII and U.S. English. 3594 Keywords are for use in the protocol. A user interface will likely 3595 provide a mapping between protocol keywords and displayable user- 3596 friendly words and phrases which are localized to the natural language 3597 of the user. While the keywords specified in this document MAY be 3598 displayed to users whose natural language is U.S. English, they MAY be 3599 mapped to other U.S. English words for U.S. English users, since the 3600 user interface is outside the scope of this document. 3602 In the definition for each attribute of this syntax type, the full set 3603 of defined keyword values for that attribute are listed. 3605 When a keyword is used to represent an attribute (its name), it MUST be 3606 unique within the full scope of all IPP objects and attributes. When a 3607 keyword is used to represent a value of an attribute, it MUST be unique 3608 just within the scope of that attribute. That is, the same keyword MUST 3609 NOT be used for two different values within the same attribute to mean 3610 two different semantic ideas. However, the same keyword MAY be used 3611 across two or more attributes, representing different semantic ideas for 3612 each attribute. Section 6.1 describes how the protocol can be extended 3613 with new keyword values. Examples of attribute name keywords: 3615 "job-name" 3616 "attributes-charset" 3618 Note: This document uses "type1", "type2", and "type3" prefixes to the 3619 "keyword" basic syntax to indicate different levels of review for 3620 extensions (see section 6.1). 3622 4.1.4 'enum' 3624 The 'enum' attribute syntax is an enumerated integer value that is in 3625 the range from 1 to 2**31 - 1 (MAX). Each value has an associated 3626 'keyword' name. In the definition for each attribute of this syntax 3627 type, the full set of possible values for that attribute are listed. 3628 This syntax type is used for attributes for which there are enum values 3629 assigned by other standards, such as SNMP MIBs. A number of attribute 3630 enum values in this specification are also used for corresponding 3631 attributes in other standards [RFC1759]. This syntax type is not used 3633 Expires August 17, 1999 3634 for attributes to which the administrator may assign values. Section 3635 6.1 describes how the protocol can be extended with new enum values. 3637 Enum values are for use in the protocol. A user interface will provide 3638 a mapping between protocol enum values and displayable user-friendly 3639 words and phrases which are localized to the natural language of the 3640 user. While the enum symbols specified in this document MAY be 3641 displayed to users whose natural language is U.S. English, they MAY be 3642 mapped to other U.S. English words for U.S. English users, since the 3643 user interface is outside the scope of this document. 3645 Note: SNMP MIBs use '2' for 'unknown' which corresponds to the IPP "out- 3646 of-band" value 'unknown'. See the description of the "out-of-band" 3647 values at the beginning of Section 4.1. Therefore, attributes of type 3648 'enum' start at '3'. 3650 Note: This document uses "type1", "type2", and "type3" prefixes to the 3651 "enum" basic syntax to indicate different levels of review for 3652 extensions (see section 6.1). 3654 4.1.5 'uri' 3656 The 'uri' attribute syntax is any valid Uniform Resource Identifier or 3657 URI [RFC2396]. Most often, URIs are simply Uniform Resource Locators or 3658 URLs. The maximum length of URIs used as values of IPP attributes is 3659 1023 octets. Although most other IPP attribute syntax types allow for 3660 only lower-cased values, this attribute syntax type conforms to the 3661 case-sensitive and case-insensitive rules specified in [RFC2396]. See 3662 also [IPP-IIG] for a discussion of case in URIs. 3664 4.1.6 'uriScheme' 3666 The 'uriScheme' attribute syntax is a sequence of characters 3667 representing a URI scheme according to RFC 2396 [RFC2396]. Though RFC 3668 2396 requires that the values be case-insensitive, IPP requires all 3669 lower case values in IPP attributes to simplify comparing by IPP clients 3670 and Printer objects. Standard values for this syntax type are the 3671 following keywords: 3673 'http': for HTTP schemed URIs (e.g., "http:.") 3674 'https': for use with HTTPS schemed URIs (e.g., "https:...") (not on 3675 IETF standards track) 3676 'ftp': for FTP schemed URIs (e.g., "ftp:...") 3677 'mailto': for SMTP schemed URIs (e.g., "mailto:...") 3678 'file': for file schemed URIs (e.g., "file:...") 3680 A Printer object MAY support any URI 'scheme' that has been registered 3681 with IANA [IANA-MT]. The maximum length of URI 'scheme' values used to 3682 represent IPP attribute values is 63 octets. 3684 Expires August 17, 1999 3685 4.1.7 'charset' 3687 The 'charset' attribute syntax is a standard identifier for a charset. 3688 A charset is a coded character set and encoding scheme. Charsets are 3689 used for labeling certain document contents and 'text' and 'name' 3690 attribute values. The syntax and semantics of this attribute syntax are 3691 specified in RFC 2046 [RFC2046] and contained in the IANA character-set 3692 Registry [IANA-CS] according to the IANA procedures [RFC2278]. Though 3693 RFC 2046 requires that the values be case-insensitive US-ASCII, IPP 3694 requires all lower case values in IPP attributes to simplify comparing 3695 by IPP clients and Printer objects. When a character-set in the IANA 3696 registry has more than one name (alias), the name labeled as "(preferred 3697 MIME name)", if present, MUST be used. 3699 The maximum length of 'charset' values used to represent IPP attribute 3700 values is 63 octets. 3702 Some examples are: 3704 'utf-8': ISO 10646 Universal Multiple-Octet Coded Character Set 3705 (UCS) represented as the UTF-8 [RFC2279] transfer encoding scheme 3706 in which US-ASCII is a subset charset. 3707 'us-ascii': 7-bit American Standard Code for Information Interchange 3708 (ASCII), ANSI X3.4-1986 [ASCII]. That standard defines US-ASCII, 3709 but RFC 2045 [RFC2045] eliminates most of the control characters 3710 from conformant usage in MIME and IPP. 3711 'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet Nr 3712 1 [ISO8859-1]. That standard defines a coded character set that is 3713 used by Latin languages in the Western Hemisphere and Western 3714 Europe. US-ASCII is a subset charset. 3715 'iso-10646-ucs-2': ISO 10646 Universal Multiple-Octet Coded 3716 Character Set (UCS) represented as two octets (UCS-2), with the 3717 high order octet of each pair coming first (so-called Big Endian 3718 integer). 3720 Some attribute descriptions MAY place additional requirements on charset 3721 values that may be used, such as REQUIRED values that MUST be supported 3722 or additional restrictions, such as requiring that the charset have US- 3723 ASCII as a subset charset. 3725 4.1.8 'naturalLanguage' 3727 The 'naturalLanguage' attribute syntax is a standard identifier for a 3728 natural language and optionally a country. The values for this syntax 3729 type are defined by RFC 1766 [RFC1766]. Though RFC 1766 requires that 3730 the values be case-insensitive US-ASCII, IPP requires all lower case to 3731 simplify comparing by IPP clients and Printer objects. Examples 3732 include: 3734 'en': for English 3735 'en-us': for US English 3736 'fr': for French 3737 'de': for German 3739 Expires August 17, 1999 3741 The maximum length of 'naturalLanguage' values used to represent IPP 3742 attribute values is 63 octets. 3744 4.1.9 'mimeMediaType' 3746 The 'mimeMediaType' attribute syntax is the Internet Media Type 3747 (sometimes called MIME type) as defined by RFC 2046 [RFC2046] and 3748 registered according to the procedures of RFC 2048 [RFC2048] for 3749 identifying a document format. The value MAY include a charset 3750 parameter, depending on the specification of the Media Type in the IANA 3751 Registry [IANA-MT]. Although most other IPP syntax types allow for only 3752 lower-cased values, this syntax type allows for mixed-case values which 3753 are case-insensitive. 3755 Examples are: 3757 'text/html': An HTML document 3758 'text/plain': A plain text document in US-ASCII (RFC 2046 indicates 3759 that in the absence of the charset parameter MUST mean US-ASCII 3760 rather than simply unspecified) [RFC2046]. 3761 'text/plain; charset=US-ASCII': A plain text document in US-ASCII 3762 [52, 56]. 3763 'text/plain; charset=ISO-8859-1': A plain text document in ISO 8859- 3764 1 (Latin 1) [ISO8859-1]. 3765 'text/plain; charset=utf-8': A plain text document in ISO 10646 3766 represented as UTF-8 [RFC2279] 3767 'application/postscript': A PostScript document [RFC2046] 3768 'application/vnd.hp-PCL': A PCL document [IANA-MT] (charset escape 3769 sequence embedded in the document data) 3770 'image/tiff': Tag Image Format - see IANA MIME Media Type registry 3771 'application/pdf': Portable Document Format - see IANA MIME Media 3772 Type registry 3773 'application/octet-stream': (REQUIRED) Auto-sense - see below 3775 One special type is 'application/octet-stream'. If the Printer object 3776 supports this value, the Printer object MUST be capable of auto-sensing 3777 the format of the document data. If the Printer object's default value 3778 attribute "document-format-default" is set to 'application/octet- 3779 stream', the Printer object not only supports auto-sensing of the 3780 document format, but will depend on the result of applying its auto- 3781 sensing when the client does not supply the "document-format" attribute. 3782 If the client supplies a document format value, the Printer MUST rely on 3783 the supplied attribute, rather than trust its auto-sensing algorithm. 3784 To summarize: 3786 1. If the client does not supply a document format value, the Printer 3787 MUST rely on its default value setting (which may be 3788 'application/octet-stream' indicating an auto-sensing mechanism). 3789 2. If the client supplies a value other than 'application/octet- 3790 stream', the client is supplying valid information about the format 3791 of the document data and the Printer object MUST trust the client 3792 supplied value more than the outcome of applying an automatic 3793 format detection mechanism. For example, the client may be 3794 requesting the printing of a PostScript file as a 'text/plain' 3796 Expires August 17, 1999 3797 document. The Printer object MUST print a text representation of 3798 the PostScript commands rather than interpret the stream of 3799 PostScript commands and print the result. 3800 3. If the client supplies a value of 'application/octet-stream', the 3801 client is indicating that the Printer object MUST use its auto- 3802 sensing mechanism on the client supplied document data whether 3803 auto-sensing is the Printer object's default or not. 3805 Note: Since the auto-sensing algorithm is probabilistic, if the client 3806 requests both auto-sensing ("document-format" set to 'application/octet- 3807 stream') and true fidelity ("ipp-attribute-fidelity" set to 'true'), the 3808 Printer object might not be able to guarantee exactly what the end user 3809 intended (the auto-sensing algorithm might mistake one document format 3810 for another ), but it is able to guarantee that its auto-sensing 3811 mechanism be used. 3813 The maximum length of a 'mimeMediaType' value to represent IPP attribute 3814 values is 255 octets. 3816 4.1.10 'octetString' 3818 The 'octetString' attribute syntax is a sequence of octets encoded in a 3819 maximum of 1023 octets which is indicated in sub-section headers using 3820 the notation: octetString(MAX). This syntax type is used for opaque 3821 data. 3823 4.1.11 'boolean' 3825 The 'boolean' attribute syntax has only two values: 'true' and 'false'. 3827 4.1.12 'integer' 3829 The 'integer' attribute syntax is an integer value that is in the range 3830 from -2**31 (MIN) to 2**31 - 1 (MAX). Each individual attribute may 3831 specify the range constraint explicitly in sub-section headers if the 3832 range is different from the full range of possible integer values. For 3833 example: job-priority (integer(1:100)) for the "job-priority" 3834 attribute. However, the enforcement of that additional constraint is up 3835 to the IPP objects, not the protocol. 3837 4.1.13 'rangeOfInteger' 3839 The 'rangeOfInteger' attribute syntax is an ordered pair of integers 3840 that defines an inclusive range of integer values. The first integer 3841 specifies the lower bound and the second specifies the upper bound. If 3842 a range constraint is specified in the header description for an 3843 attribute in this document whose attribute syntax is 'rangeOfInteger' 3844 (i.e., 'X:Y' indicating X as a minimum value and Y as a maximum value), 3845 then the constraint applies to both integers. 3847 Expires August 17, 1999 3848 4.1.14 'dateTime' 3850 The 'dateTime' attribute syntax is a standard, fixed length, 11 octet 3851 representation of the "DateAndTime" syntax as defined in RFC 1903 3852 [RFC1903]. RFC 1903 also identifies an 8 octet representation of a 3853 "DateAndTime" value, but IPP objects MUST use the 11 octet 3854 representation. A user interface will provide a mapping between 3855 protocol dateTime values and displayable user-friendly words or 3856 presentation values and phrases which are localized to the natural 3857 language and date format of the user. 3859 4.1.15 'resolution' 3861 The 'resolution' attribute syntax specifies a two-dimensional resolution 3862 in the indicated units. It consists of 3 values: a cross feed direction 3863 resolution (positive integer value), a feed direction resolution 3864 (positive integer value), and a units value. The semantics of these 3865 three components are taken from the Printer MIB [RFC1759] suggested 3866 values. That is, the cross feed direction component resolution 3867 component is the same as the prtMarkerAddressabilityXFeedDir object in 3868 the Printer MIB, the feed direction component resolution component is 3869 the same as the prtMarkerAddressabilityFeedDir in the Printer MIB, and 3870 the units component is the same as the prtMarkerAddressabilityUnit 3871 object in the Printer MIB (namely, '3' indicates dots per inch and '4' 3872 indicates dots per centimeter). All three values MUST be present even 3873 if the first two values are the same. Example: '300', '600', '3' 3874 indicates a 300 dpi cross-feed direction resolution, a 600 dpi feed 3875 direction resolution, since a '3' indicates dots per inch (dpi). 3877 4.1.16 '1setOf X' 3879 The '1setOf X' attribute syntax is 1 or more values of attribute syntax 3880 type X. This syntax type is used for multi-valued attributes. The 3881 syntax type is called '1setOf' rather than just 'setOf' as a reminder 3882 that the set of values MUST NOT be empty (i.e., a set of size 0). Sets 3883 are normally unordered. However each attribute description of this type 3884 may specify that the values MUST be in a certain order for that 3885 attribute. 3887 4.2 Job Template Attributes 3889 Job Template attributes describe job processing behavior. Support for 3890 Job Template attributes by a Printer object is OPTIONAL (see section 3891 13.2.3 for a description of support for OPTIONAL attributes). Also, 3892 clients OPTIONALLY supply Job Template attributes in create requests. 3894 Job Template attributes conform to the following rules. For each Job 3895 Template attribute called "xxx": 3897 1. If the Printer object supports "xxx" then it MUST support both a 3898 "xxx-default" attribute (unless there is a "No" in the table below) 3899 and a "xxx-supported" attribute. If the Printer object doesn't 3901 Expires August 17, 1999 3902 support "xxx", then it MUST support neither an "xxx-default" 3903 attribute nor an "xxx-supported" attribute, and it MUST treat an 3904 attribute "xxx" supplied by a client as unsupported. An attribute 3905 "xxx" may be supported for some document formats and not supported 3906 for other document formats. For example, it is expected that a 3907 Printer object would only support "orientation-requested" for some 3908 document formats (such as 'text/plain' or 'text/html') but not 3909 others (such as 'application/postscript'). 3911 2. "xxx" is OPTIONALLY supplied by the client in a create request. 3912 If "xxx" is supplied, the client is indicating a desired job 3913 processing behavior for this Job. When "xxx" is not supplied, the 3914 client is indicating that the Printer object apply its default job 3915 processing behavior at job processing time if the document content 3916 does not contain an embedded instruction indicating an xxx-related 3917 behavior. 3919 Note: Since an administrator MAY change the default value attribute 3920 after a Job object has been submitted but before it has been 3921 processed, the default value used by the Printer object at job 3922 processing time may be different that the default value in effect 3923 at job submission time. 3925 3. The "xxx-supported" attribute is a Printer object attribute that 3926 describes which job processing behaviors are supported by that 3927 Printer object. A client can query the Printer object to find out 3928 what xxx-related behaviors are supported by inspecting the returned 3929 values of the "xxx-supported" attribute. 3931 Note: The "xxx" in each "xxx-supported" attribute name is singular, 3932 even though an "xxx-supported" attribute usually has more than one 3933 value, such as "job-sheet-supported", unless the "xxx" Job Template 3934 attribute is plural, such as "finishings" or "sides". In such 3935 cases the "xxx-supported" attribute names are: "finishings- 3936 supported" and "sides-supported". 3938 4. The "xxx-default" default value attribute describes what will be 3939 done at job processing time when no other job processing 3940 information is supplied by the client (either explicitly as an IPP 3941 attribute in the create request or implicitly as an embedded 3942 instruction within the document data). 3944 If an application wishes to present an end user with a list of supported 3945 values from which to choose, the application SHOULD query the Printer 3946 object for its supported value attributes. The application SHOULD also 3947 query the default value attributes. If the application then limits 3948 selectable values to only those value that are supported, the 3949 application can guarantee that the values supplied by the client in the 3950 create request all fall within the set of supported values at the 3951 Printer. When querying the Printer, the client MAY enumerate each 3952 attribute by name in the Get-Printer-Attributes Request, or the client 3953 MAY just name the "job-template" group in order to get the complete set 3954 of supported attributes (both supported and default attributes). 3956 Expires August 17, 1999 3957 The "finishings" attribute is an example of a Job Template attribute. 3958 It can take on a set of values such as 'staple', 'punch', and/or 3959 'cover'. A client can query the Printer object for the "finishings- 3960 supported" attribute and the "finishings-default" attribute. The 3961 supported attribute contains a set of supported values. The default 3962 value attribute contains the finishing value(s) that will be used for a 3963 new Job if the client does not supply a "finishings" attribute in the 3964 create request and the document data does not contain any corresponding 3965 finishing instructions. If the client does supply the "finishings" 3966 attribute in the create request, the IPP object validates the value or 3967 values to make sure that they are a subset of the supported values 3968 identified in the Printer object's "finishings-supported" attribute. 3969 See section 3.2.1.2. 3971 The table below summarizes the names and relationships for all Job 3972 Template attributes. The first column of the table (labeled "Job 3973 Attribute") shows the name and syntax for each Job Template attribute in 3974 the Job object. These are the attributes that can optionally be supplied 3975 by the client in a create request. The last two columns (labeled 3976 "Printer: Default Value Attribute" and "Printer: Supported Values 3977 Attribute") shows the name and syntax for each Job Template attribute in 3978 the Printer object (the default value attribute and the supported values 3979 attribute). A "No" in the table means the Printer MUST NOT support the 3980 attribute (that is, the attribute is simply not applicable). For 3981 brevity in the table, the 'text' and 'name' entries do not show the 3982 maximum length for each attribute. 3984 Expires August 17, 1999 3985 +===================+======================+======================+ 3986 | Job Attribute |Printer: Default Value| Printer: Supported | 3987 | | Attribute | Values Attribute | 3988 +===================+======================+======================+ 3989 | job-priority | job-priority-default |job-priority-supported| 3990 | (integer 1:100) | (integer 1:100) |(integer 1:100) | 3991 +-------------------+----------------------+----------------------+ 3992 | job-hold-until | job-hold-until- |job-hold-until- | 3993 | (type3 keyword | | default | supported | 3994 | name) | (type3 keyword | |(1setOf | 3995 | | name) | type3 keyword | name)| 3996 +-------------------+----------------------+----------------------+ 3997 | job-sheets | job-sheets-default |job-sheets-supported | 3998 | (type3 keyword | | (type3 keyword | |(1setOf | 3999 | name) | name) | type3 keyword | name)| 4000 +-------------------+----------------------+----------------------+ 4001 |multiple-document- |multiple-document- |multiple-document- | 4002 | handling | handling-default |handling-supported | 4003 | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)| 4004 +-------------------+----------------------+----------------------+ 4005 | copies | copies-default | copies-supported | 4006 | (integer (1:MAX)) | (integer (1:MAX)) | (rangeOfInteger | 4007 | | | (1:MAX)) | 4008 +-------------------+----------------------+----------------------+ 4009 | finishings | finishings-default | finishings-supported | 4010 |(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) | 4011 +-------------------+----------------------+----------------------+ 4012 | page-ranges | No | page-ranges- | 4013 | (1setOf | | supported (boolean) | 4014 | rangeOfInteger | | | 4015 | (1:MAX)) | | | 4016 +-------------------+----------------------+----------------------+ 4017 | sides | sides-default | sides-supported | 4018 | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)| 4019 +-------------------+----------------------+----------------------+ 4020 | number-up | number-up-default | number-up-supported | 4021 | (integer (1:MAX)) | (integer (1:MAX)) |(1setOf integer | 4022 | | | (1:MAX) | | 4023 | | | rangeOfInteger | 4024 | | | (1:MAX)) | 4025 +-------------------+----------------------+----------------------+ 4026 | orientation- |orientation-requested-|orientation-requested-| 4027 | requested | default | supported | 4028 | (type2 enum) | (type2 enum) | (1setOf type2 enum) | 4029 +-------------------+----------------------+----------------------+ 4030 | media | media-default | media-supported | 4031 | (type3 keyword | | (type3 keyword | |(1setOf | 4032 | name) | name) | type3 keyword | name)| 4033 | | | | 4034 | | | media-ready | 4035 | | |(1setOf | 4036 | | | type3 keyword | name)| 4037 +-------------------+----------------------+----------------------+ 4038 | printer-resolution| printer-resolution- | printer-resolution- | 4040 Expires August 17, 1999 4041 | (resolution) | default | supported | 4042 | | (resolution) |(1setOf resolution) | 4043 +-------------------+----------------------+----------------------+ 4044 | print-quality | print-quality-default| print-quality- | 4045 | (type2 enum) | (type2 enum) | supported | 4046 | | |(1setOf type2 enum) | 4047 +-------------------+----------------------+----------------------+ 4049 4.2.1 job-priority (integer(1:100)) 4051 This attribute specifies a priority for scheduling the Job. A higher 4052 value specifies a higher priority. The value 1 indicates the lowest 4053 possible priority. The value 100 indicates the highest possible 4054 priority. Among those jobs that are ready to print, a Printer MUST 4055 print all jobs with a priority value of n before printing those with a 4056 priority value of n-1 for all n. 4058 If the Printer object supports this attribute, it MUST always support 4059 the full range from 1 to 100. No administrative restrictions are 4060 permitted. This way an end-user can always make full use of the entire 4061 range with any Printer object. If privileged jobs are implemented 4062 outside IPP/1.1, they MUST have priorities higher than 100, rather than 4063 restricting the range available to end-users. 4065 If the client does not supply this attribute and this attribute is 4066 supported by the Printer object, the Printer object MUST use the value 4067 of the Printer object's "job-priority-default" at job submission time 4068 (unlike most Job Template attributes that are used if necessary at job 4069 processing time). 4071 The syntax for the "job-priority-supported" is also integer(1:100). 4072 This single integer value indicates the number of priority levels 4073 supported. The Printer object MUST take the value supplied by the 4074 client and map it to the closest integer in a sequence of n integers 4075 values that are evenly distributed over the range from 1 to 100 using 4076 the formula: 4078 roundToNearestInt((100x+50)/n) 4080 where n is the value of "job-priority-supported" and x ranges from 0 4081 through n-1. 4083 For example, if n=1 the sequence of values is 50; if n=2, the sequence 4084 of values is: 25 and 75; if n = 3, the sequence of values is: 17, 50 4085 and 83; if n = 10, the sequence of values is: 5, 15, 25, 35, 45, 55, 4086 65, 75, 85, and 95; if n = 100, the sequence of values is: 1, 2, 3, . 4087 100. 4089 If the value of the Printer object's "job-priority-supported" is 10 and 4090 the client supplies values in the range 1 to 10, the Printer object maps 4091 them to 5, in the range 11 to 20, the Printer object maps them to 15, 4092 etc. 4094 Expires August 17, 1999 4095 4.2.2 job-hold-until (type3 keyword | name (MAX)) 4097 This attribute specifies the named time period during which the Job MUST 4098 become a candidate for printing. 4100 Standard keyword values for named time periods are: 4102 'no-hold': immediately, if there are not other reasons to hold the 4103 job 4104 'indefinite': - the job is held indefinitely, until a client 4105 performs a Release-Job (section 3.3.6) 4106 'day-time': during the day 4107 'evening': evening 4108 'night': night 4109 'weekend': weekend 4110 'second-shift': second-shift (after close of business) 4111 'third-shift': third-shift (after midnight) 4113 An administrator MUST associate allowable print times with a named time 4114 period (by means outside the scope of this IPP/1.1 document). An 4115 administrator is encouraged to pick names that suggest the type of time 4116 period. An administrator MAY define additional values using the 'name' 4117 or 'keyword' attribute syntax, depending on implementation. 4119 If the value of this attribute specifies a time period that is in the 4120 future, the Printer MUST add the 'job-hold-until-specified' value to the 4121 job's "job-state-reasons" attribute, move the job to the 'pending-held' 4122 state, and MUST NOT schedule the job for printing until the specified 4123 time-period arrives. When the specified time period arrives, the 4124 Printer MUST remove the 'job-hold-until-specified' value from the job's 4125 "job-state-reason" attribute and, if there are no other job state 4126 reasons that keep the job in the 'pending-held' state, the Printer MUST 4127 consider the job as a candidate for processing by moving the job to the 4128 'pending' state. 4130 If this job attribute value is the named value 'no-hold', or the 4131 specified time period has already started, the job MUST be a candidate 4132 for processing immediately. 4134 If the client does not supply this attribute and this attribute is 4135 supported by the Printer object, the Printer object MUST use the value 4136 of the Printer object's "job-hold-until-default" at job submission time 4137 (unlike most Job Template attributes that are used if necessary at job 4138 processing time). 4140 4.2.3 job-sheets (type3 keyword | name(MAX)) 4142 This attribute determines which job start/end sheet(s), if any, MUST be 4143 printed with a job. 4145 Standard keyword values are: 4147 'none': no job sheet is printed 4149 Expires August 17, 1999 4150 'standard': one or more site specific standard job sheets are 4151 printed, e.g. a single start sheet or both start and end sheet is 4152 printed 4154 An administrator MAY define additional values using the 'name' or 4155 'keyword' attribute syntax, depending on implementation. 4157 Note: The effect of this attribute on jobs with multiple documents MAY 4158 be affected by the "multiple-document-handling" job attribute (section 4159 4.2.4), depending on the job sheet semantics. 4161 4.2.4 multiple-document-handling (type2 keyword) 4163 This attribute is relevant only if a job consists of two or more 4164 documents. The attribute controls finishing operations and the placement 4165 of one or more print-stream pages into impressions and onto media 4166 sheets. When the value of the "copies" attribute exceeds 1, it also 4167 controls the order in which the copies that result from processing the 4168 documents are produced. For the purposes of this explanations, if "a" 4169 represents an instance of document data, then the result of processing 4170 the data in document "a" is a sequence of media sheets represented by 4171 "a(*)". 4173 Standard keyword values are: 4175 'single-document': If a Job object has multiple documents, say, the 4176 document data is called a and b, then the result of processing all 4177 the document data (a and then b) MUST be treated as a single 4178 sequence of media sheets for finishing operations; that is, 4179 finishing would be performed on the concatenation of the sequences 4180 a(*),b(*). The Printer object MUST NOT force the data in each 4181 document instance to be formatted onto a new print-stream page, nor 4182 to start a new impression on a new media sheet. If more than one 4183 copy is made, the ordering of the sets of media sheets resulting 4184 from processing the document data MUST be a(*), b(*), a(*), b(*), 4185 ..., and the Printer object MUST force each copy (a(*),b(*)) to 4186 start on a new media sheet. 4187 'separate-documents-uncollated-copies': If a Job object has multiple 4188 documents, say, the document data is called a and b, then the 4189 result of processing the data in each document instance MUST be 4190 treated as a single sequence of media sheets for finishing 4191 operations; that is, the sets a(*) and b(*) would each be finished 4192 separately. The Printer object MUST force each copy of the result 4193 of processing the data in a single document to start on a new media 4194 sheet. If more than one copy is made, the ordering of the sets of 4195 media sheets resulting from processing the document data MUST be 4196 a(*), a(*), ..., b(*), b(*) ... . 4197 'separate-documents-collated-copies': If a Job object has multiple 4198 documents, say, the document data is called a and b, then the 4199 result of processing the data in each document instance MUST be 4200 treated as a single sequence of media sheets for finishing 4201 operations; that is, the sets a(*) and b(*) would each be finished 4202 separately. The Printer object MUST force each copy of the result 4204 Expires August 17, 1999 4205 of processing the data in a single document to start on a new media 4206 sheet. If more than one copy is made, the ordering of the sets of 4207 media sheets resulting from processing the document data MUST be 4208 a(*), b(*), a(*), b(*), ... . 4209 'single-document-new-sheet': Same as 'single-document', except that 4210 the Printer object MUST ensure that the first impression of each 4211 document instance in the job is placed on a new media sheet. This 4212 value allows multiple documents to be stapled together with a 4213 single staple where each document starts on a new sheet. 4215 The 'single-document' value is the same as 'separate-documents-collated- 4216 copies' with respect to ordering of print-stream pages, but not media 4217 sheet generation, since 'single-document' will put the first page of the 4218 next document on the back side of a sheet if an odd number of pages have 4219 been produced so far for the job, while 'separate-documents-collated- 4220 copies' always forces the next document or document copy on to a new 4221 sheet. In addition, if the "finishings" attribute specifies 'staple', 4222 then with 'single-document', documents a and b are stapled together as a 4223 single document with no regard to new sheets, with 'single-document-new- 4224 sheet', documents a and b are stapled together as a single document, but 4225 document b starts on a new sheet, but with 'separate-documents- 4226 uncollated-copies' and 'separate-documents-collated-copies', documents a 4227 and b are stapled separately. 4229 Note: None of these values provide means to produce uncollated sheets 4230 within a document, i.e., where multiple copies of sheet n are produced 4231 before sheet n+1 of the same document. 4233 The relationship of this attribute and the other attributes that control 4234 document processing is described in section 16.3. 4236 4.2.5 copies (integer(1:MAX)) 4238 This attribute specifies the number of copies to be printed. 4240 On many devices the supported number of collated copies will be limited 4241 by the number of physical output bins on the device, and may be 4242 different from the number of uncollated copies which can be supported. 4244 Note: The effect of this attribute on jobs with multiple documents is 4245 controlled by the "multiple-document-handling" job attribute (section 4246 4.2.4) and the relationship of this attribute and the other attributes 4247 that control document processing is described in section 16.3. 4249 4.2.6 finishings (1setOf type2 enum) 4251 This attribute identifies the finishing operations that the Printer uses 4252 for each copy of each printed document in the Job. For Jobs with 4253 multiple documents, the "multiple-document-handling" attribute 4254 determines what constitutes a "copy" for purposes of finishing. 4256 Standard enum values are: 4258 Expires August 17, 1999 4259 Value Symbolic Name and Description 4261 '3' 'none': Perform no finishing 4262 '4' 'staple': Bind the document(s) with one or more staples. The 4263 exact number and placement of the staples is site- 4264 defined. 4265 '5' 'punch': This value indicates that holes are required in the 4266 finished document. The exact number and placement of the 4267 holes is site-defined The punch specification MAY be 4268 satisfied (in a site- and implementation-specific manner) 4269 either by drilling/punching, or by substituting pre- 4270 drilled media. 4271 '6' 'cover': This value is specified when it is desired to select 4272 a non-printed (or pre-printed) cover for the document. 4273 This does not supplant the specification of a printed 4274 cover (on cover stock medium) by the document itself. 4275 '7' 'bind': This value indicates that a binding is to be applied 4276 to the document; the type and placement of the binding is 4277 site-defined. 4279 '8' 'saddle-stitch': Bind the document(s) with one or more 4280 staples (wire stitches) along the middle fold. The exact 4281 number and placement of the staples and the middle fold 4282 is implementation and/or site-defined. 4283 '9' 'edge-stitch': Bind the document(s) with one or more staples 4284 (wire stitches) along one edge. The exact number and 4285 placement of the staples is implementation and/or site- 4286 defined. 4287 '10'-'19' reserved for future generic finishing enum values. 4289 The following values are more specific; they indicate a corner or an 4290 edge as if the document were a portrait document (see below): 4292 '20' 'staple-top-left': Bind the document(s) with one or more 4293 staples in the top left corner. 4294 '21' 'staple-bottom-left': Bind the document(s) with one or more 4295 staples in the bottom left corner. 4296 '22' 'staple-top-right': Bind the document(s) with one or more 4297 staples in the top right corner. 4298 '23' 'staple-bottom-right': Bind the document(s) with one or more 4299 staples in the bottom right corner. 4300 '24' 'edge-stitch-left': Bind the document(s) with one or more 4301 staples (wire stitches) along the left edge. The exact 4302 number and placement of the staples is implementation 4303 and/or site-defined. 4304 '25' 'edge-stitch-top': Bind the document(s) with one or more 4305 staples (wire stitches) along the top edge. The exact 4306 number and placement of the staples is implementation 4307 and/or site-defined. 4308 '26' 'edge-stitch-right': Bind the document(s) with one or more 4309 staples (wire stitches) along the right edge. The exact 4310 number and placement of the staples is implementation 4311 and/or site-defined. 4312 '27' 'edge-stitch-bottom': Bind the document(s) with one or more 4313 staples (wire stitches) along the bottom edge. The exact 4315 Expires August 17, 1999 4316 number and placement of the staples is implementation 4317 and/or site-defined. 4318 '28' 'staple-dual-left': Bind the document(s) with two staples 4319 (wire stitches) along the left edge assuming a portrait 4320 document (see above). 4321 '29' 'staple-dual-top': Bind the document(s) with two staples 4322 (wire stitches) along the top edge assuming a portrait 4323 document (see above). 4324 '30' 'staple-dual-right': Bind the document(s) with two staples 4325 (wire stitches) along the right edge assuming a portrait 4326 document (see above). 4327 '31' 'staple-dual-bottom': Bind the document(s) with two staples 4328 (wire stitches) along the bottom edge assuming a portrait 4329 document (see above). 4331 The 'staple-xxx' values are specified with respect to the document as if 4332 the document were a portrait document. If the document is actually a 4333 landscape or a reverse-landscape document, the client supplies the 4334 appropriate transformed value. For example, to position a staple in the 4335 upper left hand corner of a landscape document when held for reading, 4336 the client supplies the 'staple-bottom-left' value (since landscape is 4337 defined as a +90 degree rotation from portrait, i.e., anti-clockwise). 4338 On the other hand, to position a staple in the upper left hand corner of 4339 a reverse-landscape document when held for reading, the client supplies 4340 the 'staple-top-right' value (since reverse-landscape is defined as a - 4341 90 degree rotation from portrait, i.e., clockwise). 4343 The angle (vertical, horizontal, angled) of each staple with respect to 4344 the document depends on the implementation which may in turn depend on 4345 the value of the attribute. 4347 Note: The effect of this attribute on jobs with multiple documents is 4348 controlled by the "multiple-document-handling" job attribute (section 4349 4.2.4) and the relationship of this attribute and the other attributes 4350 that control document processing is described in section 16.3. 4352 If the client supplies a value of 'none' along with any other 4353 combination of values, it is the same as if only that other combination 4354 of values had been supplied (that is the 'none' value has no effect). 4356 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX)) 4358 This attribute identifies the range(s) of print-stream pages that the 4359 Printer object uses for each copy of each document which are to be 4360 printed. Nothing is printed for any pages identified that do not exist 4361 in the document(s). Ranges MUST be in ascending order, for example: 1- 4362 3, 5-7, 15-19 and MUST NOT overlap, so that a non-spooling Printer 4363 object can process the job in a single pass. If the ranges are not 4364 ascending or are overlapping, the IPP object MUST reject the request and 4365 return the 'client-error-bad-request' status code. The attribute is 4366 associated with print-stream pages not application-numbered pages (for 4367 example, the page numbers found in the headers and or footers for 4368 certain word processing applications). 4370 Expires August 17, 1999 4371 For Jobs with multiple documents, the "multiple-document-handling" 4372 attribute determines what constitutes a "copy" for purposes of the 4373 specified page range(s). When "multiple-document-handling" is 'single- 4374 document', the Printer object MUST apply each supplied page range once 4375 to the concatenation of the print-stream pages. For example, if there 4376 are 8 documents of 10 pages each, the page-range '41:60' prints the 4377 pages in the 5th and 6th documents as a single document and none of the 4378 pages of the other documents are printed. When "multiple-document- 4379 handling" is 'separate-document-uncollated-copies' or 'separate- 4380 document-collated-copies', the Printer object MUST apply each supplied 4381 page range repeatedly to each document copy. For the same job, the 4382 page-range '1:3, 10:10' would print the first 3 pages and the 10th page 4383 of each of the 8 documents in the Job, as 8 separate documents. 4385 In most cases, the exact pages to be printed will be generated by a 4386 device driver and this attribute would not be required. However, when 4387 printing an archived document which has already been formatted, the end 4388 user may elect to print just a subset of the pages contained in the 4389 document. In this case, if page-range = n.m is specified, the first 4390 page to be printed will be page n. All subsequent pages of the document 4391 will be printed through and including page m. 4393 "page-ranges-supported" is a boolean value indicating whether or not the 4394 printer is capable of supporting the printing of page ranges. This 4395 capability may differ from one PDL to another. There is no "page-ranges- 4396 default" attribute. If the "page-ranges" attribute is not supplied by 4397 the client, all pages of the document will be printed. 4399 Note: The effect of this attribute on jobs with multiple documents is 4400 controlled by the "multiple-document-handling" job attribute (section 4401 4.2.4) and the relationship of this attribute and the other attributes 4402 that control document processing is described in section 16.3. 4404 4.2.8 sides (type2 keyword) 4406 This attribute specifies how print-stream pages are to be imposed upon 4407 the sides of an instance of a selected medium, i.e., an impression. 4409 The standard keyword values are: 4411 'one-sided': imposes each consecutive print-stream page upon the same 4412 side of consecutive media sheets. 4413 'two-sided-long-edge': imposes each consecutive pair of print-stream 4414 pages upon front and back sides of consecutive media sheets, such 4415 that the orientation of each pair of print-stream pages on the 4416 medium would be correct for the reader as if for binding on the 4417 long edge. This imposition is sometimes called 'duplex' or 'head- 4418 to-head'. 4419 'two-sided-short-edge': imposes each consecutive pair of print-stream 4420 pages upon front and back sides of consecutive media sheets, such 4421 that the orientation of each pair of print-stream pages on the 4422 medium would be correct for the reader as if for binding on the 4423 short edge. This imposition is sometimes called 'tumble' or 'head- 4424 to-toe'. 4426 Expires August 17, 1999 4428 'two-sided-long-edge', 'two-sided-short-edge', 'tumble', and 'duplex' 4429 all work the same for portrait or landscape. However 'head-to-toe' is 4430 'tumble' in portrait but 'duplex' in landscape. 'head-to-head' also 4431 switches between 'duplex' and 'tumble' when using portrait and landscape 4432 modes. 4434 Note: The effect of this attribute on jobs with multiple documents is 4435 controlled by the "multiple-document-handling" job attribute (section 4436 4.2.4) and the relationship of this attribute and the other attributes 4437 that control document processing is described in section 16.3. 4439 4.2.9 number-up (integer(1:MAX)) 4441 This attribute specifies the number of print-stream pages to impose upon 4442 a single side of an instance of a selected medium. For example, if the 4443 value is: 4445 Value Description 4447 '1' the Printer MUST place one print-stream page on a single side 4448 of an instance of the selected medium (MAY add some sort 4449 of translation, scaling, or rotation). 4450 '2' the Printer MUST place two print-stream pages on a single side 4451 of an instance of the selected medium (MAY add some sort 4452 of translation, scaling, or rotation). 4453 '4' the Printer MUST place four print-stream pages on a single 4454 side of an instance of the selected medium (MAY add some 4455 sort of translation, scaling, or rotation). 4457 This attribute primarily controls the translation, scaling and rotation 4458 of print-stream pages. 4460 Note: The effect of this attribute on jobs with multiple documents is 4461 controlled by the "multiple-document-handling" job attribute (section 4462 4.2.4) and the relationship of this attribute and the other attributes 4463 that control document processing is described in section 16.3. 4465 4.2.10 orientation-requested (type2 enum) 4467 This attribute indicates the desired orientation for printed print- 4468 stream pages; it does not describe the orientation of the client- 4469 supplied print-stream pages. 4471 For some document formats (such as 'application/postscript'), the 4472 desired orientation of the print-stream pages is specified within the 4473 document data. This information is generated by a device driver prior 4474 to the submission of the print job. Other document formats (such as 4475 'text/plain') do not include the notion of desired orientation within 4476 the document data. In the latter case it is possible for the Printer 4477 object to bind the desired orientation to the document data after it has 4478 been submitted. It is expected that a Printer object would only support 4480 Expires August 17, 1999 4481 "orientations-requested" for some document formats (e.g., 'text/plain' 4482 or 'text/html') but not others (e.g., 'application/postscript'). This 4483 is no different than any other Job Template attribute since section 4.2, 4484 item 1, points out that a Printer object may support or not support any 4485 Job Template attribute based on the document format supplied by the 4486 client. However, a special mention is made here since it is very likely 4487 that a Printer object will support "orientation-requested" for only a 4488 subset of the supported document formats. 4490 Standard enum values are: 4492 Value Symbolic Name and Description 4494 '3' 'portrait': The content will be imaged across the short edge 4495 of the medium. 4496 '4' 'landscape': The content will be imaged across the long edge 4497 of the medium. Landscape is defined to be a rotation of 4498 the print-stream page to be imaged by +90 degrees with 4499 respect to the medium (i.e. anti-clockwise) from the 4500 portrait orientation. Note: The +90 direction was 4501 chosen because simple finishing on the long edge is the 4502 same edge whether portrait or landscape 4503 '5' 'reverse-landscape': The content will be imaged across the 4504 long edge of the medium. Reverse-landscape is defined to 4505 be a rotation of the print-stream page to be imaged by - 4506 90 degrees with respect to the medium (i.e. clockwise) 4507 from the portrait orientation. Note: The 'reverse- 4508 landscape' value was added because some applications 4509 rotate landscape -90 degrees from portrait, rather than 4510 +90 degrees. 4511 '6' 'reverse-portrait': The content will be imaged across the 4512 short edge of the medium. Reverse-portrait is defined to 4513 be a rotation of the print-stream page to be imaged by 4514 180 degrees with respect to the medium from the portrait 4515 orientation. Note: The 'reverse-portrait' value was 4516 added for use with the "finishings" attribute in cases 4517 where the opposite edge is desired for finishing a 4518 portrait document on simple finishing devices that have 4519 only one finishing position. Thus a 'text'/plain' 4520 portrait document can be stapled "on the right" by a 4521 simple finishing device as is common use with some middle 4522 eastern languages such as Hebrew. 4524 Note: The effect of this attribute on jobs with multiple documents is 4525 controlled by the "multiple-document-handling" job attribute (section 4526 4.2.4) and the relationship of this attribute and the other attributes 4527 that control document processing is described in section 16.3. 4529 4.2.11 media (type3 keyword | name(MAX)) 4531 This attribute identifies the medium that the Printer uses for all 4532 impressions of the Job. 4534 Expires August 17, 1999 4535 The values for "media" include medium-names, medium-sizes, input-trays 4536 and electronic forms so that one attribute specifies the media. If a 4537 Printer object supports a medium name as a value of this attribute, such 4538 a medium name implicitly selects an input-tray that contains the 4539 specified medium. If a Printer object supports a medium size as a value 4540 of this attribute, such a medium size implicitly selects a medium name 4541 that in turn implicitly selects an input-tray that contains the medium 4542 with the specified size. If a Printer object supports an input-tray as 4543 the value of this attribute, such an input-tray implicitly selects the 4544 medium that is in that input-tray at the time the job prints. This case 4545 includes manual-feed input-trays. If a Printer object supports an 4546 electronic form as the value of this attribute, such an electronic form 4547 implicitly selects a medium-name that in turn implicitly selects an 4548 input-tray that contains the medium specified by the electronic form. 4549 The electronic form also implicitly selects an image that the Printer 4550 MUST merge with the document data as its prints each page. 4552 Standard keyword values are (taken from ISO DPA and the Printer MIB) and 4553 are listed in section 15. An administrator MAY define additional values 4554 using the 'name' or 'keyword' attribute syntax, depending on 4555 implementation. 4557 There is also an additional Printer attribute named "media-ready" which 4558 differs from "media-supported" in that legal values only include the 4559 subset of "media-supported" values that are physically loaded and ready 4560 for printing with no operator intervention required. If an IPP object 4561 supports "media-supported", it NEED NOT support "media-ready". 4563 The relationship of this attribute and the other attributes that control 4564 document processing is described in section 16.3. 4566 4.2.12 printer-resolution (resolution) 4568 This attribute identifies the resolution that Printer uses for the Job. 4570 4.2.13 print-quality (type2 enum) 4572 This attribute specifies the print quality that the Printer uses for the 4573 Job. 4575 The standard enum values are: 4577 Value Symbolic Name and Description 4579 '3' 'draft': lowest quality available on the printer 4580 '4' 'normal': normal or intermediate quality on the printer 4581 '5' 'high': highest quality available on the printer 4583 Expires August 17, 1999 4585 4.3 Job Description Attributes 4587 The attributes in this section form the attribute group called "job- 4588 description". The following table summarizes these attributes. The 4589 third column indicates whether the attribute is a REQUIRED attribute 4590 that MUST be supported by Printer objects. If it is not indicated as 4591 REQUIRED, then it is OPTIONAL. The maximum size in octets for 'text' 4592 and 'name' attributes is indicated in parenthesizes. 4594 Expires August 17, 1999 4595 +----------------------------+----------------------+----------------+ 4596 | Attribute | Syntax | REQUIRED? | 4597 +----------------------------+----------------------+----------------+ 4598 | job-uri | uri | REQUIRED | 4599 +----------------------------+----------------------+----------------+ 4600 | job-id | integer(1:MAX) | REQUIRED | 4601 +----------------------------+----------------------+----------------+ 4602 | job-printer-uri | uri | REQUIRED | 4603 +----------------------------+----------------------+----------------+ 4604 | job-more-info | uri | | 4605 +----------------------------+----------------------+----------------+ 4606 | job-name | name (MAX) | REQUIRED | 4607 +----------------------------+----------------------+----------------+ 4608 | job-originating-user-name | name (MAX) | REQUIRED | 4609 +----------------------------+----------------------+----------------+ 4610 | job-state | type1 enum | REQUIRED | 4611 +----------------------------+----------------------+----------------+ 4612 | job-state-reasons | 1setOf type2 keyword | | 4613 +----------------------------+----------------------+----------------+ 4614 | job-state-message | text (MAX) | | 4615 +----------------------------+----------------------+----------------+ 4616 | number-of-documents | integer (0:MAX) | | 4617 +----------------------------+----------------------+----------------+ 4618 | output-device-assigned | name (127) | | 4619 +----------------------------+----------------------+----------------+ 4620 | time-at-creation | integer (0:MAX) | | 4621 +----------------------------+----------------------+----------------+ 4622 | time-at-processing | integer (0:MAX) | | 4623 +----------------------------+----------------------+----------------+ 4624 | time-at-completed | integer (0:MAX) | | 4625 +----------------------------+----------------------+----------------+ 4626 | number-of-intervening-jobs | integer (0:MAX) | | 4627 +----------------------------+----------------------+----------------+ 4628 | job-message-from-operator | text (127) | | 4629 +----------------------------+----------------------+----------------+ 4630 | job-k-octets | integer (0:MAX) | | 4631 +----------------------------+----------------------+----------------+ 4632 | job-impressions | integer (0:MAX) | | 4633 +----------------------------+----------------------+----------------+ 4634 | job-media-sheets | integer (0:MAX) | | 4635 +----------------------------+----------------------+----------------+ 4636 | job-k-octets-processed | integer (0:MAX) | | 4637 +----------------------------+----------------------+----------------+ 4638 | job-impressions-completed | integer (0:MAX) | | 4639 +----------------------------+----------------------+----------------+ 4640 | job-media-sheets-completed | integer (0:MAX) | | 4641 +----------------------------+----------------------+----------------+ 4642 | attributes-charset | charset | REQUIRED | 4643 +----------------------------+----------------------+----------------+ 4644 | attributes-natural-language| naturalLanguage | REQUIRED | 4645 +----------------------------+----------------------+----------------+ 4647 Expires August 17, 1999 4648 4.3.1 job-uri (uri) 4650 This REQUIRED attribute contains the URI for the job. The Printer 4651 object, on receipt of a new job, generates a URI which identifies the 4652 new Job. The Printer object returns the value of the "job-uri" 4653 attribute as part of the response to a create request. The precise 4654 format of a Job URI is implementation dependent. If the Printer object 4655 supports more than one URI and there is some relationship between the 4656 newly formed Job URI and the Printer object's URI, the Printer object 4657 uses the Printer URI supplied by the client in the create request. For 4658 example, if the create request comes in over a secure channel, the new 4659 Job URI MUST use the same secure channel. This can be guaranteed 4660 because the Printer object is responsible for generating the Job URI and 4661 the Printer object is aware of its security configuration and policy as 4662 well as the Printer URI used in the create request. 4664 For a description of this attribute and its relationship to "job-id" and 4665 "job-printer-uri" attribute, see the discussion in section 2.4 on 4666 "Object Identity". 4668 4.3.2 job-id (integer(1:MAX)) 4670 This REQUIRED attribute contains the ID of the job. The Printer, on 4671 receipt of a new job, generates an ID which identifies the new Job on 4672 that Printer. The Printer returns the value of the "job-id" attribute 4673 as part of the response to a create request. The 0 value is not 4674 included to allow for compatibility with SNMP index values which also 4675 cannot be 0. 4677 For a description of this attribute and its relationship to "job-uri" 4678 and "job-printer-uri" attribute, see the discussion in section 2.4 on 4679 "Object Identity". 4681 4.3.3 job-printer-uri (uri) 4683 This REQUIRED attribute identifies the Printer object that created this 4684 Job object. When a Printer object creates a Job object, it populates 4685 this attribute with the Printer object URI that was used in the create 4686 request. This attribute permits a client to identify the Printer object 4687 that created this Job object when only the Job object's URI is available 4688 to the client. The client queries the creating Printer object to 4689 determine which languages, charsets, operations, are supported for this 4690 Job. 4692 For a description of this attribute and its relationship to "job-uri" 4693 and "job-id" attribute, see the discussion in section 2.4 on "Object 4694 Identity". 4696 Expires August 17, 1999 4697 4.3.4 job-more-info (uri) 4699 Similar to "printer-more-info", this attribute contains the URI 4700 referencing some resource with more information about this Job object, 4701 perhaps an HTML page containing information about the Job. 4703 4.3.5 job-name (name(MAX)) 4705 This REQUIRED attribute is the name of the job. It is a name that is 4706 more user friendly than the "job-uri" attribute value. It does not need 4707 to be unique between Jobs. The Job's "job-name" attribute is set to the 4708 value supplied by the client in the "job-name" operation attribute in 4709 the create request (see Section 3.2.1.1). If, however, the "job-name" 4710 operation attribute is not supplied by the client in the create request, 4711 the Printer object, on creation of the Job, MUST generate a name. The 4712 printer SHOULD generate the value of the Job's "job-name" attribute from 4713 the first of the following sources that produces a value: 1) the 4714 "document-name" operation attribute of the first (or only) document, 2) 4715 the "document-URI" attribute of the first (or only) document, or 3) any 4716 other piece of Job specific and/or Document Content information. 4718 4.3.6 job-originating-user-name (name(MAX)) 4720 This REQUIRED attribute contains the name of the end user that submitted 4721 the print job. The Printer object sets this attribute to the most 4722 authenticated printable name that it can obtain from the authentication 4723 service over which the IPP operation was received. Only if such is not 4724 available, does the Printer object use the value supplied by the client 4725 in the "requesting-user-name" operation attribute of the create 4726 operation (see Section 8). 4728 Note: The Printer object needs to keep an internal originating user id 4729 of some form, typically as a credential of a principal, with the Job 4730 object. Since such an internal attribute is implementation-dependent 4731 and not of interest to clients, it is not specified as a Job Description 4732 attribute. This originating user id is used for authorization checks 4733 (if any) on all subsequent operation. 4735 4.3.7 job-state (type1 enum) 4737 This REQUIRED attribute identifies the current state of the job. Even 4738 though the IPP protocol defines seven values for job states (plus the 4739 out-of-band 'unknown' value - see Section 4.1), implementations only 4740 need to support those states which are appropriate for the particular 4741 implementation. In other words, a Printer supports only those job 4742 states implemented by the output device and available to the Printer 4743 object implementation. 4745 Standard enum values are: 4747 Values Symbolic Name and Description 4749 Expires August 17, 1999 4750 '3' 'pending': The job is a candidate to start processing, but is 4751 not yet processing. 4753 '4' 'pending-held': The job is not a candidate for processing for 4754 any number of reasons but will return to the 'pending' 4755 state as soon as the reasons are no longer present. The 4756 job's "job-state-reason" attribute MUST indicate why the 4757 job is no longer a candidate for processing. 4759 '5' 'processing': One or more of: 4761 1. the job is using, or is attempting to use, one or 4762 more purely software processes that are analyzing, 4763 creating, or interpreting a PDL, etc., 4764 2. the job is using, or is attempting to use, one or 4765 more hardware devices that are interpreting a PDL, making 4766 marks on a medium, and/or performing finishing, such as 4767 stapling, etc., 4768 3. the Printer object has made the job ready for 4769 printing, but the output device is not yet printing it, 4770 either because the job hasn't reached the output device 4771 or because the job is queued in the output device or some 4772 other spooler, awaiting the output device to print it. 4774 When the job is in the 'processing' state, the entire job 4775 state includes the detailed status represented in the 4776 printer's "printer-state", "printer-state-reasons", and 4777 "printer-state-message" attributes. 4779 Implementations MAY, though they NEED NOT, include 4780 additional values in the job's "job-state-reasons" 4781 attribute to indicate the progress of the job, such as 4782 adding the 'job-printing' value to indicate when the 4783 output device is actually making marks on paper and/or 4784 the 'processing-to-stop-point' value to indicate that the 4785 IPP object is in the process of canceling or aborting the 4786 job. Most implementations won't bother with this nuance. 4788 '6' 'processing-stopped': The job has stopped while processing 4789 for any number of reasons and will return to the 4790 'processing' state as soon as the reasons are no longer 4791 present. 4793 The job's "job-state-reason" attribute MAY indicate why 4794 the job has stopped processing. For example, if the 4795 output device is stopped, the 'printer-stopped' value MAY 4796 be included in the job's "job-state-reasons" attribute. 4798 Note: When an output device is stopped, the device 4799 usually indicates its condition in human readable form 4800 locally at the device. A client can obtain more complete 4801 device status remotely by querying the Printer object's 4803 Expires August 17, 1999 4804 "printer-state", "printer-state-reasons" and "printer- 4805 state-message" attributes. 4807 '7' 'canceled': The job has been canceled by a Cancel-Job 4808 operation and the Printer object has completed canceling 4809 the job and all job status attributes have reached their 4810 final values for the job. While the Printer object is 4811 canceling the job, the job remains in its current state, 4812 but the job's "job-state-reasons" attribute SHOULD 4813 contain the 'processing-to-stop-point' value and one of 4814 the 'canceled-by-user', 'canceled-by-operator', or 4815 'canceled-at-device' value. When the job moves to the 4816 'canceled' state, the 'processing-to-stop-point' value, 4817 if present, MUST be removed, but the 'canceled-by-xxx', 4818 if present, MUST remain. 4820 '8' 'aborted': The job has been aborted by the system, usually 4821 while the job was in the 'processing' or 'processing- 4822 stopped' state and the Printer has completed aborting the 4823 job and all job status attributes have reached their 4824 final values for the job. While the Printer object is 4825 aborting the job, the job remains in its current state, 4826 but the job's "job-state-reasons" attribute SHOULD 4827 contain the 'processing-to-stop-point' and 'aborted-by- 4828 system' values. When the job moves to the 'aborted' 4829 state, the 'processing-to-stop-point' value, if present, 4830 MUST be removed, but the 'aborted-by-system' value, if 4831 present, MUST remain. 4833 '9' 'completed': The job has completed successfully or with 4834 warnings or errors after processing and all of the job 4835 media sheets have been successfully stacked in the 4836 appropriate output bin(s) and all job status attributes 4837 have reached their final values for the job. The job's 4838 "job-state-reasons" attribute SHOULD contain one of: 4839 'completed-successfully', 'completed-with-warnings', or 4840 'completed-with-errors' values. 4842 The final value for this attribute MUST be one of: 'completed', 4843 'canceled', or 'aborted' before the Printer removes the job altogether. 4844 The length of time that jobs remain in the 'canceled', 'aborted', and 4845 'completed' states depends on implementation. See section 4.3.7.1. 4847 The following figure shows the normal job state transitions. 4849 Expires August 17, 1999 4850 +----> canceled 4851 / 4852 +----> pending --------> processing ---------+------> completed 4853 | ^ ^ \ 4854 --->+ | | +----> aborted 4855 | v v / 4856 +----> pending-held processing-stopped ---+ 4858 Normally a job progresses from left to right. Other state transitions 4859 are unlikely, but are not forbidden. Not shown are the transitions to 4860 the 'canceled' state from the 'pending', 'pending-held', and 4861 'processing-stopped' states. 4863 Jobs reach one of the three terminal states: 'completed', 'canceled', or 4864 'aborted', after the jobs have completed all activity, including 4865 stacking output media, after the jobs have completed all activity, and 4866 all job status attributes have reached their final values for the job. 4868 Note: As with all other IPP attributes, if the implementation can not 4869 determine the correct value for this attribute, it SHOULD respond with 4870 the out-of-band value 'unknown' (see section 4.1) rather than try to 4871 guess at some possibly incorrect value and give the end user the wrong 4872 impression about the state of the Job object. For example, if the 4873 implementation is just a gateway into some printing system that does not 4874 provide detailed status about the print job, the IPP Job object's state 4875 might literally be 'unknown'. 4877 4.3.7.1 Partitioning of Job States 4879 This section partitions the 7 job states into phases: Job Not 4880 Completed, Job Retention, Job History, and Job Removal. This section 4881 also explains the 'job-restartable' value of the "job-state-reasons" Job 4882 Description attribute for use with the Restart-Job operation. 4884 Job Not Completed: When a job is in the 'pending', 'pending-held', 4885 'processing', or 'processing-stopped' states, the job is not completed. 4887 Job Retention: When a job enters one of the three terminal job states: 4888 'completed', 'canceled', or 'aborted', the IPP Printer object MAY 4889 "retain" the job in a restartable condition for an implementation- 4890 defined time period. This time period MAY be zero seconds and MAY 4891 depend on the terminal job state. This phase is called Job Retention. 4892 While in the Job Retention phase, the job's document data is retained 4893 and a client may restart the job using the Restart-Job operation. If 4894 the IPP object supports the "job-state-reasons" attribute and the 4895 Restart-Job operation, then it SHOULD indicate that the job is 4896 restartable by adding the 'job-restartable' value to the job's "job- 4897 state-reasons" attribute (see Section 4.3.8) during the Job Retention 4898 phase. 4900 Job History: After the Job Retention phase expires for a job, the 4901 Printer object deletes the document data for the job and the job becomes 4902 part of the Job History. The Printer object MAY also delete any number 4903 of the job attributes. Since the job is no longer restartable, the 4905 Expires August 17, 1999 4906 Printer object MUST remove the 'job-restartable' value from the job's 4907 "job-state-reasons" attribute, if present. 4909 Job Removal: After the job has remained in the Job History for an 4910 implementation-defined time, such as when the number of jobs exceeds a 4911 fixed number or after a fixed time period (which MAY be zero seconds), 4912 the IPP Printer removes the job from the system. 4914 Using the Get-Jobs operation and supplying the 'not-completed' value for 4915 the "which-jobs" operation attribute, a client is requesting jobs in the 4916 Job Not Completed phase. Using the Get-Jobs operation and supplying the 4917 'completed' value for the "which-jobs" operation attribute, a client is 4918 requesting jobs in the Job Retention and Job History phases. Using the 4919 Get-Job-Attributes operation, a client is requesting a job in any phase 4920 except Job Removal. After Job Removal, the Get-Job-Attributes and Get- 4921 Jobs operations no longer are capable of returning any information about 4922 a job. 4924 4.3.8 job-state-reasons (1setOf type2 keyword) 4926 This attribute provides additional information about the job's current 4927 state, i.e., information that augments the value of the job's "job- 4928 state" attribute. 4930 Implementation of these values is OPTIONAL, i.e., a Printer NEED NOT 4931 implement them, even if (1) the output device supports the functionality 4932 represented by the reason and (2) is available to the Printer object 4933 implementation. These values MAY be used with any job state or states 4934 for which the reason makes sense. Furthermore, when implemented, the 4935 Printer MUST return these values when the reason applies and MUST NOT 4936 return them when the reason no longer applies whether the value of the 4937 Job's "job-state" attribute changed or not. When the Job does not have 4938 any reasons for being in its current state, the value of the Job's "job- 4939 state-reasons" attribute MUST be 'none'. 4941 Note: While values cannot be added to the 'job-state' attribute without 4942 impacting deployed clients that take actions upon receiving "job-state" 4943 values, it is the intent that additional "job-state-reasons" values can 4944 be defined and registered without impacting such deployed clients. In 4945 other words, the "job-state-reasons" attribute is intended to be 4946 extensible. 4948 The following standard keyword values are defined. For ease of 4949 understanding, the values are presented in the order in which the 4950 reasons are likely to occur (if implemented), starting with the 'job- 4951 incoming' value: 4953 'none': There are no reasons for the job's current state. 4954 'job-incoming': The Create-Job operation has been accepted by the 4955 Printer, but the Printer is expecting additional Send-Document 4956 and/or Send-URI operations and/or is accessing/accepting document 4957 data. 4958 'submission-interrupted': The job was not completely submitted for 4959 some unforeseen reason, such as: (1) the Printer has crashed before 4961 Expires August 17, 1999 4962 the job was closed by the client, (2) the Printer or the document 4963 transfer method has crashed in some non-recoverable way before the 4964 document data was entirely transferred to the Printer, (3) the 4965 client crashed or failed to close the job before the time-out 4966 period. See section 4.4.28. 4967 'job-outgoing': The Printer is transmitting the job to the output 4968 device. 4969 'job-hold-until-specified': The value of the job's "job-hold-until" 4970 attribute was specified with a time period that is still in the 4971 future. The job MUST NOT be a candidate for processing until this 4972 reason is removed and there are no other reasons to hold the job. 4973 'resources-are-not-ready': At least one of the resources needed by 4974 the job, such as media, fonts, resource objects, etc., is not ready 4975 on any of the physical printer's for which the job is a candidate. 4976 This condition MAY be detected when the job is accepted, or 4977 subsequently while the job is pending or processing, depending on 4978 implementation. The job may remain in its current state or be 4979 moved to the 'pending-held' state, depending on implementation 4980 and/or job scheduling policy. 4981 'printer-stopped-partly': The value of the Printer's "printer-state- 4982 reasons" attribute contains the value 'stopped-partly'. 4983 'printer-stopped': The value of the Printer's "printer-state" 4984 attribute is 'stopped'. 4985 'job-interpreting': Job is in the 'processing' state, but more 4986 specifically, the Printer is interpreting the document data. 4987 'job-queued': Job is in the 'processing' state, but more 4988 specifically, the Printer has queued the document data. 4989 'job-transforming': Job is in the 'processing' state, but more 4990 specifically, the Printer is interpreting document data and 4991 producing another electronic representation. 4992 'job-printing': The output device is marking media. This value is 4993 useful for Printers which spend a great deal of time processing (1) 4994 when no marking is happening and then want to show that marking is 4995 now happening or (2) when the job is in the process of being 4996 canceled or aborted while the job remains in the 'processing' 4997 state, but the marking has not yet stopped so that impression or 4998 sheet counts are still increasing for the job. 4999 'job-canceled-by-user': The job was canceled by the owner of the job 5000 using the Cancel-Job request, i.e., by a user whose authenticated 5001 identity is the same as the value of the originating user that 5002 created the Job object, or by some other authorized end-user, such 5003 as a member of the job owner's security group. 5004 'job-canceled-by-operator': The job was canceled by the operator 5005 using the Cancel-Job request, i.e., by a user who has been 5006 authenticated as having operator privileges (whether local or 5007 remote). If the security policy is to allow anyone to cancel 5008 anyone's job, then this value may be used when the job is canceled 5009 by other than the owner of the job. For such a security policy, in 5010 effect, everyone is an operator as far as canceling jobs with IPP 5011 is concerned. 5012 'job-canceled-at-device': The job was canceled by an unidentified 5013 local user, i.e., a user at a console at the device. 5014 'aborted-by-system': The job (1) is in the process of being aborted, 5015 (2) has been aborted by the system and placed in the 'aborted' 5017 Expires August 17, 1999 5018 state, or (3) has been aborted by the system and placed in the 5019 'pending-held' state, so that a user or operator can manually try 5020 the job again. 5021 'processing-to-stop-point': The requester has issued a Cancel-job 5022 operation or the Printer object has aborted the job, but is still 5023 performing some actions on the job until a specified stop point 5024 occurs or job termination/cleanup is completed. 5026 This reason is recommended to be used in conjunction with the 5027 'processing' job state to indicate that the Printer object is still 5028 performing some actions on the job while the job remains in the 5029 'processing' state. After all the job's job description attributes 5030 have stopped incrementing, the Printer object moves the job from 5031 the 'processing' state to the 'canceled' or 'aborted' job states. 5033 'service-off-line': The Printer is off-line and accepting no jobs. 5034 All 'pending' jobs are put into the 'pending-held' state. This 5035 situation could be true if the service's or document transform's 5036 input is impaired or broken. 5037 'job-completed-successfully': The job completed successfully. 5038 'job-completed-with-warnings': The job completed with warnings. 5039 'job-completed-with-errors': The job completed with errors (and 5040 possibly warnings too). 5041 'job-restartable' - This job is retained (see section 4.3.7.1) and is 5042 currently able to be restarted using the Restart-Job operation (see 5043 section 3.3.7). If 'job-restartable' is a value of the job's 'job- 5044 state-reasons' attribute, then the IPP object MUST accept a 5045 Restart-Job operation for that job. 5047 4.3.9 job-state-message (text(MAX)) 5049 This attribute specifies information about the "job-state" and "job- 5050 state-reasons" attributes in human readable text. If the Printer object 5051 supports this attribute, the Printer object MUST be able to generate 5052 this message in any of the natural languages identified by the Printer's 5053 "generated-natural-language-supported" attribute (see the "attributes- 5054 natural-language" operation attribute specified in Section 3.1.4.1). 5056 Note: the value SHOULD NOT contain additional information not contained 5057 in the values of the "job-state" and "job-states-reasons" attributes, 5058 such as interpreter error information. Otherwise, application programs 5059 might attempt to parse the (localized text). For such additional 5060 information such as interpreter errors for application program 5061 consumption, a new attribute with keyword values, needs to be developed 5062 and registered. 5064 4.3.10 number-of-documents (integer(0:MAX)) 5066 This attribute indicates the number of documents in the job, i.e., the 5067 number of Send-Document, Send-URI, Print-Job, or Print-URI operations 5068 that the Printer has accepted for this job, regardless of whether the 5069 document data has reached the Printer object or not. 5071 Expires August 17, 1999 5072 Implementations supporting the OPTIONAL Create-Job/Send-Document/Send- 5073 URI operations SHOULD support this attribute so that clients can query 5074 the number of documents in each job. 5076 4.3.11 output-device-assigned (name(127)) 5078 This attribute identifies the output device to which the Printer object 5079 has assigned this job. If an output device implements an embedded 5080 Printer object, the Printer object NEED NOT set this attribute. If a 5081 print server implements a Printer object, the value MAY be empty (zero- 5082 length string) or not returned until the Printer object assigns an 5083 output device to the job. This attribute is particularly useful when a 5084 single Printer object support multiple devices (so called "fan-out"). 5086 4.3.12 time-at-creation (integer(0:MAX)) 5088 This attribute indicates the point in time at which the Job object was 5089 created. In order to populate this attribute, the Printer object uses 5090 the value in its "printer-up-time" attribute at the time the Job object 5091 is created. 5093 4.3.13 time-at-processing (integer(0:MAX)) 5095 This attribute indicates the point in time at which the Job object began 5096 processing. In order to populate this attribute, the Printer object 5097 uses the value in its "printer-up-time" attribute at the time the Job 5098 object is moved into the 'processing' state for the first time. 5100 4.3.14 time-at-completed (integer(0:MAX)) 5102 This attribute indicates the point in time at which the Job object 5103 completed (or was cancelled or aborted). In order to populate this 5104 attribute, the Printer object uses the value in its "printer-up-time" 5105 attribute at the time the Job object is moved into the 'completed' or 5106 'canceled' or 'aborted' state. 5108 4.3.15 number-of-intervening-jobs (integer(0:MAX)) 5110 This attribute indicates the number of jobs that are "ahead" of this job 5111 in the relative chronological order of expected time to complete (i.e., 5112 the current scheduled order). For efficiency, it is only necessary to 5113 calculate this value when an operation is performed that requests this 5114 attribute. 5116 4.3.16 job-message-from-operator (text(127)) 5118 This attribute provides a message from an operator, system administrator 5119 or "intelligent" process to indicate to the end user the reasons for 5120 modification or other management action taken on a job. 5122 Expires August 17, 1999 5123 4.3.17 job-k-octets (integer(0:MAX)) 5125 This attribute specifies the total size of the document(s) in K octets, 5126 i.e., in units of 1024 octets requested to be processed in the job. The 5127 value MUST be rounded up, so that a job between 1 and 1024 octets MUST 5128 be indicated as being 1, 1025 to 2048 MUST be 2, etc. 5130 This value MUST NOT include the multiplicative factors contributed by 5131 the number of copies specified by the "copies" attribute, independent of 5132 whether the device can process multiple copies without making multiple 5133 passes over the job or document data and independent of whether the 5134 output is collated or not. Thus the value is independent of the 5135 implementation and indicates the size of the document(s) measured in K 5136 octets independent of the number of copies. 5138 This value MUST also not include the multiplicative factor due to a 5139 copies instruction embedded in the document data. If the document data 5140 actually includes replications of the document data, this value will 5141 include such replication. In other words, this value is always the size 5142 of the source document data, rather than a measure of the hardcopy 5143 output to be produced. 5145 Note: This attribute and the following two attributes ("job-impressions" 5146 and "job-media-sheets") are not intended to be counters; they are 5147 intended to be useful routing and scheduling information if known. For 5148 these three attributes, the Printer object may try to compute the value 5149 if it is not supplied in the create request. Even if the client does 5150 supply a value for these three attributes in the create request, the 5151 Printer object MAY choose to change the value if the Printer object is 5152 able to compute a value which is more accurate than the client supplied 5153 value. The Printer object may be able to determine the correct value 5154 for these three attributes either right at job submission time or at any 5155 later point in time. 5157 4.3.18 job-impressions (integer(0:MAX)) 5159 This attribute specifies the total size in number of impressions of the 5160 document(s) being submitted (see the definition of impression in section 5161 13.2.5). 5163 As with "job-k-octets", this value MUST NOT include the multiplicative 5164 factors contributed by the number of copies specified by the "copies" 5165 attribute, independent of whether the device can process multiple copies 5166 without making multiple passes over the job or document data and 5167 independent of whether the output is collated or not. Thus the value is 5168 independent of the implementation and reflects the size of the 5169 document(s) measured in impressions independent of the number of copies. 5171 As with "job-k-octets", this value MUST also not include the 5172 multiplicative factor due to a copies instruction embedded in the 5173 document data. If the document data actually includes replications of 5174 the document data, this value will include such replication. In other 5175 words, this value is always the number of impressions in the source 5177 Expires August 17, 1999 5178 document data, rather than a measure of the number of impressions to be 5179 produced by the job. 5181 See the Note in the "job-k-octets" attribute that also applies to this 5182 attribute. 5184 4.3.19 job-media-sheets (integer(0:MAX)) 5186 This attribute specifies the total number of media sheets to be produced 5187 for this job. 5189 Unlike the "job-k-octets" and the "job-impressions" attributes, this 5190 value MUST include the multiplicative factors contributed by the number 5191 of copies specified by the "copies" attribute and a 'number of copies' 5192 instruction embedded in the document data, if any. This difference 5193 allows the system administrator to control the lower and upper bounds of 5194 both (1) the size of the document(s) with "job-k-octets-supported" and 5195 "job-impressions-supported" and (2) the size of the job with "job-media- 5196 sheets-supported". 5198 See the Note in the "job-k-octets" attribute that also applies to this 5199 attribute. 5201 4.3.20 job-k-octets-processed (integer(0:MAX)) 5203 This attribute specifies the total number of octets processed in K 5204 octets, i.e., in units of 1024 octets so far. The value MUST be rounded 5205 up, so that a job between 1 and 1024 octets inclusive MUST be indicated 5206 as being 1, 1025 to 2048 inclusive MUST be 2, etc. 5208 For implementations where multiple copies are produced by the 5209 interpreter with only a single pass over the data, the final value MUST 5210 be equal to the value of the "job-k-octets" attribute. For 5211 implementations where multiple copies are produced by the interpreter by 5212 processing the data for each copy, the final value MUST be a multiple of 5213 the value of the "job-k-octets" attribute. 5215 Note: This attribute and the following two attributes ("job-impressions- 5216 completed" and "job-sheets-completed") are intended to be counters. That 5217 is, the value for a job that has not started processing MUST be 0. When 5218 the job's "job-state" is 'processing' or 'processing-stopped', this 5219 value is intended to contain the amount of the job that has been 5220 processed to the time at which the attributes are requested. 5222 4.3.21 job-impressions-completed (integer(0:MAX)) 5224 This job attribute specifies the number of impressions completed for the 5225 job so far. For printing devices, the impressions completed includes 5226 interpreting, marking, and stacking the output. 5228 See the note in "job-k-octets-processed" which also applies to this 5229 attribute. 5231 Expires August 17, 1999 5232 4.3.22 job-media-sheets-completed (integer(0:MAX)) 5234 This job attribute specifies the media-sheets completed marking and 5235 stacking for the entire job so far whether those sheets have been 5236 processed on one side or on both. 5238 See the note in "job-k-octets-processed" which also applies to this 5239 attribute. 5241 4.3.23 attributes-charset (charset) 5243 This REQUIRED attribute is populated using the value in the client 5244 supplied "attributes-charset" attribute in the create request. It 5245 identifies the charset (coded character set and encoding method) used by 5246 any Job attributes with attribute syntax 'text' and 'name' that were 5247 supplied by the client in the create request. See Section 3.1.4 for a 5248 complete description of the "attributes-charset" operation attribute. 5250 This attribute does not indicate the charset in which the 'text' and 5251 'name' values are stored internally in the Job object. The internal 5252 charset is implementation-defined. The IPP object MUST convert from 5253 whatever the internal charset is to that being requested in an operation 5254 as specified in Section 3.1.4. 5256 4.3.24 attributes-natural-language (naturalLanguage) 5258 This REQUIRED attribute is populated using the value in the client 5259 supplied "attributes-natural-language" attribute in the create request. 5260 It identifies the natural language used for any Job attributes with 5261 attribute syntax 'text' and 'name' that were supplied by the client in 5262 the create request. See Section 3.1.4 for a complete description of the 5263 "attributes-natural-language" operation attribute. See Sections 4.1.1.2 5264 and 4.1.2.2 for how a Natural Language Override may be supplied 5265 explicitly for each 'text' and 'name' attribute value that differs from 5266 the value identified by the "attributes-natural-language" attribute. 5268 4.4 Printer Description Attributes 5270 These attributes form the attribute group called "printer-description". 5271 The following table summarizes these attributes, their syntax, and 5272 whether or not they are REQUIRED for a Printer object to support. If 5273 they are not indicated as REQUIRED, they are OPTIONAL. The maximum size 5274 in octets for 'text' and 'name' attributes is indicated in 5275 parenthesizes. 5277 Note: How these attributes are set by an Administrator is outside the 5278 scope of this IPP/1.1 document. 5280 Expires August 17, 1999 5281 +----------------------------+---------------------------+-----------+ 5282 | Attribute | Syntax | REQUIRED? | 5283 +----------------------------+---------------------------+-----------+ 5284 | printer-uri-supported | 1setOf uri | REQUIRED | 5285 +----------------------------+---------------------------+-----------+ 5286 | uri-security-supported | 1setOf type2 keyword | REQUIRED | 5287 +----------------------------+---------------------------+-----------+ 5288 | printer-name | name (127) | REQUIRED | 5289 +----------------------------+---------------------------+-----------+ 5290 | printer-location | text (127) | | 5291 +----------------------------+---------------------------+-----------+ 5292 | printer-info | text (127) | | 5293 +----------------------------+---------------------------+-----------+ 5294 | printer-more-info | uri | | 5295 +----------------------------+---------------------------+-----------+ 5296 | printer-driver-installer | uri | | 5297 +----------------------------+---------------------------+-----------+ 5298 | printer-make-and-model | text (127) | | 5299 +----------------------------+---------------------------+-----------+ 5300 | printer-more-info- | uri | | 5301 | manufacturer | | | 5302 +----------------------------+---------------------------+-----------+ 5303 | printer-state | type1 enum | REQUIRED | 5304 +----------------------------+---------------------------+-----------+ 5305 | printer-state-reasons | 1setOf type2 keyword | | 5306 +----------------------------+---------------------------+-----------+ 5307 | printer-state-message | text (MAX) | | 5308 +----------------------------+---------------------------+-----------+ 5309 | operations-supported | 1setOf type2 enum | REQUIRED | 5310 +----------------------------+---------------------------+-----------+ 5311 | charset-configured | charset | REQUIRED | 5312 +----------------------------+---------------------------+-----------+ 5313 | charset-supported | 1setOf charset | REQUIRED | 5314 +----------------------------+---------------------------+-----------+ 5315 | natural-language-configured| naturalLanguage | REQUIRED | 5316 +----------------------------+---------------------------+-----------+ 5317 | generated-natural-language-| 1setOf naturalLanguage | REQUIRED | 5318 | supported | | | 5319 +----------------------------+---------------------------+-----------+ 5320 | document-format-default | mimeMediaType | REQUIRED | 5321 +----------------------------+---------------------------+-----------+ 5322 | document-format-supported | 1setOf mimeMediaType | REQUIRED | 5323 +----------------------------+---------------------------+-----------+ 5324 | printer-is-accepting-jobs | boolean | REQUIRED | 5325 +----------------------------+---------------------------+-----------+ 5326 | queued-job-count | integer (0:MAX) |RECOMMENDED| 5327 +----------------------------+---------------------------+-----------+ 5328 | printer-message-from- | text (127) | | 5329 | operator | | | 5330 +----------------------------+---------------------------+-----------+ 5331 | color-supported | boolean | | 5332 +----------------------------+---------------------------+-----------+ 5333 | reference-uri-schemes- | 1setOf uriScheme | | 5334 | supported | | | 5336 Expires August 17, 1999 5337 +----------------------------+---------------------------+-----------+ 5338 | pdl-override-supported | type2 keyword | REQUIRED | 5339 +----------------------------+---------------------------+-----------+ 5340 | printer-up-time | integer (1:MAX) | REQUIRED | 5341 +----------------------------+---------------------------+-----------+ 5342 | printer-current-time | dateTime | | 5343 +----------------------------+---------------------------+-----------+ 5344 | multiple-operation-time-out| integer (1:MAX) | | 5345 +----------------------------+---------------------------+-----------+ 5346 | compression-supported | 1setOf type3 keyword | | 5347 +----------------------------+---------------------------+-----------+ 5348 | job-k-octets-supported | rangeOfInteger (0:MAX) | | 5349 +----------------------------+---------------------------+-----------+ 5350 | job-impressions-supported | rangeOfInteger (0:MAX) | | 5351 +----------------------------+---------------------------+-----------+ 5352 | job-media-sheets-supported | rangeOfInteger (0:MAX) | | 5353 +----------------------------+---------------------------+-----------+ 5354 | pages-per-minute | integer(0:MAX) | | 5355 +----------------------------+---------------------------+-----------+ 5356 | pages-per-minute-color | integer(0:MAX) | | 5357 +----------------------------+---------------------------+-----------+ 5359 4.4.1 printer-uri-supported (1setOf uri) 5361 This REQUIRED Printer attribute contains at least one URI for the 5362 Printer object. It OPTIONALLY contains more than one URI for the 5363 Printer object. An administrator determines a Printer object's URI(s) 5364 and configures this attribute to contain those URIs by some means 5365 outside the scope of this IPP/1.1 document. The precise format of this 5366 URI is implementation dependent and depends on the protocol. See the 5367 next section for a description "uri-security-supported" which is the 5368 REQUIRED companion attribute to this "printer-uri-supported" attribute. 5369 See section 2.4 on Printer object identity and section 8.2 on security 5370 and URIs for more information. 5372 4.4.2 uri-security-supported (1setOf type2 keyword) 5374 This REQUIRED Printer attribute MUST have the same cardinality (contain 5375 the same number of values) as the "printer-uri-supported" attribute. 5376 This attribute identifies the security mechanisms used for each URI 5377 listed in the "printer-uri-supported" attribute. The "i th" value in 5378 "uri-security-supported" corresponds to the "i th" value in "printer- 5379 uri-supported" and it describes the security mechanisms used for 5380 accessing the Printer object via that URI. The following standard values 5381 are defined: 5383 'none': There are no secure communication channel protocols in use 5384 for the given URI. 5385 'ssl3': SSL3 [SSL] is the secure communications channel protocol in 5386 use for the given URI. For use in IPP/1.0. 5387 'tls': TLS [RFC2246] is the secure communications channel protocol 5388 in use for the given URI. For use in IPP/1.1. 5390 Expires August 17, 1999 5392 Consider the following example. For a single Printer object, an 5393 administrator configures the "printer-uri-supported" and "uri-security- 5394 supported" attributes as follows: 5396 "printer-uri-supported": 'xxx://acme.com/open-use-printer', 5397 'xxx://acme.com/restricted-use-printer', 'xxx://acme.com/private- 5398 printer' 5399 "uri-security-supported": 'none', 'none', 'tls' 5401 Note: 'xxx' is not a valid scheme. See the IPP/1.1 "Transport and 5402 Encoding" specification [ipp-pro] for the actual URI schemes to be used 5403 in object target attributes. 5405 In this case, one Printer object has three URIs. 5407 - For the first URI, 'xxx://acme.com/open-use-printer', the value 5408 'none' in "uri-security-supported" indicates that there is no 5409 secure channel protocol configured to run under HTTP. The name 5410 implies that there is no Basic or Digest authentication being used, 5411 but it is up to the client to determine that while using HTTP 5412 underneath the IPP application protocol. 5413 - For the second URI, 'xxx://acme.com/restricted-use-printer', the 5414 value 'none' in "uri-security-supported" indicates that there is no 5415 secure channel protocol configured to run under HTTP. In this 5416 case, although the name does imply that there is some sort of Basic 5417 or Digest authentication being used within HTTP, it is up to the 5418 client to determine that while using HTTP and by processing any 5419 '401 Unauthorized' HTTP error messages. 5420 - For the third URI, 'xxx://acme.com/private-printer', the value 5421 'tls' in "uri-security-supported" indicates that TLS is being used 5422 to secure the channel. The client SHOULD be prepared to use TLS 5423 framing to negotiate an acceptable ciphersuite to use while 5424 communicating with the Printer object. In this case, the name 5425 implies the use of a secure communications channel, but the fact is 5426 made explicit by the presence of the 'tls' value in "uri-security- 5427 supported". The client does not need to resort to understanding 5428 which security it must use by following naming conventions or by 5429 parsing the URI to determine which security mechanisms are implied. 5431 It is expected that many IPP Printer objects will be configured to 5432 support only one channel (either configured to use TLS access or not), 5433 and will therefore only ever have one URI listed in the "printer-uri- 5434 supported" attribute. No matter the configuration of the Printer object 5435 (whether it has only one URI or more than one URI), a client MUST supply 5436 only one URI in the target "printer-uri" operation attribute. 5438 4.4.3 printer-name (name(127)) 5440 This REQUIRED Printer attribute contains the name of the Printer object. 5441 It is a name that is more end-user friendly than a URI. An administrator 5442 determines a printer's name and sets this attribute to that name. This 5443 name may be the last part of the printer's URI or it may be unrelated. 5445 Expires August 17, 1999 5446 In non-US-English locales, a name may contain characters that are not 5447 allowed in a URI. 5449 4.4.4 printer-location (text(127)) 5451 This Printer attribute identifies the location of the device. This could 5452 include things like: "in Room 123A, second floor of building XYZ". 5454 4.4.5 printer-info (text(127)) 5456 This Printer attribute identifies the descriptive information about this 5457 Printer object. This could include things like: "This printer can be 5458 used for printing color transparencies for HR presentations", or "Out of 5459 courtesy for others, please print only small (1-5 page) jobs at this 5460 printer", or even "This printer is going away on July 1, 1997, please 5461 find a new printer". 5463 4.4.6 printer-more-info (uri) 5465 This Printer attribute contains a URI used to obtain more information 5466 about this specific Printer object. For example, this could be an HTTP 5467 type URI referencing an HTML page accessible to a Web Browser. The 5468 information obtained from this URI is intended for end user consumption. 5469 Features outside the scope of IPP can be accessed from this URI. The 5470 information is intended to be specific to this printer instance and site 5471 specific services (e.g. job pricing, services offered, end user 5472 assistance). The device manufacturer may initially populate this 5473 attribute. 5475 4.4.7 printer-driver-installer (uri) 5477 This Printer attribute contains a URI to use to locate the driver 5478 installer for this Printer object. This attribute is intended for 5479 consumption by automata. The mechanics of print driver installation is 5480 outside the scope of this IPP/1.1 document. The device manufacturer may 5481 initially populate this attribute. 5483 4.4.8 printer-make-and-model (text(127)) 5485 This Printer attribute identifies the make and model of the device. The 5486 device manufacturer may initially populate this attribute. 5488 4.4.9 printer-more-info-manufacturer (uri) 5490 This Printer attribute contains a URI used to obtain more information 5491 about this type of device. The information obtained from this URI is 5492 intended for end user consumption. Features outside the scope of IPP 5493 can be accessed from this URI (e.g., latest firmware, upgrades, print 5494 drivers, optional features available, details on color support). The 5495 information is intended to be germane to this printer without regard to 5497 Expires August 17, 1999 5498 site specific modifications or services. The device manufacturer may 5499 initially populate this attribute. 5501 4.4.10 printer-state (type1 enum) 5503 This REQUIRED Printer attribute identifies the current state of the 5504 device. The "printer-state reasons" attribute augments the "printer- 5505 state" attribute to give more detailed information about the Printer in 5506 the given printer state. 5508 A Printer object need only update this attribute before responding to an 5509 operation which requests the attribute; the Printer object NEED NOT 5510 update this attribute continually, since asynchronous event notification 5511 is not part of IPP/1.1. A Printer NEED NOT implement all values if they 5512 are not applicable to a given implementation. 5514 The following standard enum values are defined: 5516 Value Symbolic Name and Description 5518 '3' 'idle': If a Printer receives a job (whose required resources 5519 are ready) while in this state, such a job MUST transit 5520 into the 'processing' state immediately. If the 5521 "printer-state-reasons" attribute contains any reasons, 5522 they MUST be reasons that would not prevent a job from 5523 transiting into the 'processing' state immediately, e.g., 5524 'toner-low'. Note: if a Printer controls more than one 5525 output device, the above definition implies that a 5526 Printer is 'idle' if at least one output device is idle. 5528 '4' 'processing': If a Printer receives a job (whose required 5529 resources are ready) while in this state, such a job MUST 5530 transit into the 'pending' state immediately. Such a job 5531 MUST transit into the 'processing' state only after jobs 5532 ahead of it complete. If the "printer-state-reasons" 5533 attribute contains any reasons, they MUST be reasons that 5534 do not prevent the current job from printing, e.g. 5535 'toner-low'. Note: if a Printer controls more than one 5536 output device, the above definition implies that a 5537 Printer is 'processing' if at least one output device is 5538 processing, and none is idle. 5540 '5' 'stopped': If a Printer receives a job (whose required 5541 resources are ready) while in this state, such a job MUST 5542 transit into the 'pending' state immediately. Such a job 5543 MUST transit into the 'processing' state only after some 5544 human fixes the problem that stopped the printer and 5545 after jobs ahead of it complete processing. If 5546 supported, the "printer-state-reasons" attribute MUST 5547 contain at least one reason, e.g. 'media-jam', which 5548 prevents it from either processing the current job or 5549 transitioning a 'pending' job to the 'processing' state. 5551 Expires August 17, 1999 5552 Note: if a Printer controls more than one output device, 5553 the above definition implies that a Printer is 'stopped' 5554 only if all output devices are stopped. Also, it is 5555 tempting to define 'stopped' as when a sufficient number 5556 of output devices are stopped and leave it to an 5557 implementation to define the sufficient number. But such 5558 a rule complicates the definition of 'stopped' and 5559 'processing'. For example, with this alternate definition 5560 of 'stopped', a job can move from 'pending' to 5561 'processing' without human intervention, even though the 5562 Printer is stopped. 5564 4.4.11 printer-state-reasons (1setOf type2 keyword) 5566 This Printer attribute supplies additional detail about the device's 5567 state. 5569 Each keyword value MAY have a suffix to indicate its level of severity. 5570 The three levels are: report (least severe), warning, and error (most 5571 severe). 5573 - '-report': This suffix indicates that the reason is a "report". An 5574 implementation may choose to omit some or all reports. Some reports 5575 specify finer granularity about the printer state; others serve as 5576 a precursor to a warning. A report MUST contain nothing that could 5577 affect the printed output. 5578 - '-warning': This suffix indicates that the reason is a "warning". 5579 An implementation may choose to omit some or all warnings. Warnings 5580 serve as a precursor to an error. A warning MUST contain nothing 5581 that prevents a job from completing, though in some cases the 5582 output may be of lower quality. 5583 - '-error': This suffix indicates that the reason is an "error". An 5584 implementation MUST include all errors. If this attribute contains 5585 one or more errors, printer MUST be in the stopped state. 5587 If the implementation does not add any one of the three suffixes, all 5588 parties MUST assume that the reason is an "error". 5590 If a Printer object controls more than one output device, each value of 5591 this attribute MAY apply to one or more of the output devices. An error 5592 on one output device that does not stop the Printer object as a whole 5593 MAY appear as a warning in the Printer's "printer-state-reasons 5594 attribute". If the "printer-state" for such a Printer has a value of 5595 'stopped', then there MUST be an error reason among the values in the 5596 "printer-state-reasons" attribute. 5598 The following standard keyword values are defined: 5600 'other': The device has detected an error other than one listed in 5601 this document. 5602 'none': There are not reasons. This state reason is semantically 5603 equivalent to "printer-state-reasons" without any value. 5605 Expires August 17, 1999 5607 'media-needed': A tray has run out of media. 5608 'media-jam': The device has a media jam. 5609 'moving-to-paused': Someone has paused the Printer object using the 5610 Pause-Printer operation (see section 3.2.7) or other means, but the 5611 device(s) are taking an appreciable time to stop. Later, when all 5612 output has stopped, the "printer-state" becomes 'stopped', and the 5613 'paused' value replaces the 'moving-to-paused' value in the 5614 "printer-state-reasons" attribute. 5615 'paused': Someone has paused the Printer object using the Pause- 5616 Printer operation (see section 3.2.7) or other means and the 5617 Printer object's "printer-state" is 'stopped'. In this state, a 5618 Printer MUST NOT produce printed output, but it MUST perform other 5619 operations requested by a client. If a Printer had been printing a 5620 job when the Printer was paused, the Printer MUST resume printing 5621 that job when the Printer is no longer paused and leave no evidence 5622 in the printed output of such a pause. 5623 'shutdown': Someone has removed a Printer object from service, and 5624 the device may be powered down or physically removed. In this 5625 state, a Printer object MUST NOT produce printed output, and unless 5626 the Printer object is realized by a print server that is still 5627 active, the Printer object MUST perform no other operations 5628 requested by a client, including returning this value. If a Printer 5629 object had been printing a job when it was shutdown, the Printer 5630 NEED NOT resume printing that job when the Printer is no longer 5631 shutdown. If the Printer resumes printing such a job, it may leave 5632 evidence in the printed output of such a shutdown, e.g. the part 5633 printed before the shutdown may be printed a second time after the 5634 shutdown. 5635 'connecting-to-device': The Printer object has scheduled a job on the 5636 output device and is in the process of connecting to a shared 5637 network output device (and might not be able to actually start 5638 printing the job for an arbitrarily long time depending on the 5639 usage of the output device by other servers on the network). 5640 'timed-out': The server was able to connect to the output device (or 5641 is always connected), but was unable to get a response from the 5642 output device. 5643 'stopping': The Printer object is in the process of stopping the 5644 device and will be stopped in a while. When the device is stopped, 5645 the Printer object will change the Printer object's state to 5646 'stopped'. The 'stopping-warning' reason is never an error, even 5647 for a Printer with a single output device. When an output-device 5648 ceases accepting jobs, the Printer will have this reason while the 5649 output device completes printing. 5650 'stopped-partly': When a Printer object controls more than one output 5651 device, this reason indicates that one or more output devices are 5652 stopped. If the reason is a report, fewer than half of the output 5653 devices are stopped. If the reason is a warning, fewer than all of 5654 the output devices are stopped. 5655 'toner-low': The device is low on toner. 5656 'toner-empty': The device is out of toner. 5657 'spool-area-full': The limit of persistent storage allocated for 5658 spooling has been reached. 5659 'cover-open': One or more covers on the device are open. 5661 Expires August 17, 1999 5662 'interlock-open': One or more interlock devices on the printer are 5663 unlocked. 5664 'door-open': One or more doors on the device are open. 5665 'input-tray-missing': One or more input trays are not in the device. 5666 'media-low': At least one input tray is low on media. 5667 'media-empty': At least one input tray is empty. 5668 'output-tray-missing': One or more output trays are not in the device 5669 'output-area-almost-full': One or more output area is almost full 5670 (e.g. tray, stacker, collator). 5671 'output-area-full': One or more output area is full. (e.g. tray, 5672 stacker, collator) 5673 'marker-supply-low': The device is low on at least one marker supply. 5674 (e.g. toner, ink, ribbon) 5675 'marker-supply-empty: The device is out of at least one marker 5676 supply. (e.g. toner, ink, ribbon) 5677 'marker-waste-almost-full': The device marker supply waste receptacle 5678 is almost full. 5679 'marker-waste-full': The device marker supply waste receptacle is 5680 full. 5681 'fuser-over-temp': The fuser temperature is above normal. 5682 'fuser-under-temp': The fuser temperature is below normal. 5683 'opc-near-eol': The optical photo conductor is near end of life. 5684 'opc-life-over': The optical photo conductor is no longer 5685 functioning. 5686 'developer-low': The device is low on developer. 5687 'developer-empty: The device is out of developer. 5688 'interpreter-resource-unavailable': An interpreter resource is 5689 unavailable (i.e. font, form) 5691 4.4.12 printer-state-message (text(MAX)) 5693 This Printer attribute specifies the additional information about the 5694 printer state and printer state reasons in human readable text. If the 5695 Printer object supports this attribute, the Printer object MUST be able 5696 to generate this message in any of the natural languages identified by 5697 the Printer's "generated-natural-language-supported" attribute (see the 5698 "attributes-natural-language" operation attribute specified in Section 5699 3.1.4.1). 5701 4.4.13 operations-supported (1setOf type2 enum) 5703 This REQUIRED Printer attribute specifies the set of supported 5704 operations for this Printer object and contained Job objects. 5706 Note: This attribute is encoded as any other enum attribute syntax 5707 according to [IPP-PRO] as 32-bits. However, all 32-bit enum values for 5708 this attribute MUST NOT exceed 0x00008FFF, since these same values are 5709 also passed in two octets in the "operation-id" parameter (see section 5710 3.1.1) in each Protocol request with the two high order octets omitted 5711 in order to indicate the operation being performed [IPP-PRO]. 5713 Expires August 17, 1999 5714 The following standard enum and "operation-id" (see section 3.1.2) 5715 values are defined: 5717 Value Operation Name 5718 ----------------- ------------------------------------- 5720 0x0000 reserved, not used 5721 0x0001 reserved, not used 5722 0x0002 Print-Job 5723 0x0003 Print-URI 5724 0x0004 Validate-Job 5725 0x0005 Create-Job 5726 0x0006 Send-Document 5727 0x0007 Send-URI 5728 0x0008 Cancel-Job 5729 0x0009 Get-Job-Attributes 5730 0x000A Get-Jobs 5731 0x000B Get-Printer-Attributes 5732 0x000C Hold-Job 5733 0x000D Release-Job 5734 0x000E Restart-Job 5735 0x000F reserved for a future operation 5736 0x0010 Pause-Printer 5737 0x0011 Resume-Printer 5738 0x0012 Purge-Jobs 5739 0x00013-0x3FFF reserved for future operations 5740 0x4000-0x8FFF reserved for private extensions 5742 This allows for certain vendors to implement private extensions that are 5743 guaranteed to not conflict with future registered extensions. However, 5744 there is no guarantee that two or more private extensions will not 5745 conflict. 5747 4.4.14 charset-configured (charset) 5749 This REQUIRED Printer attribute identifies the charset that the Printer 5750 object has been configured to represent 'text' and 'name' Printer 5751 attributes that are set by the operator, system administrator, or 5752 manufacturer, i.e., for "printer-name" (name), "printer-location" 5753 (text), "printer-info" (text), and "printer-make-and-model" (text). 5754 Therefore, the value of the Printer object's "charset-configured" 5755 attribute MUST also be among the values of the Printer object's 5756 "charset-supported" attribute. 5758 4.4.15 charset-supported (1setOf charset) 5760 This REQUIRED Printer attribute identifies the set of charsets that the 5761 Printer and contained Job objects support in attributes with attribute 5762 syntax 'text' and 'name'. At least the value 'utf-8' MUST be present, 5763 since IPP objects MUST support the UTF-8 [RFC2279] charset. If a 5764 Printer object supports a charset, it means that for all attributes of 5765 syntax 'text' and 'name' the IPP object MUST (1) accept the charset in 5766 requests and return the charset in responses as needed. 5768 Expires August 17, 1999 5769 If more charsets than UTF-8 are supported, the IPP object MUST perform 5770 charset conversion between the charsets as described in Section 3.2.1.2. 5772 4.4.16 natural-language-configured (naturalLanguage) 5774 This REQUIRED Printer attribute identifies the natural language that the 5775 Printer object has been configured to represent 'text' and 'name' 5776 Printer attributes that are set by the operator, system administrator, 5777 or manufacturer, i.e., for "printer-name" (name), "printer-location" 5778 (text), "printer-info" (text), and "printer-make-and-model" (text). 5779 When returning these Printer attributes, the Printer object MAY return 5780 them in the configured natural language specified by this attribute, 5781 instead of the natural language requested by the client in the 5782 "attributes-natural-language" operation attribute. See Section 3.1.4.1 5783 for the specification of the OPTIONAL multiple natural language support. 5784 Therefore, the value of the Printer object's "natural-language- 5785 configured" attribute MUST also be among the values of the Printer 5786 object's "generated-natural-language-supported" attribute. 5788 4.4.17 generated-natural-language-supported (1setOf naturalLanguage) 5790 This REQUIRED Printer attribute identifies the natural language(s) that 5791 the Printer object and contained Job objects support in attributes with 5792 attribute syntax 'text' and 'name'. The natural language(s) supported 5793 depends on implementation and/or configuration. Unlike charsets, IPP 5794 objects MUST accept requests with any natural language or any Natural 5795 Language Override whether the natural language is supported or not. 5797 If a Printer object supports a natural language, it means that for any 5798 of the attributes for which the Printer or Job object generates 5799 messages, i.e., for the "job-state-message" and "printer-state-message" 5800 attributes and Operation Messages (see Section 3.1.5) in operation 5801 responses, the Printer and Job objects MUST be able to generate messages 5802 in any of the Printer's supported natural languages. See section 3.1.4 5803 for the specification of 'text' and 'name' attributes in operation 5804 requests and responses. 5806 Note: A Printer object that supports multiple natural languages, often 5807 has separate catalogs of messages, one for each natural language 5808 supported. 5810 4.4.18 document-format-default (mimeMediaType) 5812 This REQUIRED Printer attribute identifies the document format that the 5813 Printer object has been configured to assume if the client does not 5814 supply a "document-format" operation attribute in any of the operation 5815 requests that supply document data. The standard values for this 5816 attribute are Internet Media types (sometimes called MIME types). For 5817 further details see the description of the 'mimeMediaType' attribute 5818 syntax in Section 4.1.9. 5820 Expires August 17, 1999 5821 4.4.19 document-format-supported (1setOf mimeMediaType) 5823 This REQUIRED Printer attribute identifies the set of document formats 5824 that the Printer object and contained Job objects can support. For 5825 further details see the description of the 'mimeMediaType' attribute 5826 syntax in Section 4.1.9. 5828 4.4.20 printer-is-accepting-jobs (boolean) 5830 This REQUIRED Printer attribute indicates whether the printer is 5831 currently able to accept jobs, i.e., is accepting Print-Job, Print-URI, 5832 and Create-Job requests. If the value is 'true', the printer is 5833 accepting jobs. If the value is 'false', the Printer object is 5834 currently rejecting any jobs submitted to it. In this case, the Printer 5835 object returns the 'server-error-not-accepting-jobs' status code. 5837 Note: This value is independent of the "printer-state" and "printer- 5838 state-reasons" attributes because its value does not affect the current 5839 job; rather it affects future jobs. This attribute may cause the 5840 Printer to reject jobs when the "printer-state" is 'idle' or it may 5841 cause the Printer object to accepts jobs when the "printer-state" is 5842 'stopped'. 5844 4.4.21 queued-job-count (integer(0:MAX)) 5846 This RECOMMENDED Printer attribute contains a count of the number of 5847 jobs that are either 'pending', 'processing', 'pending-held', or 5848 'processing-stopped' and is set by the Printer object. 5850 4.4.22 printer-message-from-operator (text(127)) 5852 This Printer attribute provides a message from an operator, system 5853 administrator or "intelligent" process to indicate to the end user 5854 information or status of the printer, such as why it is unavailable or 5855 when it is expected to be available. 5857 4.4.23 color-supported (boolean) 5859 This Printer attribute identifies whether the device is capable of any 5860 type of color printing at all, including highlight color. All document 5861 instructions having to do with color are embedded within the document 5862 PDL (none are external IPP attributes in IPP/1.1). 5864 Note: end-users are able to determine the nature and details of the 5865 color support by querying the "printer-more-info-manufacturer" Printer 5866 attribute. 5868 4.4.24 reference-uri-schemes-supported (1setOf uriScheme) 5870 This Printer attribute specifies which URI schemes are supported for use 5871 in the "document-uri" operation attribute of the Print-URI or Send-URI 5873 Expires August 17, 1999 5874 operation. If a Printer object supports these optional operations, it 5875 MUST support the "reference-uri-schemes-supported" Printer attribute 5876 with at least the following schemed URI value: 5878 'ftp': The Printer object will use an FTP 'get' operation as defined 5879 in RFC 2228 [RFC2228] using FTP URLs as defined by [RFC2396] 5880 and[RFC2316]. 5882 The Printer object MAY OPTIONALLY support other URI schemes (see section 5883 4.1.6). 5885 4.4.25 pdl-override-supported (type2 keyword) 5887 This REQUIRED Printer attribute expresses the ability for a particular 5888 Printer implementation to either attempt to override document data 5889 instructions with IPP attributes or not. 5891 This attribute takes on the following values: 5893 - 'attempted': This value indicates that the Printer object attempts 5894 to make the IPP attribute values take precedence over embedded 5895 instructions in the document data, however there is no guarantee. 5896 - 'not-attempted': This value indicates that the Printer object makes 5897 no attempt to make the IPP attribute values take precedence over 5898 embedded instructions in the document data. 5900 Section 16 contains a full description of how this attribute interacts 5901 with and affects other IPP attributes, especially the "ipp-attribute- 5902 fidelity" attribute. 5904 4.4.26 printer-up-time (integer(1:MAX)) 5906 This REQUIRED Printer attribute indicates the amount of time (in 5907 seconds) that this instance of this Printer implementation has been up 5908 and running. This value is used to populate the Job attributes "time- 5909 at-creation", "time-at-processing", and "time-at-completed". These time 5910 values are all measured in seconds and all have meaning only relative to 5911 this attribute, "printer-up-time". The value is a monotonically 5912 increasing value starting from 1 when the Printer object is started-up 5913 (initialized, booted, etc.). 5915 If the Printer object goes down at some value 'n', and comes back up, 5916 the implementation MAY: 5918 1. Know how long it has been down, and resume at some value greater 5919 than 'n', or 5920 2. Restart from 1. 5922 In the first case, the Printer SHOULD not tweak any existing related Job 5923 attributes ("time-at-creation", "time-at-processing", and "time-at- 5924 completed"). In the second case, the Printer object SHOULD reset those 5925 attributes to 0. If a client queries a time-related Job attribute and 5927 Expires August 17, 1999 5928 finds the value to be 0, the client MUST assume that the Job was 5929 submitted in some life other than the Printer's current life. 5931 4.4.27 printer-current-time (dateTime) 5933 This Printer attribute indicates the current absolute wall-clock time. 5934 If an implementation supports this attribute, then a client could 5935 calculate the absolute wall-clock time each Job's "time-at-creation", 5936 "time-at-processing", and "time-at-completed" attributes by using both 5937 "printer-up-time" and this attribute, "printer-current-time". If an 5938 implementation does not support this attribute, a client can only 5939 calculate the relative time of certain events based on the REQUIRED 5940 "printer-up-time" attribute. 5942 4.4.28 multiple-operation-time-out (integer(1:MAX)) 5944 This Printer attributes identifies the minimum time (in seconds) that 5945 the Printer object waits for additional Send-Document or Send-URI 5946 operations to follow a still-open multi-document Job object before 5947 taking any recovery actions, such as the ones indicated in section 5948 3.3.1. If the Printer object supports the Create-Job operation (see 5949 section 3.2.4), it MUST support this attribute. 5951 It is RECOMMENDED that vendors supply a value for this attribute that is 5952 between 60 and 240 seconds. An implementation MAY allow a system 5953 administrator to set this attribute (by means outside this IPP/1.1 5954 document). If so, the system administrator MAY be able to set values 5955 outside this range. 5957 4.4.29 compression-supported (1setOf type3 keyword) 5959 This Printer attribute identifies the set of supported compression 5960 algorithms for document data. Compression only applies to the document 5961 data; compression does not apply to the encoding of the IPP operation 5962 itself. The supported values are used to validate the client supplied 5963 "compression" operation attributes in Print-Job, Send-Document, and 5964 Send-URI requests. 5966 Standard values are : 5968 'none': no compression is used. 5969 'deflate': ZIP public domain inflate/deflate) compression technology 5970 'gzip' GNU zip compression technology described in RFC 1952 5971 [RFC1952]. 5972 'compress': UNIX compression technology 5974 4.4.30 job-k-octets-supported (rangeOfInteger(0:MAX)) 5976 This Printer attribute specifies the upper and lower bounds of total 5977 sizes of jobs in K octets, i.e., in units of 1024 octets. The supported 5978 values are used to validate the client supplied "job-k-octets" operation 5980 Expires August 17, 1999 5981 attributes in create requests. The corresponding job description 5982 attribute "job-k-octets" is defined in section 4.3.17. 5984 4.4.31 job-impressions-supported (rangeOfInteger(0:MAX)) 5986 This Printer attribute specifies the upper and lower bounds for the 5987 number of impressions per job. The supported values are used to validate 5988 the client supplied "job-impressions" operation attributes in create 5989 requests. The corresponding job description attribute "job-impressions" 5990 is defined in section 4.3.18. 5992 4.4.32 job-media-sheets-supported (rangeOfInteger(0:MAX)) 5994 This Printer attribute specifies the upper and lower bounds for the 5995 number of media sheets per job. The supported values are used to 5996 validate the client supplied "job-media-sheets" operation attributes in 5997 create requests. The corresponding Job attribute "job-media-sheets" is 5998 defined in section 4.3.19. 6000 4.4.33 pages-per-minute (integer(0:MAX)) 6002 This Printer attributes specifies the nominal number of pages per minute 6003 to the nearest whole number which may be generated by this printer 6004 (e.g., simplex, black-and-white). This attribute is informative, not a 6005 service guarantee. Generally, it is the value used in the marketing 6006 literature to describe the device. 6008 A value of 0 indicates a device that takes more than two minutes to 6009 process a page. 6011 4.4.34 pages-per-minute-color (integer(0:MAX)) 6013 This Printer attributes specifies the nominal number of pages per minute 6014 to the nearest whole number which may be generated by this printer when 6015 printing color (e.g., simplex, color). For purposes of this attribute, 6016 "color" means the same as for the "color-supported" attribute, namely, 6017 the device is capable of any type of color printing at all, including 6018 highlight color. This attribute is informative, not a service 6019 guarantee. Generally, it is the value used in the marketing literature 6020 to describe the color capabilities of this device. 6022 A value of 0 indicates a device that takes more than two minutes to 6023 process a page. 6025 Note: If a color device has several color modes, it MAY use the pages- 6026 per-minute value for this attribute that corresponds to the mode that 6027 produces the highest number. 6029 Black and white only printers MUST NOT support this attribute. If this 6030 attribute is present, then the "color-supported" Printer description 6031 attribute MUST be present and have a 'true' value. 6033 Expires August 17, 1999 6034 Note: The values of these two attributes returned by the Get-Printer- 6035 Attributes operation MAY be affected by the "document-format" attribute 6036 supplied by the client in the Get-Printer-Attributes request. In other 6037 words, the implementation MAY have different speeds depending on the 6038 document format being processed. See section 3.2.5.1 Get-Printer- 6039 Attributes. 6041 5. Conformance 6043 This section describes conformance issues and requirements. This 6044 document introduces model entities such as objects, operations, 6045 attributes, attribute syntaxes, and attribute values. These conformance 6046 sections describe the conformance requirements which apply to these 6047 model entities. 6049 5.1 Client Conformance Requirements 6051 A conforming client MUST support all REQUIRED operations as defined in 6052 this document. For each attribute included in an operation request, a 6053 conforming client MUST supply a value whose type and value syntax 6054 conforms to the requirements of the Model document as specified in 6055 Sections 3 and 3.3.5. A conforming client MAY supply any registered 6056 extensions and/or private extensions in an operation request, as long as 6057 they meet the requirements in Section 6. 6059 Otherwise, there are no conformance requirements placed on the user 6060 interfaces provided by IPP clients or their applications. For example, 6061 one application might not allow an end user to submit multiple documents 6062 per job, while another does. One application might first query a 6063 Printer object in order to supply a graphical user interface (GUI) 6064 dialogue box with supported and default values whereas a different 6065 implementation might not. 6067 When sending a request, an IPP client NEED NOT supply any attributes 6068 that are indicated as OPTIONALLY supplied by the client. 6070 A client MUST be able to accept any of the attribute syntaxes defined in 6071 Section 4.1, including their full range, that may be returned to it in a 6072 response from a Printer object. In particular for each attribute that 6073 the client supports whose attribute syntax is 'text', the client MUST 6074 accept and process both the 'textWithoutLanguage' and 'textWithLanguage' 6075 forms. Similarly, for each attribute that the client supports whose 6076 attribute syntax is 'name', the client MUST accept and process both the 6077 'nameWithoutLanguage' and 'nameWithLanguage' forms. For presentation 6078 purposes, truncation of long attribute values is not recommended. A 6079 recommended approach would be for the client implementation to allow the 6080 user to scroll through long attribute values. 6082 A query response may contain attribute groups, attributes, and values 6083 that the client does not expect. Therefore, a client implementation 6084 MUST gracefully handle such responses and not refuse to inter-operate 6086 Expires August 17, 1999 6087 with a conforming Printer that is returning extended registered or 6088 private attributes and/or attribute values that conform to Section 6. 6089 Clients may choose to ignore any parameters, attributes, or values that 6090 they do not understand. 6092 5.2 IPP Object Conformance Requirements 6094 This section specifies the conformance requirements for conforming 6095 implementations with respect to objects, operations, and attributes. 6097 5.2.1 Objects 6099 Conforming implementations MUST implement all of the model objects as 6100 defined in this specification in the indicated sections: 6102 Section 2.1 - Printer Object 6103 Section 2.2 - Job Object 6105 5.2.2 Operations 6107 Conforming IPP object implementations MUST implement all of the REQUIRED 6108 model operations, including REQUIRED responses, as defined in this 6109 specification in the indicated sections: 6111 For a Printer object: 6112 Print-Job (section 3.2.1) REQUIRED 6113 Print-URI (section 3.2.2) OPTIONAL 6114 Validate-Job (section 3.2.3) REQUIRED 6115 Create-Job (section 3.2.4) OPTIONAL 6116 Get-Printer-Attributes (section 3.2.5) REQUIRED 6117 Get-Jobs (section 3.2.6) REQUIRED 6118 Pause-Printer (section 3.2.7) OPTIONAL 6119 Resume-Printer (section 3.2.8) OPTIONAL 6120 Purge-Jobs (section 3.2.9) OPTIONAL 6122 For a Job object: 6123 Send-Document (section 3.3.1) OPTIONAL 6124 Send-URI (section 3.3.2) OPTIONAL 6125 Cancel-Job (section 3.3.3) REQUIRED 6126 Get-Job-Attributes (section 3.3.4) REQUIRED 6127 Hold-Job (section 3.3.5) OPTIONAL 6128 Release-Job (section 3.3.6) OPTIONAL 6129 Restart-Job (section 3.3.7) OPTIONAL 6131 Conforming IPP objects MUST support all REQUIRED operation attributes 6132 and all values of such attributes if so indicated in the description. 6133 Conforming IPP objects MUST ignore all unsupported or unknown operation 6134 attributes or operation attribute groups received in a request, but MUST 6135 reject a request that contains a supported operation attribute that 6136 contains an unsupported value. 6138 Expires August 17, 1999 6139 The following section on object attributes specifies the support 6140 required for object attributes. 6142 5.2.3 IPP Object Attributes 6144 Conforming IPP objects MUST support all of the REQUIRED object 6145 attributes, as defined in this specification in the indicated sections. 6147 If an object supports an attribute, it MUST support only those values 6148 specified in this document or through the extension mechanism described 6149 in section 5.2.4. It MAY support any non-empty subset of these values. 6150 That is, it MUST support at least one of the specified values and at 6151 most all of them. 6153 5.2.4 Versions 6155 Clients MUST support version 1.1 and MAY also support version 1.0. IPP 6156 objects MUST support both version 1.0 and 1.1. See section 3.1.7. 6158 5.2.5 Extensions 6160 A conforming IPP object MAY support registered extensions and private 6161 extensions, as long as they meet the requirements specified in Section 6162 6. 6164 For each attribute included in an operation response, a conforming IPP 6165 object MUST return a value whose type and value syntax conforms to the 6166 requirement of the Model document as specified in Sections 3 and 3.3.5. 6168 5.2.6 Attribute Syntaxes 6170 An IPP object MUST be able to accept any of the attribute syntaxes 6171 defined in Section 4.1, including their full range, in any operation in 6172 which a client may supply attributes or the system administrator may 6173 configure attributes (by means outside the scope of this IPP/1.1 6174 document). In particular for each attribute that the IPP object 6175 supports whose attribute syntax is 'text', the IPP object MUST accept 6176 and process both the 'textWithoutLanguage' and 'textWithLanguage' forms. 6177 Similarly, for each attribute that the IPP object supports whose 6178 attribute syntax is 'name', the IPP object MUST accept and process both 6179 the 'nameWithoutLanguage' and 'nameWithLanguage' forms. Furthermore, an 6180 IPP object MUST return attributes to the client in operation responses 6181 that conform to the syntax specified in Section 4.1, including their 6182 full range if supplied previously by a client. 6184 5.3 Charset and Natural Language Requirements 6186 All clients and IPP objects MUST support the 'utf-8' charset as defined 6187 in section 4.1.7. 6189 Expires August 17, 1999 6190 IPP objects MUST be able to accept any client request which correctly 6191 uses the "attributes-natural-language" operation attribute or the 6192 Natural Language Override mechanism on any individual attribute whether 6193 or not the natural language is supported by the IPP object. If an IPP 6194 object supports a natural language, then it MUST be able to translate 6195 (perhaps by table lookup) all generated 'text' or 'name' attribute 6196 values into one of the supported languages (see section 3.1.4). That 6197 is, the IPP object that supports a natural language NEED NOT be a 6198 general purpose translator of any arbitrary 'text' or 'name' value 6199 supplied by the client into that natural language. However, the object 6200 MUST be able to translate (automatically generate) any of its own 6201 attribute values and messages into that natural language. 6203 5.4 Security Conformance Requirements 6205 Conforming IPP Printer objects SHOULD support Transport Layer Security 6206 (TLS) protocol Version 1 (TLS) [RFC2246] access, MAY support access 6207 without TLS, or MAY support both means of access. 6209 Conforming IPP clients SHOULD support TLS access and non-TLS access. 6210 Note: This client recommendation to support both means that conforming 6211 IPP clients will be able to inter-operate with any IPP Printer object. 6213 For a detailed discussion of security considerations and the IPP 6214 application security profile required for TLS support, see section 8. 6216 6. IANA Considerations (registered and private extensions) 6218 This section describes how IPP can be extended to allow the following 6219 registered and private extensions to IPP: 6221 1. keyword attribute values 6222 2. enum attribute values 6223 3. attributes 6224 4. attribute syntaxes 6225 5. operations 6226 6. attribute groups 6227 7. status codes 6229 Extensions registered for use with IPP/1.1 are OPTIONAL for client and 6230 IPP object conformance to the IPP/1.1 Model specification. 6232 These extension procedures are aligned with the guidelines as set forth 6233 by the IESG [IANA-CON]. Section 12 describes how to propose new 6234 registrations for consideration. IANA will reject registration 6235 proposals that leave out required information or do not follow the 6236 appropriate format described in Section 12. IPP/1.1 may also be 6237 extended by an appropriate RFC that specifies any of the above 6238 extensions. 6240 Expires August 17, 1999 6241 6.1 Typed 'keyword' and 'enum' Extensions 6243 IPP allows for 'keyword' and 'enum' extensions (see sections 4.1.2.3 and 6244 4.1.4). This document uses prefixes to the 'keyword' and 'enum' basic 6245 attribute syntax type in order to communicate extra information to the 6246 reader through its name. This extra information is not represented in 6247 the protocol because it is unimportant to a client or Printer object. 6248 The list below describes the prefixes and their meaning. 6250 "type1": The IPP specification must be revised to add a new keyword 6251 or a new enum. No private keywords or enums are allowed. 6253 "type2": Implementers can, at any time, add new keyword or enum 6254 values by proposing the complete specification to IANA: 6256 iana@iana.org 6258 IANA will forward the registration proposal to the IPP Designated 6259 Expert who will review the proposal with a mailing list that the 6260 Designated Expert keeps for this purpose. Initially, that list 6261 will be the mailing list used by the IPP WG: 6263 ipp@pwg.org 6265 even after the IPP WG is disbanded as permitted by [IANA-CON]. The 6266 IPP Designated Expert is appointed by the IESG Area Director 6267 responsible for IPP, according to [IANA-CON]. 6269 When a type2 keyword or enum is approved, the IPP Designated Expert 6270 becomes the point of contact for any future maintenance that might 6271 be required for that registration. 6273 "type3": Implementers can, at any time, add new keyword and enum 6274 values by submitting the complete specification to IANA as for 6275 type2 who will forward the proposal to the IPP Designated Expert. 6276 While no additional technical review is required, the IPP 6277 Designated Expert may, at his/her discretion, forward the proposal 6278 to the same mailing list as for type2 registrations for advice and 6279 comment. 6281 When a type3 keyword or enum is approved by the IPP Designated 6282 Expert, the original proposer becomes the point of contact for any 6283 future maintenance that might be required for that registration. 6285 For type2 and type3 keywords, the proposer includes the name of the 6286 keyword in the registration proposal and the name is part of the 6287 technical review. 6289 After type2 and type3 enums specifications are approved, the IPP 6290 Designated Expert in consultation with IANA assigns the next available 6291 enum number for each enum value. 6293 Expires August 17, 1999 6294 IANA will publish approved type2 and type3 keyword and enum attributes 6295 value registration specifications in: 6297 ftp.isi.edu/iana/assignments/ipp/attribute-values/xxx/yyy.txt 6299 where xxx is the attribute name that specifies the initial values and 6300 yyy.txt is a descriptive file name that contains one or more enums or 6301 keywords approved at the same time. For example, if several additional 6302 enums for stapling are approved for use with the "finishings" attribute 6303 (and "finishings-default" and "finishings-supported" attributes), IANA 6304 will publish the additional values in the file: 6306 ftp.isi.edu/iana/assignments/ipp/attribute- 6307 values/finishings/stapling.txt. 6309 Note: Some attributes are defined to be: 'type3 keywords' | 'name' which 6310 allows for attribute values to be extended by a site administrator with 6311 administrator defined names. Such names are not registered with IANA. 6313 By definition, each of the three types above assert some sort of 6314 registry or review process in order for extensions to be considered 6315 valid. Each higher numbered level (1, 2, 3) tends to be decreasingly 6316 less stringent than the previous level. Therefore, any typeN value MAY 6317 be registered using a process for some typeM where M is less than N, 6318 however such registration is NOT REQUIRED. For example, a type3 value 6319 MAY be registered in a type 1 manner (by being included in a future 6320 version of an IPP specification), however, it is NOT REQUIRED. 6322 This specification defines keyword and enum values for all of the above 6323 types, including type3 keywords. 6325 For private (unregistered) keyword extensions, implementers SHOULD use 6326 keywords with a suitable distinguishing prefix, such as "xxx-" where xxx 6327 is the (lowercase) fully qualified company name registered with IANA for 6328 use in domain names [RFC1035]. For example, if the company XYZ Corp. 6329 had obtained the domain name "XYZ.com", then a private keyword 'abc' 6330 would be: 'xyz.com-abc'. 6332 Note: RFC 1035 [RFC1035] indicates that while upper and lower case 6333 letters are allowed in domain names, no significance is attached to the 6334 case. That is, two names with the same spelling but different case are 6335 to be treated as if identical. Also, the labels in a domain name must 6336 follow the rules for ARPANET host names: They must start with a letter, 6337 end with a letter or digit, and have as interior characters only 6338 letters, digits, and hyphen. Labels must be 63 characters or less. 6339 Labels are separated by the "." character. 6341 For private (unregistered) enum extension, implementers MUST use values 6342 in the reserved integer range which is 2**30 to 2**31-1. 6344 Expires August 17, 1999 6345 6.2 Attribute Extensibility 6347 Attribute names are type2 keywords. Therefore, new attributes may be 6348 registered and have the same status as attributes in this document by 6349 following the type2 extension rules. For private (unregistered) 6350 attribute extensions, implementers SHOULD use keywords with a suitable 6351 distinguishing prefix as described in Section 6.1. 6353 IANA will publish approved attribute registration specifications as 6354 separate files: 6356 ftp.isi.edu/iana/assignments/ipp/attributes/xxx-yyy.txt 6358 where "xxx-yyy" is the new attribute name. 6360 If a new Printer object attribute is defined and its values can be 6361 affected by a specific document format, its specification needs to 6362 contain the following sentence: 6364 "The value of this attribute returned in a Get-Printer- 6365 Attributes response MAY depend on the "document-format" 6366 attribute supplied (see Section 3.2.5.1)." 6368 If the specification does not, then its value in the Get-Printer- 6369 Attributes response MUST NOT depend on the "document-format" supplied in 6370 the request. When a new Job Template attribute is registered, the value 6371 of the Printer attributes MAY vary with "document-format" supplied in 6372 the request without the specification having to indicate so. 6374 6.3 Attribute Syntax Extensibility 6376 Attribute syntaxes are like type2 enums. Therefore, new attribute 6377 syntaxes may be registered and have the same status as attribute 6378 syntaxes in this document by following the type2 extension rules 6379 described in Section 6.1. The value codes that identify each of the 6380 attribute syntaxes are assigned in the "Encoding and Transport" 6381 specification [IPP-PRO], including a designated range for private, 6382 experimental use. 6384 For attribute syntaxes, the IPP Designated Expert in consultation with 6385 IANA assigns the next attribute syntax code in the appropriate range as 6386 specified in [IPP-PRO]. IANA will publish approved attribute syntax 6387 registration specifications as separate files: 6389 ftp.isi.edu/iana/assignments/ipp/attribute-syntaxes/xxx-yyy.txt 6391 where 'xxx-yyy' is the new attribute syntax name. 6393 Expires August 17, 1999 6394 6.4 Operation Extensibility 6396 Operations may also be registered following the type2 procedures 6397 described in Section 6.1, though major new operations will usually be 6398 done by a new standards track RFC that augments this document. For 6399 private (unregistered) operation extensions, implementers MUST use the 6400 range for the "operation-id" in requests specified in Section 4.4.13 6401 "operations-supported" Printer attribute. 6403 For operations, the IPP Designated Expert in consultation with IANA 6404 assigns the next operation-id code as specified in Section 4.4.13. IANA 6405 will publish approved operation registration specifications as separate 6406 files: 6408 ftp.isi.edu/iana/assignments/ipp/operations/Xxx-Yyy.txt 6410 where "Xxx-Yyy" is the new operation name. 6412 6.5 Attribute Groups 6414 Attribute groups passed in requests and responses may be registered 6415 following the type2 procedures described in Section 6.1. The tags that 6416 identify each of the attribute groups are assigned in [IPP-PRO]. 6418 For attribute groups, the IPP Designated Expert in consultation with 6419 IANA assigns the next attribute group tag code in the appropriate range 6420 as specified in [IPP-PRO]. IANA will publish approved attribute group 6421 registration specifications as separate files: 6423 ftp.isi.edu/iana/assignments/ipp/attribute-group-tags/xxx-yyy- 6424 tag.txt 6426 where 'xxx-yyy-tag' is the new attribute group tag name. 6428 6.6 Status Code Extensibility 6430 Operation status codes may also be registered following the type2 6431 procedures described in Section 6.1. The values for status codes are 6432 allocated in ranges as specified in Section 14 for each status code 6433 class: 6435 "informational" - Request received, continuing process 6436 "successful" - The action was successfully received, understood, and 6437 accepted 6438 "redirection" - Further action must be taken in order to complete the 6439 request 6440 "client-error" - The request contains bad syntax or cannot be 6441 fulfilled 6442 "server-error" - The IPP object failed to fulfill an apparently 6443 valid request 6445 Expires August 17, 1999 6447 For private (unregistered) operation status code extensions, 6448 implementers MUST use the top of each range as specified in Section 14. 6450 For operation status codes, the IPP Designated Expert in consultation 6451 with IANA assigns the next status code in the appropriate class range as 6452 specified in Section 14. IANA will publish approved status code 6453 registration specifications as separate files: 6455 ftp.isi.edu/iana/assignments/ipp/status-codes/xxx-yyy.txt 6457 where "xxx-yyy" is the new operation status code keyword. 6459 6.7 Registration of MIME types/sub-types for document-formats 6461 The "document-format" attribute's syntax is 'mimeMediaType'. This means 6462 that valid values are Internet Media Types (see Section 4.1.9). RFC 6463 2045 [RFC2045] defines the syntax for valid Internet media types. IANA 6464 is the registry for all Internet media types. 6466 6.8 Registration of charsets for use in 'charset' attribute values 6468 The "attributes-charset" attribute's syntax is 'charset'. This means 6469 that valid values are charsets names. When a charset in the IANA 6470 registry has more than one name (alias), the name labeled as "(preferred 6471 MIME name)", if present, MUST be used (see Section 4.1.7). IANA is the 6472 registry for charsets following the procedures of [RFC2278]. 6474 7. Internationalization Considerations 6476 Some of the attributes have values that are text strings and names which 6477 are intended for human understanding rather than machine understanding 6478 (see the 'text' and 'name' attribute syntaxes in Sections 4.1.1 and 6479 4.1.2). 6481 In each operation request, the client 6483 - identifies the charset and natural language of the request which 6484 affects each supplied 'text' and 'name' attribute value, and 6485 - requests the charset and natural language for attributes returned 6486 by the IPP object in operation responses (as described in Section 6487 3.1.4.1). 6489 In addition, the client MAY separately and individually identify the 6490 Natural Language Override of a supplied 'text' or 'name' attribute using 6491 the 'textWithLanguage' and 'nameWithLanguage' technique described 6492 section 4.1.1.2 and 4.1.2.2 respectively. 6494 All IPP objects MUST support the UTF-8 [RFC2279] charset in all 'text' 6495 and 'name' attributes supported. If an IPP object supports more than 6496 the UTF-8 charset, the object MUST convert between them in order to 6497 return the requested charset to the client according to Section 3.1.4.2. 6499 Expires August 17, 1999 6500 If an IPP object supports more than one natural language, the object 6501 SHOULD return 'text' and 'name' values in the natural language requested 6502 where those values are generated by the Printer (see Section 3.1.4.1). 6504 For Printers that support multiple charsets and/or multiple natural 6505 languages in 'text' and 'name' attributes, different jobs may have been 6506 submitted in differing charsets and/or natural languages. All responses 6507 MUST be returned in the charset requested by the client. However, the 6508 Get-Jobs operation uses the 'textWithLanguage' and 'nameWithLanguage' 6509 mechanism to identify the differing natural languages with each job 6510 attribute returned. 6512 The Printer object also has configured charset and natural language 6513 attributes. The client can query the Printer object to determine the 6514 list of charsets and natural languages supported by the Printer object 6515 and what the Printer object's configured values are. See the "charset- 6516 configured", "charset-supported", "natural-language-configured", and 6517 "generated-natural-language-supported" Printer description attributes 6518 for more details. 6520 The "charset-supported" attributed identifies the supported charsets. 6521 If a charset is supported, the IPP object MUST be capable of converting 6522 to and from that charset into any other supported charset. In many 6523 cases, an IPP object will support only one charset and it MUST be the 6524 UTF-8 charset. 6526 The "charset-configured" attribute identifies the one supported charset 6527 which is the native charset given the current configuration of the IPP 6528 object (administrator defined). 6530 The "generated-natural-language-supported" attribute identifies the set 6531 of supported natural languages for generated messages; it is not related 6532 to the set of natural languages that must be accepted for client 6533 supplied 'text' and 'name' attributes. For client supplied 'text' and 6534 'name' attributes, an IPP object MUST accept ALL supplied natural 6535 languages. Just because a Printer object is currently configured to 6536 support 'en-us' natural language does not mean that the Printer object 6537 should reject a job if the client supplies a job name that is in 'fr- 6538 ca'. 6540 The "natural-language-configured" attribute identifies the one supported 6541 natural language for generated messages which is the native natural 6542 language given the current configuration of the IPP object 6543 (administrator defined). 6545 Attributes of type 'text' and 'name' are populated from different 6546 sources. These attributes can be categorized into following groups 6547 (depending on the source of the attribute): 6549 1. Some attributes are supplied by the client (e.g., the client 6550 supplied "job-name", "document-name", and "requesting-user-name" 6551 operation attributes along with the corresponding Job object's 6552 "job-name" and "job-originating-user-name" attributes). The IPP 6554 Expires August 17, 1999 6555 object MUST accept these attributes in any natural language no 6556 matter what the set of supported languages for generated messages 6557 2. Some attributes are supplied by the system administrator (e.g., 6558 the Printer object's "printer-name" and "printer-location" 6559 attributes). These too can be in any natural language. If the 6560 natural language for these attributes is different than what a 6561 client requests, then they must be reported using the Natural 6562 Language Override mechanism. 6563 3. Some attributes are supplied by the device manufacturer (e.g., the 6564 Printer object's "printer-make-and-model" attribute). These too 6565 can be in any natural language. If the natural language for these 6566 attributes is different than what a client requests, then they must 6567 be reported using the Natural Language Override mechanism. 6568 4. Some attributes are supplied by the operator (e.g., the Job 6569 object's "job-message-from-operator" attribute). These too can be 6570 in any natural language. If the natural language for these 6571 attributes is different than what a client requests, then they must 6572 be reported using the Natural Language Override mechanism. 6573 5. Some attributes are generated by the IPP object (e.g., the Job 6574 object's "job-state-message" attribute, the Printer object's 6575 "printer-state-message" attribute, and the "status-message" 6576 operation attribute). These attributes can only be in one of the 6577 "generated-natural-language-supported" natural languages. If a 6578 client requests some natural language for these attributes other 6579 than one of the supported values, the IPP object SHOULD respond 6580 using the value of the "natural-language-configured" attribute 6581 (using the Natural Language Override mechanism if needed). 6583 The 'text' and 'name' attributes specified in this version of this 6584 document (additional ones will be registered according to the procedures 6585 in Section 6) are: 6587 Attributes Source 6588 -------------------------- ---------- 6589 Operation Attributes 6590 job-name (name) client 6591 document-name (name) client 6592 requesting-user-name (name) client 6593 status-message Job or Printer object 6595 Job Template Attributes: 6596 job-hold-until (keyword | name) client matches administrator- 6597 configured 6598 job-hold-until-default (keyword | name) client matches 6599 administrator-configured 6600 job-hold-until-supported (keyword | name) client matches 6601 administrator-configured 6602 job-sheets (keyword | name) client matches administrator- 6603 configured 6604 job-sheets-default (keyword | name) client matches 6605 administrator-configured 6606 job-sheets-supported (keyword | name) client matches 6607 administrator-configured 6609 Expires August 17, 1999 6610 media (keyword | name) client matches administrator- 6611 configured 6612 media-default (keyword | name) client matches administrator- 6613 configured 6614 media-supported (keyword | name) client matches administrator- 6615 configured 6616 media-ready (keyword | name) client matches administrator- 6617 configured 6619 Job Description Attributes: 6620 job-name (name) client or Printer object 6621 job-originating-user-name (name) Printer object 6622 job-state-message (text) Job or Printer object 6623 output-device-assigned (name(127)) administrator 6624 job-message-from-operator (text(127)) operator 6626 Printer Description Attributes: 6627 printer-name (name(127)) administrator 6628 printer-location (text(127)) administrator 6629 printer-info (text(127)) administrator 6630 printer-make-and-model (text(127)) administrator or manufacturer 6631 printer-state-message (text) Printer object 6632 printer-message-from-operator (text(127)) operator 6634 8. Security Considerations 6636 IPP objects SHOULD be deployed over protocol stacks that support the 6637 Transport Layer Security (TLS) protocol [RFC2246]. Other IPP objects 6638 MAY be deployed over protocol stacks that do not support TLS. Some IPP 6639 objects MAY be deployed over both types of protocol stacks. Those IPP 6640 objects that support TLS, are capable of supporting mutual 6641 authentication as well as privacy of messages via multiple encryption 6642 schemes. An important point about security related information for TLS 6643 access to an IPP object, is that the security-related parameters 6644 (authentication, encryption keys, etc.) are "out-of-band" to the actual 6645 IPP protocol. 6647 An IPP object that does not support TLS MAY elect to support a transport 6648 layer that provides other security mechanisms. For example, in a 6649 mapping of IPP over HTTP/1.1 [IPP-PRO], if the IPP object does not 6650 support TLS, HTTP still allows for client authentication using Digest 6651 Access Authentication (DAA) [RFC2069]. 6653 It is difficult to anticipate the security risks that might exist in any 6654 given IPP environment. For example, if IPP is used within a given 6655 corporation over a private network, the risks of exposing document data 6656 may be low enough that the corporation will choose not to use encryption 6657 on that data. However, if the connection between the client and the IPP 6658 object is over a public network, the client may wish to protect the 6659 content of the information during transmission through the network with 6660 encryption. 6662 Expires August 17, 1999 6663 Furthermore, the value of the information being printed may vary from 6664 one IPP environment to the next. Printing payroll checks, for example, 6665 would have a different value than printing public information from a 6666 file. There is also the possibly of denial-of-service attacks, but 6667 denial-of-service attacks against printing resources are not well 6668 understood and there is no published precedents regarding this scenario. 6670 Once the authenticated identity of the requester has been supplied to 6671 the IPP object, the object uses that identity to enforce any 6672 authorization policy that might be in place. For example, one site's 6673 policy might be that only the job owner is allowed to cancel a job. The 6674 details and mechanisms to set up a particular access control policy are 6675 not part of IPP/1.1, and must be established via some other type of 6676 administrative or access control framework. However, there are 6677 operation status codes that allow an IPP server to return information 6678 back to a client about any potential access control violations for an 6679 IPP object. 6681 During a create operation, the client's identity is recorded in the Job 6682 object in an implementation-defined attribute. This information can be 6683 used to verify a client's identity for subsequent operations on that Job 6684 object in order to enforce any access control policy that might be in 6685 effect. See section 8.3 below for more details. 6687 Since the security levels or the specific threats that any given IPP 6688 system administrator may be concerned with cannot be anticipated, IPP 6689 MUST be capable of operating with different security mechanisms and 6690 security policies as required by the individual installation. Security 6691 policies might vary from very strong, to very weak, to none at all, and 6692 corresponding security mechanisms will be required. TLS supports the 6693 type of negotiated levels of security required by most, if not all, 6694 potential IPP environments. IPP environments that require no security 6695 can elect to deploy IPP objects that do not utilize the optional TLS 6696 security mechanisms. 6698 8.1 Security Scenarios 6700 The following sections describe specific security attacks for IPP 6701 environments. Where examples are provided they should be considered 6702 illustrative of the environment and not an exhaustive set. Not all of 6703 these environments will necessarily be addressed in initial 6704 implementations of IPP. 6706 8.1.1 Client and Server in the Same Security Domain 6708 This environment is typical of internal networks where traditional 6709 office workers print the output of personal productivity applications on 6710 shared work-group printers, or where batch applications print their 6711 output on large production printers. Although the identity of the user 6712 may be trusted in this environment, a user might want to protect the 6713 content of a document against such attacks as eavesdropping, replaying 6714 or tampering. 6716 Expires August 17, 1999 6717 8.1.2 Client and Server in Different Security Domains 6719 Examples of this environment include printing a document created by the 6720 client on a publicly available printer, such as at a commercial print 6721 shop; or printing a document remotely on a business associate's printer. 6722 This latter operation is functionally equivalent to sending the document 6723 to the business associate as a facsimile. Printing sensitive information 6724 on a Printer in a different security domain requires strong security 6725 measures. In this environment authentication of the printer is required 6726 as well as protection against unauthorized use of print resources. Since 6727 the document crosses security domains, protection against eavesdropping 6728 and document tampering are also required. It will also be important in 6729 this environment to protect Printers against "spamming" and malicious 6730 document content. 6732 8.1.3 Print by Reference 6734 When the document is not stored on the client, printing can be done by 6735 reference. That is, the print request can contain a reference, or 6736 pointer, to the document instead of the actual document itself. Standard 6737 methods currently do not exist for remote entities to "assume" the 6738 credentials of a client for forwarding requests to a 3rd party. It is 6739 anticipated that Print-By-Reference will be used to access "public" 6740 documents and that sophisticated methods for authenticating "proxies" 6741 will not be specified for version 1 of IPP. 6743 8.2 URIs for TLS and non-TLS Access 6745 As described earlier, an IPP object SHOULD support TLS access, MAY non- 6746 TLS access, or both. The "printer-uri-supported" attribute contains the 6747 Printer object's URI(s). Its companion attribute, "uri-security- 6748 supported", identifies the security mechanism used for each URI listed 6749 in the "printer-uri-supported" attribute. For each Printer operation 6750 request, a client MUST supply only one URI in the "printer-uri" 6751 operation attribute. In other words, even though the Printer supports 6752 more than one URI, the client only interacts with the Printer object 6753 using one if its URIs. This duality is not needed for Job objects, 6754 since the Printer objects is the factory for Job objects, and the 6755 Printer object will generate the correct URI for new Job objects 6756 depending on the Printer object's security configuration. 6758 8.3 The "requesting-user-name" (name(MAX)) Operation Attribute 6760 Each operation MUST specify the user who is performing the operation in 6761 both of the following two ways: 6763 1) via the REQUIRED "requesting-user-name" operation attribute that a 6764 client SHOULD supply in all operations. The client MUST obtain the 6765 value for this attribute from an environmental or network login 6766 name for the user, rather than allowing the user to supply any 6767 value. If the client does not supply a value for "requesting-user- 6769 Expires August 17, 1999 6770 name", the printer MUST assume that the client is supplying some 6771 anonymous name, such as "anonymous". 6772 2) via an authentication mechanism of the underlying transport which 6773 may be configured to give no authentication information. 6775 There are six cases to consider: 6777 a) the authentication mechanism gives no information, and the client 6778 doesn't specify "requesting-user-name". 6779 b) the authentication mechanism gives no information, but the client 6780 specifies "requesting-user-name". 6781 c) the authentication mechanism specifies a user which has no human 6782 readable representation, and the client doesn't specify 6783 "requesting-user-name". 6784 d) the authentication mechanism specifies a user which has no human 6785 readable representation, but the client specifies "requesting-user- 6786 name". 6787 e) the authentication mechanism specifies a user which has a human 6788 readable representation. The Printer object ignores the 6789 "requesting-user-name". 6790 f) the authentication mechanism specifies a user who is trusted and 6791 whose name means that the value of the "requesting-user-name", 6792 which MUST be present, is treated as the authenticated name. 6794 Note: Case "f" is intended for a tightly coupled gateway and server to 6795 work together so that the "user" name is able to be that of the gateway 6796 client and not that of the gateway. Because most, if not all, system 6797 vendors will initially implement IPP via a gateway into their existing 6798 print system, this mechanism is necessary unless the authentication 6799 mechanism allows a gateway (client) to act on behalf of some other 6800 client. 6802 The user-name has two forms: 6804 - one that is human readable: it is held in the REQUIRED "job- 6805 originating-user-name" Job Description attribute which is set 6806 during the job creation operations. It is used for presentation 6807 only, such as returning in queries or printing on start sheets 6808 - one for authorization: it is held in an undefined (by IPP) Job 6809 object attribute which is set by the job creation operation. It is 6810 used to authorize other operations, such as Send-Document, Send- 6811 URI, Cancel-Job, to determine the user when the "my-jobs" attribute 6812 is specified with Get-Jobs, and to limit what attributes and values 6813 to return with Get-Job-Attributes and Get-Jobs. 6815 The human readable user name: 6817 - is the value of the "requesting-user-name" for cases b, d and f. 6818 - comes from the authentication mechanism for case e 6819 - is some anonymous name, such as "anonymous" for cases a and c. 6821 The user name used for authorization: 6823 - is the value of the "requesting-user-name" for cases b and f. 6825 Expires August 17, 1999 6826 - comes from the authentication mechanism for cases c, d and e 6827 - is some anonymous name, such as "anonymous" for case a. 6829 The essence of these rules for resolving conflicting sources of user- 6830 names is that a printer implementation is free to pick either source as 6831 long as it achieves consistent results. That is, if a user uses the 6832 same path for a series of requests, the requests MUST appear to come 6833 from the same user from the standpoint of both the human-readable user 6834 name and the user name for authorization. This rule MUST continue to 6835 apply even if a request could be authenticated by two or more 6836 mechanisms. It doesn't matter which of several authentication 6837 mechanisms a Printer uses as long as it achieves consistent results. If 6838 a client uses more than one authentication mechanism, it is recommended 6839 that an administrator make all credentials resolve to the same user and 6840 user-name as much as possible. 6842 8.4 Restricted Queries 6844 In many IPP operations, a client supplies a list of attributes to be 6845 returned in the response. For security reasons, an IPP object may be 6846 configured not to return all attributes (or all values) that a client 6847 requests. The job attributes returned MAY depend on whether the 6848 requesting user is the same as the user that submitted the job. The IPP 6849 object MAY even return none of the requested attributes. In such cases, 6850 the status returned is the same as if the object had returned all 6851 requested attributes. The client cannot tell by such a response whether 6852 the requested attribute was present or absent on the object. 6854 8.5 Operations performed by operators and system administrators 6856 For the three printer operations Pause-Printer, Resume-Printer, and 6857 Purge-Jobs (see sections 3.2.7, 3.2.8 and 3.2.9), the requesting user is 6858 intended to be an operator or administrator of the Printer object (see 6859 section 1). The means for authorizing an operator or administrator of 6860 the Printer object are not specified in this document. 6862 8.6 Queries on jobs submitted using non-IPP protocols 6864 If the device that an IPP Printer is representing is able to accept jobs 6865 using other job submission protocols in addition to IPP, it is 6866 RECOMMENDED that such an implementation at least allow such "foreign" 6867 jobs to be queried using Get-Jobs returning "job-id" and "job-uri" as 6868 'unknown'. Such an implementation NEED NOT support all of the same IPP 6869 job attributes as for IPP jobs. The IPP object returns the 'unknown' 6870 out-of-band value for any requested attribute of a foreign job that is 6871 supported for IPP jobs, but not for foreign jobs. 6873 It is further RECOMMENDED, that the IPP Printer generate "job-id" and 6874 "job-uri" values for such "foreign jobs", if possible, so that they may 6875 be targets of other IPP operations, such as Get-Job-Attributes and 6876 Cancel-Job. Such an implementation also needs to deal with the problem 6878 Expires August 17, 1999 6879 of authentication of such foreign jobs. One approach would be to treat 6880 all such foreign jobs as belonging to users other than the user of the 6881 IPP client. Another approach would be for the foreign job to belong to 6882 'anonymous'. Only if the IPP client has been authenticated as an 6883 operator or administrator of the IPP Printer object, could the foreign 6884 jobs be queried by an IPP request. Alternatively, if the security 6885 policy is to allow users to query other users' jobs, then the foreign 6886 jobs would also be visible to an end-user IPP client using Get-Jobs and 6887 Get-Job-Attributes. 6889 8.7 IPP Security Application Profile for TLS 6891 The IPP application profile for TLS follows the standard "Mandatory 6892 Cipher Suites" requirement as documented in the TLS specification 6893 [RFC2246]. 6895 If a conforming IPP object supports TLS, it MUST implement and support 6896 the "Mandatory Cipher Suites" as specified in the TLS specification 6897 [RFC2246] and MAY support additional cipher suites. 6899 A conforming IPP client SHOULD support TLS including the "Mandatory 6900 Cipher Suites" as specified in the TLS specification [RFC2246]. A 6901 conforming IPP client MAY support additional cipher suites. Client 6902 implementations MUST NOT assume any other cipher suites are supported by 6903 an IPP Printer object. 6905 9. See the TLS specification [RFC2246] for a discussion of any 6906 government export restrictions on implementations conforming to the 6907 "Mandatory Cipher Suites". References 6909 [ASCII] 6910 Coded Character Set - 7-bit American Standard Code for Information 6911 Interchange (ASCII), ANSI X3.4-1986. This standard is the 6912 specification of the US-ASCII charset. 6914 [BCP-11] 6915 Bradner S., Hovey R., "The Organizations Involved in the IETF 6916 Standards Process", 1996/10/29 (RFC 2028) 6918 [HTPP] 6919 J. Barnett, K. Carter, R. DeBry, "Initial Draft - Hypertext 6920 Printing Protocol - HTPP/1.0", October 1996, 6921 ftp://ftp.pwg.org/pub/pwg/ipp/historic/htpp/overview.ps.gz 6923 [IANA-CON] 6924 Narte, T. and Alvestrand, H.T.: Guidelines for Writing an IANA 6925 Considerations Section in RFCs, Work in Progress, draft-iesg-iana- 6926 considerations-04.txt, May 21, 1998. 6928 Expires August 17, 1999 6930 [IANA-CS] 6931 IANA Registry of Coded Character Sets: ftp://ftp.isi.edu/in- 6932 notes/iana/assignments/character-sets 6934 [IANA-MT] 6935 IANA Registry of Media Types: ftp://ftp.isi.edu/in- 6936 notes/iana/assignments/media-types/ 6938 [IPP-IIG] 6939 Hastings, T., Manros, C., "Internet Printing Protocol/1.1: draft- 6940 ietf-ipp-implementers-guide-v11-??.txt, ?? 1999, work in progress. 6942 [IPP-IIG1.0] 6943 Hastings, T., Manros, C., "Internet Printing Protocol/1.0: 6944 Implementer's Guide", draft-ietf-ipp-implementers-guide-01.txt, 6945 February 1999, work in progress. 6947 [IPP LPD] 6948 Herriot, R., Hastings, T., Jacobs, N., Martin, J., "Mapping between 6949 LPD and IPP Protocols", draft-ietf-ipp-lpd-ipp-map-05.txt, November 6950 1998. 6952 [IPP-MOD1.0] 6953 R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell, 6954 "Internet Printing Protocol/1.0: Model and Semantics", draft-ietf- 6955 ipp-model-11.txt, November, 1998. 6957 [IPP-PRO] 6958 Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing 6959 Protocol/1.1: Encoding and Transport", draft-ietf-ipp-protocol-v11- 6960 00.txt, February, 1999. 6962 [IPP-PRO1.0] 6963 Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing 6964 Protocol/1.0: Encoding and Transport", draft-ietf-ipp-protocol- 6965 07.txt, November, 1998. 6967 [IPP-RAT] 6968 Zilles, S., "Rationale for the Structure and Model and Protocol for 6969 the Internet Printing Protocol", draft-ietf-ipp-rat-04.txt, 6970 November, 1998. 6972 [IPP-REQ] 6973 Wright, D., "Design Goals for an Internet Printing Protocol", 6974 draft-ietf-ipp-req-03.txt, November, 1998. 6976 [ISO10646-1] 6977 ISO/IEC 10646-1:1993, "Information technology -- Universal 6978 Multiple-Octet Coded Character Set (UCS) - Part 1: Architecture and 6979 Basic Multilingual Plane, JTC1/SC2." 6981 [ISO8859-1] 6982 ISO/IEC 8859-1:1987, "Information technology -- 8-bit One-Byte 6983 Coded Character Set - Part 1: Latin Alphabet Nr 1", 1987, JTC1/SC2. 6985 Expires August 17, 1999 6987 [ISO10175] 6988 ISO/IEC 10175 Document Printing Application (DPA), June 1996. 6990 [LDPA] 6991 T. Hastings, S. Isaacson, M. MacKay, C. Manros, D. Taylor, P. 6992 Zehler, "LDPA - Lightweight Document Printing Application", 6993 October 1996, 6994 ftp://ftp.pwg.org/pub/pwg/ipp/historic/ldpa/ldpa8.pdf.gz 6996 [P1387.4] 6997 Kirk, M. (editor), POSIX System Administration - Part 4: Printing 6998 Interfaces, POSIX 1387.4 D8, 1994. 7000 [PSIS] Herriot, R. (editor), X/Open A Printing System 7001 Interoperability Specification (PSIS), August 1995. 7003 [PWG] 7004 Printer Working Group, http://www.pwg.org. 7006 [RFC1035] 7007 P. Mockapetris, "DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION", 7008 RFC 1035, November 1987. 7010 [RFC1179] 7011 McLaughlin, L. III, (editor), "Line Printer Daemon Protocol" RFC 7012 1179, August 1990. 7014 [RFC1759] 7015 Smith, R., Wright, F., Hastings, T., Zilles, S., and Gyllenskog, 7016 J., "Printer MIB", RFC 1759, March 1995. 7018 [RFC1766] 7019 H. Alvestrand, "Tags for the Identification of Languages", RFC 7020 1766, March 1995. 7022 [RFC1903] 7023 J. Case, et.al., "Textual Conventions for Version 2 of the Simple 7024 Network Management Protocol (SNMP v2)" RFC 1903, January 1996. 7026 [RFC1952] 7027 P. Deutsch, "GZIP file format specification version 4.3", RFC 1952, 7028 May 1996. 7030 [RFC2026] 7031 S. Bradner, "The Internet Standards Process -- Revision 3", RFC 7032 2026, October 1996. 7034 [RFC2045] 7035 N. Fried, N. Borenstein, ", Multipurpose Internet Mail Extensions 7036 (MIME) Part One: Format of Internet Message Bodies " RFC 2045, 7037 November 1996. 7039 Expires August 17, 1999 7041 [RFC2046] 7042 Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types. 7043 N. Freed & N. Borenstein. November 1996. (Obsoletes RFC1521, 7044 RFC1522, RFC1590), RFC 2046. 7046 [RFC2048] 7047 N. Freed, J. Klensin & J. Postel, "Multipurpose Internet Mail 7048 Extension (MIME) Part Four: Registration Procedures". RFC 2048, 7049 November 1996. 7051 [RFC2068] 7052 R. Fielding, J. Gettys, J. Mogul, H. Frystyk, T. Berners-Lee, 7053 "Hypertext Transfer Protocol - HTTP/1.1", RFC 2068, January 1997 7055 [RFC2069] 7056 J. Franks, P. Hallam-Baker, J. Hostetler, P. Leach, A. Luotonen, E. 7057 Sink, L. Stewart, "An Extension to HTTP: Digest Access 7058 Authentication", RFC-2069, Jan 1997. 7060 [RFC2119] 7061 S. Bradner, "Key words for use in RFCs to Indicate Requirement 7062 Levels", RFC 2119 , March 1997 7064 [RFC2228] 7065 M. Horowitz, S. Lunt, "FTP Security Extensions", RFC 2228, October 7066 1997. 7068 [RFC2246] 7069 T. Dierks, C. Allen, "The TLS Protocol Version 1.0", RFC 2246, 7070 January 1999. 7072 [RFC2277] 7073 H. Alvestrand, "IETF Policy on Character Sets and Languages" RFC 7074 2277, January 1998. 7076 [RFC2278] 7077 N. Freed, J. Postel: "IANA CharSet Registration Procedures", RFC 7078 2278, January 1998. 7080 [RFC2279] 7081 F. Yergeau , "UTF-8, a transformation format of ISO 10646", RFC 7082 2279. January 1998. 7084 [RFC2316] 7085 S. Bellovin , "Report of the IAB Security Architecture Workshop", 7086 RFC 2316, April 1998. 7088 [RFC2396] 7089 Berners-Lee, T., Fielding, R., Masinter, L., "Uniform Resource 7090 Identifiers (URI): Generic Syntax", RFC 2396, August 1998. 7092 [SSL] 7093 Netscape, The SSL Protocol, Version 3, (Text version 3.02), 7094 November 1996. 7096 Expires August 17, 1999 7098 [SWP] 7099 P. Moore, B. Jahromi, S. Butler, "Simple Web Printing SWP/1.0", May 7100 7, 1997, ftp://ftp.pwg.org/pub/pwg/ipp/new_PRO/swp9705.pdf 7102 10. Notices 7104 The IETF takes no position regarding the validity or scope of any 7105 intellectual property or other rights that might be claimed to pertain 7106 to the implementation or use of the technology described in this 7107 document or the extent to which any license under such rights might or 7108 might not be available; neither does it represent that it has made any 7109 effort to identify any such rights. Information on the IETF's 7110 procedures with respect to rights in standards-track and standards- 7111 related documentation can be found in BCP-11[BCP-11]. Copies of claims 7112 of rights made available for publication and any assurances of licenses 7113 to be made available, or the result of an attempt made to obtain a 7114 general license or permission for the use of such proprietary rights by 7115 implementers or users of this specification can be obtained from the 7116 IETF Secretariat. 7118 The IETF invites any interested party to bring to its attention any 7119 copyrights, patents or patent applications, or other proprietary rights 7120 which may cover technology that may be required to practice this 7121 standard. Please address the information to the IETF Executive 7122 Director. 7124 Copyright (C) The Internet Society (1999). All Rights Reserved. 7126 This document and translations of it may be copied and furnished to 7127 others, and derivative works that comment on or otherwise explain it or 7128 assist in its implementation may be prepared, copied, published and 7129 distributed, in whole or in part, without restriction of any kind, 7130 provided that the above copyright notice and this paragraph are included 7131 on all such copies and derivative works. However, this document itself 7132 may not be modified in any way, such as by removing the copyright notice 7133 or references to the Internet Society or other Internet organizations, 7134 except as needed for the purpose of developing Internet standards in 7135 which case the procedures for copyrights defined in the Internet 7136 Standards process must be followed, or as required to translate it into 7137 languages other than English. 7139 The limited permissions granted above are perpetual and will not be 7140 revoked by the Internet Society or its successors or assigns. 7142 This document and the information contained herein is provided on an "AS 7143 IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK 7144 FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT 7145 LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT 7146 INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR 7147 FITNESS FOR A PARTICULAR PURPOSE. 7149 Expires August 17, 1999 7150 11. Author's Address 7152 Scott A. Isaacson (Editor) 7153 Novell, Inc. 7154 122 E 1700 S 7155 Provo, UT 84606 7157 Phone: 801-861-7366 7158 Fax: 801-861-2517 7159 e-mail: sisaacson@novell.com 7161 Tom Hastings 7162 Xerox Corporation 7163 737 Hawaii St. ESAE 231 7164 El Segundo, CA 90245 7166 Phone: 310-333-6413 7167 Fax: 310-333-5514 7168 e-mail: hastings@cp10.es.xerox.com 7170 Robert Herriot 7171 Xerox Corp. 7172 3400 Hill View Ave, Building 1 7173 Palo Alto, CA 94304 7175 Phone: 650-813-7696 7176 Fax: 650-813-6860 7177 e-mail: robert.herriot@pahv.xerox.com 7179 Roger deBry 7180 HUC/003G 7181 IBM Corporation 7182 P.O. Box 1900 7183 Boulder, CO 80301-9191 7185 Phone: (303) 924-4080 7186 Fax: (303) 924-9889 7187 e-mail: debry@vnet.ibm.com 7189 Patrick Powell 7190 Astart Technologies 7191 9475 Chesapeake Dr., Suite D 7192 San Diego, CA 95123 7194 Phone: (619) 874-6543 7195 Fax: (619) 279-8424 7196 e-mail: papowell@astart.com 7198 IPP Mailing List: ipp@pwg.org 7199 IPP Mailing List Subscription: ipp-request@pwg.org 7200 IPP Web Page: http://www.pwg.org/ipp/ 7202 Implementers of this specification are encouraged to join IPP Mailing 7203 List in order to participate in any discussions of clarification issues 7205 Expires August 17, 1999 7206 and review of registration proposals for additional attributes and 7207 values. 7209 Other Participants: 7211 Chuck Adams - Tektronix 7212 Jeff Barnett - IBM 7213 Ron Bergman - Dataproducts Corp. 7214 Sylvan Butler - HP 7215 Keith Carter - IBM Corporation 7216 Jeff Copeland - QMS 7217 Andy Davidson - Tektronix 7218 Mabry Dozier - QMS 7219 Lee Farrell - Canon Information Systems 7220 Steve Gebert - IBM 7221 Babek Jahromi - Microsoft 7222 David Kellerman - Northlake Software 7223 Rick Landau - Digital 7224 Greg LeClair - Epson 7225 Harry Lewis - IBM 7226 Pete Loya - HP 7227 Ray Lutz - Cognisys 7228 Mike MacKay - Novell, Inc. 7229 Daniel Manchala - Xerox 7230 Carl-Uno Manros - Xerox 7231 Jay Martin - Underscore 7232 Larry Masinter - Xerox 7233 Stan McConnell - Xerox 7234 Ira McDonald - High North Inc. 7235 Paul Moore - Microsoft 7236 Tetsuya Morita - Ricoh 7237 Yuichi Niwa - Ricoh 7238 Pat Nogay - IBM 7239 Ron Norton - Printronics 7240 Bob Pentecost - HP 7241 Rob Rhoads - Intel 7242 Xavier Riley - Xerox 7243 David Roach - Unisys 7244 Stuart Rowley - Kyocera 7245 Hiroyuki Sato - Canon 7246 Bob Setterbo - Adobe 7247 Devon Taylor - Novell, Inc. 7248 Mike Timperman - Lexmark 7249 Randy Turner - Sharp 7250 Atsushi Yuki - Kyocera 7251 Rick Yardumian - Xerox 7252 Lloyd Young - Lexmark 7253 Bill Wagner - DPI 7254 Jim Walker - DAZEL 7255 Chris Wellens - Interworking Labs 7256 Rob Whittle - Novell, Inc. 7257 Don Wright - Lexmark 7258 Peter Zehler - Xerox 7259 Steve Zilles - Adobe 7261 Expires August 17, 1999 7263 12. Formats for IPP Registration Proposals 7265 In order to propose an IPP extension for registration, the proposer must 7266 submit an application to IANA by email to "iana@iana.org" or by filling 7267 out the appropriate form on the IANA web pages (http://www.iana.org). 7268 This section specifies the required information and the formats for 7269 proposing registrations of extensions to IPP as provided in Section 6 7270 for: 7272 1. type2 'keyword' attribute values 7273 2. type3 'keyword' attribute values 7274 3. type2 'enum' attribute values 7275 4. type3 'enum' attribute values 7276 5. attributes 7277 6. attribute syntaxes 7278 7. operations 7279 8. status codes 7281 12.1 Type2 keyword attribute values registration 7283 Type of registration: type2 keyword attribute value 7284 Name of attribute to which this keyword specification is to be added: 7285 Proposed keyword name of this keyword value: 7286 Specification of this keyword value (follow the style of IPP Model 7287 Section 4.1.2.3): 7288 Name of proposer: 7289 Address of proposer: 7290 Email address of proposer: 7292 Note: For type2 keywords, the Designated Expert will be the point of 7293 contact for the approved registration specification, if any maintenance 7294 of the registration specification is needed. 7296 12.2 Type3 keyword attribute values registration 7298 Type of registration: type3 keyword attribute value 7299 Name of attribute to which this keyword specification is to be added: 7300 Proposed keyword name of this keyword value: 7301 Specification of this keyword value (follow the style of IPP Model 7302 Section 4.1.2.3): 7303 Name of proposer: 7304 Address of proposer: 7305 Email address of proposer: 7307 Note: For type3 keywords, the proposer will be the point of contact for 7308 the approved registration specification, if any maintenance of the 7309 registration specification is needed. 7311 12.3 Type2 enum attribute values registration 7313 Type of registration: type2 enum attribute value 7314 Name of attribute to which this enum specification is to be added: 7315 Keyword symbolic name of this enum value: 7317 Expires August 17, 1999 7318 Numeric value (to be assigned by the IPP Designated Expert in 7319 consultation with IANA): 7320 Specification of this enum value (follow the style of IPP Model Section 7321 4.1.4): 7322 Name of proposer: 7323 Address of proposer: 7324 Email address of proposer: 7326 Note: For type2 enums, the Designated Expert will be the point of 7327 contact for the approved registration specification, if any maintenance 7328 of the registration specification is needed. 7330 12.4 Type3 enum attribute values registration 7332 Type of registration: type3 enum attribute value 7333 Name of attribute to which this enum specification is to be added: 7334 Keyword symbolic name of this enum value: 7335 Numeric value (to be assigned by the IPP Designated Expert in 7336 consultation with IANA): 7337 Specification of this enum value (follow the style of IPP Model Section 7338 4.1.4): 7339 Name of proposer: 7340 Address of proposer: 7341 Email address of proposer: 7343 Note: For type3 enums, the proposer will be the point of contact for 7344 the approved registration specification, if any maintenance of the 7345 registration specification is needed. 7347 12.5 Attribute registration 7349 Type of registration: attribute 7350 Proposed keyword name of this attribute: 7351 Types of attribute (Operation, Job Template, Job Description, Printer 7352 Description): 7353 Operations to be used with if the attribute is an operation attribute: 7354 Object (Job, Printer, etc. if bound to an object): 7355 Attribute syntax(es) (include 1setOf and range as in Section 4.2): 7356 If attribute syntax is 'keyword' or 'enum', is it type2 or type3: 7357 If this is a Printer attribute, MAY the value returned depend on 7358 "document-format" (See Section 6.2): 7359 If this is a Job Template attribute, how does its specification depend 7360 on the value of the "multiple-document-handling" attribute: 7361 Specification of this attribute (follow the style of IPP Model Section 7362 4.2): 7363 Name of proposer: 7364 Address of proposer: 7365 Email address of proposer: 7367 Note: For attributes, the IPP Designated Expert will be the point of 7368 contact for the approved registration specification, if any maintenance 7369 of the registration specification is needed. 7371 Expires August 17, 1999 7372 12.6 Attribute Syntax registration 7374 Type of registration: attribute syntax 7375 Proposed name of this attribute syntax: 7376 Type of attribute syntax (integer, octetString, character-string, see 7377 [IPP-PRO]): 7378 Numeric value (to be assigned by the IPP Designated Expert in 7379 consultation with IANA): 7380 Specification of this attribute (follow the style of IPP Model Section 7381 4.1): 7382 Name of proposer: 7383 Address of proposer: 7384 Email address of proposer: 7386 Note: For attribute syntaxes, the IPP Designated Expert will be the 7387 point of contact for the approved registration specification, if any 7388 maintenance of the registration specification is needed. 7390 12.7 Operation registration 7392 Type of registration: operation 7393 Proposed name of this operation: 7394 Numeric operation-id value (to be assigned by the IPP Designated Expert 7395 in consultation with IANA): 7396 Object Target (Job, Printer, etc. that operation is upon): 7397 Specification of this attribute (follow the style of IPP Model Section 7398 3): 7399 Name of proposer: 7400 Address of proposer: 7401 Email address of proposer: 7403 Note: For operations, the IPP Designated Expert will be the point of 7404 contact for the approved registration specification, if any maintenance 7405 of the registration specification is needed. 7407 12.8 Attribute Group registration 7409 Type of registration: attribute group 7410 Proposed name of this attribute group: 7411 Numeric tag according to [IPP-PRO] (to be assigned by the IPP Designated 7412 Expert in consultation with IANA): 7413 Operation requests and group number for each operation in which the 7414 attribute group occurs: 7415 Operation responses and group number for each operation in which the 7416 attribute group occurs: 7417 Specification of this attribute group (follow the style of IPP Model 7418 Section 3): 7419 Name of proposer: 7420 Address of proposer: 7421 Email address of proposer: 7423 Note: For attribute groups, the IPP Designated Expert will be the point 7424 of contact for the approved registration specification, if any 7425 maintenance of the registration specification is needed. 7427 Expires August 17, 1999 7428 12.9 Status code registration 7430 Type of registration: status code 7431 Keyword symbolic name of this status code value: 7432 Numeric value (to be assigned by the IPP Designated Expert in 7433 consultation with IANA): 7434 Operations that this status code may be used with: 7435 Specification of this status code (follow the style of IPP Model Section 7436 14 APPENDIX B: Status Codes and Suggested Status Code Messages): 7437 Name of proposer: 7438 Address of proposer: 7439 Email address of proposer: 7441 Note: For status codes, the Designated Expert will be the point of 7442 contact for the approved registration specification, if any maintenance 7443 of the registration specification is needed. 7445 13. APPENDIX A: Terminology 7447 This specification uses the terminology defined in this section. 7449 13.1 Conformance Terminology 7451 The key words "MUST", "MUST NOT", "REQUIRED", "SHOULD", "SHOULD NOT", 7452 "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be 7453 interpreted as described in RFC 2119 [RFC2119]. 7455 13.1.1 NEED NOT 7457 This term is not included in RFC 2119. The verb "NEED NOT" indicates an 7458 action that the subject of the sentence does not have to implement in 7459 order to claim conformance to the standard. The verb "NEED NOT" is used 7460 instead of "MAY NOT" since "MAY NOT" sounds like a prohibition. 7462 13.2 Model Terminology 7464 13.2.1 Keyword 7466 Keywords are used within this document as identifiers of semantic 7467 entities within the abstract model (see section 4.1.2.3). Attribute 7468 names, some attribute values, attribute syntaxes, and attribute group 7469 names are represented as keywords. 7471 13.2.2 Attributes 7473 An attribute is an item of information that is associated with an 7474 instance of an IPP object. An attribute consists of an attribute name 7475 and one or more attribute values. Each attribute has a specific 7477 Expires August 17, 1999 7478 attribute syntax. All object attributes are defined in section 3.3.5 7479 and all operation attributes are defined in section 3. 7481 Job Template Attributes are described in section 4.2. The client 7482 optionally supplies Job Template attributes in a create request 7483 (operation requests that create Job objects). The Printer object has 7484 associated attributes which define supported and default values for the 7485 Printer. 7487 13.2.2.1 Attribute Name 7489 Each attribute is uniquely identified in this document by its attribute 7490 name. An attribute name is a keyword. The keyword attribute name is 7491 given in the section header describing that attribute. In running text 7492 in this document, attribute names are indicated inside double quotation 7493 marks (") where the quotation marks are not part of the keyword itself. 7495 13.2.2.2 Attribute Group Name 7497 Related attributes are grouped into named groups. The name of the group 7498 is a keyword. The group name may be used in place of naming all the 7499 attributes in the group explicitly. Attribute groups are defined in 7500 section 3. 7502 13.2.2.3 Attribute Value 7504 Each attribute has one or more values. Attribute values are represented 7505 in the syntax type specified for that attribute. In running text in this 7506 document, attribute values are indicated inside single quotation marks 7507 ('), whether their attribute syntax is keyword, integer, text, etc. 7508 where the quotation marks are not part of the value itself. 7510 13.2.2.4 Attribute Syntax 7512 Each attribute is defined using an explicit syntax type. In this 7513 document, each syntax type is defined as a keyword with specific 7514 meaning. The "Encoding and Transport" document [IPP-PRO] indicates the 7515 actual "on-the-wire" encoding rules for each syntax type. Attribute 7516 syntax types are defined in section 4.1. 7518 13.2.3 Supports 7520 By definition, a Printer object supports an attribute only if that 7521 Printer object responds with the corresponding attribute populated with 7522 some value(s) in a response to a query for that attribute. A Printer 7523 object supports an attribute value if the value is one of the Printer 7524 object's "supported values" attributes. The device behind a Printer 7525 object may exhibit a behavior that corresponds to some IPP attribute, 7526 but if the Printer object, when queried for that attribute, doesn't 7527 respond with the attribute, then as far as IPP is concerned, that 7528 implementation does not support that feature. If the Printer object's 7530 Expires August 17, 1999 7531 "xxx-supported" attribute is not populated with a particular value (even 7532 if that value is a legal value for that attribute), then that Printer 7533 object does not support that particular value. 7535 A conforming implementation MUST support all REQUIRED attributes. 7536 However, even for REQUIRED attributes, conformance to IPP does not 7537 mandate that all implementations support all possible values 7538 representing all possible job processing behaviors and features. For 7539 example, if a given instance of a Printer supports only certain document 7540 formats, then that Printer responds with the "document-format-supported" 7541 attribute populated with a set of values, possibly only one, taken from 7542 the entire set of possible values defined for that attribute. This 7543 limited set of values represents the Printer's set of supported document 7544 formats. Supporting an attribute and some set of values for that 7545 attribute enables IPP end users to be aware of and make use of those 7546 features associated with that attribute and those values. If an 7547 implementation chooses to not support an attribute or some specific 7548 value, then IPP end users would have no ability to make use of that 7549 feature within the context of IPP itself. However, due to existing 7550 practice and legacy systems which are not IPP aware, there might be some 7551 other mechanism outside the scope of IPP to control or request the 7552 "unsupported" feature (such as embedded instructions within the document 7553 data itself). 7555 For example, consider the "finishings-supported" attribute. 7557 1) If a Printer object is not physically capable of stapling, the 7558 "finishings-supported" attribute MUST NOT be populated with the 7559 value of 'staple'. 7560 2) A Printer object is physically capable of stapling, however an 7561 implementation chooses not to support stapling in the IPP 7562 "finishings" attribute. In this case, 'staple' MUST NOT be a value 7563 in the "finishings-supported" Printer object attribute. Without 7564 support for the value 'staple', an IPP end user would have no means 7565 within the protocol itself to request that a Job be stapled. 7566 However, an existing document data formatter might be able to 7567 request that the document be stapled directly with an embedded 7568 instruction within the document data. In this case, the IPP 7569 implementation does not "support" stapling, however the end user is 7570 still able to have some control over the stapling of the completed 7571 job. 7572 3) A Printer object is physically capable of stapling, and an 7573 implementation chooses to support stapling in the IPP "finishings" 7574 attribute. In this case, 'staple' MUST be a value in the 7575 "finishings-supported" Printer object attribute. Doing so, would 7576 enable end users to be aware of and make use of the stapling 7577 feature using IPP attributes. 7579 Even though support for Job Template attributes by a Printer object is 7580 OPTIONAL, it is RECOMMENDED that if the device behind a Printer object 7581 is capable of realizing any feature or function that corresponds to an 7582 IPP attribute and some associated value, then that implementation SHOULD 7583 support that IPP attribute and value. 7585 Expires August 17, 1999 7586 The set of values in any of the supported value attributes is set 7587 (populated) by some administrative process or automatic sensing 7588 mechanism that is outside the scope of this IPP/1.1 document. For 7589 administrative policy and control reasons, an administrator may choose 7590 to make only a subset of possible values visible to the end user. In 7591 this case, the real output device behind the IPP Printer abstraction may 7592 be capable of a certain feature, however an administrator is specifying 7593 that access to that feature not be exposed to the end user through the 7594 IPP protocol. Also, since a Printer object may represent a logical 7595 print device (not just a physical device) the actual process for 7596 supporting a value is undefined and left up to the implementation. 7597 However, if a Printer object supports a value, some manual human action 7598 may be needed to realize the semantic action associated with the value, 7599 but no end user action is required. 7601 For example, if one of the values in the "finishings-supported" 7602 attribute is 'staple', the actual process might be an automatic staple 7603 action by a physical device controlled by some command sent to the 7604 device. Or, the actual process of stapling might be a manual action by 7605 an operator at an operator attended Printer object. 7607 For another example of how supported attributes function, consider a 7608 system administrator who desires to control all print jobs so that no 7609 job sheets are printed in order to conserve paper. To force no job 7610 sheets, the system administrator sets the only supported value for the 7611 "job-sheets-supported" attribute to 'none'. In this case, if a client 7612 requests anything except 'none', the create request is rejected or the 7613 "job-sheets" value is ignored (depending on the value of "ipp-attribute- 7614 fidelity"). To force the use of job start/end sheets on all jobs, the 7615 administrator does not include the value 'none' in the "job-sheets- 7616 supported" attribute. In this case, if a client requests 'none', the 7617 create request is rejected or the "job-sheets" value is ignored (again 7618 depending on the value of "ipp-attribute-fidelity"). 7620 13.2.4 print-stream page 7622 A "print-stream page" is a page according to the definition of pages in 7623 the language used to express the document data. 7625 13.2.5 impression 7627 An "impression" is the image (possibly many print-stream pages in 7628 different configurations) imposed onto a single media page. 7630 14. APPENDIX B: Status Codes and Suggested Status Code Messages 7632 This section defines status code enum keywords and values that are used 7633 to provide semantic information on the results of an operation request. 7634 Each operation response MUST include a status code. The response MAY 7635 also contain a status message that provides a short textual description 7636 of the status. The status code is intended for use by automata, and the 7638 Expires August 17, 1999 7639 status message is intended for the human end user. Since the status 7640 message is an OPTIONAL component of the operation response, an IPP 7641 application (i.e., a browser, GUI, print driver or gateway) is NOT 7642 REQUIRED to examine or display the status message, since it MAY not be 7643 returned to the application. 7645 The prefix of the status keyword defines the class of response as 7646 follows: 7648 "informational" - Request received, continuing process 7649 "successful" - The action was successfully received, understood, and 7650 accepted 7651 "redirection" - Further action must be taken in order to complete the 7652 request 7653 "client-error" - The request contains bad syntax or cannot be 7654 fulfilled 7655 "server-error" - The IPP object failed to fulfill an apparently 7656 valid request 7658 As with type2 enums, IPP status codes are extensible. IPP clients are 7659 NOT REQUIRED to understand the meaning of all registered status codes, 7660 though such understanding is obviously desirable. However, IPP clients 7661 MUST understand the class of any status code, as indicated by the 7662 prefix, and treat any unrecognized response as being equivalent to the 7663 first status code of that class, with the exception that an unrecognized 7664 response MUST NOT be cached. For example, if an unrecognized status 7665 code of "client-error-xxx-yyy" is received by the client, it can safely 7666 assume that there was something wrong with its request and treat the 7667 response as if it had received a "client-error-bad-request" status code. 7668 In such cases, IPP applications SHOULD present the OPTIONAL message (if 7669 present) to the end user since the message is likely to contain human 7670 readable information which will help to explain the unusual status. The 7671 name of the enum is the suggested status message for US English. 7673 The status code values range from 0x0000 to 0x7FFF. The value ranges 7674 for each status code class are as follows: 7676 "successful" - 0x0000 to 0x00FF 7677 "informational" - 0x0100 to 0x01FF 7678 "redirection" - 0x0200 to 0x02FF 7679 "client-error" - 0x0400 to 0x04FF 7680 "server-error" - 0x0500 to 0x05FF 7682 The top half (128 values) of each range (0x0n40 to 0x0nFF, for n = 0 to 7683 5) is reserved for private use within each status code class. Values 7684 0x0600 to 0x7FFF are reserved for future assignment and MUST NOT be 7685 used. 7687 14.1 Status Codes 7689 Each status code is described below. Section 14.1.5.9 contains a table 7690 that indicates which status codes apply to which operations. The 7691 Implementer's Guide [IPP-IIG] describe the suggested steps for 7693 Expires August 17, 1999 7694 processing IPP attributes for all operations, including returning status 7695 codes. 7697 14.1.1 Informational 7699 This class of status code indicates a provisional response and is to be 7700 used for informational purposes only. 7702 There are no status codes defined in IPP/1.1 for this class of status 7703 code. 7705 14.1.2 Successful Status Codes 7707 This class of status code indicates that the client's request was 7708 successfully received, understood, and accepted. 7710 14.1.2.1 successful-ok (0x0000) 7712 The request has succeeded and no request attributes were substituted or 7713 ignored. In the case of a response to a create request, the 7714 'successful-ok' status code indicates that the request was successfully 7715 received and validated, and that the Job object has been created; it 7716 does not indicate that the job has been processed. The transition of 7717 the Job object into the 'completed' state is the only indicator that the 7718 job has been printed. 7720 14.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001) 7722 The request has succeeded, but some supplied (1) attributes were ignored 7723 or (2) unsupported values were substituted with supported values or were 7724 ignored in order to perform the operation without rejecting it. 7725 Unsupported attributes, attribute syntaxes, or values MUST be returned 7726 in the Unsupported Attributes group of the response for all operations. 7727 There is an exception to this rule for the query operations: Get- 7728 Printer-Attributes, Get-Jobs, and Get-Job-Attributes for the "requested- 7729 attributes" operation attribute only. When the supplied values of the 7730 "requested-attributes" operation attribute are requesting attributes 7731 that are not supported, the IPP object MAY, but is NOT REQUIRED to, 7732 return the "requested-attributes" attribute in the Unsupported Attribute 7733 response group (with the unsupported values only). See section 3.2.1.2. 7735 14.1.2.3 successful-ok-conflicting-attributes (0x0002) 7737 The request has succeeded, but some supplied attribute values conflicted 7738 with the values of other supplied attributes. These conflicting values 7739 were either (1) substituted with (supported) values or (2) the 7740 attributes were removed in order to process the job without rejecting 7741 it. Attributes or values which conflict with other attributes and have 7742 been substituted or ignored MUST be returned in the Unsupported 7743 Attributes group of the response for all operations as supplied by the 7744 client. See section 3.2.1.2. 7746 Expires August 17, 1999 7747 14.1.3 Redirection Status Codes 7749 This class of status code indicates that further action needs to be 7750 taken to fulfill the request. 7752 There are no status codes defined in IPP/1.1 for this class of status 7753 code. 7755 14.1.4 Client Error Status Codes 7757 This class of status code is intended for cases in which the client 7758 seems to have erred. The IPP object SHOULD return a message containing 7759 an explanation of the error situation and whether it is a temporary or 7760 permanent condition. 7762 14.1.4.1 client-error-bad-request (0x0400) 7764 The request could not be understood by the IPP object due to malformed 7765 syntax (such as the value of a fixed length attribute whose length does 7766 not match the prescribed length for that attribute - see the 7767 Implementer's Guide [IPP-IIG] ). The IPP application SHOULD NOT repeat 7768 the request without modifications. 7770 14.1.4.2 client-error-forbidden (0x0401) 7772 The IPP object understood the request, but is refusing to fulfill it. 7773 Additional authentication information or authorization credentials will 7774 not help and the request SHOULD NOT be repeated. This status code is 7775 commonly used when the IPP object does not wish to reveal exactly why 7776 the request has been refused or when no other response is applicable. 7778 14.1.4.3 client-error-not-authenticated (0x0402) 7780 The request requires user authentication. The IPP client may repeat the 7781 request with suitable authentication information. If the request already 7782 included authentication information, then this status code indicates 7783 that authorization has been refused for those credentials. If this 7784 response contains the same challenge as the prior response, and the user 7785 agent has already attempted authentication at least once, then the 7786 response message may contain relevant diagnostic information. This 7787 status codes reveals more information than "client-error-forbidden". 7789 14.1.4.4 client-error-not-authorized (0x0403) 7791 The requester is not authorized to perform the request. Additional 7792 authentication information or authorization credentials will not help 7793 and the request SHOULD NOT be repeated. This status code is used when 7794 the IPP object wishes to reveal that the authentication information is 7795 understandable, however, the requester is explicitly not authorized to 7796 perform the request. This status codes reveals more information than 7797 "client-error-forbidden" and "client-error-not-authenticated". 7799 Expires August 17, 1999 7800 14.1.4.5 client-error-not-possible (0x0404) 7802 This status code is used when the request is for something that can not 7803 happen. For example, there might be a request to cancel a job that has 7804 already been canceled or aborted by the system. The IPP client SHOULD 7805 NOT repeat the request. 7807 14.1.4.6 client-error-timeout (0x0405) 7809 The client did not produce a request within the time that the IPP object 7810 was prepared to wait. For example, a client issued a Create-Job 7811 operation and then, after a long period of time, issued a Send-Document 7812 operation and this error status code was returned in response to the 7813 Send-Document request (see section 3.3.1). The IPP object might have 7814 been forced to clean up resources that had been held for the waiting 7815 additional Documents. The IPP object was forced to close the Job since 7816 the client took too long. The client SHOULD NOT repeat the request 7817 without modifications. 7819 14.1.4.7 client-error-not-found (0x0406) 7821 The IPP object has not found anything matching the request URI. No 7822 indication is given of whether the condition is temporary or permanent. 7823 For example, a client with an old reference to a Job (a URI) tries to 7824 cancel the Job, however in the mean time the Job might have been 7825 completed and all record of it at the Printer has been deleted. This 7826 status code, 'client-error-not-found' is returned indicating that the 7827 referenced Job can not be found. This error status code is also used 7828 when a client supplies a URI as a reference to the document data in 7829 either a Print-URI or Send-URI operation, but the document can not be 7830 found. 7832 In practice, an IPP application should avoid a not found situation by 7833 first querying and presenting a list of valid Printer URIs and Job URIs 7834 to the end-user. 7836 14.1.4.8 client-error-gone (0x0407) 7838 The requested object is no longer available and no forwarding address is 7839 known. This condition should be considered permanent. Clients with 7840 link editing capabilities should delete references to the request URI 7841 after user approval. If the IPP object does not know or has no facility 7842 to determine, whether or not the condition is permanent, the status code 7843 "client-error-not-found" should be used instead. 7845 This response is primarily intended to assist the task of maintenance by 7846 notifying the recipient that the resource is intentionally unavailable 7847 and that the IPP object administrator desires that remote links to that 7848 resource be removed. It is not necessary to mark all permanently 7849 unavailable resources as "gone" or to keep the mark for any length of 7850 time -- that is left to the discretion of the IPP object administrator. 7852 Expires August 17, 1999 7853 14.1.4.9 client-error-request-entity-too-large (0x0408) 7855 The IPP object is refusing to process a request because the request 7856 entity is larger than the IPP object is willing or able to process. An 7857 IPP Printer returns this status code when it limits the size of print 7858 jobs and it receives a print job that exceeds that limit or when the 7859 attributes are so many that their encoding causes the request entity to 7860 exceed IPP object capacity. 7862 14.1.4.10 client-error-request-value-too-long (0x0409) 7864 The IPP object is refusing to service the request because one or more of 7865 the client-supplied attributes has a variable length value that is 7866 longer than the maximum length specified for that attribute. The IPP 7867 object might not have sufficient resources (memory, buffers, etc.) to 7868 process (even temporarily), interpret, and/or ignore a value larger than 7869 the maximum length. Another use of this error code is when the IPP 7870 object supports the processing of a large value that is less than the 7871 maximum length, but during the processing of the request as a whole, the 7872 object may pass the value onto some other system component which is not 7873 able to accept the large value. For more details, see the Implementer's 7874 Guide [IPP-IIG] . 7876 Note: For attribute values that are URIs, this rare condition is only 7877 likely to occur when a client has improperly submitted a request with 7878 long query information (e.g. an IPP application allows an end-user to 7879 enter an invalid URI), when the client has descended into a URI "black 7880 hole" of redirection (e.g., a redirected URI prefix that points to a 7881 suffix of itself), or when the IPP object is under attack by a client 7882 attempting to exploit security holes present in some IPP objects using 7883 fixed-length buffers for reading or manipulating the Request-URI. 7885 14.1.4.11 client-error-document-format-not-supported (0x040A) 7887 The IPP object is refusing to service the request because the document 7888 data is in a format, as specified in the "document-format" operation 7889 attribute, that is not supported by the Printer object. This error is 7890 returned independent of the client-supplied "ipp-attribute-fidelity". 7891 The Printer object MUST return this status code, even if there are other 7892 attributes that are not supported as well, since this error is a bigger 7893 problem than with Job Template attributes. 7895 14.1.4.12 client-error-attributes-or-values-not-supported (0x040B) 7897 In a create request, if the Printer object does not support one or more 7898 attributes, attribute syntaxes, or attribute values supplied in the 7899 request and the client supplied the "ipp-attributes-fidelity" operation 7900 attribute with the 'true' value, the Printer object MUST return this 7901 status code. For example, if the request indicates 'iso-a4' media, but 7902 that media type is not supported by the Printer object. Or, if the 7903 client supplies an optional attribute and the attribute itself is not 7904 even supported by the Printer. If the "ipp-attribute-fidelity" 7906 Expires August 17, 1999 7907 attribute is 'false', the Printer MUST ignore or substitute values for 7908 unsupported attributes and values rather than reject the request and 7909 return this status code. 7911 For any operation where a client requests attributes (such as a Get- 7912 Jobs, Get-Printer-Attributes, or Get-Job-Attributes operation), if the 7913 IPP object does not support one or more of the requested attributes, the 7914 IPP object simply ignores the unsupported requested attributes and 7915 processes the request as if they had not been supplied, rather than 7916 returning this status code. In this case, the IPP object MUST return 7917 the 'successful-ok-ignored-or-substituted-attributes' status code and 7918 MAY return the unsupported attributes as values of the "requested- 7919 attributes" in the Unsupported Attributes Group (see section 14.1.2.2). 7921 14.1.4.13 client-error-uri-scheme-not-supported (0x040C) 7923 The type of the client supplied URI in a Print-URI or a Send-URI 7924 operation is not supported. 7926 14.1.4.14 client-error-charset-not-supported (0x040D) 7928 For any operation, if the IPP Printer does not support the charset 7929 supplied by the client in the "attributes-charset" operation attribute, 7930 the Printer MUST reject the operation and return this status and any 7931 'text' or 'name' attributes using the 'utf-8' charset (see Section 7932 3.1.4.1). 7934 14.1.4.15 client-error-conflicting-attributes (0x040E) 7936 The request is rejected because some attribute values conflicted with 7937 the values of other attributes which this specification does not permit 7938 to be substituted or ignored. 7940 14.1.5 Server Error Status Codes 7942 This class of status codes indicates cases in which the IPP object is 7943 aware that it has erred or is incapable of performing the request. The 7944 IPP object SHOULD include a message containing an explanation of the 7945 error situation, and whether it is a temporary or permanent condition. 7947 14.1.5.1 server-error-internal-error (0x0500) 7949 The IPP object encountered an unexpected condition that prevented it 7950 from fulfilling the request. This error status code differs from 7951 "server-error-temporary-error" in that it implies a more permanent type 7952 of internal error. It also differs from "server-error-device-error" in 7953 that it implies an unexpected condition (unlike a paper-jam or out-of- 7954 toner problem which is undesirable but expected). This error status 7955 code indicates that probably some knowledgeable human intervention is 7956 required. 7958 Expires August 17, 1999 7959 14.1.5.2 server-error-operation-not-supported (0x0501) 7961 The IPP object does not support the functionality required to fulfill 7962 the request. This is the appropriate response when the IPP object does 7963 not recognize an operation or is not capable of supporting it. 7965 14.1.5.3 server-error-service-unavailable (0x0502) 7967 The IPP object is currently unable to handle the request due to a 7968 temporary overloading or maintenance of the IPP object. The implication 7969 is that this is a temporary condition which will be alleviated after 7970 some delay. If known, the length of the delay may be indicated in the 7971 message. If no delay is given, the IPP application should handle the 7972 response as it would for a "server-error-temporary-error" response. If 7973 the condition is more permanent, the error status codes "client-error- 7974 gone" or "client-error-not-found" could be used. 7976 14.1.5.4 server-error-version-not-supported (0x0503) 7978 The IPP object does not support, or refuses to support, the IPP protocol 7979 version that was used in the request message. The IPP object is 7980 indicating that it is unable or unwilling to complete the request using 7981 the same version as supplied in the request other than with this error 7982 message. The response should contain a Message describing why that 7983 version is not supported and what other versions are supported by that 7984 IPP object. 7986 A conforming IPP/1.1 client MUST specify a valid version ('1.1' or 7987 '1.0') on each request. A conforming IPP/1.1 object MUST NOT return 7988 this status code to a conforming IPP/1.1 or IPP/1.0 client. An IPP 7989 object MUST return this status code to a non-conforming IPP client. The 7990 response MUST identify in the "version-number" operation attribute the 7991 closest version number that the IPP object does support. For example, 7992 if a client supplies version '1.0', a conforming IPP/1.1 object MUST 7993 respond with version '1.0'. 7995 14.1.5.5 server-error-device-error (0x0504) 7997 A printer error, such as a paper jam, occurs while the IPP object 7998 processes a Print or Send operation. The response contains the true Job 7999 Status (the values of the "job-state" and "job-state-reasons" 8000 attributes). Additional information can be returned in the optional 8001 "job-state-message" attribute value or in the OPTIONAL status message 8002 that describes the error in more detail. This error status code is only 8003 returned in situations where the Printer is unable to accept the create 8004 request because of such a device error. For example, if the Printer is 8005 unable to spool, and can only accept one job at a time, the reason it 8006 might reject a create request is that the printer currently has a paper 8007 jam. In many cases however, where the Printer object can accept the 8008 request even though the Printer has some error condition, the 8009 'successful-ok' status code will be returned. In such a case, the 8011 Expires August 17, 1999 8012 client would look at the returned Job Object Attributes or later query 8013 the Printer to determine its state and state reasons. 8015 14.1.5.6 server-error-temporary-error (0x0505) 8017 A temporary error such as a buffer full write error, a memory overflow 8018 (i.e. the document data exceeds the memory of the Printer), or a disk 8019 full condition, occurs while the IPP Printer processes an operation. 8020 The client MAY try the unmodified request again at some later point in 8021 time with an expectation that the temporary internal error condition may 8022 have been cleared. Alternatively, as an implementation option, a 8023 Printer object MAY delay the response until the temporary condition is 8024 cleared so that no error is returned. 8026 14.1.5.7 server-error-not-accepting-jobs (0x0506) 8028 A temporary error indicating that the Printer is not currently accepting 8029 jobs, because the administrator has set the value of the Printer's 8030 "printer-is-not-accepting-jobs" attribute to 'false' (by means outside 8031 the scope of this IPP/1.1 document). 8033 14.1.5.8 server-error-busy (0x0507) 8035 A temporary error indicating that the Printer is too busy processing 8036 jobs and/or other requests. The client SHOULD try the unmodified request 8037 again at some later point in time with an expectation that the temporary 8038 busy condition will have been cleared. 8040 14.1.5.9 server-error-job-canceled (0x0508) 8042 An error indicating that the job has been canceled by an operator or the 8043 system while the client was transmitting the data to the IPP Printer. 8044 If a job-id and job-uri had been created, then they are returned in the 8045 Print-Job, Send-Document, or Send-URI response as usual; otherwise, no 8046 job-id and job-uri are returned in the response. 8048 Expires August 17, 1999 8049 14.2 Status Codes for IPP Operations 8051 PJ = Print-Job, PU = Print-URI, CJ = Create-Job, SD = Send-Document 8052 SU = Send-URI, V = Validate-Job, GA = Get-Job-Attributes and 8053 Get-Printer-Attributes, GJ = Get-Jobs, C = Cancel-Job 8055 IPP Operations 8056 IPP Status Keyword PJ PU CJ SD SU V GA GJ C 8057 ------------------ -- -- -- -- -- - -- -- - 8058 successful-ok x x x x x x x x x 8059 successful-ok-ignored-or-substituted- x x x x x x x x x 8060 attributes 8061 successful-ok-conflicting-attributes x x x x x x x x x 8062 client-error-bad-request x x x x x x x x x 8063 client-error-forbidden x x x x x x x x x 8064 client-error-not-authenticated x x x x x x x x x 8065 client-error-not-authorized x x x x x x x x x 8066 client-error-not-possible x x x x x x x x x 8067 client-error-timeout x x 8068 client-error-not-found x x x x x x x x x 8069 client-error-gone x x x x x x x x x 8070 client-error-request-entity-too-large x x x x x x x x x 8071 client-error-request-value-too-long x x x x x x x x x 8072 client-error-document-format-not- x x x x x x 8073 supported 8074 client-error-attributes-or-values-not- x x x x x x x x x 8075 supported 8076 client-error-uri-scheme-not-supported x x 8077 client-error-charset-not-supported x x x x x x x x x 8078 client-error-conflicting-attributes x x x x x x x x x 8079 server-error-internal-error x x x x x x x x x 8080 server-error-operation-not-supported x x x x 8081 server-error-service-unavailable x x x x x x x x x 8082 server-error-version-not-supported x x x x x x x x x 8083 server-error-device-error x x x x x 8084 server-error-temporary-error x x x x x 8085 server-error-not-accepting-jobs x x x x 8086 server-error-busy x x x x x x x x x 8087 server-error-job-canceled x x 8089 Expires August 17, 1999 8090 HJ = Hold-Job, RJ = Release-Job, RS = Restart-Job 8091 PP = Pause-Printer, RP = Resume-Printer, PJ = Purge-Jobs 8093 IPP Operations (cont.) 8094 IPP Status Keyword HJ RJ RS PP RP PJ 8095 ------------------ -- -- -- -- -- -- 8096 successful-ok x x x x x x 8097 successful-ok-ignored-or-substituted- x x x x x x 8098 attributes 8099 successful-ok-conflicting-attributes x x x x x x 8100 client-error-bad-request x x x x x x 8101 client-error-forbidden x x x x x x 8102 client-error-not-authenticated x x x x x x 8103 client-error-not-authorized x x x x x x 8104 client-error-not-possible x x x x x x 8105 client-error-timeout 8106 client-error-not-found x x x x x x 8107 client-error-gone x x x x x x 8108 client-error-request-entity-too-large x x x x x x 8109 client-error-request-value-too-long x x x x x x 8110 client-error-document-format-not- 8111 supported 8112 client-error-attributes-or-values-not- x x x x x x 8113 supported 8114 client-error-uri-scheme-not-supported 8115 client-error-charset-not-supported x x x x x x 8116 client-error-conflicting-attributes x x x x x x 8117 server-error-internal-error x x x x x x 8118 server-error-operation-not-supported x x x x x x 8119 server-error-service-unavailable x x x x x x 8120 server-error-version-not-supported x x x x x x 8121 server-error-device-error 8122 server-error-temporary-error 8123 server-error-not-accepting-jobs 8124 server-error-busy x x x x x x 8125 server-error-job-canceled 8127 Expires August 17, 1999 8128 15. APPENDIX C: "media" keyword values 8130 Standard keyword values are taken from several sources. 8132 Standard values are defined (taken from DPA[ISO10175] and the Printer 8133 MIB[RFC1759]): 8135 'default': The default medium for the output device 8136 'iso-a4-white': Specifies the ISO A4 white medium 8137 'iso-a4-colored': Specifies the ISO A4 colored medium 8138 'iso-a4-transparent' Specifies the ISO A4 transparent medium 8139 'iso-a3-white': Specifies the ISO A3 white medium 8140 'iso-a3-colored': Specifies the ISO A3 colored medium 8141 'iso-a5-white': Specifies the ISO A5 white medium 8142 'iso-a5-colored': Specifies the ISO A5 colored medium 8143 'iso-b4-white': Specifies the ISO B4 white medium 8144 'iso-b4-colored': Specifies the ISO B4 colored medium 8145 'iso-b5-white': Specifies the ISO B5 white medium 8146 'iso-b5-colored': Specifies the ISO B5 colored medium 8147 'jis-b4-white': Specifies the JIS B4 white medium 8148 'jis-b4-colored': Specifies the JIS B4 colored medium 8149 'jis-b5-white': Specifies the JIS B5 white medium 8150 'jis-b5-colored': Specifies the JIS B5 colored medium 8152 The following standard values are defined for North American media: 8154 'na-letter-white': Specifies the North American letter white medium 8155 'na-letter-colored': Specifies the North American letter colored 8156 medium 8157 'na-letter-transparent': Specifies the North American letter 8158 transparent medium 8159 'na-legal-white': Specifies the North American legal white medium 8160 'na-legal-colored': Specifies the North American legal colored medium 8162 The following standard values are defined for envelopes: 8164 'iso-b4-envelope': Specifies the ISO B4 envelope medium 8165 'iso-b5-envelope': Specifies the ISO B5 envelope medium 8166 'iso-c3-envelope': Specifies the ISO C3 envelope medium 8167 'iso-c4-envelope': Specifies the ISO C4 envelope medium 8168 'iso-c5-envelope': Specifies the ISO C5 envelope medium 8169 'iso-c6-envelope': Specifies the ISO C6 envelope medium 8170 'iso-designated-long-envelope': Specifies the ISO Designated Long 8171 envelope medium 8172 'na-10x13-envelope': Specifies the North American 10x13 envelope 8173 medium 8174 'na-9x12-envelope': Specifies the North American 9x12 envelope medium 8175 'monarch-envelope': Specifies the Monarch envelope 8176 'na-number-10-envelope': Specifies the North American number 10 8177 business envelope medium 8179 Expires August 17, 1999 8181 'na-7x9-envelope': Specifies the North American 7x9 inch envelope 8182 'na-9x11-envelope': Specifies the North American 9x11 inch envelope 8183 'na-10x14-envelope': Specifies the North American 10x14 inch envelope 8184 'na-number-9-envelope': Specifies the North American number 9 8185 business envelope 8186 'na-6x9-envelope': Specifies the North American 6x9 inch envelope 8187 'na-10x15-envelope': Specifies the North American 10x15 inch envelope 8189 The following standard values are defined for the less commonly used 8190 media (white-only): 8192 'executive-white': Specifies the white executive medium 8193 'folio-white': Specifies the folio white medium 8194 'invoice-white': Specifies the white invoice medium 8195 'ledger-white': Specifies the white ledger medium 8196 'quarto-white': Specified the white quarto medium 8197 'iso-a0-white': Specifies the ISO A0 white medium 8198 'iso-a1-white': Specifies the ISO A1 white medium 8199 'iso-a2-white': Specifies the ISO A2 white medium 8200 'iso-a6-white': Specifies the ISO A6 white medium 8201 'iso-a7-white': Specifies the ISO A7 white medium 8202 'iso-a8-white': Specifies the ISO A8 white medium 8203 'iso-a9-white': Specifies the ISO A9 white medium 8204 'iso-10-white': Specifies the ISO A10 white medium 8205 'iso-b0-white': Specifies the ISO B0 white medium 8206 'iso-b1-white': Specifies the ISO B1 white medium 8207 'iso-b2-white': Specifies the ISO B2 white medium 8208 'iso-b3-white': Specifies the ISO B3 white medium 8209 'iso-b6-white': Specifies the ISO B6 white medium 8210 'iso-b7-white': Specifies the ISO B7 white medium 8211 'iso-b8-white': Specifies the ISO B8 white medium 8212 'iso-b9-white': Specifies the ISO B9 white medium 8213 'iso-b10-white': Specifies the ISO B10 white medium 8214 'jis-b0-white': Specifies the JIS B0 white medium 8215 'jis-b1-white': Specifies the JIS B1 white medium 8216 'jis-b2-white': Specifies the JIS B2 white medium 8217 'jis-b3-white': Specifies the JIS B3 white medium 8218 'jis-b6-white': Specifies the JIS B6 white medium 8219 'jis-b7-white': Specifies the JIS B7 white medium 8220 'jis-b8-white': Specifies the JIS B8 white medium 8221 'jis-b9-white': Specifies the JIS B9 white medium 8222 'jis-b10-white': Specifies the JIS B10 white medium 8224 The following standard values are defined for engineering media: 8226 'a': Specifies the engineering A size medium 8227 'b': Specifies the engineering B size medium 8228 'c': Specifies the engineering C size medium 8229 'd': Specifies the engineering D size medium 8230 'e': Specifies the engineering E size medium 8232 Expires August 17, 1999 8234 The following standard values are defined for input-trays (from ISO DPA 8235 and the Printer MIB): 8237 'top': The top input tray in the printer. 8238 'middle': The middle input tray in the printer. 8239 'bottom': The bottom input tray in the printer. 8240 'envelope': The envelope input tray in the printer. 8241 'manual': The manual feed input tray in the printer. 8242 'large-capacity': The large capacity input tray in the printer. 8243 'main': The main input tray 8244 'side': The side input tray 8246 The following standard values are defined for media sizes (from ISO 8247 DPA): 8249 'iso-a0': Specifies the ISO A0 size: 841 mm by 1189 mm as defined in 8250 ISO 216 8251 'iso-a1': Specifies the ISO A1 size: 594 mm by 841 mm as defined in 8252 ISO 216 8253 'iso-a2': Specifies the ISO A2 size: 420 mm by 594 mm as defined in 8254 ISO 216 8255 'iso-a3': Specifies the ISO A3 size: 297 mm by 420 mm as defined in 8256 ISO 216 8257 'iso-a4': Specifies the ISO A4 size: 210 mm by 297 mm as defined in 8258 ISO 216 8259 'iso-a5': Specifies the ISO A5 size: 148 mm by 210 mm as defined in 8260 ISO 216 8261 'iso-a6': Specifies the ISO A6 size: 105 mm by 148 mm as defined in 8262 ISO 216 8263 'iso-a7': Specifies the ISO A7 size: 74 mm by 105 mm as defined in 8264 ISO 216 8265 'iso-a8': Specifies the ISO A8 size: 52 mm by 74 mm as defined in ISO 8266 216 8267 'iso-a9': Specifies the ISO A9 size: 37 mm by 52 mm as defined in ISO 8268 216 8269 'iso-a10': Specifies the ISO A10 size: 26 mm by 37 mm as defined in 8270 ISO 216 8271 'iso-b0': Specifies the ISO B0 size: 1000 mm by 1414 mm as defined in 8272 ISO 216 8273 'iso-b1': Specifies the ISO B1 size: 707 mm by 1000 mm as defined in 8274 ISO 216 8275 'iso-b2': Specifies the ISO B2 size: 500 mm by 707 mm as defined in 8276 ISO 216 8277 'iso-b3': Specifies the ISO B3 size: 353 mm by 500 mm as defined in 8278 ISO 216 8279 'iso-b4': Specifies the ISO B4 size: 250 mm by 353 mm as defined in 8280 ISO 216 8281 'iso-b5': Specifies the ISO B5 size: 176 mm by 250 mm as defined in 8282 ISO 216 8283 'iso-b6': Specifies the ISO B6 size: 125 mm by 176 mm as defined in 8284 ISO 216 8285 'iso-b7': Specifies the ISO B7 size: 88 mm by 125 mm as defined in 8286 ISO 216 8288 Expires August 17, 1999 8290 'iso-b8': Specifies the ISO B8 size: 62 mm by 88 mm as defined in ISO 8291 216 8292 'iso-b9': Specifies the ISO B9 size: 44 mm by 62 mm as defined in ISO 8293 216 8294 'iso-b10': Specifies the ISO B10 size: 31 mm by 44 mm as defined in 8295 ISO 216 8296 'na-letter': Specifies the North American letter size: 8.5 inches by 8297 11 inches 8298 'na-legal': Specifies the North American legal size: 8.5 inches by 14 8299 inches 8300 'executive': Specifies the executive size (7.25 X 10.5 in) 8301 'folio': Specifies the folio size (8.5 X 13 in) 8302 'invoice': Specifies the invoice size (5.5 X 8.5 in) 8303 'ledger': Specifies the ledger size (11 X 17 in) 8304 'quarto': Specifies the quarto size (8.5 X 10.83 in) 8305 'iso-c3': Specifies the ISO C3 size: 324 mm by 458 mm as defined in 8306 ISO 269 8307 'iso-c4': Specifies the ISO C4 size: 229 mm by 324 mm as defined in 8308 ISO 269 8309 'iso-c5': Specifies the ISO C5 size: 162 mm by 229 mm as defined in 8310 ISO 269 8311 'iso-c6': Specifies the ISO C6 size: 114 mm by 162 mm as defined in 8312 ISO 269 8313 'iso-designated-long': Specifies the ISO Designated Long size: 110 mm 8314 by 220 mm as defined in ISO 269 8315 'na-10x13-envelope': Specifies the North American 10x13 size: 10 8316 inches by 13 inches 8317 'na-9x12-envelope': Specifies the North American 9x12 size: 9 inches 8318 by 12 inches 8319 'na-number-10-envelope': Specifies the North American number 10 8320 business envelope size: 4.125 inches by 9.5 inches 8321 'na-7x9-envelope': Specifies the North American 7x9 inch envelope 8322 size 8323 'na-9x11-envelope': Specifies the North American 9x11 inch envelope 8324 size 8325 'na-10x14-envelope': Specifies the North American 10x14 inch envelope 8326 size 8327 'na-number-9-envelope': Specifies the North American number 9 8328 business envelope size 8329 'na-6x9-envelope': Specifies the North American 6x9 envelope size 8330 'na-10x15-envelope': Specifies the North American 10x15 envelope size 8331 'monarch-envelope': Specifies the Monarch envelope size (3.87 x 7.5 8332 in) 8333 'jis-b0': Specifies the JIS B0 size: 1030mm x 1456mm 8334 'jis-b1': Specifies the JIS B1 size: 728mm x 1030mm 8335 'jis-b2': Specifies the JIS B2 size: 515mm x 728mm 8336 'jis-b3': Specifies the JIS B3 size: 364mm x 515mm 8337 'jis-b4': Specifies the JIS B4 size: 257mm x 364mm 8338 'jis-b5': Specifies the JIS B5 size: 182mm x 257mm 8339 'jis-b6': Specifies the JIS B6 size: 128mm x 182mm 8340 'jis-b7': Specifies the JIS B7 size: 91mm x 128mm 8341 'jis-b8': Specifies the JIS B8 size: 64mm x 91mm 8342 'jis-b9': Specifies the JIS B9 size: 45mm x 64mm 8343 'jis-b10': Specifies the JIS B10 size: 32mm x 45mm 8345 Expires August 17, 1999 8347 16. APPENDIX D: Processing IPP Attributes 8349 When submitting a print job to a Printer object, the IPP model allows a 8350 client to supply operation and Job Template attributes along with the 8351 document data. These Job Template attributes in the create request 8352 affect the rendering, production and finishing of the documents in the 8353 job. Similar types of instructions may also be contained in the 8354 document to be printed, that is, embedded within the print data itself. 8355 In addition, the Printer has a set of attributes that describe what 8356 rendering and finishing options which are supported by that Printer. 8357 This model, which allows for flexibility and power, also introduces the 8358 potential that at job submission time, these client-supplied attributes 8359 may conflict with either: 8361 - what the implementation is capable of realizing (i.e., what the 8362 Printer supports), as well as 8363 - the instructions embedded within the print data itself. 8365 The following sections describe how these two types of conflicts are 8366 handled in the IPP model. 8368 16.1 Fidelity 8370 If there is a conflict between what the client requests and what a 8371 Printer object supports, the client may request one of two possible 8372 conflict handling mechanisms: 8374 1) either reject the job since the job can not be processed exactly 8375 as specified, or 8376 2) allow the Printer to make any changes necessary to proceed with 8377 processing the Job the best it can. 8379 In the first case the client is indicating to the Printer object: "Print 8380 the job exactly as specified with no exceptions, and if that can't be 8381 done, don't even bother printing the job at all." In the second case, 8382 the client is indicating to the Printer object: "It is more important to 8383 make sure the job is printed rather than be processed exactly as 8384 specified; just make sure the job is printed even if client supplied 8385 attributes need to be changed or ignored." 8387 The IPP model accounts for this situation by introducing an "ipp- 8388 attribute-fidelity" attribute. 8390 In a create request, "ipp-attribute-fidelity" is a boolean operation 8391 attribute that is OPTIONALLY supplied by the client. The value 'true' 8392 indicates that total fidelity to client supplied Job Template attributes 8393 and values is required. The client is requesting that the Job be 8394 printed exactly as specified, and if that is not possible then the job 8395 MUST be rejected rather than processed incorrectly. The value 'false' 8396 indicates that a reasonable attempt to print the Job is acceptable. If 8397 a Printer does not support some of the client supplied Job Template 8398 attributes or values, the Printer MUST ignore them or substitute any 8400 Expires August 17, 1999 8401 supported value for unsupported values, respectively. The Printer may 8402 choose to substitute the default value associated with that attribute, 8403 or use some other supported value that is similar to the unsupported 8404 requested value. For example, if a client supplies a "media" value of 8405 'na-letter', the Printer may choose to substitute 'iso-a4' rather than a 8406 default value of 'envelope'. If the client does not supply the "ipp- 8407 attribute-fidelity" attribute, the Printer assumes a value of 'false'. 8409 Each Printer implementation MUST support both types of "fidelity" 8410 printing (that is whether the client supplies a value of 'true' or 8411 'false'): 8413 - If the client supplies 'false' or does not supply the attribute, 8414 the Printer object MUST always accept the request by ignoring 8415 unsupported Job Template attributes and by substituting unsupported 8416 values of supported Job Template attributes with supported values. 8417 - If the client supplies 'true', the Printer object MUST reject the 8418 request if the client supplies unsupported Job Template attributes. 8420 Since a client can always query a Printer to find out exactly what is 8421 and is not supported, "ipp-attribute-fidelity" set to 'false' is useful 8422 when: 8424 1) The End-User uses a command line interface to request attributes 8425 that might not be supported. 8426 2) In a GUI context, if the End User expects the job might be moved 8427 to another printer and prefers a sub-optimal result to nothing at 8428 all. 8429 3) The End User just wants something reasonable in lieu of nothing at 8430 all. 8432 16.2 Page Description Language (PDL) Override 8434 If there is a conflict between the value of an IPP Job Template 8435 attribute and a corresponding instruction in the document data, the 8436 value of the IPP attribute SHOULD take precedence over the document 8437 instruction. Consider the case where a previously formatted file of 8438 document data is sent to an IPP Printer. In this case, if the client 8439 supplies any attributes at job submission time, the client desires that 8440 those attributes override the embedded instructions. Consider the case 8441 were a previously formatted document has embedded in it commands to load 8442 'iso-a4' media. However, the document is passed to an end user that 8443 only has access to a printer with 'na-letter' media loaded. That end 8444 user most likely wants to submit that document to an IPP Printer with 8445 the "media" Job Template attribute set to 'na-letter'. The job 8446 submission attribute should take precedence over the embedded PDL 8447 instruction. However, until companies that supply document data 8448 interpreters allow a way for external IPP attributes to take precedence 8449 over embedded job production instructions, a Printer might not be able 8450 to support the semantics that IPP attributes override the embedded 8451 instructions. 8453 Expires August 17, 1999 8454 The IPP model accounts for this situation by introducing a "pdl- 8455 override-supported" attribute that describes the Printer objects 8456 capabilities to override instructions embedded in the PDL data stream. 8457 The value of the "pdl-override-supported" attribute is configured by 8458 means outside the scope of this IPP/1.1 document. 8460 This REQUIRED Printer attribute takes on the following values: 8462 - 'attempted': This value indicates that the Printer object attempts 8463 to make the IPP attribute values take precedence over embedded 8464 instructions in the document data, however there is no guarantee. 8465 - 'not-attempted': This value indicates that the Printer object makes 8466 no attempt to make the IPP attribute values take precedence over 8467 embedded instructions in the document data. 8469 At job processing time, an implementation that supports the value of 8470 'attempted' might do one of several different actions: 8472 1) Generate an output device specific command sequence to realize the 8473 feature represented by the IPP attribute value. 8474 2) Parse the document data itself and replace the conflicting 8475 embedded instruction with a new embedded instruction that matches 8476 the intent of the IPP attribute value. 8477 3) Indicate to the Printer that external supplied attributes take 8478 precedence over embedded instructions and then pass the external 8479 IPP attribute values to the document data interpreter. 8480 4) Anything else that allows for the semantics that IPP attributes 8481 override embedded document data instructions. 8483 Since 'attempted' does not offer any type of guarantee, even though a 8484 given Printer object might not do a very "good" job of attempting to 8485 ensure that IPP attributes take a higher precedence over instructions 8486 embedded in the document data, it would still be a conforming 8487 implementation. 8489 At job processing time, an implementation that supports the value of 8490 'not-attempted' might do one of the following actions: 8492 1) Simply pre-pend the document data with the PDL instruction that 8493 corresponds to the client-supplied PDL attribute, such that if the 8494 document data also has the same PDL instruction, it will override 8495 what the Printer object pre-pended. In other words, this 8496 implementation is using the same implementation semantics for the 8497 client-supplied IPP attributes as for the Printer object defaults. 8498 2) Parse the document data and replace the conflicting embedded 8499 instruction with a new embedded instruction that approximates, but 8500 does not match, the semantic intent of the IPP attribute value. 8502 Note: The "ipp-attribute-fidelity" attribute applies to the Printer's 8503 ability to either accept or reject other unsupported Job Template 8504 attributes. In other words, if "ipp-attribute-fidelity" is set to 8505 'true', a Job is accepted if and only if the client supplied Job 8506 Template attributes and values are supported by the Printer. Whether 8507 these attributes actually affect the processing of the Job when the 8509 Expires August 17, 1999 8510 document data contains embedded instructions depends on the ability of 8511 the Printer to override the instructions embedded in the document data 8512 with the semantics of the IPP attributes. If the document data 8513 attributes can be overridden ("pdl-override-supported" set to 8514 'attempted'), the Printer makes an attempt to use the IPP attributes 8515 when processing the Job. If the document data attributes can not be 8516 overridden ("pdl-override-supported" set to 'not-attempted'), the 8517 Printer makes no attempt to override the embedded document data 8518 instructions with the IPP attributes when processing the Job, and hence, 8519 the IPP attributes may fail to affect the Job processing and output when 8520 the corresponding instruction is embedded in the document data. 8522 16.3 Using Job Template Attributes During Document Processing. 8524 The Printer object uses some of the Job object's Job Template attributes 8525 during the processing of the document data associated with that job. 8526 These include, but are not limited to, "orientation-requested", "number- 8527 up", "sides", "media", and "copies". The processing of each document in 8528 a Job Object MUST follow the steps below. These steps are intended only 8529 to identify when and how attributes are to be used in processing 8530 document data and any alternative steps that accomplishes the same 8531 effect can be used to implement this specification. 8533 1. Using the client supplied "document-format" attribute or some form 8534 of document format detection algorithm (if the value of "document- 8535 format" is not specific enough), determine whether or not the 8536 document data has already been formatted for printing. If the 8537 document data has been formatted, then go to step 2. Otherwise, the 8538 document data MUST be formatted. The formatting detection algorithm 8539 is implementation defined and is not specified by this 8540 specification. The formatting of the document data uses the 8541 "orientation-requested" attribute to determine how the formatted 8542 print data should be placed on a print-stream page, see section 8543 4.2.10 for the details. 8545 2. The document data is in the form of a print-stream in a known 8546 media type. The "page-ranges" attribute is used to select, as 8547 specified in section 4.2.7, a sub-sequence of the pages in the 8548 print-stream that are to be processed and images. 8550 3. The input to this step is a sequence of print-stream pages. This 8551 step is controlled by the "number-up" attribute. If the value of 8552 "number-up" is N, then during the processing of the print-stream 8553 pages, each N print-stream pages are positioned, as specified in 8554 section 4.2.9, to create a single impression. If a given document 8555 does not have N more print-stream pages, then the completion of the 8556 impression is controlled by the "multiple-document-handling" 8557 attribute as described in section 4.2.4; when the value of this 8558 attribute is 'single-document' or 'single-document-new-sheet', the 8559 print-stream pages of document data from subsequent documents is 8560 used to complete the impression. 8562 Expires August 17, 1999 8563 The size(scaling), position(translation) and rotation of the print- 8564 stream pages on the impression is implementation defined. Note 8565 that during this process the print-stream pages may be rendered to 8566 a form suitable for placing on the impression; this rendering is 8567 controlled by the values of the "printer-resolution" and "print- 8568 quality" attributes as described in sections 4.2.12 and 4.2.13. In 8569 the case N=1, the impression is nearly the same as the print-stream 8570 page; the differences would only be in the size, position and 8571 rotation of the print-stream page and/or any decoration, such as a 8572 frame to the page, that is added by the implementation. 8574 4. The collection of impressions is placed, in sequence, onto sides 8575 of the media sheets. This placement is controlled by the "sides" 8576 attribute and the orientation of the print-stream page, as 8577 described in section 4.2.8. The orientation of the print-stream 8578 pages affects the orientation of the impression; for example, if 8579 "number-up" equals 2, then, typically, two portrait print-stream 8580 pages become one landscape impression. Note that the placement of 8581 impressions onto media sheets is also controlled by the "multiple- 8582 document-handling" attribute as described in section 4.2.4. 8584 5. The "copies" and "multiple-document-handling" attributes are used 8585 to determine how many copies of each media instance are created and 8586 in what order. See sections 4.2.5 and 4.2.4 for the details. 8588 6. When the correct number of copies are created, the media instances 8589 are finished according to the values of the "finishings" attribute 8590 as described in 4.2.6. Note that sometimes finishing operations may 8591 require manual intervention to perform the finishing operations on 8592 the copies, especially uncollated copies. This specification allows 8593 any or all of the processing steps to be performed automatically or 8594 manually at the discretion of the Printer object. 8596 17. APPENDIX E: Generic Directory Schema 8598 This section defines a generic schema for an entry in a directory 8599 service. A directory service is a means by which service users can 8600 locate service providers. In IPP environments, this means that IPP 8601 Printers can be registered (either automatically or with the help of an 8602 administrator) as entries of type printer in the directory using an 8603 implementation specific mechanism such as entry attributes, entry type 8604 fields, specific branches, etc. IPP clients can search or browse for 8605 entries of type printer. Clients use the directory service to find 8606 entries based on naming, organizational contexts, or filtered searches 8607 on attribute values of entries. For example, a client can find all 8608 printers in the "Local Department" context. Authentication and 8609 authorization are also often part of a directory service so that an 8610 administrator can place limits on end users so that they are only 8611 allowed to find entries to which they have certain access rights. IPP 8612 itself does not require any specific directory service protocol or 8613 provider. 8615 Expires August 17, 1999 8616 Note: Some directory implementations allow for the notion of "aliasing". 8617 That is, one directory entry object can appear as multiple directory 8618 entry object with different names for each object. In each case, each 8619 alias refers to the same directory entry object which refers to a single 8620 IPP Printer object. 8622 The generic schema is a subset of IPP Printer Job Template and Printer 8623 Description attributes (sections 4.2 and 4.4). These attributes are 8624 identified as either RECOMMENDED or OPTIONAL for the directory entry 8625 itself. This conformance labeling is NOT the same conformance labeling 8626 applied to the attributes of IPP Printers objects. The conformance 8627 labeling in this Appendix is intended to apply to directory templates 8628 and to IPP Printer implementations that subscribe by adding one or more 8629 entries to a directory. RECOMMENDED attributes SHOULD be associated 8630 with each directory entry. OPTIONAL attributes MAY be associated with 8631 the directory entry (if known or supported). In addition, all directory 8632 entry attributes SHOULD reflect the current attribute values for the 8633 corresponding Printer object. 8635 The names of attributes in directory schema and entries SHOULD be the 8636 same as the IPP Printer attribute names as shown. 8638 In order to bridge between the directory service and the IPP Printer 8639 object, one of the RECOMMENDED directory entry attributes is the Printer 8640 object's "printer-uri-supported" attribute. The IPP client queries the 8641 "printer-uri-supported" attribute in the directory entry and then 8642 addresses the IPP Printer object using one of its URIs. The "uri- 8643 security-supported" attribute identifies the protocol (if any) used to 8644 secure a channel. 8646 The following attributes define the generic schema for directory entries 8647 of type PRINTER: 8649 printer-uri-supported RECOMMENDED Section 4.4.1 8650 uri-security-supported RECOMMENDED Section 4.4.2 8651 printer-name RECOMMENDED Section 4.4.3 8652 printer-location RECOMMENDED Section 4.4.4 8653 printer-info OPTIONAL Section 4.4.5 8654 printer-more-info OPTIONAL Section 4.4.6 8655 printer-make-and-model RECOMMENDED Section 4.4.8 8656 charset-supported OPTIONAL Section 4.4.15| 8657 generated-natural-language- 8658 supported OPTIONAL Section 4.4.17 8659 document-format-supported RECOMMENDED Section 4.4.19 8660 color-supported RECOMMENDED Section 4.4.23 8661 finishings-supported OPTIONAL Section 4.2.6 8662 number-up-supported OPTIONAL Section 4.2.7 8663 sides-supported RECOMMENDED Section 4.2.8 8664 media-supported RECOMMENDED Section 4.2.11 8665 printer-resolution-supported OPTIONAL Section 4.2.12 8666 print-quality-supported OPTIONAL Section 4.2.13 8667 pages-per-minute OPTIONAL Section 4.4.33 8668 pages-per-minute-color OPTIONAL Section 4.4.34 8670 Expires August 17, 1999 8672 18. APPENDIX F: Differences between the IPP/1.0 and IPP/1.1 "Model and 8673 Semantics" Specifications 8675 The following IPP/1.0 [IPP-MOD1.0] extensions and clarifications have 8676 been incorporated into IPP/1.1: 8678 1. Section 3.1.7 - clarified that only the version number parameter 8679 will be carried forward into future major or minor versions of the 8680 protocol. 8681 2. Section 3.2.1.1 - clarified that the Printer object rejects a 8682 Print-Job request if it does not support the "compression" 8683 operation attribute and a client supplies it. 8684 3. Sections 3.2.7, 3.2.8, and 3.2.9 - added the OPTIONAL Pause- 8685 Printer, Resume-Printer, and Purge-Jobs operations 8686 4. Sections 3.3.5, 3.3.6, and 3.3.7 - added the OPTIONAL Hold-Job, 8687 Release-Job, and Restart-Job operations. 8689 5. Section 4.1.9 - added 'image-tiff' and 'application/pdf' values. 8691 6. Section 4.2.2 - added the 'indefinite' keyword value to the "job- 8692 hold-until" attribute for use with the create operations and Hold- 8693 Job and Restart-Job operations. 8695 7. Section 4.2.6 - added more enum values to the "finishings" Job 8696 Template attribute. 8698 8. Section 4.3.7.1 - added the Partitioning of Job States section. 8699 9. Section 4.3.8 - added the 'job-restartable' keyword value to the 8700 "job-state-reasons" attribute for use with the Restart-Job 8701 operation. 8702 10. Section 4.4.2 - added the 'tls' keyword value to the "uri- 8703 security-supported" attribute. 8704 11. Section 4.4.11 - added the 'moving-to-paused' keyword value to 8705 the "printer-state-reasons" attribute for use with the Pause-Job 8706 operation. 8708 12. Section 4.4.11 - replaced the duplicate 'marker-supply-low' 8709 keyword with the missing 'toner-empty' keyword for the "printer- 8710 state-reasons" attribute. 8712 13. Section 4.4.13 - added the enum values to the "operations- 8713 supported" attribute for the new operations. Clarified that the 8714 values of this attribute are encoded as any enum, namely 32-bit 8715 values. 8716 14. Sections 4.4.33 and 4.4.34 - added the OPTIONAL "pages-per- 8717 minute" and "pages-per-minute-color" Printer Description 8718 attributes. 8719 15. Section 8.5 - added the security discussion around the new 8720 operator operations. 8721 16. Section 17 - added the OPTIONAL "pages-per-minute" and "pages- 8722 per-minute-color" Printer attributes to the Directory schema. 8724 The following changes were made to IPP/1.0 [IPP-MOD1.0] to create this 8725 IPP/1.1 document: 8727 Expires August 17, 1999 8728 1. Section 3.1.7, 5.2.4, and 14.1.5.4 - IPP objects MUST support both 8729 version 1.0 and 1.1. Clients MUST support version 1.1 and MAY 8730 support version 1.0. 8732 2. Section 4.1.9 - deleted 'text/plain; charset=iso-10646-ucs-2', 8733 since binary is not legal with the 'text' type. 8735 3. Section 5.4, 8.2, and 8.7 - changed the IPP object security 8736 requirements from OPTIONAL non-standards track SSL3 to RECOMMENDED 8737 standards track TLS. Changed the client security requirements from 8738 RECOMMENDED non-standards track SSL3 to RECOMMENDED standards track 8739 TLS 8741 See also the "IPP/1.1 Encoding and Transport" [ipp-pro] document for 8742 differences between IPP/1.0 [IPP-PRO1.0] and IPP/1.1 [IPP-PRO]. 8744 Expires August 17, 1999