idnits 2.17.1 draft-ietf-ipp-job-printer-set-ops-03.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: ---------------------------------------------------------------------------- ** 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. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. ** The abstract seems to contain references ([RFC2568], [RFC2616], [RFC2569], [IPP-IIG], [RFC2911,RFC2910], [RFC2910], [RFC2911], [RFC2565,RFC2566], [RFC2567]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. == There are 4 instances of lines with non-RFC2606-compliant FQDNs in the document. == There are 5 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. RFC 2119 keyword, line 35: '...ies 3 additional OPTIONAL operations f...' RFC 2119 keyword, line 80: '... IPP/1.0. A few OPTIONAL operator ope...' RFC 2119 keyword, line 219: '...fines additional OPTIONAL end user, op...' RFC 2119 keyword, line 225: '...Values operation MUST be supported, if...' RFC 2119 keyword, line 241: '...Attributes operations, the client MUST...' (181 more instances...) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 950 has weird spacing: '... set in a Set...' == Line 1282 has weird spacing: '... supply sup...' == Line 1491 has weird spacing: '...onse to indic...' == Line 1855 has weird spacing: '...e to be sup...' == Line 1895 has weird spacing: '...Integer eac...' == (2 more instances...) -- 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 (January 22, 2001) is 8495 days in the past. Is this intentional? 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: 'RFC2026' is mentioned on line 22, but not defined == Missing Reference: 'RFC2567' is mentioned on line 66, but not defined == Missing Reference: 'RFC2568' is mentioned on line 68, but not defined == Missing Reference: 'IPP-IIG' is mentioned on line 71, but not defined == Missing Reference: 'RFC2569' is mentioned on line 72, but not defined == Missing Reference: 'RFC2616' is mentioned on line 91, but not defined ** Obsolete undefined reference: RFC 2616 (Obsoleted by RFC 7230, RFC 7231, RFC 7232, RFC 7233, RFC 7234, RFC 7235) == Missing Reference: 'RFC2119' is mentioned on line 260, but not defined ** Obsolete normative reference: RFC 2565 (Obsoleted by RFC 2910) ** Obsolete normative reference: RFC 2566 (Obsoleted by RFC 2911) ** Obsolete normative reference: RFC 2910 (Obsoleted by RFC 8010) ** Obsolete normative reference: RFC 2911 (Obsoleted by RFC 8011) Summary: 11 errors (**), 0 flaws (~~), 16 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 INTERNET-DRAFT T. Hastings 3 R. Herriot 4 Category: standards track Xerox Corporation 5 Carl Kugler 6 H. Lewis 7 IBM Corporation 8 January 22, 2001 10 Internet Printing Protocol (IPP): 11 Job and Printer Set Operations 13 Copyright (C) The Internet Society (2001). All Rights Reserved. 15 Status of this Memo 17 This document is an Internet-Draft and is in full conformance with 18 all provisions of Section 10 of [RFC2026]. Internet-Drafts are 19 working documents of the Internet Engineering Task Force (IETF), its 20 areas, and its working groups. Note that other groups may also 21 distribute working documents as Internet-Drafts. 23 Internet-Drafts are draft documents valid for a maximum of six months 24 and may be updated, replaced, or obsoleted by other documents at any 25 time. It is inappropriate to use Internet-Drafts as reference 26 material or to cite them other than as "work in progress". 28 The list of current Internet-Drafts can be accessed at 29 http://www.ietf.org/ietf/1id-abstracts.txt 30 The list of Internet-Draft Shadow Directories can be accessed as 31 http://www.ietf.org/shadow.html. 33 Abstract 35 This document specifies 3 additional OPTIONAL operations for use with 36 the Internet Printing Protocol/1.0 (IPP) [RFC2565, RFC2566], IPP/1.1 37 [RFC2911, RFC2910], and future versions. The end user, operator, and 38 administrator Set-Job-Attributes and Set-Printer-Attributes 39 operations are used to modify IPP Job objects and Printer objects, 40 respectively. The third administrator Get-Printer-Supported-Values 41 operation returns values that the IPP Printer will accept for setting 42 its "xxx-supported" attributes. 44 Three out-of-band values are defined for use with these operations: 45 'delete-attribute', 'admin-define', and 'not-settable', along with a 46 'client-error-attributes-not-settable' status code. 48 Two operation attributes: "printer-message-from-operator" (text) and 49 "job-message-from-operator" (text) are defined to set the 50 corresponding IPP/1.1 Printer and Job Description attributes with the 51 same names. 53 Nine Printer Description attributes are defined: 54 printer-settable-attributes-supported (1setOf type2 keyword) 55 job-settable-attributes-supported (1setOf type2 keyword) 56 document-format-varying-attributes (1setOf type2 keyword) 57 printer-message-time (integer(MIN:MAX)) 58 printer-message-date-time (dateTime) 59 printer-xri-supported (1setOf collection) 60 xri-uri-scheme-supported (1setOf uriScheme) 61 xri-authentication-supported (1setOf type2 keyword) 62 xri-security-supported (1setOf type2 keyword) 64 The full set of IPP documents includes: 66 Design Goals for an Internet Printing Protocol [RFC2567] 67 Rationale for the Structure and Model and Protocol for the Internet 68 Printing Protocol [RFC2568] 69 Internet Printing Protocol/1.1: Model and Semantics [RFC2911] 70 Internet Printing Protocol/1.1: Encoding and Transport [RFC2910] 71 Internet Printing Protocol/1.1: Implementer's Guide [IPP-IIG] 72 Mapping between LPD and IPP Protocols [RFC2569] 74 The "Design Goals for an Internet Printing Protocol" document takes a 75 broad look at distributed printing functionality, and it enumerates 76 real-life scenarios that help to clarify the features that need to be 77 included in a printing protocol for the Internet. It identifies 78 requirements for three types of users: end users, operators, and 79 administrators. It calls out a subset of end user requirements that 80 are satisfied in IPP/1.0. A few OPTIONAL operator operations have 81 been added to IPP/1.1. 83 The "Rationale for the Structure and Model and Protocol for the 84 Internet Printing Protocol" document describes IPP from a high level 85 view, defines a roadmap for the various documents that form the suite 86 of IPP specification documents, and gives background and rationale 87 for the IETF working group's major decisions. 89 The "Internet Printing Protocol/1.1: Encoding and Transport" document 90 is a formal mapping of the abstract operations and attributes defined 91 in the model document onto HTTP/1.1 [RFC2616]. It defines the 92 encoding rules for a new Internet MIME media type called 93 "application/ipp". This document also defines the rules for 94 transporting over HTTP a message body whose Content-Type is 95 "application/ipp". This document defines a new scheme named 'ipp' 96 for identifying IPP printers and jobs. 98 The "Internet Printing Protocol/1.1: Implementer's Guide" document 99 gives insight and advice to implementers of IPP clients and IPP 100 objects. It is intended to help them understand IPP/1.1 and some of 101 the considerations that may assist them in the design of their client 102 and/or IPP object implementations. For example, a typical order of 103 processing requests is given, including error checking. Motivation 104 for some of the specification decisions is also included. 106 The "Mapping between LPD and IPP Protocols" document gives some 107 advice to implementers of gateways between IPP and LPD (Line Printer 108 Daemon) implementations. 110 Table of Contents 112 1 Introduction....................................................8 114 2 Terminology.....................................................8 115 2.1 Conformance Terminology......................................9 116 2.2 Other terminology............................................9 118 3 Requirements and Use Cases......................................9 120 4 Definition of the Set operations...............................10 121 4.1 Set-Printer-Attributes Operation............................11 122 4.1.1 Settable and READ-ONLY Printer Description attributes.....13 123 4.1.2 Set-Printer-Attributes Request............................15 124 4.1.3 Set-Printer-Attributes Response...........................16 125 4.2 Set-Job-Attributes Operation................................18 126 4.2.1 Settable and READ-ONLY Job Description attributes.........21 127 4.2.2 Set-Job-Attributes Request................................21 128 4.2.3 Set-Job-Attributes Response...............................22 129 4.3 Get-Printer-Supported-Values Operation......................24 130 4.3.1 Definition of the usage of the 'admin-define' out-of-band 131 attribute value...................................................25 133 5 New Operation attributes.......................................27 134 5.1 printer-message-from-operator (text(127))...................27 135 5.2 job-message-from-operator (text(127)).......................28 137 6 New Printer Description Attributes.............................29 138 6.1 printer-settable-attributes-supported (1setOf type2 keyword)29 139 6.2 job-settable-attributes-supported (1setOf type2 keyword)....30 140 6.3 document-format-varying-attributes (1setOf type2 keyword)...30 141 6.4 printer-message-time (integer(MIN:MAX)).....................31 142 6.5 printer-message-date-time (dateTime)........................31 143 6.6 printer-xri-supported (1setOf collection)...................32 144 6.7 xri-uri-scheme-supported (1setOf uriScheme).................34 145 6.8 xri-authentication-supported (1setOf type2 keyword).........35 146 6.9 xri-security-supported (1setOf type2 keyword)...............35 148 7 Additional status codes........................................35 149 7.1 'client-error-attributes-not-settable' (0x0413).............35 151 8 Additional out-of-band values..................................36 152 8.1 'not-settable' out-of-band value............................36 153 8.1.1 Encoding of the 'not-settable' out-of-band attribute value37 154 8.2 'delete-attribute' out-of-band value........................37 155 8.2.1 Encoding of the 'delete-attribute' out-of-band value......37 156 8.3 'admin-define' out-of-band attribute value..................38 157 8.3.1 Encoding of the 'admin-define' out-of-band attribute value39 158 9 Conformance Requirements.......................................39 160 10 IANA Considerations............................................41 161 10.1 Operation Registrations.....................................41 162 10.2 Attribute Registrations.....................................41 163 10.3 Status code Registrations...................................42 164 10.4 Out-of-band Attribute Value Registrations...................42 166 11 Internationalization Considerations............................43 168 12 Security Considerations........................................43 170 13 Author's Addresses.............................................44 172 14 References.....................................................45 174 15 Appendix A: Allowed Values for Set-Printer-Attributes and Set-Job- 175 Attributes requests...............................................46 177 16 Appendix B: Attributes returned from Get-Printer-Supported-Values 178 60 180 17 Appendix C: Full Copyright Statement...........................65 182 Table of Tables 184 Table 1 - Operation-Id assignments................................11 185 Table 2 - Job State Transition Table for the Set-Job-Attributes 186 operation .....................................................20 187 Table 3 - Member attributes of "printer-xri-supported" (1setOf 188 collection) ...................................................33 189 Table 4 - Validation rules for 'Any of "xxx-supported" '..........47 190 Table 5 - Validation rules for 'From Get-Printer-Supported-Values'48 191 Table 6 - Values allowed for Job Template Attributes in the Set-Job- 192 Attributes Operation ..........................................50 193 Table 7 - Values allowed for Job Description Attributes in the Set- 194 Job-Attributes Operation ......................................52 195 Table 8 - Values allowed for Printer Job Template Attributes in the 196 Set-Printer-Attributes Operation ..............................54 197 Table 9 - Values allowed for Printer Description Attributes in the 198 Set-Printer-Attributes Operation ..............................57 199 Table 10 - Printer Job Template Attributes returned from Get-Printer- 200 Supported-Values ..............................................61 201 Table 11 - Printer Job Template Attributes returned from Get-Printer- 202 Supported-Values ..............................................61 203 Table 12 - Printer Description Attributes returned from Get-Printer- 204 Supported-Values ..............................................62 205 Table 13 - Printer Job Template Attributes returned from Get-Printer- 206 Supported-Values ..............................................62 208 Table 14 - Printer Job Template Attributes returned from Get-Printer- 209 Supported-Values ..............................................63 210 Table 15 - Printer Description Attributes returned from Get-Printer- 211 Supported-Values ..............................................64 213 1 Introduction 215 The Internet Printing Protocol (IPP) is an application level protocol 216 that can be used for distributed printing using Internet tools and 217 technologies. IPP version 1.1 [RFC2911, RFC2910] focuses on end user 218 functionality with a few administrative operations included. This 219 document defines additional OPTIONAL end user, operator, and 220 administrator Set-Job-Attributes and Set-Printer-Attributes 221 operations used to modify IPP Job objects and Printer objects, 222 respectively. It also defines a third administrator Get-Printer- 223 Supported-Values operation that returns values that the IPP Printer 224 will accept for setting its "xxx-supported" attributes. The Get- 225 Printer-Supported-Values operation MUST be supported, if the 226 implementation supports setting any "xxx-supported" Printer 227 attributes using the Set-Printer-Attributes operation. 229 Three out-of-band values are defined for use with these three 230 operations: 'delete-attribute' for deleting Job attributes with the 231 Set-Job-Attributes request, 'not-settable' for use in either the Set- 232 Job-Attributes or Set-Printer-Attributes responses, and 'admin- 233 define' for use in the Get-Printer-Supported-Values response. 235 Two operation attributes: "printer-message-from-operator" (text) and 236 "job-message-from-operator" (text) are defined to set the 237 corresponding IPP/1.1 Printer and Job Description attributes with the 238 same names. These operation attributes may be used with any 239 operation that affect the Printer or Job object for which an 240 operation might want to indicate a message. For the Set-Job- 241 Attributes and Set-Printer-Attributes operations, the client MUST 242 explicitly set them, rather than using these operation attributes. 244 A Printer implementation can make the value of some attributes 245 dependent on the document-format, e.g. "resolution-supported". 247 This document is an extension to IPP/1.0 [RFC2565, RFC2566] and 248 IPP/1.1 [RFC2911, RFC2910], and future versions. 250 2 Terminology 252 This section defines terminology used throughout this document. 254 2.1 Conformance Terminology 256 Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD 257 NOT, MAY, NEED NOT, and OPTIONAL, have special meaning relating to 258 conformance. These terms are defined in [RFC2911] section 12.1 on 259 conformance terminology, most of which is taken from RFC 2119 260 [RFC2119]. 262 The following specialization of these terms apply to this document: 264 REQUIRED: if an implementation supports the extensions described in 265 this document, it MUST support a REQUIRED feature. 266 OPTIONAL: if an implementation supports the extensions described in 267 this document, it MAY support an OPTIONAL feature. 269 2.2 Other terminology 271 This document uses terms such as Job object (or Job), IPP Printer 272 object (or Printer), "operation", "request", response", "attributes", 273 "keywords", and "support". These terms have special meaning and are 274 defined in the model terminology [RFC2911] section 12.2. The 275 following additional terms are introduced in this document: 277 READ-ONLY: used in an attribute definition document to indicate that 278 the attribute MUST NOT be settable using an IPP protocol Set 279 operation. In other words, the attribute is not settable by 280 definition. 281 not-settable: an implementation does not support setting an 282 attribute (whether or not the attribute's definition is READ-ONLY). 284 3 Requirements and Use Cases 286 The following requirements and usage are intended to be met by the 287 specification in this document. 289 1. The end-user and the operator need a way to modify a Job that is in 290 the 'pending' or 'pending-held' state. 292 Usage: The end-user discovers that he/she forgot to include a 293 print instruction, such as "finishings" = 'staple' after submitting 294 a job. Rather than canceling the job and resubmitting it to the 295 same IPP Printer, the end-user is able to modify the job on the IPP 296 Printer. 298 The operator needs to modify a job because it is requesting a 299 particular kind of media for which there is no more, but the policy 300 is to print the job on a comparable medium. 302 2. The system administrator needs a way to re-configure or change the 303 policy of the IPP Printer remotely. 305 Usage: The system administrator is adding additional named media 306 to the supported media list (setting 'name' values to the "media- 307 supported" Printer attribute). 309 The system administrator is reducing the capability of the IPP 310 Printer by removing one of the operations from the supported 311 operations list, such as Cancel-Job, because the policy is to run 312 the IPP Printer like a public facsimile machine. After having 313 removed Cancel-Job from the list of supported operations, an 314 administrative client needs to be able to display to an 315 administrator that the implementation is capable of being 316 reconfigured to support Cancel-Job once again. 318 The system administrator is remotely configuring the IPP Printer 319 after installing it, and so is replacing the Printer Description 320 attributes that have the out-of-band 'no-value' value (see 321 [RFC2911] section 4.1) with the proper values. 323 The operator is changing the media loaded in the input tray and so 324 is replacing the "media-ready" Job Template Printer attribute value 325 with the proper values 327 4 Definition of the Set operations 329 The Set-Printer-Attributes operation (as are all Printer operations) 330 are directed at Printer objects. A client MUST always supply the 331 "printer-uri" operation attribute in order to identify the correct 332 target of the operation. These descriptions assume all of the common 333 semantics of IPP/1.1 Model and Semantics document [RFC2911] section 334 3.1. 336 The Set-Job-Attributes operation (as are all Job operations) are 337 directed at Job objects. A client MUST always supply some means of 338 identifying the Job object in order to identify the correct target of 339 the operation. That job identification MAY either be a single Job 340 URI or a combination of a Printer URI with a Job ID as defined in 341 [RFC2911]. The IPP object implementation MUST support both forms of 342 identification for every job. If possible, a client SHOULD use the 343 Printer URI with a Job ID rather than a Job URI, since the 32-bit 344 "job-id" is more readily translated to and from other print protocols 345 that MAY be serving as gateways into or out of the IPP 346 implementation. 348 The Set Printer operations are summarized in Table 1: 350 Table 1 - Operation-Id assignments 352 Operation Name Operation Brief description 353 -Id 355 Set-Printer- 0x0013 Sets attribute values of the target 356 Attributes Printer object 358 Set-Job-Attributes 0x0014 Sets attribute values of the target 359 Job object 361 Get-Printer- 0x0015 Gets values that are valid for 362 Supported-Values setting "xxx-supported" attributes 363 using the Set-Printer-Attributes 364 operation 366 4.1 Set-Printer-Attributes Operation 368 This OPTIONAL operation allows a client to set the values of the 369 attributes of a Printer object. In the request, the client supplies 370 the set of Printer keyword attribute names and values that are to be 371 set. In the response, the Printer object returns success or rejects 372 the entire request with indications of which attribute or attributes 373 could not be set. 375 The Printer object validates the client-supplied attributes in the 376 Set-Printer-Attributes request. For an attribute to validate it MUST 377 meet all of the following rules: 379 1. The number of attributes supplied by the client MUST NOT exceed the 380 maximum number that the Printer supports in a Set-Printer- 381 Attributes request. A Printer MUST accept at least one attribute, 382 but SHOULD accept a reasonable number in a single Set-Printer- 383 Attributes request. 385 Note: There is no way for the client to determine the maximum 386 number of attributes that the Printer supports in a Set-Printer- 387 Attributes request, except to try a reasonable number. 389 2. The Printer MUST support the attribute. 391 3. The attribute MUST NOT be READ-ONLY, i.e., the definition of the 392 attribute MUST NOT indicate that the attribute is READ-ONLY (see 393 Appendix A for an indication of which IPP/1.1 attributes are READ- 394 ONLY). 396 4. The attribute MUST be settable in this implementation. 398 5. The Printer MUST support the value according to the rules defined 399 in Appendix A, i.e., each value of each supplied "xxx" attribute 400 MUST be validated against a value of a corresponding "xxx- 401 supported" Printer attribute. One of those rules permits an 402 administrator to set arbitrary 'name' values to those "xxx- 403 supported" Printer attributes that include the 'name' attribute 404 syntax if the implementation supports the 'admin-define' out-of- 405 band value for that "xxx-supported" attribute (see section 15 and 406 8.3). 408 6. The attribute's values MUST NOT conflict with the values of other 409 Printer attributes, including ones being set in this same 410 operation. 412 If any of the supplied attributes does not validate, the Printer 413 object MUST reject the entire operation; the Printer object MUST NOT 414 partially set some of the supplied attributes. In other words, after 415 the operation, all the supplied attributes MUST be set or none of 416 them MUST be set, thus making the Set-Printer-Attributes an atomic 417 operation. 419 The Printer MUST accept this operation when its READ-ONLY "printer- 420 state" attribute (see RFC2911] section 4.4.11) is 'idle' or 421 'stopped', and SHOULD accept it when the value is 'processing'. The 422 Printer MUST accept this operation for any of the values of the 423 Printer object's READ-ONLY "printer-state-reasons" and "printer-is- 424 accepting-jobs" attributes, unless explicitly defined otherwise in 425 the definition of these attributes' values. 427 This operation MUST NOT change the value of attributes not specified 428 in the operation unless the definition of the attribute explicitly 429 specifies such side-effects. For example, this document explicitly 430 specifies that when this operation sets "printer-message-from- 431 operator", the Printer also MUST set the READ-ONLY "printer-message- 432 time" and READ-ONLY "printer-message-date-time" attributes to the 433 time of the operation as a side effect . In particular, if this 434 operation changes an "xxx-default" attribute, the new value MUST be 435 in the "xxx-supported" attribute or the request MUST contain a new 436 value for "xxx-supported" which contains the new value for the "xxx- 437 default". Otherwise, the Printer MUST reject the operation. In 438 general, Printer attribute definitions that are settable will not 439 define side-effects on other attributes that are settable, only side 440 effects on READ-ONLY attributes, if any. 442 4.1.1 Settable and READ-ONLY Printer Description attributes 444 If the Printer supports the Set-Printer-Attributes operation, then it 445 SHOULD support setting of: 447 all Job Template Default ("xxx-default") attributes 449 all Job Template Supported ("xxx-supported") attributes 451 all Job Template Ready ("xxx-ready") attributes 453 that the implementation supports (see [RFC2911] section 4.2 and 454 extensions). 456 Some Printer Description attributes (see [RFC2911] section 4.4) MUST 457 NOT be settable, i.e., they are defined to be READ-ONLY. An 458 attribute marked as "READ-ONLY" in the Printer Description attribute 459 table in Appendix A is such an attribute. The Printer attributes 460 that are not marked as "READ-ONLY" MAY be settable using the Set- 461 Printer-Attributes operation, depending on implementation. 463 Note: From now on, all extensions that define new object attributes 464 will indicate whether or not the attributes are READ-ONLY, by 465 including the "READ-ONLY" adjective in their descriptions and/or 466 explicitly stating whether they MAY be settable. 468 The current values of each "xxx-supported" Printer attribute MUST 469 reflect the current policy for support of the corresponding "xxx" 470 attribute. If an "xxx-supported" Printer attribute is settable in an 471 implementation, then its value(s) MUST affect the behavior of the 472 implementation. If an "xxx-supported" Printer attribute is defined 473 to be READ-ONLY or is not-settable in an implementation, then its 474 values MUST NOT be settable using the Set-Printer-Attributes 475 operation. Consider the following example: 477 For example, if the "operations-supported" Printer Description 478 attribute (see [RFC2911] section 4.4.15) is settable in a 479 particular implementation, then changing its value with a Set- 480 Printer-Attributes operation MUST affect the operations that the 481 implementation accepts or rejects. Such an implementation will 482 need to be able to reject values for operations that it contains no 483 code support for (see section 4.3). If the "operations-supported" 484 Printer Description attribute is not settable in a particular 485 implementation, then that implementation MUST reject an attempt to 486 set it with a Set-Printer-Attributes operation, return the 'client- 487 error-attributes-not-settable' status code (see section 7.1), and 488 return the "operations-supported" attribute with the out-of-band 489 'not-settable' value in the Unsupported Attributes Group. 491 As another example, consider an implementation in which the "media- 492 default" and "media-supported" are settable. If a client supplies 493 a Set-Printer-Attributes request that contains the "media-default" 494 attribute with a value that is not a member of the Printer's 495 "media-supported" attribute, the Printer MUST reject the request 496 and return the "client-error-conflicting-attributes" status code 497 with the "media-default" and "media-supported" attributes and their 498 values (see [RFC2911] section 3.1.7). 500 As a third example, if a client supplies a Set-Printer-Attributes 501 request that contains both the "media-default" and the "media- 502 supported" attributes, but includes a value in the "media-default" 503 that is not a member of the supplied "media-supported" attribute, 504 the Printer MUST reject the request and return the "client-error- 505 conflicting-attributes" status code with the "media-default" and 506 "media-supported" attributes and their values (see [RFC2911] 507 section 3.1.7). 509 Access Rights: The authenticated user (see [RFC2911] section 8.3) 510 performing this operation must be an operator or administrator of the 511 Printer object (see [RFC2911] Sections 1 and 8.5). Most Printer 512 attributes will require administrator access rights to set, such as 513 "xxx-supported", while some will require operator access rights only, 514 such as "media-ready" and "printer-message-from-operator". Which 515 attributes require which access rights depends on implementation and 516 MAY depend on site policy. 518 4.1.2 Set-Printer-Attributes Request 520 The following sets of attributes are part of the Set-Printer- 521 Attributes Request: 523 Group 1: Operation Attributes 525 Natural Language and Character Set: 526 The "attributes-charset" and "attributes-natural-language" 527 attributes as described in [RFC2911] section 3.1.4.1. 529 Target: 530 The "printer-uri" (uri) operation attribute which is the target 531 for this operation as described in [RFC2911] section 3.1.5. 533 Requesting User Name: 534 The "requesting-user-name" (name(MAX)) attribute SHOULD be 535 supplied by the client as described in [RFC2911] section 8.3. 537 "document-format" (mimeMediaType): 538 The client OPTIONALLY supplies this attribute. The Printer 539 object MUST support this attribute. This attribute is useful 540 for a client to select the document-format to which the 541 attribute modification should be applied. A Printer 542 implementation MAY allow some attributes to have different 543 values for each document format that it supports. See [RFC2911] 544 section 3.2.5.1 "Get-Printer-Attributes Request". 546 If the client includes this attribute, the Printer MUST change 547 the supplied attributes for the document format specified by 548 this attribute. If a supplied attribute is a member of the 549 "document-format-varying-attributes" (i.e., the attribute 550 varies by document format, see section 6.3), the Printer MUST 551 change the supplied attribute for the document format specified 552 by this attribute, but not for other document formats. If a 553 supplied attribute isn't a member of the "document-format- 554 varying-attributes" (i.e. it doesn't vary by document format), 555 the Printer MUST change the supplied attribute for all document 556 formats. 558 If the client omits this attribute, the Printer MUST change the 559 supplied attributes for all document formats whether or not 560 they vary by document-format. 562 If the client supplies a value for the "document-format" 563 Operation attribute that is either 'application/octet-stream' 564 or not supported by the Printer, i.e., is not among the values 565 of the Printer object's "document-format-supported" attribute, 566 the Printer object MUST reject the operation and return the 567 'client-error-document-format-not-supported' status code. 568 Note: the document-format 'application/octet-stream' is the 569 union of several document-formats (see [RFC2911] section 570 3.2.5.1, Get-Printer-Attributes) and is not a true document- 571 format. 573 Group 2: Printer Attributes 575 The client MUST supply a set of Printer attributes with one or 576 more values (including explicitly allowed out-of-band values) 577 as defined in [RFC2911] section 4.2 Job Template Attributes 578 ("xxx-default", "xxx-supported", and "xxx-ready" attributes), 579 section 4.4 Printer Description Attributes, and any attribute 580 extensions supported by the Printer. The value(s) of each 581 Printer attribute supplied in Group 2 replaces the value(s) of 582 the corresponding Printer attribute on the target Printer 583 object. For attributes that can have multiple values (1setOf), 584 all values supplied by the client replace all values of the 585 corresponding Printer object attribute. If a Printer object 586 attribute had not been configured yet and so had the 'no-value' 587 out-of-band value (see [RFC2911] section 4.1), the supplied 588 value(s) replace the 'no-value' value. 590 4.1.3 Set-Printer-Attributes Response 592 The Printer object returns the following sets of attributes as part 593 of the Get-Printer-Attributes Response: 595 Group 1: Operation Attributes 597 Status Message: 598 In addition to the REQUIRED status code returned in every 599 response, the response OPTIONALLY includes a "status-message" 600 (text(255)) and/or a "detailed-status-message" (text(MAX)) 601 operation attribute as described in [RFC2911] sections 13 and 602 3.1.6. 604 Natural Language and Character Set: 605 The "attributes-charset" and "attributes-natural-language" 606 attributes as described in [RFC2911] section 3.1.4.2. 608 Group 2: Unsupported Attributes 610 See [RFC2911] section 3.1.7 for details on returning 611 Unsupported Attributes. 613 If some of the attributes in the operation fail to validate, 614 the Printer MUST reject the operation, MUST NOT change any 615 Printer attributes, and MUST return the indicated status code 616 below. In this group, the Printer MUST also return all 617 attributes that fail to validate. The following are the 618 reasons that an attribute fails to validate and the value 619 returned for the attribute, along with the indicated status 620 code and order of detection: 622 1.The number of attributes supplied by the client exceeds the 623 maximum number that the Printer supports in a Set-Printer- 624 Attributes request: return the 'client-error-request- 625 entity-too-large' (see [RFC2911] section 13.1.4.9). 627 2.The Printer doesn't support the attribute: return the 628 attribute with the "out-of-band" value 'unsupported' (see 629 [RFC2911] section 3.1.7 and [RFC2910]) and the 'client- 630 error-attributes-or-values-not-supported (see [RFC2911] 631 section 13.1.4.12). 633 3.The attribute is either READ-ONLY (in its definition) or is 634 not-settable in this implementation: return the attribute 635 with the "out-of-band" value 'not-settable' (see section 636 8.1) and the 'client-error-attributes-not-settable' status 637 code (see section 7.1). 639 4.The Printer doesn't support the value: if the attribute in 640 the operation has a single value return it. If the 641 attribute in the operation is multi-valued, return only 642 those values in a 1setOf that are not supported. Return the 643 'client-error-attributes-or-values-not-supported' status 644 code (see [RFC2911] section 13.1.4.12). 646 5.The values of some of the supplied attributes conflict with 647 one another and/or other Printer attribute values not being 648 set: if the conflicting attribute in the operation has a 649 single value return the attribute and the value. If the 650 attribute in the operation is multi-valued, return only the 651 attribute and those values in a 1setOf that are conflicting 652 with other attributes. Return the 'client-error- 653 conflicting-attributes' status code (see [RFC2911] section 654 13.1.4.15). 656 4.2 Set-Job-Attributes Operation 658 This OPTIONAL operation allows a client to set the values of the 659 attributes of a Job object. In the request, the client supplies the 660 set of Job keyword attribute names and values that are to be set. In 661 the response, the IPP object returns success or rejects the entire 662 request with indications of which attribute or attributes could not 663 be set. 665 This operation is almost identical to the Set-Printer-Attributes 666 operation and follows the same rules for validation (see section 667 4.1). The only differences are that the Set-Job-Attributes operation 668 is directed at a Job object rather than a Printer object, there is no 669 "document-format" operation attribute used when setting a Job object, 670 the operation can add an attribute to the (Job) object, the 'delete- 671 attributes' out-of-band value is permitted to remove an attribute, 672 and the validation is the same as the Job Creation operations (Print- 673 Job, Print-URI, and Create-Job), i.e., depends on the "xxx-supported" 674 Printer Description attributes (see [RFC2911] section 3.1). Using 675 the Set-Printer-Attributes operation, the administrator can set 676 arbitrary 'name' values to those "xxx-supported" Printer attributes 677 that include the 'name' attribute syntax if the implementation 678 supports the 'admin-define' out-of-band value for that "xxx- 679 supported" attribute (see section 15 and 8.3). However, the Set-Job- 680 Attributes cannot be used to add unsupported names to the Job object. 682 If a client supplies a job attribute in a Set-Job-Attributes request 683 that the Printer supports, and the job was originally submitted 684 without supplying that attribute, the Printer adds the attribute to 685 the Job object. 687 If the client supplies a job attribute with the "out-of-band" value 688 'delete-attribute' (see section 8.2), then the Printer MUST remove 689 the attribute and all of its values from the Job object, if present. 690 The semantic effect of the client supplying the 'delete-attribute' 691 value in a Set-Job-Attributes operation MUST be the same as if the 692 attribute had not been supplied with the Job object in the Job 693 Creation operation, i.e., the Printer applies its default attribute 694 or behavior with lower precedence that the PDL (see the beginning of 695 [RFC2911] section 4.2 and [RFC2911] 3.2.1.1). Any subsequent query 696 of the Job object using Get-Job-Attributes or Get-Jobs MUST NOT 697 return any attribute that has been deleted using the 'delete- 698 attribute' out-of-band value. However, a client can re-establish 699 such a deleted Job attribute with any supported value(s) using a 700 subsequent Set-Job-Attributes operation. 702 If the client supplies an attribute in a Set-Job-Attributes request 703 with the 'delete-attribute' value and that attribute is not present 704 on the Job object, the Printer ignores that supplied attribute in the 705 request, does not return the attribute in the Unsupported Attributes 706 group, and returns the 'successful-ok' status code, if there are no 707 other problems with the request. 709 The validation of the Set-Job-Attributes request is performed by the 710 Printer as if the job had been submitted originally with the new 711 attribute values (and the deleted attributes removed) and with "ipp- 712 attribute-fidelity" set to 'true', i.e., all modified attributes Job 713 attributes and values MUST be supported in combination with the Job 714 attributes not modified. If such a Job Creation operation would have 715 been accepted, then the Set-Job-Attributes MUST be accepted. If such 716 a Job Creation operation would have been rejected, then the Set-Job- 717 Attributes MUST be rejected and the Job MUST be unchanged. In 718 addition, if any of the supplied attributes are not supported, are 719 not settable, or the values are not supported, the Printer object 720 MUST reject the entire operation; the Printer object MUST NOT 721 partially set some of the supplied attributes. In other words, after 722 the operation, all the supplied attributes MUST be set or none of 723 them MUST be set, thus making the Set-Job-Attributes an atomic 724 operation. 726 The IPP object MUST accept or reject this operations when the Job's 727 READ-ONLY "job-state" attribute has the values shown in Table 2. The 728 job's current state MUST affect whether the IPP object accepts or 729 rejects the request. For example, in the case where the operation 730 creates a request for unavailable resources, the Job transitions to a 731 new state. Table 2 shows the allowed behaviors in each job state and 732 the transitions. 734 Table 2 - Job State Transition Table for the Set-Job-Attributes 735 operation 737 Current "job- New "job- IPP object's response status code 738 state" state" and action: 740 'pending' 'pending' 'successful-ok' 742 'pending' 'pending-held' 'successful-ok' - needed resources 743 are not ready 745 'pending-held' 'pending-held' 'successful-ok' 747 'pending-held' 'pending' 'successful-ok' - needed resources 748 are ready 750 'processing' 'processing' 'successful-ok' or 'client-error- 751 not-possible' depending on 752 implementation, including the 753 attributes being set, whether the 754 job has started marking media, 755 etc. 757 'processing- 'processing- 'successful-ok' or 'client-error- 758 stopped' stopped' not-possible' depending on 759 implementation, including the 760 attributes being set, whether the 761 job has started marking media, 762 etc. 764 'completed' 'completed' 'client-error-not-possible' 766 'canceled' 'canceled' 'client-error-not-possible' 768 'aborted' 'aborted' 'client-error-not-possible' 770 This operation MUST NOT change the value of attributes not specified 771 in the operation unless the definition of the attribute explicitly 772 specifies such side-effects. In general, Job attribute definitions 773 that are settable will not define side-effects on other attributes 774 that are settable, only side effects on READ-ONLY attributes, if any. 776 4.2.1 Settable and READ-ONLY Job Description attributes 778 If the Printer supports the "job-message-from-operator" Job 779 Description attribute (see [RFC2911] section 4.3.16) and the client 780 explicitly supplies a new value for the "job-message-from-operator" 781 in the Set-Job-Attributes request, then the Printer MUST set the 782 "job-message-from-operator" Job attribute to this new value. 784 If the Printer supports the Set-Job-Attributes operation, then it 785 SHOULD support setting of: 787 all Job Template job ("xxx") attributes 789 that the implementation supports (see [RFC2911] section 4.2 and 790 extensions). 792 Some Job Description attributes (see [RFC2911] section 4.3) MUST NOT 793 be settable, i.e., they are defined to be READ-ONLY. An attribute 794 marked as "READ-ONLY" in the Job Description attribute table in 795 Appendix A is such an attribute. The Job attributes not marked as 796 "READ-ONLY" MAY be settable using the Set-Job-Attributes operation, 797 depending on implementation. 799 Note: From now on, all extensions that define new object attributes 800 will indicate whether or not the attributes are READ-ONLY, by 801 including the "READ-ONLY" adjective in their descriptions and/or 802 explicitly stating whether they MAY be settable. 804 Access Rights: The authenticated user (see [RFC2911] section 8.3) 805 performing this operation must either be the job owner (as determined 806 in the Job Creation operation) or an operator or administrator of the 807 Printer object (see [RFC2911] Sections 1 and 8.5). 809 4.2.2 Set-Job-Attributes Request 811 The following sets of attributes are part of the Set-Job-Attributes 812 Request: 814 Group 1: Operation Attributes 815 Natural Language and Character Set: 816 The "attributes-charset" and "attributes-natural-language" 817 attributes as described in [RFC2911] section 3.1.4.1. 819 Target: 820 Either (1) the "printer-uri" (uri) plus "job-id" 821 (integer(1:MAX)) or (2) the "job-uri" (uri) operation 822 attribute(s) which define the target for this operation as 823 described in [RFC2911] section 3.1.5. 825 Requesting User Name: 826 The "requesting-user-name" (name(MAX)) attribute SHOULD be 827 supplied by the client as described in [RFC2911] section 8.3. 829 Group 2: Job Attributes 831 The client MUST supply a set of Job attributes with one or more 832 values (including explicitly allowed out-of-band values) as 833 defined in [RFC2911] section 4.2 Job Template Attributes ("xxx" 834 attributes), section 4.3 Job Description Attributes, and any 835 attribute extensions supported by the Printer. The value(s) of 836 each Job attribute supplied in Group 2 replaces the value(s) of 837 the corresponding Job attribute on the target Job object. For 838 attributes that can have multiple values (1setOf), all values 839 supplied by the client replace all values of the corresponding 840 Job object attribute. 842 If the client supplies an "xxx" attribute with the 'delete- 843 attribute' out-of-band value (see section 8.2), the Printer 844 MUST remove the "xxx" attribute from the Job object, if 845 present. 847 4.2.3 Set-Job-Attributes Response 849 The IPP object returns the following sets of attributes as part of 850 the Set-Job-Attributes Response: 852 Group 1: Operation Attributes 854 Status Message: 855 In addition to the REQUIRED status code returned in every 856 response, the response OPTIONALLY includes a "status-message" 857 (text(255)) and/or a "detailed-status-message" (text(MAX)) 858 operation attribute as described in [RFC2911] sections 13 and 859 3.1.6. 861 Natural Language and Character Set: 862 The "attributes-charset" and "attributes-natural-language" 863 attributes as described in [RFC2911] section 3.1.4.2. 865 Group 2: Unsupported Attributes 867 See [RFC2911] section 3.1.7 for details on returning 868 Unsupported Attributes. 870 If some of the attributes in the operation fail to validate, 871 the Printer MUST reject the operation, MUST NOT change any Job 872 attributes, and MUST return the indicated status code below. 873 In this group, the Printer MUST also return all attributes that 874 fail to validate. The following are the reasons that an 875 attribute fails to validate and the value returned for the 876 attribute, along with the indicated status code and order of 877 detection: 879 1.The number of attributes supplied by the client exceeds the 880 maximum number that the Printer supports in a Set-Printer- 881 Attributes request: return the 'client-error-request- 882 entity-too-large' (see [RFC2911] section 13.1.4.9). 884 2.The Printer doesn't support the attribute: return the 885 attribute with the 'unsupported' out-of-band attribute value 886 (see [RFC2911] section 3.1.7 and [RFC2910]) and the 'client- 887 error-attributes-or-values-not-supported (see [RFC2911] 888 section 13.1.4.12). 890 3.The attribute is READ-ONLY (in its definition) or is not- 891 settable in this implementation: return the attribute with 892 the 'not-settable' out-of-band attribute value (see section 893 8.1) and the 'client-error-attributes-not-settable' status 894 code (see section 7.1). 896 4.The Printer doesn't support the value: if the attribute in 897 the operation has a single value return it. If the 898 attribute in the operation is multi-valued, return only 899 those values in a 1setOf that are not supported. Return the 900 'client-error-attributes-or-values-not-supported' status 901 code (see [RFC2911] section 13.1.4.12). 903 5.The values of some of the supplied attributes conflict with 904 one another and/or other Job attribute values not being set: 905 if the conflicting attribute in the operation has a single 906 value return the attribute and the value. If the attribute 907 in the operation is multi-valued, return only the attribute 908 and those values in a 1setOf that are conflicting with other 909 attributes. Return the 'client-error-conflicting- 910 attributes' status code (see [RFC2911] section 13.1.4.15). 912 4.3 Get-Printer-Supported-Values Operation 914 This OPTIONAL operation allows a client to request the values that 915 the Printer allows in the Set-Printer-Attributes operation for "xxx- 916 supported" attributes. If the Printer supports the Set-Printer- 917 Attributes operation AND some of its "xxx-supported" Printer 918 attributes are settable, then the Printer MUST also support this 919 operation. 921 The Printer MUST return in the Get-Printer-Supported-Values response 922 those, and only those, "xxx-supported" Printer attributes that it 923 supports setting with the Set-Printer-Attributes operation. 924 Furthermore, if a client requests the value of an attribute that is 925 not settable or is not supported (as in the Get-Printer-Attributes 926 response), the Unsupported Attributes Group of the response NEED NOT 927 contain the "requested-attributes" operation attribute with any such 928 requested (attribute keyword) values. 930 This operation has identical request/response attributes to the Get- 931 Printer-Attributes operation in IPP/1.1 [RFC2911]. The operation 932 also behaves identically to the Get-Printer-Attributes operation in 933 IPP/1.1 [RFC2911] with the following exceptions: 935 1.The Get-Printer-Supported-Values operation supports only "xxx- 936 supported" attributes. 938 2.The Get-Printer-Attributes operation returns the few "xxx- 939 supported" attributes that are defined to be single valued, such 940 as "page-ranges-supported" (boolean) or "pdl-override-supported" 941 (type2 keyword), as single values, while Get-Printer-Supported- 942 Values returns the possible values that can be set as a 1setOf of 943 the same attribute syntax type (See Appendix B: Attributes 944 returned from Get-Printer-Supported-Values). 946 3.The Get-Printer-Attributes operation returns the current values of 947 requested attributes while the Get-Printer-Supported-Values 948 operation returns the values that are inherently supported by the 949 implementation code, i.e., the values that an administrative 950 client can set in a Set-Printer-Attributes request. 952 4.The Get-Printer-Attributes operation returns the current values of 953 requested "xxx-supported" attributes that the Printer is 954 configured to accept in Job Creation operations, including 955 additional values defined by the administrator, while the Get- 956 Printer-Supported-Values operation returns only the values of 957 "xxx-supported" attributes that are inherently supported by the 958 implementation and does not return any additional values defined 959 by the administrator where the implementation supports the 'admin- 960 define' out-of-band value. 962 5.The Get-Printer-Attributes never returns the 'admin-define' out- 963 of-band attribute value, while the Get-Printer-Supported- 964 Attributes operation does, if the implementation allows the 965 administrator to define name values by setting that "xxx- 966 supported" attribute with any 'name' value(s). 968 6.The Get-Printer-Attributes operation only requires end-user access 969 rights, while the Get-Printer-Supported-Values requires 970 administrator access rights. 972 Access Rights: The authenticated user (see [RFC2911] section 8.3) 973 performing this operation must be an administrator of the Printer 974 object (see [RFC2911] Sections 1 and 8.5). 976 4.3.1 Definition of the usage of the 'admin-define' out-of-band 977 attribute value 979 If the Set-Printer-Attributes operation allows the System 980 Administrator to define arbitrary 'name' values for an "xxx- 981 supported" attribute, then the Get-Printer-Supported-Values operation 982 MUST return the 'admin-define' out-of-band attribute value (see 983 section 8.3) as one of the values of the "xxx-supported" attribute. 984 In other words, the 'admin-define' out-of-band attribute value 985 indicates that the Printer implementation supports clients setting 986 arbitrary 'name' attribute syntax values for that "xxx-supported" 987 attribute using the Set-Printer-Attributes operation as long as the 988 attribute is defined with the 'name' attribute syntax. 990 For example, if the Get-Printer-Supported-Values operation returns 991 several keywords as the value of the "media-supported" attribute, 992 then the Set-Printer-Attributes operation MUST accept any of these 993 keywords as values for the "media-supported" attribute. If the Get- 994 Printer-Supported-Values operation returns an 'admin-define' out-of- 995 band attribute value as one of the values of the "media-supported" 996 attribute, then the Set-Printer-Attributes operation MUST accept any 997 value whose attribute syntax is 'name' as a value for the "media- 998 supported" attribute (provided that the user is properly 999 authenticated to use the Set-Printer-Attributes operation, e.g., has 1000 administrative access rights). 1002 The Get-Printer-Supported-Values MAY return the 'admin-define' out- 1003 of-band attribute value for any IPP/1.1 or extension Job Template 1004 attribute if the implementation supports allowing the System 1005 Administrator to add values to the "xxx-supported" attribute using 1006 the Set-Printer-Attributes operation. In this case, the Printer MUST 1007 accept any 'name' value of the correct attribute syntax in a Set- 1008 Printer-Attributes operation that is setting that attribute. For 1009 "xxx-supported" attributes that are defined with a choice of 1010 attribute syntaxes, such as 'keyword | name', it is the 'name' 1011 attribute syntax that the System Administrator can use to add new 1012 values, not the 'keyword' attribute syntax. For IPP/1.1 this 1013 requirement includes the following Job Template attributes: 1015 media-supported 1016 job-hold-until-supported 1017 job-sheets-supported 1019 Implementations that support additional Job Template attributes that 1020 include the 'name' attribute syntax, MAY use the 'admin-define' out- 1021 of-band value with them. 1023 If the 'admin-define' out-of-band attribute value is not one of the 1024 values of an "xxx-supported" attribute returned in a Get-Printer- 1025 Supported-Values response, then the Printer MUST NOT allow the Set- 1026 Printer-Attributes operation for that attribute to contain a value 1027 that is not one of the explicit 'keyword' or 'name' values returned 1028 in a Get-Printer-Supported-Values response. 1030 See Appendix B: Attributes returned from Get-Printer-Supported-Values 1031 for a full list of values returned by this operation. 1033 5 New Operation attributes 1035 This section defines new operation attributes for use with the 1036 IPP/1.1 operations indicated. As new operations are defined they 1037 will also indicate explicitly whether these operation attributes are 1038 defined for use with them. 1040 5.1 printer-message-from-operator (text(127)) 1042 The Printer SHOULD support this Operation attribute in following 1043 operations if it supports the corresponding "printer-message-from- 1044 operator" Printer Description attribute. 1046 Pause-Printer 1047 Resume-Printer 1048 Purge-Jobs 1050 The client OPTIONALLY supplies this attribute in the above 1051 operations. The value of this attribute is a message from the 1052 operator about the Printer object on which the operator is performing 1053 the operation. If this operation attribute is supported, the Printer 1054 copies the value to its "printer-message-from-operator" Printer 1055 Description attribute (see [RFC2911] section 4.4.25) even if this 1056 Operation attribute is a zero-length text value or consists solely of 1057 white space. 1059 If the Printer supports this operation attribute, it MUST support 1060 both a zero-length text value and the 'no-value' out-of-band value 1061 (see [RFC2911] section 4.1) to indicate that the operator has sent no 1062 message. In this case, the Printer sets the value of the "printer- 1063 message-from-operator" to the zero-length value or 'no-value' out-of- 1064 band value, respectively. If the client queries the "printer- 1065 message-from-operator" Printer attribute, the Printer returns the 1066 attribute with the zero-length value or the 'no-value' value, 1067 respectively. 1069 In addition, the Printer automatically copies: 1071 1.the value of its "printer-up-time" attribute (see [RFC2911] 1072 section 4.4.29) to its "printer-message-time" attribute, 1074 2.the value of its printer-current-time" (dateTime) attribute (see 1075 [RFC2911] section 4.4.30) to its "printer-message-date-time" 1076 attribute, if supported. 1078 If the client omits this operation attribute, the Printer does not 1079 change the value of its "printer-message-from-operator", "printer- 1080 message-time" and "printer-message-date-time" Printer Description 1081 attributes. 1083 The "printer-message-from-operator" operation attribute MUST NOT be 1084 supported as an operation attribute for the Set-Printer-Attributes 1085 operation. If the operator wants to set the Printer's "printer- 1086 message-from-operator" Printer Description attribute when issuing the 1087 Set-Printer-Attributes operation, the client supplies the "printer- 1088 message-from-operator" explicitly with its new value as one of the 1089 Printer Description attributes in Group 2 in the request. The 1090 Printer also updates its "printer-message-time" and "printer-message- 1091 date-time" Printer Description attributes. If the client does not 1092 explicitly supply the "printer-message-from-operator" with its new 1093 value in the Set-Printer-Attributes request, the Printer leaves the 1094 value of the Printer's "printer-message-from-operator" Printer 1095 Description attribute unchanged. 1097 5.2 job-message-from-operator (text(127)) 1099 The Printer SHOULD support this Operation attribute in following 1100 operations if it supports the corresponding "job-message-from- 1101 operator" Job Description attribute. 1103 Cancel-Job 1104 Hold-Job 1105 Release-Job 1106 Restart-Job 1108 The client OPTIONALLY supplies this attribute in the above 1109 operations. The value of this attribute is a message from the 1110 operator about the Job object on which the operator has just 1111 performed an operation. If supported, the Printer copies the value 1112 to the Job's "job-message-from-operator" Job Description attribute 1113 (see [RFC2911] section 4.3.16) (even if this Operation attribute is a 1114 zero-length text value or consists solely of white space). 1116 If the Printer supports this operation attribute, it MUST support 1117 both a zero-length text value and the 'no-value' out-of-band value 1118 (see [RFC2911] section 4.1) to indicate that the operator has sent no 1119 message. In this case, the Printer sets the value of the "job- 1120 message-from-operator" to the zero-length value or 'no-value' out-of- 1121 band value, respectively. If the client queries the "job-message- 1122 from-operator" Job attribute, the IPP object returns the attribute 1123 with the zero-length value or the 'no-value' value, respectively. 1125 If the client omits this attribute, the Printer does not change the 1126 value of its "job-message-from-operator" Job Description attribute. 1128 Note: There are no corresponding 'job-message-time" and "job- 1129 message-date-time" Job Description attributes, since the usual 1130 lifetime of a job is limited. 1132 The "job-message-from-operator" operation attribute MUST NOT be 1133 supported as an operation attribute for the Set-Job-Attributes 1134 operation. If the operator wants to set the Job's "job-message-from- 1135 operator" Job Description attribute when issuing the Set-Job- 1136 Attributes operation, the client MUST supply the "job-message-from- 1137 operator" with its new value as one of the Job Description attributes 1138 in Group 2 in the request. Otherwise, the Printer leaves the value 1139 of the Job's "job-message-from-operator" Job Description attribute 1140 unchanged by not explicitly setting the attribute. If the client 1141 does not explicitly supply the "job-message-from-operator" with its 1142 new value in the Set-Job-Attributes request, the Printer leaves the 1143 value of the Job's "job-message-from-operator" Job Description 1144 attribute unchanged. 1146 6 New Printer Description Attributes 1148 The following new Printer Description attributes are needed to 1149 support the new operations defined in this document. 1151 6.1 printer-settable-attributes-supported (1setOf type2 keyword) 1153 This REQUIRED READ-ONLY Printer attribute identifies the Printer 1154 object attributes that are settable in this implementation, i.e., 1155 that are settable using the Set-Printer-Attributes operations (see 1156 section 4.1). This attribute MUST be supported if the Set-Printer- 1157 Attributes operations is supported. The Printer MUST reject attempts 1158 to set any Printer attributes that are not one of the values of this 1159 attribute, returning the 'client-error-attributes-not-settable' 1160 status code (see section 7.1). The value of this attribute MAY 1161 depend on the value of the "document-format" operation attribute 1162 supplied in the Get-Printer-Attributes operation (see [RFC2911] 1163 section 3.2.5.1). 1165 Standard keyword values are: 1167 'none': There are no settable Printer attributes. 1168 'xxx': Where 'xxx' is any of the keyword attribute names allowed 1169 by section 4.1.1 1171 6.2 job-settable-attributes-supported (1setOf type2 keyword) 1173 This REQUIRED READ-ONLY Printer attribute identifies the Job object 1174 attributes that are settable in this implementation, i.e., that are 1175 settable using the Set-Job-Attributes operation (see section 4.2). 1176 This attribute MUST be supported if the Set-Job-Attributes operations 1177 is supported. The Printer MUST reject attempts to set any Job 1178 attributes that are not one of the values of this attribute, 1179 returning the 'client-error-attributes-not-settable' status code (see 1180 section 7.1). 1182 Standard keyword values are: 1184 'none': There are no settable Job attributes. 1185 'xxx': Where 'xxx' is any of the keyword attribute names allowed 1186 by section 4.2.1. 1188 6.3 document-format-varying-attributes (1setOf type2 keyword) 1190 This OPTIONAL READ-ONLY Printer Description attribute contains a set 1191 of attribute name keywords. This attribute SHOULD be supported by a 1192 Printer object, if the Printer object has Printer attributes whose 1193 value vary depending on document format (see [RFC2911] Get-Printer- 1194 Attributes operation). This attribute specifies which attribute 1195 values can vary by document-format. If an attribute's name "xxx" is 1196 a member of this attribute and the value of attribute "xxx" is 1197 changed with the Set-Printer-Attributes operation that included the 1198 "document-format" operation attribute, then the Printer MUST change 1199 the value for the specified document format and no other document 1200 formats (see section 4.1.2). If an attribute's name "xxx" is not a 1201 member of this attribute and the value of attribute "xxx" is changed 1202 with the Set-Printer-Attributes operation, then the attribute is 1203 changed for all document formats (whether or not the client supplied 1204 the "document-format" operation attribute). 1206 6.4 printer-message-time (integer(MIN:MAX)) 1208 This OPTIONAL READ-ONLY Printer Description attribute contains the 1209 time that the Printer's "printer-message-from-operator" was changed 1210 by the operator using any operation where the client supplied the 1211 "printer-message-from-operator" operation attribute (see section 5.1) 1212 or was explicitly set using the Set-Printer-Attributes operation (see 1213 section 4.1). This attribute allows the users to know when the 1214 "printer-message-from-operator" attribute was last set. 1216 The Printer sets the value of this attribute by copying the value of 1217 the Printer's "printer-up-time" attribute (see [RFC2911] section 1218 4.3.14). If the Printer resets its "printer-up-time" attribute to 1 1219 on power-up, then it MUST change the value of the "printer-message- 1220 time" to 0 or a negative number as specified in [RFC2911] section 1221 4.3.14. 1223 Note: This attribute helps users better understand the context for 1224 the "printer-message-from-operator" message. 1226 6.5 printer-message-date-time (dateTime) 1228 This OPTIONAL READ-ONLY Printer Description attribute contains the 1229 date and time that the Printer's "printer-message-from-operator" was 1230 changed by the operator using any operation where the client supplied 1231 the "printer-message-from-operator" operation attribute (see section 1232 5.1) or was explicitly set using the Set-Printer-Attributes operation 1233 (see section 4.1). This attribute allows the users to know when the 1234 "printer-message-from-operator" attribute was last set. 1236 This attribute MUST be supported if the Printer supports both the 1237 "printer-message-time" and the "printer-current-time" (dateTime) 1238 attributes (see [RFC2911] section 4.4.30). 1240 Note: This attribute helps users better understand the context for 1241 the "printer-message-from-operator" message. 1243 6.6 printer-xri-supported (1setOf collection) 1245 This OPTIONAL Printer Description attribute is a multi-valued 1246 attribute where each value has the 'collection' attribute syntax (see 1247 [ipp-coll]) containing member attributes with the same semantics as 1248 the following IPP/1.1 READ-ONLY Printer Description attributes, 1249 except for cardinality: 1251 printer-uri-supported (1setOf uri) - see [RFC2911] section 1252 4.4.1 1253 uri-authentication-supported (1setOf type2 keyword) - see 1254 [RFC2911] section 4.4.2 1255 uri-security-supported (1setOf type2 keyword) - see [RFC2911] 1256 section 4.4.3 1258 When setting the "printer-xri-supported" attribute with a Set- 1259 Printer-Attributes request, the Printer MUST also set these three 1260 IPP/1.1 READ-ONLY Printer Description attributes as a defined side 1261 effect. Thus, this collection attribute provides the means to set 1262 these three IPP/1.1 READ-ONLY attributes atomically so that they are 1263 never left in a partially inconsistent state. 1265 An IPP Printer MUST NOT provide any other way using IPP to set these 1266 three IPP/1.1 READ-ONLY Printer Description attributes, since they 1267 are READ-ONLY and MUST have consistent values at all times. Note: 1268 The "xri-printer-supported" (1setOf collection) attribute can be put 1269 into a directory schema that requires a single text string value, 1270 such as SLP or LDPA, by using suitable delimiting characters to 1271 separate member attributes of the collection and/or terminating 1272 collection values. See [svrloc-printer] and [ldap-printer]. 1274 The member attributes of the "printer-xri-supported" (1setOf 1275 collection) are given in Table 3. 1277 Table 3 - Member attributes of "printer-xri-supported" (1setOf 1278 collection) 1280 Member attribute client Printer 1281 MUST MUST 1282 supply support 1284 xri-uri (uri) yes yes 1286 xri-authentication (1setOf type2 keyword) yes yes 1288 xri-security (1setOf type2 keyword) yes yes 1290 Each collection value MUST contain a single unique value for the 1291 "xri-uri" member attribute. However, the other two member attributes 1292 are multi-valued, so that a single URI can support more than one 1293 authentication scheme and/or more than one security scheme. Other 1294 than the uniqueness and the cardinality requirements, the semantics 1295 of these three member attributes is given in [RFC2911] sections 1296 4.4.1, 4.4.2, and 4.4.3, respectively. 1298 A client can query the current values using the Get-Printer- 1299 Attributes operation by supplying either: 1301 1.the three IPP/1.1 attribute names: "printer-uri-supported", "uri- 1302 authentication-supported", "uri-security-supported" and getting 1303 back the parallel values OR 1305 2.the single attribute name: "printer-xri-supported" and getting 1306 back the 1setOf collection which contains the same information 1307 semantically, but in a different form. 1309 A client can query what member attribute values can be set by 1310 supplying the three attribute names: "xri-uri-scheme-supported", 1311 "xri-authentication-supported", and "xri-security-supported" in a 1312 Get-Printer-Supported-Values request and getting back the uriScheme 1313 and type2 keyword values that can be set. Since the "printer-xri- 1314 supported", "uri-authentication-supported", and "uri-security- 1315 supported" attributes are READ-ONLY, they are not queriable with the 1316 Get-Printer-Supported-Values operation (see section 4.3). See Table 1317 15. 1319 When performing a Set-Printer-Attributes operation, if there are 1320 multiple values for the "xri-authentication" and/or "xri-security" 1321 member attributes, the Printer MUST set the corresponding three READ- 1322 ONLY attributes with all possible combinations of values. For 1323 example, setting the "printer-xri-supported" with the following two 1324 collection values where the first URI has both 'basic' and 'digest' 1325 authentication: 1327 "printer-xri-supported = 1328 { "xri-uri" = ipp://abc.com/p1 1329 "xri-authentication" = basic, digest 1330 "xri-security" = tls 1331 }, 1332 { "xri-uri" = http://abc.com/pq 1333 "xri-authentication" = none 1334 "xri-security" = none 1335 } 1337 would cause the Printer to set the three corresponding IPP/1.1 READ- 1338 ONLY attributes, each with three parallel values as follows: 1340 "printer-uri-supported" = { ipp://abc.com/p1, ipp://abc.com/p1, 1341 http://abc.com/pq } 1342 "uri-authentication-supported" = { basic, digest, none } 1343 "uri-security-supported" = { tls, tls, none } 1345 Because there were two authentication values for the ipp://abc.com/p1 1346 URL, that URL value is repeated. Had the ipp URL had 2 1347 authentication values and 3 security values, then there would have 1348 been 7 (2*3 + 1) parallel values for each of the three attributes, 6 1349 with the same ipp URI and 1 with the http URI. 1351 6.7 xri-uri-scheme-supported (1setOf uriScheme) 1353 This OPTIONAL READ-ONLY Printer Description attribute identifies the 1354 URI schemes that the implementation supports for use in the "printer- 1355 uri-supported" (1setOf uri) Printer Description attribute (see 1356 [RFC2911] section 4.4.1) and the "xri-uri" member attribute of the 1357 "xri-printer-supported" (1setOf collection) Printer Description 1358 attribute (see section 6.6). 1360 A Printer MUST support this attribute if it supports setting the 1361 "printer-xri-supported" (1setOf collection) with the Set-Printer- 1362 Attributes operation. 1364 6.8 xri-authentication-supported (1setOf type2 keyword) 1366 This OPTIONAL READ-ONLY Printer Description attribute identifies the 1367 Client Authentication mechanisms that the implementation supports for 1368 use in the "uri-authentication-supported" (1setOf type2 keyword) 1369 Printer Description attribute (see [RFC2911] section 4.4.2) and the 1370 "xri-authentication" member attribute of the "xri-printer-supported" 1371 (1setOf collection) Printer Description attribute (see section 6.6). 1373 A Printer MUST support this attribute if it supports setting the 1374 "printer-xri-supported" (1setOf collection) with the Set-Printer- 1375 Attributes operation. 1377 6.9 xri-security-supported (1setOf type2 keyword) 1379 This OPTIONAL READ-ONLY Printer Description attribute identifies the 1380 URI schemes that the implementation supports for use in the "uri- 1381 security-supported" (1setOf type2 keyword) Printer Description 1382 attribute (see [RFC2911] section 4.4.3) and the "xri-security" member 1383 attribute of the "xri-printer-supported" (1setOf collection) Printer 1384 Description attribute (see section 6.6). 1386 A Printer MUST support this attribute if it supports setting the 1387 "printer-xri-supported" (1setOf collection) with the Set-Printer- 1388 Attributes operation. 1390 7 Additional status codes 1392 This section defines new status codes used by the operations defined 1393 in this document. 1395 7.1 'client-error-attributes-not-settable' (0x0413) 1397 The Set-Printer-Attributes or Set-Job-Attributes operation failed 1398 because one or more of the specified attributes cannot be set either 1399 because the attribute is defined to be READ-ONLY or the attribute is 1400 not settable in this implementation (see sections 4.1.3 and 4.2.3), 1401 the Printer MUST return this error code and the attribute keyword 1402 name(s) and the 'not-settable' out-of-band value (see section 8.1) in 1403 the Unsupported Attributes Group(see [RFC2911] section 3.1.7) for all 1404 of the attributes that could not be set. When the Printer returns 1405 this status, it MUST NOT change any of the attributes supplied in the 1406 operation. 1408 8 Additional out-of-band values 1410 This section defines additional out-of-band values. As with all out- 1411 of-band values, a client or a Printer MUST NOT use an out-of-band 1412 value unless the definition of the attribute in an operation request 1413 and/or response explicitly allows such usage. See the beginning of 1414 [RFC2911] section 4.1. 1416 8.1 'not-settable' out-of-band value 1418 The 'not-settable' out-of-band attribute value is returned by the IPP 1419 Printer in the Unsupported Attributes group of a response to indicate 1420 that the attribute supplied by the client in the request is READ-ONLY 1421 by definition or is not settable in this implementation. 1423 The 'not-settable' out-of-band attribute value is defined for use 1424 with the Set-Job-Attributes and Set-Printer-Attributes response only. 1425 If a future additional "set" operation allows the 'not-settable' out- 1426 of-band value, its definition document MUST indicate such use 1427 explicitly, including with which attributes. 1429 An IPP object MUST support the 'not-settable' out-of-band value in a 1430 Set-Job-Attributes or Set-Printer-Attributes request if it supports 1431 those operations. A client MUST NOT supply the 'not-settable' out- 1432 of-band value in any request. An IPP object MUST NOT support the 1433 'not-settable' out-of-band value in other operations, unless the 1434 operations' definition document explicitly defines such usage. If a 1435 Printer receives this out-of-band value in any operation request, the 1436 Printer MUST either (1) reject the entire request and return the 1437 'client-error-bad-request' status code or (2) ignore the attribute 1438 and return it with the 'unsupported' out-of-band value. 1440 See sections 4.1.3 and 4.2.3 in this document for an example 1441 definition of the usage of the 'not-settable' out-of-band value in 1442 the Set-Printer-Attributes and Set-Job-Attributes responses. 1444 8.1.1 Encoding of the 'not-settable' out-of-band attribute value 1446 The encoding of the 'not-settable' out-of-band value is 0x15 (see 1447 [RFC2910]). The value-length MUST be 0 and the value empty. 1449 8.2 'delete-attribute' out-of-band value 1451 The 'delete-attribute' out-of-band attribute value is supplied by the 1452 client in a request to indicate that the Printer is to remove the 1453 supplied attribute and all of its values from the target object, if 1454 present. 1456 The 'delete-attribute' out-of-band attribute value is defined for use 1457 with the Set-Job-Attributes request only. If a future additional 1458 "set" operation allows the 'delete-attribute' out-of-band value, its 1459 definition document MUST indicate such use explicitly, including with 1460 which attributes. 1462 An IPP Printer MUST support the 'delete-attribute' out-of-band value 1463 if it supports the Set-Job-Attributes operation. A client MUST NOT 1464 supply and an IPP object MUST NOT support the 'delete-attribute' out- 1465 of-band value in other operations, unless the operations' definition 1466 document explicitly defines such usage. For example, the 'delete- 1467 attribute' out-of-band value MUST NOT be used in the Set-Printer- 1468 Attributes operation, where the absence of an attribute from an IPP 1469 object indicates that the attribute is not supported. If a Printer 1470 receives this out-of-band value in other operation requests, the 1471 Printer MUST either (1) reject the entire request and return the 1472 'client-error-bad-request' status code or (2) ignore the attribute 1473 and return it with the 'unsupported' out-of-band value. 1475 See section 4.2 in this document for the definition of the usage of 1476 the 'delete-attribute' out-of-band value in the Set-Job-Attributes 1477 request. 1479 8.2.1 Encoding of the 'delete-attribute' out-of-band value 1481 The encoding of the 'delete-attribute' out-of-band value is 0x16 (see 1482 [RFC2910]). The value-length MUST be 0 and the value empty. 1484 8.3 'admin-define' out-of-band attribute value 1486 Section 4.3 defines the Get-Printer-Supported-Values response to 1487 contain the values of an "xxx-supported" attribute that are supported 1488 by the implementation before any additional value are defined by the 1489 administrator. The 'admin-define' out-of-band attribute value is 1490 returned as an additional value of an "xxx-supported" attribute in a 1491 Get-Printer-Supported-Values response to indicate that the 1492 implementation supports allowing an administrator to define 1493 additional arbitrary 'name' values for that "xxx-supported" 1494 attribute. 1496 For example, if the "media-supported" (1setOf (type3 keyword | name)) 1497 attribute contains this value, then the Printer MUST permit an 1498 administrator to add new media names to the Printer's "media- 1499 supported" attribute. In order for an administrator to add new 1500 values to a Printer's "xxx-supported" attribute, the client supplies 1501 the existing and new values in a Set-Printer-Attributes request for 1502 that attribute. The client MUST supply any such administratively 1503 defined values in the Set-Printer-Attributes request using the 'name' 1504 attribute syntax. 1506 The 'admin-define' out-of-band attribute value is defined for use 1507 with the Get-Printer-Supported-Values response only. A Printer MUST 1508 NOT return the 'admin-define' out-of-band value in a Get-Printer- 1509 Attributes response, since such a response indicates what an end-user 1510 client can supply in a Job Creation operation. If a future 1511 additional "get" operation allows the 'admin-define' out-of-band 1512 value, its definition document MUST indicate such use explicitly, 1513 including with which attributes. 1515 An IPP Printer MUST support the 'admin-define' out-of-band value, if 1516 it supports a client setting arbitrary 'name' values of an "xxx- 1517 supported" Printer attribute using the Set-Printer-Attributes 1518 operation. A client MUST NOT supply the 'admin-define' out-of-band 1519 value in any request. An IPP object MUST NOT support the 'admin- 1520 define' out-of-band value in other operations, unless the operations' 1521 definition document explicitly defines such usage. If a Printer 1522 receives this out-of-band value in any operation request, the Printer 1523 MUST either (1) reject the entire request and return the 'client- 1524 error-bad-request' status code or (2) ignore the attribute and return 1525 it with the 'unsupported' out-of-band value. 1527 This document defines that the 'admin-define' out-of-band value MUST 1528 be used only with "xxx-supported" attributes that are defined to 1529 include the 'name' attribute syntax. This out-of-band value is not 1530 intended to be used with "xxx-supported" attributes of other 1531 attribute syntaxes, such as 'uri', even though the administrator 1532 defines arbitrary values for such attributes. If other documents 1533 extend the use of the 'admin-define' out-of-band value to other 1534 attribute syntaxes, such a document MUST define such use explicitly, 1535 including with which attributes. 1537 See section 4.3 in this document for an example definition of the 1538 usage of the 'admin-define' out-of-band attribute value in any "xxx- 1539 supported" attribute returned in a Get-Printer-Supported-Values 1540 response that is defined to include the 'name' attribute syntax. 1542 8.3.1 Encoding of the 'admin-define' out-of-band attribute value 1544 The encoding of the 'admin-define' out-of-band attribute value is 1545 0x17 (see [RFC2910]). The value-length MUST be 0 and the value 1546 empty. 1548 9 Conformance Requirements 1550 This section specifies the conformance requirements for clients and 1551 IPP objects. 1553 Both the Set-Job-Attributes and the Set-Printer-Attributes operations 1554 defined in the document are OPTIONAL for an IPP object to support. 1555 Either one MAY be supported without the other or both MAY be 1556 supported. However, if the Set-Printer-Attributes operation is 1557 supported, then the Get-Printer-Supported-Values operation MUST be 1558 supported if any "xxx-supported" attributes are settable. Otherwise, 1559 the Get-Printer-Supported-Values operation is OPTIONAL for an IPP 1560 Printer to support. 1562 If the Set-Printer-Attributes operation is supported, then the 1563 Printer MUST support the following additional items: 1565 1.the Get-Printer-Supported-Values operation (see section 5), if 1566 any "xxx-supported" attributes are settable. 1568 2.the "printer-settable-attributes-supported" Printer Description 1569 attribute (see section 6.1) 1571 3.the 'not-settable' out-of-band value in responses (see section 1572 8.1) 1574 4.the 'client-error-not-settable' status code (see section 7.1) 1576 5.If "printer-message-from-operator" Printer Description attribute 1577 is supported (see [RFC2911] section 4.4.25), then it MUST be 1578 settable. 1580 6.the Get-Printer-Supported-Values operation (see section 4.3), if 1581 any "xxx-supported" attributes are settable. 1583 7.If a client can set a value with the 'name' attribute syntax for 1584 one or more "xxx-supported" attributes, then the 'admin-define' 1585 out-of-band attribute value (see section 8.3) MUST be supported 1586 in the Get-Printer-Supported-Values response for each such 1587 settable attribute (see section 4.3) 1589 If the Set-Job-Attributes operation is supported, then the Printer 1590 MUST support the following additional items: 1592 1.the "job-settable-attributes-supported " Printer Description 1593 attribute (see section 6.2) 1595 2.the 'not-settable' out-of-band value in responses (see section 1596 8.1) 1598 3.the 'delete-attribute' out-of-band value in requests (see 1599 section 8.2) 1601 4.the 'client-error-not-settable' status code (see section 7.1) 1603 5.If the "job-message-from-operator" Printer Description attribute 1604 is supported (see [RFC2911] 4.3.16), then it MUST be settable. 1606 It is OPTIONAL for the Printer object to support the "printer- 1607 message-time" (integer) and "printer-message-date-time" (dateTime) 1608 Printer Description attributes. If both the "printer-message-time" 1609 (integer) and the "printer-current-time" (dateTime) (see [RFC2911] 1610 section 4.4.30) attributes are supported, then the "printer-message- 1611 date-time" (dateTime) Printer Description attribute MUST be 1612 supported. 1614 As with all out-of-band values, a client or a Printer MUST NOT use an 1615 out-of-band value unless the definition document for the attribute in 1616 an operation request and/or response explicitly allows such usage. 1618 10 IANA Considerations 1620 This section contains the exact information for IANA to add to the 1621 IPP Registries according to the procedures defined in RFC 2911 1622 [RFC2911] section 6. 1624 Note to RFC Editors: Replace RFC NNNN below with the RFC number for 1625 this document, so that it accurately reflects the content of the 1626 information for the IANA Registry. 1628 10.1 Operation Registrations 1630 The operations defined in this document will be published by IANA 1631 according to the procedures in RFC 2911 [RFC2911] section 6.4 with 1632 the following path: 1634 ftp.isi.edu/iana/assignments/ipp/operations/ 1636 The registry entry will contain the following information: 1638 Operations: Ref. Section: 1639 Set-Printer-Attributes RFC NNNN 4.1 1640 Set-Job-Attributes RFC NNNN 4.2 1641 Get-Printer-Supported-Values RFC NNNN 4.3 1643 10.2 Attribute Registrations 1645 The attributes defined in this document will be published by IANA 1646 according to the procedures in RFC 2911 [RFC2911] section 6.2 with 1647 the following path: 1649 ftp.isi.edu/iana/assignments/ipp/attributes/ 1651 The registry entry will contain the following information: 1653 Operation attributes: Ref. Section: 1654 printer-message-from-operator (text(127)) RFC NNNN 5.1 1655 job-message-from-operator (text(127)) RFC NNNN 5.2 1657 Printer Description attributes: Ref. Section: 1658 printer-settable-attributes-supported (1setOf type2 keyword) 1659 RFC NNNN 6.1 1660 job-settable-attributes-supported (1setOf type2 keyword) 1661 RFC NNNN 6.2 1662 document-format-varying-attributes (1setOf type2 keyword) 1663 RFC NNNN 6.3 1664 printer-message-time (integer(MIN:MAX)) RFC NNNN 6.4 1665 printer-message-date-time (dateTime) RFC NNNN 6.5 1666 printer-xri-supported (1setOf collection) RFC NNNN 6.6 1667 xri-uri-scheme-supported (1setOf uriScheme) RFC NNNN 6.7 1668 xri-authentication-supported (1setOf type2 keyword) 6.8 1669 xri-security-supported (1setOf type2 keyword) RFC NNNN 6.9 1671 10.3 Status code Registrations 1673 The status codes defined in this document will be published by IANA 1674 according to the procedures in RFC 2911 [RFC2911] section 6.6 with 1675 the following path: 1677 ftp.isi.edu/iana/assignments/ipp/status-codes/ 1679 The registry entry will contain the following information: 1681 Status codes: Ref. Section: 1682 'client-error-attributes-not-settable' (0x0413) RFC NNNN 7.1 1684 10.4 Out-of-band Attribute Value Registrations 1686 The out-of-band attribute values defined in this document will be 1687 published by IANA according to the procedures in RFC 2911 [RFC2911] 1688 section 6.7 with the following path: 1690 ftp.isi.edu/iana/assignments/ipp/out-of-band-attribute-value-tags/ 1692 The registry entry will contain the following information: 1694 Out-of-band Attribute Values: Ref. Section: 1695 'not-settable' out-of-band value RFC NNNN 8.1 1696 'delete-attribute' out-of-band value RFC NNNN 8.2 1697 'admin-define' out-of-band attribute value RFC NNNN 8.3 1699 11 Internationalization Considerations 1701 This document has the same localization considerations as the 1702 [RFC2911]. 1704 12 Security Considerations 1706 The IPP Model and Semantics document [RFC2911 section 8] discusses 1707 high level security requirements (Client Authentication, Server 1708 Authentication and Operation Privacy). Client Authentication is the 1709 mechanism by which the client proves its identity to the server in a 1710 secure manner. Server Authentication is the mechanism by which the 1711 server proves its identity to the client in a secure manner. 1712 Operation Privacy is defined as a mechanism for protecting operations 1713 from eavesdropping. 1715 In addition, the introduction of the Set-Printer-Attributes and Set- 1716 Job-Attributes operations creates another security threat, since the 1717 client is able to modify the Printer and Job attributes stored in the 1718 Printer. Such modifications could lead to denial of service. 1720 A malicious user could alter the policy established by the system 1721 administrator and stored in the Printer attributes. Such alteration 1722 could either grant access to more resources or deny access to 1723 resources that the system administrator has established. For 1724 example, the malicious user could remove all of the document-format 1725 values from the "document-format-supported" Printer attribute so that 1726 the Printer would refuse to accept all jobs. 1728 The general remedy for such malicious user actions against Printer 1729 attributes is to have strong Client Authentication coupled with 1730 Printer access control to limit the users who have System 1731 Administrator or Operator privileges. 1733 A malicious user could modify the Job Template attributes of another 1734 user's Job, such as the "copies" attribute. For example, setting the 1735 number of copies to a large number. 1737 The general remedy for such malicious user actions against another 1738 user's job is to have strong Client Authentication coupled with 1739 Printer access control to limit the users who have System 1740 Administrator or Operator privileges who can modify any job and, in 1741 addition, store the Client Authentication with each Job so that only 1742 the job owner End User can modify his/her own job. 1744 13 Author's Addresses 1746 Carl Kugler 1747 IBM 1748 P.O. Box 1900 1749 Boulder, CO 80301-9191 1751 Phone: (303) 924-5060 1752 FAX: 1753 e-mail: kugler@us.ibm.com 1755 Tom Hastings 1756 Xerox Corporation 1757 737 Hawaii St. ESAE 231 1758 El Segundo, CA 90245 1760 Phone: 310-333-6413 1761 Fax: 310-333-5514 1762 e-mail: hastings@cp10.es.xerox.com 1764 Robert Herriot 1765 Xerox Corp. 1766 3400 Hill View Ave, Building 1 1767 Palo Alto, CA 94304 1769 Phone: 650-813-7696 1770 Fax: 650-813-6860 1771 e-mail: robert.herriot@pahv.xerox.com 1773 Harry Lewis 1774 IBM 1775 P.O. Box 1900 1776 Boulder, CO 80301-9191 1778 Phone: (303) 924-5337 1779 FAX: 1780 e-mail: harryl@us.ibm.com 1782 14 References 1784 [ipp-coll] 1785 deBry, R., , Hastings, T., Herriot, R., "Internet Printing Protocol 1786 (IPP): The Collection Attribute Syntax", , work in progress, March 9, 2000. 1789 [ipp-set2] 1790 Kugler, C, Hastings, T., Lewis, H., "Internet Printing 1791 Protocol/1.1: Job and Printer Administrative Operations", , December 8, 1999. 1794 [ldap-printer] 1795 Fleming, P., Jones, K., Lewis, H., McDonald, I., "Internet Printing 1796 Protocol (IPP): LDAP Schema for Printer Services", , work in progress, March 8, 2000. 1799 [RFC2565] 1800 Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing 1801 Protocol/1.0: Encoding and Transport", RFC 2565, April 1999. 1803 [RFC2566] 1804 R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell, 1805 "Internet Printing Protocol/1.0: Model and Semantics", RFC 2566, 1806 April 1999. 1808 [RFC2910] 1809 Herriot, R., Butler, S., Moore, P., Turner, R., "Internet Printing 1810 Protocol/1.1: Encoding and Transport", RFC 2910, September 2000. 1812 [RFC2911] 1813 R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell, 1814 "Internet Printing Protocol/1.0: Model and Semantics", RFC 2911, 1815 September 2000. 1817 [svrloc-printer] 1818 St. Pierre, P., Isaacson, S., McDonald, I., "Definition of the 1819 Printer Abstract Service Type v2.0", , work in progress, March 8, 2000. 1822 15 Appendix A: Allowed Values for Set-Printer-Attributes and Set-Job- 1823 Attributes requests 1825 This appendix is a normative part of this document and contains a 1826 table of all IPP/1.1 attributes. Each row contains: 1828 . an attribute and 1830 . the values allowed in the Set-Printer-Attributes or Set-Job- 1831 Attributes request for the attribute. The entry in each cell is 1832 the name (first few words) of each item below 1, 2, 3, 4a-g, and 1833 5. 1835 The allowed values include the following cases: 1837 1.READ-ONLY: the Set-Printer-Attributes or Set-Job-Attributes 1838 operation MUST NOT change this attribute and MUST reject the 1839 entire operation (see section 7.1). 1841 2.Any of "xxx-supported": the Set-Printer-Attributes or Set-Job- 1842 Attributes operation accepts values that are allowed according to 1843 the IPP/1.1 rules for validating the value(s) of an "xxx" Printer 1844 or Job attribute against the value(s) of the corresponding "xxx- 1845 supported" Printer attribute. Table 4 summarizes those validation 1846 rules depending on each attribute syntax and value of an "xxx" 1847 attribute supplied in the request and that of the corresponding 1848 "xxx-supported" Printer attribute. The "xxx-supported" attribute 1849 syntax type and value(s) are obtained from a Get-Printer- 1850 Supported-Values response (see the tables in this Appendix). 1852 Table 4 - Validation rules for 'Any of "xxx-supported" ' 1854 Type of "xxx" Type of "xxx- Validates if: 1855 value to be supported" value 1856 set 1858 integer rangeOfInteger each value is in one of the 1859 "xxx-supported" ranges 1861 uri uriScheme each uri scheme matches one 1862 of the "xxx-supported" 1863 schemes 1865 any boolean if the boolean "xxx- 1866 supported" is 'true' 1868 any same type each value matches an "xxx- 1869 supported" value of the same 1870 type 1872 For additional non-normative explanatory information see section 1873 3.1.2.3 of the "Internet Printing Protocol/1.1: Implementer's 1874 Guide" [ipp-iig]). 1876 3. From Get-Printer-Supported-Values: the Set-Printer-Attributes 1877 operation accepts values that are allowed according to the IPP/1.1 1878 rules for validating the value(s) of an "xxx" Printer attribute 1879 against the value(s) of the corresponding "xxx-supported" Printer 1880 attribute. Table 5 summarizes those validation rules depending on 1881 each attribute syntax and value of an "xxx" attribute supplied in 1882 the request and that of the corresponding "xxx-supported" Printer 1883 attribute. The "xxx-supported" attribute syntax type and attribute 1884 value(s) are obtained from a Get-Printer-Supported-Values response 1885 (see Appendix B: Attributes returned from Get-Printer-Supported- 1886 Values below). 1888 Table 5 - Validation rules for 'From Get-Printer-Supported-Values' 1890 Type of Type of "xxx- Validates if: 1891 "xxx" supported" value 1892 value to 1893 be set 1895 integer rangeOfInteger each 'integer' value is in one of 1896 the "xxx-supported" ranges 1898 uri uriScheme the uri scheme of each value 1899 matches one of the "xxx-supported" 1900 schemes 1902 any boolean if the boolean "xxx-supported" is 1903 'true' 1905 name 'admin-define' any 'name' value matches 1906 out-of-band 1907 value 1909 any same type each value matches an "xxx- 1910 supported" value of the same type 1912 For additional non-normative explanatory information see section 1913 3.1.2.3 of the "Internet Printing Protocol/1.1: Implementer's 1914 Guide" [ipp-iig]). 1916 4. Any value of the proper attribute syntax: the Set-Printer- 1917 Attributes or Set-Job-Attributes operation accepts any value of the 1918 specified attribute syntax. The attribute syntaxes supported are 1919 enumerated below. 1921 a.Any text(127) 1922 b.Any name(127) 1923 c.Any uri 1924 d.Any boolean 1925 e.Any positive integer 1926 f.Any dateTime 1927 g.1setOf any uri 1929 5. Combination of 'Any of "xxx-supported"' or 'Any name'. 1931 If a Printer implementation doesn't want to allow setting values 1932 indicated in this Appendix as "any xxx", it can make the value be 1933 not-settable. 1935 Table 6 - Values allowed for Job Template Attributes in the Set-Job- 1936 Attributes Operation 1938 Job Template Attributes Values allowed for 1939 Set 1941 job-priority (integer(1:100)) Any of "xxx- 1942 supported" 1944 job-hold-until (type3 keyword | name (MAX)) Any of "xxx- 1945 supported" 1947 job-sheets (type3 keyword | name(MAX)) Any of "xxx- 1948 supported" 1950 multiple-document-handling (type2 keyword) Any of "xxx- 1951 supported" 1953 copies (integer(1:MAX)) Any of "xxx- 1954 supported" 1956 finishings (1setOf type2 enum) Any of "xxx- 1957 supported" 1959 page-ranges (1setOf rangeOfInteger (1:MAX)) Any of "xxx- 1960 supported" 1962 sides (type2 keyword) Any of "xxx- 1963 supported" 1965 number-up (integer(1:MAX)) Any of "xxx- 1966 supported" 1968 orientation-requested (type2 enum) Any of "xxx- 1969 supported" 1971 media (type3 keyword | name(MAX)) Any of "xxx- 1972 supported" 1974 printer-resolution (resolution) Any of "xxx- 1975 supported" 1977 print-quality (type2 enum) Any of "xxx- 1978 supported" 1980 Table 7 - Values allowed for Job Description Attributes in the Set- 1981 Job-Attributes Operation 1983 Job Description Attributes Values allowed for 1984 Set 1986 job-uri (uri) READ-ONLY 1988 job-id (integer(1:MAX)) READ-ONLY 1990 job-printer-uri (uri) READ-ONLY 1992 job-more-info (uri) READ-ONLY 1994 job-name (name(MAX)) Any name(MAX) 1996 job-originating-user-name (name(MAX)) READ-ONLY 1998 job-state (type1 enum) READ-ONLY 2000 job-state-reasons (1setOf type2 keyword) READ-ONLY 2002 job-state-message (text(MAX)) READ-ONLY 2004 job-detailed-status-messages (1setOf READ-ONLY 2005 text(MAX)) 2007 job-document-access-errors (1setOf READ-ONLY 2008 text(MAX)) 2010 number-of-documents (integer(0:MAX)) READ-ONLY 2012 output-device-assigned (name(127)) READ-ONLY 2014 time-at-creation (integer(MIN:MAX)) READ-ONLY 2016 time-at-processing (integer(MIN:MAX)) READ-ONLY 2018 time-at-completed (integer(MIN:MAX)) READ-ONLY 2020 job-printer-up-time (integer(1:MAX)) READ-ONLY 2022 date-time-at-creation (dateTime) READ-ONLY 2023 Job Description Attributes Values allowed for 2024 Set 2026 date-time-at-processing (dateTime) READ-ONLY 2028 date-time-at-completed (dateTime) READ-ONLY 2030 number-of-intervening-jobs (integer(0:MAX)) READ-ONLY 2032 job-message-from-operator (text(127)) Any text(127) 2034 job-k-octets (integer(0:MAX)) READ-ONLY 2036 job-impressions (integer(0:MAX)) READ-ONLY 2038 job-media-sheets (integer(0:MAX)) READ-ONLY 2040 job-k-octets-processed (integer(0:MAX)) READ-ONLY 2042 job-impressions-completed (integer(0:MAX)) READ-ONLY 2044 job-media-sheets-completed (integer(0:MAX)) READ-ONLY 2046 attributes-charset (charset) READ-ONLY 2048 attributes-natural-language READ-ONLY 2049 (naturalLanguage) 2050 Table 8 - Values allowed for Printer Job Template Attributes in the 2051 Set-Printer-Attributes Operation 2053 Printer Job Template Attributes Values allowed 2054 for Set 2056 job-priority-default (integer(1:100)) Any of "xxx- 2057 supported" 2059 job-hold-until-default (type3 keyword | name Any of "xxx- 2060 (MAX)) supported" 2062 job-sheets-default (type3 keyword | name(MAX)) Any of "xxx- 2063 supported" 2065 multiple-document-handling-default (type2 Any of "xxx- 2066 keyword) supported" 2068 copies-default (integer(1:MAX)) Any of "xxx- 2069 supported" 2071 finishings-default (1setOf type2 enum) Any of "xxx- 2072 supported" 2074 sides-default (type2 keyword) Any of "xxx- 2075 supported" 2077 number-up-default (integer(1:MAX)) Any of "xxx- 2078 supported" 2080 orientation-requested-default (type2 enum) Any of "xxx- 2081 supported" 2083 media-default (type3 keyword | name(MAX)) Any of "xxx- 2084 supported" 2086 printer-resolution-default (resolution) Any of "xxx- 2087 supported" 2089 print-quality-default (type2 enum) Any of "xxx- 2090 supported" 2092 job-priority-supported (integer(1:100)) From Get- 2093 Printer- 2094 Supported-Values 2096 Printer Job Template Attributes Values allowed 2097 for Set 2099 job-hold-until-supported (1setOf(type3 keyword From Get- 2100 | name (MAX))) Printer- 2101 Supported-Values 2103 job-sheets-supported (1setOf(type3 keyword | From Get- 2104 name(MAX))) Printer- 2105 Supported-Values 2107 multiple-document-handling-supported (1setOf From Get- 2108 type2 keyword) Printer- 2109 Supported-Values 2111 copies-supported (rangeOfInteger(1:MAX)) From Get- 2112 Printer- 2113 Supported-Values 2115 finishings-supported (1setOf type2 enum) From Get- 2116 Printer- 2117 Supported-Values 2119 page-ranges-supported (boolean) From Get- 2120 Printer- 2121 Supported-Values 2123 sides-supported (1setOf type2 keyword) From Get- 2124 Printer- 2125 Supported-Values 2127 number-up-supported (1setOf (integer(1:MAX) | From Get- 2128 rangeOfInteger(1:MAX))) Printer- 2129 Supported-Values 2131 orientation-requested-supported (1setOf type2 From Get- 2132 enum) Printer- 2133 Supported-Values 2135 media-supported (1setOf (type3 keyword | From Get- 2136 name(MAX))) Printer- 2137 Supported-Values 2139 printer-resolution-supported (1setOf From Get- 2140 resolution) Printer- 2141 Supported-Values 2143 Printer Job Template Attributes Values allowed 2144 for Set 2146 print-quality-supported (1setOf type2 enum) From Get- 2147 Printer- 2148 Supported-Values 2150 media-ready (type3 keyword | name(MAX)) From Get- 2151 Printer- 2152 Supported-Values 2154 Table 9 - Values allowed for Printer Description Attributes in the 2155 Set-Printer-Attributes Operation 2157 Printer Description Attributes Values allowed for 2158 Set 2160 printer-uri-supported (1setOf uri) READ-ONLY 2162 uri-authentication-supported (1setOf type2 READ-ONLY 2163 keyword) 2165 uri-security-supported (1setOf type2 READ-ONLY 2166 keyword) 2168 printer-xri-supported (1setOf collection) 2169 member attributes: 2171 xri-uri (uri) any uriScheme of 2172 "xri-uri-scheme- 2173 supported" from 2174 Get-Printer- 2175 Attributes 2177 xri-authentication (1setOf type2 keyword) any keyword of 2178 "xri- 2179 authentication- 2180 supported" from 2181 Get-Printer- 2182 Attributes 2184 xri-security (1setOf type2 keyword) any keyword of 2185 "xri-security- 2186 supported" from 2187 Get-Printer- 2188 Attributes 2190 xri-uri-scheme-supported (1setOf uriScheme) READ-ONLY 2192 xri-authentication-supported (1setOf type2 READ-ONLY 2193 keyword) 2195 xri-security-supported (1setOf type2 READ-ONLY 2196 keyword) 2198 printer-name (name(127)) Any name(127) 2199 Printer Description Attributes Values allowed for 2200 Set 2202 printer-location (text(127)) Any text(127) 2204 printer-info (text(127)) Any text(127) 2206 printer-more-info (uri) Any uri 2208 printer-driver-installer (uri) Any uri 2210 printer-make-and-model (text(127)) Any text(127) 2212 printer-more-info-manufacturer (uri) Any uri 2214 printer-state (type1 enum) READ-ONLY 2216 printer-state-reasons (1setOf type2 READ-ONLY 2217 keyword) 2219 printer-state-message (text(MAX)) READ-ONLY 2221 ipp-versions-supported (1setOf type2 From Get-Printer- 2222 keyword) Supported-Values 2224 operations-supported (1setOf type2 enum) From Get-Printer- 2225 Supported-Values 2227 multiple-document-jobs-supported (boolean) From Get-Printer- 2228 Supported-Values 2230 charset-configured (charset) Any of "xxx- 2231 supported", use 2232 "charset-supported" 2234 charset-supported (1setOf charset) From Get-Printer- 2235 Supported-Values 2237 natural-language-configured Any of "xxx- 2238 (naturalLanguage) supported", use 2239 "generated-natural- 2240 language-supported" 2242 generated-natural-language-supported From Get-Printer- 2243 (1setOf naturalLanguage) Supported-Values 2244 Printer Description Attributes Values allowed for 2245 Set 2247 document-format-default (mimeMediaType) Any of "xxx- 2248 supported" 2250 document-format-supported (1setOf From Get-Printer- 2251 mimeMediaType) Supported-Values 2253 printer-is-accepting-jobs (boolean) READ-ONLY 2255 queued-job-count (integer(0:MAX)) READ-ONLY 2257 printer-message-from-operator (text(127)) Any text(127) 2259 color-supported (boolean) From Get-Printer- 2260 Supported-Values 2262 reference-uri-schemes-supported (1setOf From Get-Printer- 2263 uriScheme) Supported-Values 2265 pdl-override-supported (type2 keyword) From Get-Printer- 2266 Supported-Values 2268 printer-up-time (integer(1:MAX)) READ-ONLY 2270 printer-current-time (dateTime) Any dateTime ** 2272 multiple-operation-time-out any positive 2273 (integer(1:MAX)) integer 2275 compression-supported (1setOf type3 From Get-Printer- 2276 keyword) Supported-Values 2278 job-k-octets-supported From Get-Printer- 2279 (rangeOfInteger(0:MAX)) Supported-Values 2281 job-impressions-supported From Get-Printer- 2282 (rangeOfInteger(0:MAX)) Supported-Values 2284 job-media-sheets-supported From Get-Printer- 2285 (rangeOfInteger(0:MAX)) Supported-Values 2287 pages-per-minute (integer(0:MAX)) READ-ONLY 2289 pages-per-minute-color (integer(0:MAX)) READ-ONLY 2290 Printer Description Attributes Values allowed for 2291 Set 2293 printer-settable-attributes-supported From Get-Printer- 2294 (1setOf type2 keyword) Supported-Values 2296 job-settable-attributes-supported (1setOf From Get-Printer- 2297 type2 keyword) Supported-Values 2299 document-format-varying-attributes (1setOf READ-ONLY 2300 type2 keyword) 2302 printer-message-time (integer(MIN:MAX)) READ-ONLY 2304 printer-message-date-time(dateTime) READ-ONLY 2306 ** - The "printer-current-time" (dateTime) attribute is settable in 2307 order to allow an administrator to correct an incorrect dateTime or 2308 time zone. 2310 16 Appendix B: Attributes returned from Get-Printer-Supported-Values 2312 This Appendix is a normative part of this document and lists all the 2313 attributes that are possible for an implementation to return in a 2314 Get-Printer-Supported-Values response, i.e., all the "xxx-supported" 2315 attributes that can be supplied in a Set-Printer-Attributes request. 2316 READ-ONLY attributes MUST NOT be returned in a Get-Printer-Supported- 2317 Values response and are indicated in the tables as "READ-ONLY - MUST 2318 NOT be returned." 2320 For the following attributes, the value allowed by the Set-Printer- 2321 Attributes operation MUST be a single integer value in the range 2322 specified by the value returned by the Get-Printer-Supported-Values 2323 operation. 2325 Table 10 - Printer Job Template Attributes returned from Get-Printer- 2326 Supported-Values 2328 Printer Job Template Attributes Values Returned 2330 job-priority-supported (integer(1:100)) rangeOfInteger(1:100) 2332 For the following attributes, the value allowed by the Set-Printer- 2333 Attributes operation MUST be a single rangeOfInteger value whose 2334 bounds do not exceed those of the range specified by the value 2335 returned by the Get-Printer-Supported-Values operation. 2337 Table 11 - Printer Job Template Attributes returned from Get-Printer- 2338 Supported-Values 2340 Printer Job Template Attributes Values Returned 2342 copies-supported (rangeOfInteger(1:MAX)) rangeOfInteger(1:MAX) 2344 The following table has the same criteria as the last, but is for 2345 Printer Description attributes. 2347 Table 12 - Printer Description Attributes returned from Get-Printer- 2348 Supported-Values 2350 Printer Description Attributes Values allowed for Set 2352 job-k-octets-supported rangeOfInteger(0:MAX) 2353 (rangeOfInteger(0:MAX)) 2355 job-impressions-supported rangeOfInteger(0:MAX) 2356 (rangeOfInteger(0:MAX)) 2358 job-media-sheets-supported rangeOfInteger(0:MAX) 2359 (rangeOfInteger(0:MAX)) 2361 For the following attributes, the value allowed by the Set-Printer- 2362 Attributes operation MUST be one or more integers and rangeOfInteger 2363 values, such that the integer values described by these integers and 2364 rangeOfInteger is the same as or a subset of the integers described 2365 by the integers and rangeOf Integer of value returned by the Get- 2366 Printer-Supported-Values operation. 2368 Table 13 - Printer Job Template Attributes returned from Get-Printer- 2369 Supported-Values 2371 Printer Job Template Attributes Values Returned 2373 number-up-supported (1setOf (integer(1:MAX) 1setOf 2374 | rangeOfInteger(1:MAX))) (integer(1:MAX) | 2375 rangeOfInteger(1:MA 2376 X)) 2378 For the following attributes, the value allowed by the Set-Printer- 2379 Attributes operation MUST be one or more values, where each such 2380 value matches a value returned by the Get-Printer-Supported-Values 2381 operation. A keyword, enum, boolean, charset, naturalLanguage, 2382 uriScheme, mimeMediaType or resolution value matches if it is equal. 2383 For Job Template attributes with the attribute syntax 'type3 keyword 2384 | name', any 'name' attribute syntax value matches the 'admin-define' 2385 out-of-band value, if the implementation allows the administrator to 2386 set any name values for the attribute. 2388 Table 14 - Printer Job Template Attributes returned from Get-Printer- 2389 Supported-Values 2391 Printer Job Template Attributes Values Returned 2393 job-hold-until-supported (1setOf(type3 1setOf (type3 2394 keyword | name (MAX))) keyword | 'admin- 2395 define') 2397 job-sheets-supported (1setOf(type3 keyword 1setOf (type3 2398 | name(MAX))) keyword | 'admin- 2399 define') 2401 multiple-document-handling-supported 1setOf type2 2402 (1setOf type2 keyword) keyword 2404 finishings-supported (1setOf type2 enum) 1setOf type2 enum 2406 page-ranges-supported (boolean) 1setOf boolean ** 2408 sides-supported (1setOf type2 keyword) 1setOf type2 2409 keyword 2411 orientation-requested-supported (1setOf 1setOf type2 enum 2412 type2 enum) 2414 media-supported (1setOf (type3 keyword | 1setOf (type3 2415 name(MAX))) keyword | 'admin- 2416 define') 2418 printer-resolution-supported (1setOf 1setOf resolution 2419 resolution) 2421 print-quality-supported (1setOf type2 enum) 1setOf type2 enum 2423 ** Note: the Get-Printer-Supported-Values returns a '1setOf boolean' 2424 so that all possible values are indicated, while Get-Printer- 2425 Attributes returns only a single 'boolean' value. 2427 The following table has the same criteria as the last, but is for 2428 Printer Description attributes. 2430 Table 15 - Printer Description Attributes returned from Get-Printer- 2431 Supported-Values 2433 Printer Description Attributes Values allowed for 2434 Set 2436 printer-uri-supported (1setOf uri) READ-ONLY - MUST 2437 NOT be returned 2439 uri-authentication-supported (1setOf type2 READ-ONLY - MUST 2440 keyword) NOT be returned 2442 uri-security-supported (1setOf type2 READ-ONLY - MUST 2443 keyword) NOT be returned 2445 xri-printer-supported (1setOf collection) MUST NOT be 2446 returned; see next 2447 three attributes 2448 returned with Get- 2449 Printer-Attributes: 2451 xri-uri-scheme-supported (1setOf uriScheme) READ-ONLY - MUST 2452 NOT be returned 2454 xri-authentication-supported (1setOf type2 READ-ONLY - MUST 2455 keyword) NOT be returned 2457 xri-security-supported (1setOf type2 READ-ONLY - MUST 2458 keyword) NOT be returned 2460 ipp-versions-supported (1setOf type2 1setOf type2 2461 keyword) keyword 2463 operations-supported (1setOf type2 enum) 1setOf type2 2464 keyword 2466 multiple-document-jobs-supported (boolean) 1setOf boolean ** 2468 charset-supported (1setOf charset) 1setOf charset 2470 generated-natural-language-supported 1setOf 2471 (1setOf naturalLanguage) naturalLanguage 2473 document-format-supported (1setOf 1setOf 2474 mimeMediaType) mimeMediaType 2475 Printer Description Attributes Values allowed for 2476 Set 2478 color-supported (boolean) 1setOf boolean ** 2480 reference-uri-schemes-supported (1setOf 1setOf uriScheme 2481 uriScheme) 2483 pdl-override-supported (type2 keyword) 1setOf type2 2484 keyword ** 2486 compression-supported (1setOf type3 1setOf type3 2487 keyword) keyword 2489 printer-settable-attributes-supported 1setOf type2 2490 (1setOf type2 keyword) keyword 2492 job-settable-attributes-supported (1setOf 1setOf type2 2493 type2 keyword) keyword 2495 ** Note: the Get-Printer-Supported-Values returns a '1setOf X' so 2496 that all possible values are indicated, while Get-Printer-Attributes 2497 returns only a single 'X' value. 2499 17 Appendix C: Full Copyright Statement 2501 Copyright (C) The Internet Society (1998,1999,2000,2001). All Rights 2502 Reserved 2504 This document and translations of it may be copied and furnished to 2505 others, and derivative works that comment on or otherwise explain it 2506 or assist in its implementation may be prepared, copied, published 2507 and distributed, in whole or in part, without restriction of any 2508 kind, provided that the above copyright notice and this paragraph are 2509 included on all such copies and derivative works. However, this 2510 document itself may not be modified in any way, such as by removing 2511 the copyright notice or references to the Internet Society or other 2512 Internet organizations, except as needed for the purpose of 2513 developing Internet standards in which case the procedures for 2514 copyrights defined in the Internet Standards process must be 2515 followed, or as required to translate it into languages other than 2516 English. 2518 The limited permissions granted above are perpetual and will not be 2519 revoked by the Internet Society or its successors or assigns. 2521 This document and the information contained herein is provided on an 2522 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 2523 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 2524 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 2525 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 2526 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.