idnits 2.17.1 draft-ietf-ipp-indp-method-05.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 -- however, there's a paragraph with a matching beginning. Boilerplate error? 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 ([RFC2565,RFC2910], [RFC2911,RFC2910], [RFC2566,RFC2565]), 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 3 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. == There are 2 instances of lines with non-RFC3849-compliant IPv6 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 188: '...d terms, such as MUST, MUST NOT, REQUI...' RFC 2119 keyword, line 189: '... SHOULD NOT, MAY, NEED NOT,...' RFC 2119 keyword, line 236: '...thod, the client MUST choose a value f...' RFC 2119 keyword, line 240: '... occurs, the Printer MUST immediately:...' RFC 2119 keyword, line 248: '...cription Object in M, the Printer MUST...' (73 more instances...) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 169 has weird spacing: '...ions to the N...' == Line 273 has weird spacing: '...me name ind...' == Line 282 has weird spacing: '...ter use compl...' == Line 327 has weird spacing: '...ansport itse...' == Line 340 has weird spacing: '...on that attri...' == (1 more instance...) == Unrecognized Status in '[Target Category: standards track]', assuming Proposed Standard (Expected one of 'Standards Track', 'Full Standard', 'Draft Standard', 'Proposed Standard', 'Best Current Practice', 'Informational', 'Experimental', 'Informational', 'Historic'.) -- 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 (April 5, 2001) is 8421 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: 'RFC2119' is mentioned on line 191, but not defined == Missing Reference: 'TBD' is mentioned on line 984, but not defined == Missing Reference: 'US-ASCII' is mentioned on line 892, but not defined == Missing Reference: 'RFC2246' is mentioned on line 1102, but not defined ** Obsolete undefined reference: RFC 2246 (Obsoleted by RFC 4346) -- Possible downref: Non-RFC (?) normative reference: ref. 'IANA-MIMEREG' -- Possible downref: Non-RFC (?) normative reference: ref. 'IANA-PORTREG' ** Downref: Normative reference to an Informational RFC: RFC 1900 ** Obsolete normative reference: RFC 2373 (Obsoleted by RFC 3513) ** Obsolete normative reference: RFC 2396 (Obsoleted by RFC 3986) ** Obsolete normative reference: RFC 2565 (Obsoleted by RFC 2910) ** Obsolete normative reference: RFC 2566 (Obsoleted by RFC 2911) ** Downref: Normative reference to an Experimental RFC: RFC 2567 ** Downref: Normative reference to an Experimental RFC: RFC 2568 ** Downref: Normative reference to an Experimental RFC: RFC 2569 ** Obsolete normative reference: RFC 2616 (Obsoleted by RFC 7230, RFC 7231, RFC 7232, RFC 7233, RFC 7234, RFC 7235) ** Obsolete normative reference: RFC 2617 (Obsoleted by RFC 7235, RFC 7615, RFC 7616, RFC 7617) ** Obsolete normative reference: RFC 2717 (Obsoleted by RFC 4395) ** Obsolete normative reference: RFC 2732 (Obsoleted by RFC 3986) ** Obsolete normative reference: RFC 2910 (Obsoleted by RFC 8010) ** Obsolete normative reference: RFC 2911 (Obsoleted by RFC 8011) Summary: 21 errors (**), 0 flaws (~~), 15 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 INTERNET-DRAFT Hugo Parra 3 Novell, Inc. 4 [Target Category: standards track] Tom Hastings 5 Xerox Corp. 6 April 5, 2001 8 Internet Printing Protocol (IPP): 9 The 'indp' Delivery Method for Event Notifications and Protocol/1.0 11 Copyright (C) The Internet Society (2001). All Rights Reserved. 13 Status of this Memo 15 This document is an Internet-Draft and is in full conformance with 16 all provisions of Section 10 of [RFC2026]. Internet-Drafts are 17 working documents of the Internet Engineering Task Force (IETF), its 18 areas, and its working groups. Note that other groups may also 19 distribute working documents as Internet-Drafts. 21 Internet-Drafts are draft documents valid for a maximum of six months 22 and may be updated, replaced, or obsoleted by other documents at any 23 time. It is inappropriate to use Internet-Drafts as reference 24 material or to cite them other than as "work in progress". 26 The list of current Internet-Drafts can be accessed at 27 http://www.ietf.org/ietf/1id-abstracts.txt 29 The list of Internet-Draft Shadow Directories can be accessed as 30 http://www.ietf.org/shadow.html. 32 Abstract 34 This document describes an extension to the Internet Printing 35 Protocol/1.0 (IPP) [RFC2566, RFC2565] and IPP/1.1 [RFC2911, RFC2910]. 36 This document specifies the 'indp' Delivery Method and Protocol/1.0 37 for use with the IPP Event Notification Specification [ipp-ntfy]. 38 This Delivery Method is a simple protocol consisting of a single 39 operation: the Send-Notifications operation which uses the same 40 encoding and transport as IPP [RFC2565, RFC2910]. 42 For this Delivery Method, when an Event occurs, the Printer 43 immediately sends (pushes) an Event Notification via the Send- 44 Notifications operation to the Notification Recipient specified in 45 the Subscription Object. The Event Notification content consists of 46 Machine Consumable attributes and a Human Consumable "notify-text" 47 attribute. The Notification Recipient returns a response to the 48 Printer. 50 Table of Contents 52 1 Introduction....................................................4 54 2 Terminology.....................................................4 56 3 Model and Operation.............................................5 58 4 General Information.............................................6 60 5 Subscription object attributes..................................9 61 5.1 Subscription Template Attribute Conformance..................9 62 5.2 Additional Information about Subscription Template Attributes9 63 5.2.1 notify-recipient-uri (uri).................................9 64 5.3 Subscription Description Attribute Conformance...............9 66 6 Printer Description Attributes..................................9 67 6.1 Printer Description Attribute Conformance...................10 68 6.2 New Values for Existing Printer Description Attributes......10 69 6.2.1 notify-schemes-supported (1setOf uriScheme)...............10 70 6.2.2 operations-supported (1setOf type2 enum)..................10 72 7 Attributes Only in Event Notifications.........................10 74 8 Operations for Notification....................................11 75 8.1 Send-Notifications operation................................11 76 8.1.1 Send-Notifications Request................................11 77 8.1.2 Send-Notifications Response...............................15 79 9 Status Codes...................................................16 80 9.1 Additional Status Codes.....................................16 81 9.1.1 successful-ok-ignored-notifications (0x0004)..............17 82 9.1.2 client-error-ignored-all-notifications (0x0416)...........17 83 9.2 Status Codes returned in Event Notification Attributes Groups17 84 9.2.1 client-error-not-found (0x0406)...........................17 85 9.2.2 successful-ok-but-cancel-subscription (0x0006)............18 87 10 Encoding and Transport.........................................18 88 10.1 Encoding of the Operation Layer.............................18 89 10.2 Encoding of Transport Layer.................................18 91 11 Conformance Requirements.......................................18 92 11.1 Conformance Requirements for Printers.......................19 93 11.2 Conformance Requirements for INDP Notification Recipients...19 95 12 INDP URL Scheme................................................20 96 12.1 INDP URL Scheme Applicability and Intended Usage............20 97 12.2 INDP URL Scheme Associated INDP Port........................20 98 12.3 INDP URL Scheme Associated MIME Type........................20 99 12.4 INDP URL Scheme Character Encoding..........................20 100 12.5 INDP URL Scheme Syntax in ABNF..............................21 101 12.5.1 INDP URL Examples.........................................22 102 12.5.2 INDP URL Comparisons......................................22 104 13 IANA Considerations............................................22 105 13.1 Operation Registrations.....................................23 106 13.2 Additional values of existing attributes....................23 107 13.2.1 Additional values for the "notify-schemes-supported" Printer 108 attribute..............................................23 109 13.2.2 Additional values for the "operations-supported" Printer 110 attribute..............................................24 111 13.3 Status code Registrations...................................24 113 14 Internationalization Considerations............................24 115 15 Security Considerations........................................24 116 15.1 Security Conformance........................................25 118 16 References.....................................................25 120 17 Author's Addresses.............................................27 122 18 Summary of Base IPP documents..................................27 124 19 Full Copyright Statement.......................................29 126 Tables 128 Table 1 - Information about the Delivery Method....................7 129 Table 2 - Operation-id assignments................................10 130 Table 3 - Attributes in Event Notification Content................13 131 Table 4 - Additional Attributes in Event Notification Content for Job 132 Events ........................................................14 133 Table 5 - Combinations of Events and Subscribed Events for "job- 134 impressions-completed" ........................................14 135 Table 6 - Additional Attributes in Event Notification Content for 136 Printer Events ................................................15 137 Table 7 - The "event-notification-attributes-tag" value...........18 139 1 Introduction 141 The "IPP Event Notification Specification" document [ipp-ntfy] 142 defines an extension to Internet Printing Protocol/1.0 (IPP) 143 [RFC2566, RFC2565] and IPP/1.1 [RFC2911, RFC2910]. This extension 144 defines operations that a client can perform in order to create 145 Subscription Objects in a Printer and carry out other operations on 146 them. A Subscription Object represents a Subscription abstraction. 147 A client associates Subscription Objects with a particular Job by 148 performing the Create-Job-Subscriptions operation or by submitting a 149 Job with subscription information. A client associates Subscription 150 Objects with the Printer by performing a Create-Printer-Subscriptions 151 operation. Four other operations are defined for Subscription 152 Objects: Get-Subscriptions-Attributes, Get-Subscriptions, Renew- 153 Subscription, and Cancel-Subscription. The Subscription Object 154 specifies that when one of the specified Events occurs, the Printer 155 sends an asynchronous Event Notification to the specified 156 Notification Recipient via the specified Delivery Method (i.e., 157 protocol). 159 The "IPP Event Notification Specification" document [ipp-ntfy] 160 specifies that each Delivery Method is defined in another document. 161 This document is one such document, and it specifies the 'indp' 162 Delivery Method. This Delivery Method is a simple protocol 163 consisting of a single operation: the Send-Notifications operation 164 which uses the same encoding and transport as IPP. This document 165 defines version '1.0' of the protocol. 167 For the 'indp' Delivery Method, an IPP Printer sends (pushes) a Send- 168 Notifications operation request containing one or more Event 169 Notifications to the Notification Recipient specified in the 170 Subscription Object. The Event Notification content consists of 171 Machine Consumable attributes and a Human Consumable "notify-text" 172 attribute. 174 The Notification Recipient receives the Event Notification as a Send- 175 Notifications operation, in the same way as an IPP Printer receives 176 IPP operations. The Notification Recipient returns a response to the 177 Printer. 179 2 Terminology 181 This section defines the following terms that are used throughout 182 this document: 184 Terms such as attributes, keywords, and support. These terms have 185 special meaning and are defined in the model terminology 186 [RFC2911] section 12.2. 188 Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, 189 SHOULD NOT, MAY, NEED NOT, and OPTIONAL, have special 190 meaning relating to conformance as specified in RFC 2119 191 [RFC2119] and [RFC2911] section 12.1. These terms refer to 192 conformance to this document, if this document is 193 implemented. 195 Capitalized terms, such as Notification Recipient, Event 196 Notification, Printer, etc., that are defined in [ipp-ntfy] 197 with the same meanings and are not reproduced here. 199 Event Notification Attributes Group - The attributes group in a 200 request that contains Event Notification Attributes in a 201 request or response. 203 3 Model and Operation 205 See [ipp-ntfy] for the description of the Event Notification Model 206 and Operation. This Delivery Method takes advantage of combining 207 several Event Notifications into a single Compound Event Notification 208 that is delivery by a single Send-Notification operation to a single 209 Notification Recipient. 211 When creating each Subscription object, the client supplies the 212 "notify-recipient" (uri) Subscription Template attribute. The 213 "notify-recipient" attribute specifies both a single Notification 214 Recipient that is to receive the Notifications when subsequent events 215 occur and the method for notification delivery that the IPP Printer 216 is to use. For the Notification Delivery Method defined in this 217 document, the notification method is 'indp' and the rest of the URI 218 is the address of the Notification Recipient to which the IPP Printer 219 will send the Send-Notifications operation. 221 The 'indp' Notification Delivery Method defined in this document uses 222 a client/server protocol paradigm. The "client" in this relationship 223 is the Printer described in [ipp-ntfy] while the "server" is the 224 Notification Recipient. The Printer invokes the Send-Notifications 225 operation to communicate IPP Event Notification contents to the 226 Notification Recipient. The Notification Recipient only conveys 227 information to the Printer in the form of responses to the operations 228 initiated by the Printer. 230 Printers that implement the 'indp' Notification Delivery Method will 231 need to include an HTTP client stack while Notification Recipients 232 that implement this Delivery Method will need to support an HTTP 233 server stack. See section 10.2 for more details. 235 If the client wants the Printer to send Event Notifications via the 236 'indp' Delivery Method, the client MUST choose a value for "notify- 237 recipient-uri" attribute which conforms to the rules of section 238 5.2.1. 240 When an Event occurs, the Printer MUST immediately: 242 1.Find all pertinent Subscription Objects P according to the rules of 243 section 9 of [ipp-ntfy], AND 245 2.Find the subset M of these Subscription Objects P whose "notify- 246 recipient-uri" attribute has a scheme value of 'indp', AND 248 3.For each Subscription Object in M, the Printer MUST 250 a)generate a Send-Notifications request as specified in section 251 8.1.1 AND 253 b)send the Send-Notifications request to the Notification 254 Recipient specified by the address part of the "notify- 255 recipient-uri" attribute value (see section 5.2.1). 257 If several events occur sufficiently close to one another for the 258 same or different Subscription objects, but with the same 259 Notification Recipient, the Printer MAY combine them into a single 260 Send-Notifications request using a separate Event Notification 261 Attributes group for each event (see section 8.1.1). 263 4 General Information 265 If a Printer supports this Delivery Method, Table 1 lists its 266 characteristics. 268 Table 1 - Information about the Delivery Method 270 Document Method conformance 'indp' realization 271 requirement 273 1. What is the URL scheme name indp 274 for the Delivery Method? 276 2. Is the Delivery Method is RECOMMENDED 277 REQUIRED, RECOMMENDED, or 278 OPTIONAL for an IPP Printer to 279 support? 281 3. What transport and delivery A Printer MUST support a 282 protocol does the Printer use complete HTTP/1.1 stack 283 to deliver the Event [RFC2616] 284 Notification content, i.e., 285 what is the entire network 286 stack? 288 4. Can several Event A Printer implementation MAY 289 Notifications be combined into combine several Event 290 a Compound Event Notification? Notifications into a single 291 Event Notifications request as 292 separate Event Notification 293 Attributes Groups, see section 294 8.1.1 296 5. Is the Delivery Method This Delivery Method is a push. 297 initiated by the Notification 298 Recipient (pull), or by the 299 Printer (push)? 301 6. Is the Event Notification Machine Consumable with the 302 content Machine Consumable or "notify-text" attribute being 303 Human Consumable? Human Consumable 305 7. What section in this document The representation and encoding 306 answers the following is the same as IPP. See 307 question? For a Machine section 8.1.1 308 Consumable Event Notification, 309 what is the representation and 310 encoding of values defined in 311 section 9.1 of [ipp-ntfy] and 312 the conformance requirements 313 thereof? For a Human 314 Consumable Event Notification, 316 Document Method conformance 'indp' realization 317 requirement 319 what is the representation and 320 encoding of pieces of 321 information defined in section 322 9.2 of [ipp-ntfy] and the 323 conformance requirements 324 thereof? 326 8. What are the latency and 327 reliability of the transport itselfs(see [RFC2911]).IPP/1.1 328 and delivery protocol? 330 9. What are the security aspects 15 331 of the transport and delivery 332 protocol, e.g., how it is See section 333 handled in firewalls? 335 10. What are the content length They are the same as for 336 restrictions? IPP/1.0 and IPP/1.1 itself (see 337 [RFC2911]). 339 11. What are the additional values A new Event Notifications 340 or pieces of information that attribute group (see section 341 a Printer sends in an Event 10.1) and additional status 342 Notification and the codes for use in the response 343 conformance requirements (see section 9) 344 thereof? 346 12. What are the additional None 347 Subscription Template and/or 348 Subscription Description 349 attributes and the conformance 350 requirements thereof? 352 13. What are the additional None 353 Printer Description attributes 354 and the conformance 355 requirements thereof? 357 The remaining sections of this document parallel the sections of 358 [ipp-ntfy]. 360 5 Subscription object attributes 362 This section defines the Subscription object conformance requirements 363 for Printers. 365 5.1 Subscription Template Attribute Conformance 367 The 'indp' Delivery Method has the same conformance requirements for 368 Subscription Template attributes as defined in [ipp-ntfy]. The 369 'indp' Delivery Method does not define any addition Subscription 370 Template attributes. 372 5.2 Additional Information about Subscription Template Attributes 374 This section defines additional information about Subscription 375 Template attributes defined in [ipp-ntfy]. 377 5.2.1 notify-recipient-uri (uri) 379 This section describes the syntax of the value of this attribute for 380 the 'indp' Delivery Method. The syntax for values of this attribute 381 for other Delivery Method is defined in other Delivery Method 382 Documents. 384 In order to support the 'indp' Delivery Method and Protocol, the 385 Printer MUST support the following syntax: 387 The 'indp://' URI scheme. The remainder of the URI indicates 388 the host name or host address (and optional path) of the 389 Notification Recipient that is to receive the Send- 390 Notification operation. See section 12 for a complete 391 definition of the syntax of the INDP URL. 393 5.3 Subscription Description Attribute Conformance 395 The 'indp' Delivery Method has the same conformance requirements for 396 Subscription Description attributes as defined in [ipp-ntfy]. The 397 'indp' Delivery Method does not define any addition Subscription 398 Description attributes. 400 6 Printer Description Attributes 402 This section defines the Printer Description Attributes conformance 403 requirements for Printers. 405 6.1 Printer Description Attribute Conformance 407 The 'indp' Delivery Method has the same conformance requirements for 408 Printer Description attributes as defined in [ipp-ntfy]. The 'indp' 409 Delivery Method does not define any addition Printer Description 410 attributes. 412 6.2 New Values for Existing Printer Description Attributes 414 This section defines additional values for existing Printer 415 Description attributes. 417 6.2.1 notify-schemes-supported (1setOf uriScheme) 419 The following "notify-schemes-supported" value is added in order to 420 support the new Delivery Method defined in this document: 422 'indp' - The IPP Notification Delivery Method defined in this 423 document. 425 6.2.2 operations-supported (1setOf type2 enum) 427 Table 2 lists the "operation-id" value added in order to support the 428 new operation defined in this document. The operation-id is assigned 429 in the same name space as other operations that a Printer supports. 430 However, a Printer MUST NOT include this value in its "operations- 431 supported" attribute unless it can accept the Send-Notifications 432 request. 434 Table 2 - Operation-id assignments 436 Value Operation Name 438 0x001D Send-Notifications 440 7 Attributes Only in Event Notifications 442 No additional attributes are defined only for use in Event 443 Notifications besides those defined in [ipp-ntfy]. 445 8 Operations for Notification 447 This section defines the operation for Event Notification using the 448 'indp' Delivery Method. 450 There is only one operation defined: Send-Notifications. Section 451 6.2.2 assigns of the "operation-id" for the Send-Notifications 452 operation and the following section defined the operation. 454 8.1 Send-Notifications operation 456 This REQUIRED operation allows a Printer to send one or more Event 457 Notifications to a Notification Recipient using HTTP. 459 The Printer composes the information defined for an IPP Notification 460 [ipp-ntfy] and sends it using the Sent-Notifications operation to the 461 Notification Recipient supplied in the Subscription object. 463 The Send-Notifications operation uses the operations model defined by 464 IPP [RFC2566]. This includes, the use of a URI as the identifier for 465 the target of each operation, the inclusion of a version number, 466 operation-id, and request-id in each request, and the definition of 467 attribute groups. The Send-Notifications operation uses the Operation 468 Attributes group, but currently has no need for the Unsupported 469 Attributes, Printer Object Attributes, and Job-Object Attributes 470 groups. However, it uses a new attribute group, the Event 471 Notification Attributes group. 473 The Notification Recipient MUST accept the request in any state. 474 There is no state defined for the Notification Recipient for this 475 Delivery Method. 477 Access Rights: Notification Recipient MAY enforce access rights. If 478 the Printer receives a rejection with these status codes: 'client- 479 error-forbidden', 'client-error-not-authenticated', or 'client-error- 480 not-authorized' status code , the Printer SHOULD cancel the 481 subscription. 483 8.1.1 Send-Notifications Request 485 Every operation request MUST contains the following parameters (see 486 [RFC2911] section 3.1.1): 488 - a "version-number" '1.0' - the version of the 'indp' 489 protocol is '1.0'. 490 - an "operation-id" - the value defined in Table 2 491 - a "request-id" - the request id (see [RFC2911] section 3.1.2). 493 The following groups of attributes MUST be part of the Send- 494 Notifications Request: 496 Group 1: Operation Attributes 497 Natural Language and Character Set: 498 The "attributes-charset" and "attributes-natural-language" 499 attributes as defined in [RFC2911] section 3.1.4.1. 501 The Printer MUST use the values of "notify-charset" and 502 "notify-natural-language", respectively, from one Subscription 503 Object associated with the Event Notifications in this request. 505 Normally, there is only one matched Subscription Object, or the 506 value of the "notify-charset" and "notify-natural-language" 507 attributes is the same in all Subscription Objects. If not, the 508 Printer MUST pick one Subscription Object from which to obtain 509 the value of these attributes. The algorithm for picking the 510 Subscription Object is implementation dependent. The choice of 511 natural language is not critical because 'text' and 'name' 512 values can override the "attributes-natural-language" Operation 513 attribute. The Printer's choice of charset is critical because 514 a bad choice may leave it unable to send some 'text' and 'name' 515 values accurately. 517 Target: 518 A copy of the Subscription object's "notify-recipient-uri" 519 (uri) attribute which is the target of this operation as 520 described in [RFC2911] section 3.1.5, i.e., the URI of the 521 'indp' Notification Recipient (see section 5.2.1). 523 Group 2 to N: Event Notification Attributes 525 In each group 2 to N, each attribute is encoded using the IPP 526 rules for encoding attributes [RFC2910] and may be encoded in 527 any order. Note: the Get-Jobs response in [RFC2911] acts as a 528 model for encoding multiple groups of attributes. 530 Each Event Notification Group MUST contain all of attributes 531 specified in [ipp-ntfy] section 9.1 ("Content of Machine 532 Consumable Event Notifications") with exceptions denoted by 533 asterisks in the tables below. 535 The tables below are copies of the tables in [ipp-ntfy] section 536 9.1 ("Content of Machine Consumable Event Notifications") 537 except that each cell in the "Sends" column is a "MUST". 539 For an Event Notification for all Events, the Printer sends the 540 following attributes. 542 Table 3 - Attributes in Event Notification Content 544 Source Value Sends Source Object 546 notify-subscription-id (integer(1:MAX)) MUST Subscription 548 notify-printer-uri (uri) MUST Subscription 550 notify-subscribed-event (type2 keyword) MUST Event 551 Notification 553 printer-up-time (integer(MIN:MAX)) MUST Printer 555 printer-current-time (dateTime) MUST * Printer 557 notify-sequence-number (integer (0:MAX)) MUST Subscription 559 notify-charset (charset) MUST Subscription 561 notify-natural-language (naturalLanguage) MUST Subscription 563 notify-user-data (octetString(63)) MUST ** Subscription 565 notify-text (text (MAX)) MUST Event 566 Notification 568 attributes from the "notify-attributes" MUST *** Printer 569 attribute, if any 571 attributes from the "notify-attributes" MUST *** Job 572 attribute, if any 574 attributes from the "notify-attributes" MUST *** Subscription 575 attribute, if any 577 * The Printer MUST send "printer-current-time" if and only if 578 it supports the "printer-current-time" attribute on the Printer 579 object. 581 ** If the associated Subscription Object does not contain a 582 "notify-user-data" attribute, the Printer MUST send an octet- 583 string of length 0. 585 *** If the "notify-attributes" attribute is present on the 586 Subscription Object, the Printer MUST send all attributes 587 specified by the "notify-attributes" attribute. Note: if the 588 Printer doesn't support the "notify-attributes" attribute, it 589 is not present on the associated Subscription Object and the 590 Printer does not send any client-requested attributes. 592 For Event Notifications for Job Events, the Printer sends the 593 following additional attributes shown in Table 4. 595 Table 4 - Additional Attributes in Event Notification Content for 596 Job Events 598 Source Value Sends Source Object 600 job-id (integer(1:MAX)) MUST Job 602 job-state (type1 enum) MUST Job 604 job-state-reasons (1setOf type2 keyword) MUST Job 606 job-impressions-completed MUST * Job 607 (integer(0:MAX)) 609 * The Printer MUST send the "job-impressions-completed" 610 attribute in an Event Notification only for the combinations of 611 Events and Subscribed Events shown in Table 5. 613 Table 5 - Combinations of Events and Subscribed Events for "job- 614 impressions-completed" 616 Job Event Subscribed Job Event 618 'job-progress' 'job-progress' 620 'job-completed' 'job-completed' 622 'job-completed' 'job-state-changed' 624 For Event Notification for Printer Events, the Printer sends 625 the following additional attributes shown in Table 6. 627 Table 6 - Additional Attributes in Event Notification Content for 628 Printer Events 630 Source Value Sends Source Object 632 printer-state (type1 enum) MUST Printer 634 printer-state-reasons (1setOf type2 keyword) MUST Printer 636 printer-is-accepting-jobs (boolean) MUST Printer 638 8.1.2 Send-Notifications Response 640 The Notification Recipient MUST return (to the client which is the 641 Printer) the following sets of attributes as part of a Send- 642 Notifications response: 644 Every operation response contains the following REQUIRED parameters 645 (see [RFC2911] section 3.1.1}: 647 - a "version-number" 648 - a "status-code" 649 - the "request-id" that was supplied in the corresponding request 651 Group 1: Operation Attributes 653 Status Message: 654 As defined in [RFC2911]. 656 The Notification Recipient can return any status codes defined 657 in [RFC2911] and section 9.1 that applies to all of the Event 658 Notification Attribute groups. The following is a description 659 of the important status codes: 661 'successful-ok': the Notification Recipient received all of 662 the Event Notification Attribute Groups and was expecting 663 each of them. 665 'successful-ok-ignored-notifications': the Notification 666 Recipient was able to consume some, but not all of the 667 Event Notification Attributes Groups sent. The Event 668 Notification Attributes Groups with a "notify-status- 669 code" attribute are the ones that were ignored or are to 670 be canceled. 672 'client-error-ignored-all-notifications': the Notification 673 Recipient was unable to consume any of the Event 674 Notification Attributes Groups sent. The Event 675 Notification Attributes Groups with a "notify-status- 676 code" attribute are the ones that were ignored or are to 677 be canceled. 679 Natural Language and Character Set: 680 The "attributes-charset" and "attributes-natural-language" 681 attributes as defined in [RFC2911] section 3.1.4.1. 683 Group 2 to N: Notification Attributes 685 These groups MUST be returned if and only if the "status-code" 686 parameter returned in Group 1 is anything but the 'successful-ok' 687 status code. 689 "notify-status-code" (type2 enum) 690 Indicates whether the Notification Recipient was able to 691 consume the n-th Notification Report as follows: 693 'successful-ok' - this Event Notification Attribute Group 694 was consumed 695 'client-error-not-found' - this Event Notification 696 Attribute Group was not able to be consumed. The Printer 697 MUST cancel the Subscription and MUST NOT attempt to send 698 any further Event Notifications from the associated 699 Subscription object. 700 'successful-ok-but-cancel-subscription' - the Event 701 Notification Attribute Group was consumed, but the 702 Notification Recipient wishes to cancel the Subscription 703 object. The Printer MUST cancel the Subscription and 704 MUST NOT attempt to send any further Event Notifications 705 from the associated Subscription object. 707 9 Status Codes 709 This section lists status codes whose meaning have been extended 710 and/or defined for returning in Event Notification Attribute Groups 711 as the value of the "notify-status-code" operation attribute. The 712 code values are allocated in the same space as the status codes in 713 [RFC2911]. 715 9.1 Additional Status Codes 717 The following status codes are defined as extensions for Notification 718 and are returned as the value of the "status-code" parameter in the 719 Operation Attributes Group of a response (see [RFC2911] section 720 3.1.6.1). Operations in this document can also return the status 721 codes defined in section 13 of [RFC2911]. The 'successful-ok' status 722 code is an example of such a status code. 724 9.1.1 successful-ok-ignored-notifications (0x0004) 726 The Notification Recipient was able to consume some, but not all, of 727 the Event Notifications Attributes Groups sent by the Printer in the 728 Send-Notifications request. See section 8.1.2 for further details. 730 9.1.2 client-error-ignored-all-notifications (0x0416) 732 The Notification Recipient was unable to consume any of the Event 733 Notification Attributes Groups sent by the Printer. The Event 734 Notification Attributes Groups with a "notify-status-code" attribute 735 are the ones that were ignored or are to be canceled. The Printer 736 MAY remove subscriptions for future events which this client was 737 unable to consume. 739 9.2 Status Codes returned in Event Notification Attributes Groups 741 This section contains values of the "notify-status-code" attribute 742 that the Notification Recipient returns in a Event Notification 743 Attributes Group in a response when the corresponding Event 744 Notification Attributes Group in the request: 746 1.was not consumed OR 748 2.was consumed, but the Notification Recipient wants to cancel the 749 corresponding Subscription object 751 The following sections are ordered in decreasing order of importance 752 of the status-codes. 754 9.2.1 client-error-not-found (0x0406) 756 This status code is defined in [RFC2911]. This document extends its 757 meaning and allows it to be returned in an Event Notification 758 Attributes Group of a response. 760 The Notification Recipient was unable to consume this Event 761 Notification Attributes Group because it was not expected. See 762 section 8.1.2 for further details. 764 9.2.2 successful-ok-but-cancel-subscription (0x0006) 766 The Notification Recipient was able to consume this Event 767 Notification Attributes Group that the Printer sent, but wants the 768 corresponding Subscription object to be canceled none-the-less. See 769 section 8.1.2 for further details. 771 10 Encoding and Transport 773 This section defines the encoding and transport used by the 'indp' 774 Delivery Method. 776 10.1 Encoding of the Operation Layer 778 The 'indp' Delivery Method uses the IPP operation layer encoding 779 described in [RFC2910] and the Event Notification Attributes Group 780 tag allocated by [ipp-ntfy] as shown in Table 7: 782 Table 7 - The "event-notification-attributes-tag" value 784 Tag Value (Hex) Meaning 786 0x07 "event-notification-attributes-tag" 788 10.2 Encoding of Transport Layer 790 The 'indp' Notification Delivery Method uses the IPP transport layer 791 encoding described in [RFC2910]. 793 It is REQUIRED that an 'indp' Notification Recipient implementation 794 support HTTP over the IANA assigned Well Known Port assigned to the 795 'indp' Delivery Method as its default port by IANA (see section 13), 796 though a Notification Recipient implementation MAY support HTTP over 797 some other port as well. 799 11 Conformance Requirements 801 This section defines conformance requirements for Printers and 802 Notification Recipients. 804 11.1 Conformance Requirements for Printers 806 The 'indp' Delivery Method is RECOMMENDED for a Printer to support. 808 IPP Printers that conform to this specification: 810 1.MUST meet the conformance requirements defined in [ipp-ntfy]. 812 2.MUST support the conformance requirements for Subscription object 813 attributes defined in section 5, including the syntax for the 814 "notify-recipient-uri" Subscription Object attribute defined in 815 section 5.2.1. 817 3.MUST support the conformance requirements for Printer Description 818 object attributes defined in section 6. 820 4.MUST support the 'indp' protocol by sending Event Notifications 821 using the Send-Notifications operation defined in section 8.1. 823 5.MUST send INDP URLs (e.g., in the "notify-recipient-uri" attribute 824 in 'Send-Notifications') that conform to the ABNF specified in 825 section 12.5 of this document; 827 6.MUST send the Send-Notifications operation via the port specified 828 in the INDP URL (if present) or otherwise via IANA assigned well- 829 known port [TBD]; 831 7.MUST convert INDP URLs for use in the Send-Notifications operation 832 to their corresponding HTTP URL forms for use in the HTTP layer by 833 the same rules used to convert IPP URLs to their corresponding 834 HTTP URL forms (see section 5 'IPP URL Scheme' in [RFC2910]). 836 11.2 Conformance Requirements for INDP Notification Recipients 838 INDP Notification Recipients that conform to this specification: 840 1.MUST accept Send-Notifications requests and return Send- 841 Notifications responses as defined in sections 8 and 9. 843 2.SHOULD reject received INDP URLs in "application/ipp" request 844 bodies (e.g., in the "notify-recipient-uri" attribute in 'Send- 845 Notifications') that do not conform to the ABNF for INDP URLs 846 specified in section 12.5 of this document; 848 3.MUST listen for INDP operations on IANA-assigned well-known port 849 [TBD], unless explicitly configured by system administrators or 850 site policies; 852 4.SHOULD NOT listen for INDP operations on any other port, unless 853 explicitly configured by system administrators or site policies. 855 12 INDP URL Scheme 857 12.1 INDP URL Scheme Applicability and Intended Usage 859 This section is intended for use in registering the "indp" URL scheme 860 with IANA and fully conforms to the requirements in [RFC2717]. This 861 document defines the "indp" URL (Uniform Resource Locator) scheme for 862 specifying the location of an INDP Notification Recipient object 863 which implements IPP Notification Delivery Protocol (INDP) specified 864 in this document. 866 The intended usage of the "indp" URL scheme is COMMON. 868 12.2 INDP URL Scheme Associated INDP Port 870 All INDP URLs which do NOT explicitly specify a port MUST be used 871 over IANA-assigned well-known port [TBD] for the INDP protocol. 873 See: IANA Port Numbers Registry [IANA-PORTREG]. 875 12.3 INDP URL Scheme Associated MIME Type 877 All INDP protocol operations (requests and responses) MUST be 878 conveyed in an "application/ipp" MIME media type as registered in 879 [IANA-MIMEREG]. INDP URLs MUST refer to INDP Notification Recipient 880 objects which support this "application/ipp" MIME media type. 882 See: IANA MIME Media Types Registry [IANA-MIMEREG]. 884 12.4 INDP URL Scheme Character Encoding 886 The INDP URL scheme defined in this document is based on the ABNF for 887 the HTTP URL scheme defined in HTTP/1.1 [RFC2616], which is derived 888 from the URI Generic Syntax [RFC2396] and further updated by 889 [RFC2732] and [RFC2373] (for IPv6 addresses in URLs). The INDP URL 890 scheme is case-insensitive in the 'scheme' and 'host' (host name or 891 host address) part; however the 'abs_path' part is case-sensitive, as 892 in [RFC2396]. Code points outside [US-ASCII] MUST be hex escaped by 893 the mechanism specified in [RFC2396]. 895 12.5 INDP URL Scheme Syntax in ABNF 897 This section is intended for use in registering the "indp" URL scheme 898 with IANA and fully conforms to the requirements in [RFC2717]. This 899 document defines the "indp" URL (Uniform Resource Locator) scheme for 900 specifying the location of an INDP Notification Recipient object 901 which implements IPP Notification Delivery Protocol (INDP) specified 902 in this document. 904 The intended usage of the "indp" URL scheme is COMMON. 906 The IPP protocol places a limit of 1023 octets (NOT characters) on 907 the length of a URI (see section 4.1.5 'uri' in [RFC2911]). An INDP 908 Notification Recipient MUST return 'client-error-request-value-too- 909 long' (see section 13.1.4.10 in [RFC2911]) when a URI received in a 910 request is too long. 912 Note: INDP Notification Recipients ought to be cautious about 913 depending on URI lengths above 255 bytes, because some older client 914 or proxy implementations might not properly support these lengths. 916 INDP URLs MUST be represented in absolute form. Absolute URLs always 917 begin with a scheme name followed by a colon. For definitive 918 information on URL syntax and semantics, see "Uniform Resource 919 Identifiers (URI): Generic Syntax and Semantics" [RFC2396]. This 920 specification adopts the definitions of "port", "host", "abs_path", 921 and "query" from [RFC2396], as updated by [RFC2732] and [RFC2373] 922 (for IPv6 addresses in URLs). 924 The INDP URL scheme syntax in ABNF is as follows: 926 indp_URL = "indp:" "//" host [ ":" port ] [ abs_path [ "?" query ]] 928 If the port is empty or not given, IANA-assigned well-known port 929 [TBD] is assumed. The semantics are that the identified resource 930 (see section 5.1.2 of [RFC2616]) is located at the INDP Notification 931 Recipient listening for HTTP connections on that port of that host, 932 and the Request-URI for the identified resource is 'abs_path'. 934 Note: The use of IP addresses in URLs SHOULD be avoided whenever 935 possible (see [RFC1900]). 937 If the 'abs_path' is not present in the URL, it MUST be given as "/" 938 when used as a Request-URI for a resource (see section 5.1.2 of 939 [RFC2616]). If a proxy receives a host name which is not a fully 940 qualified domain name, it MAY add its domain to the host name it 941 received. If a proxy receives a fully qualified domain name, the 942 proxy MUST NOT change the host name. 944 12.5.1 INDP URL Examples 946 The following are examples of valid INDP URLs for Notification 947 Recipient objects (using DNS host names): 949 indp://abc.com 950 indp://abc.com/listener 952 Note: The use of IP addresses in URLs SHOULD be avoided whenever 953 possible (see [RFC1900]). 955 The following literal IPv4 addresses: 957 192.9.5.5 ; IPv4 address in IPv4 style 958 186.7.8.9 ; IPv4 address in IPv4 style 960 are represented in the following example INDP URLs: 962 indp://192.9.5.5/listener 963 indp://186.7.8.9/listeners/tom 965 The following literal IPv6 addresses (conformant to [RFC2373]): 967 ::192.9.5.5 ; IPv4 address in IPv6 style 968 ::FFFF:129.144.52.38 ; IPv4 address in IPv6 style 969 2010:836B:4179::836B:4179 ; IPv6 address per RFC 2373 971 are represented in the following example INDP URLs: 973 indp://[::192.9.5.5]/listener 974 indp://[::FFFF:129.144.52.38]/listener 975 indp://[2010:836B:4179::836B:4179]/listeners/tom 977 12.5.2 INDP URL Comparisons 979 When comparing two INDP URLs to decide if they match or not, the 980 comparer MUST use the same rules as those defined for HTTP URI 981 comparisons in [RFC2616], with the sole following exception: 983 . A port that is empty or not given MUST be treated as equivalent 984 to the well-known port for that INDP URL (port [TBD]); 986 13 IANA Considerations 988 IANA is requested to register the indp URL scheme as defined in 989 section 12. 991 IANA is requested to assign a default system port (less than 1024) 992 for use with the indp URL as defined in section 12. 994 The rest of this section contains the exact information for IANA to 995 add to the IPP Registries according to the procedures defined in RFC 996 2911 [RFC2911] section 6. 998 Note to RFC Editors: Replace RFC NNNN below with the RFC number 999 for this document, so that it accurately reflects the content of 1000 the information for the IANA Registry. 1002 13.1 Operation Registrations 1004 The operations defined in this document will be published by IANA 1005 according to the procedures in RFC 2911 [RFC2911] section 6.4 with 1006 the following path: 1008 ftp.isi.edu/iana/assignments/ipp/operations/ 1010 The registry entry will contain the following information: 1012 Operations: Ref. Section: 1013 Send-Notifications operation RFC NNNN 8.1 1015 13.2 Additional values of existing attributes 1017 13.2.1 Additional values for the "notify-schemes-supported" Printer 1018 attribute 1020 The "notify-schemes-supported" uriScheme attribute value defined in 1021 this document will be published by IANA according to the procedures 1022 in RFC 2911 [RFC2911] section 6.1 with the following path: 1024 ftp.isi.edu/iana/assignments/ipp/attribute-values/notify-schemes- 1025 supported/ 1027 The registry entry will contain the following information: 1029 Ref. Section: 1030 indp RFC NNNN 6.2.1 1032 13.2.2 Additional values for the "operations-supported" Printer 1033 attribute 1035 The "operations-supported" type2 enum attribute value defined in this 1036 document will be published by IANA according to the procedures in RFC 1037 2911 [RFC2911] section 6.1 with the following path: 1039 ftp.isi.edu/iana/assignments/ipp/attribute-values/operations- 1040 supported/ 1042 The registry entry will contain the following information: 1044 Value Ref. Section: 1045 Send-Notifications 0x001D RFC NNNN 6.2.1 1047 13.3 Status code Registrations 1049 The status codes defined in this document will be published by IANA 1050 according to the procedures in RFC 2911 [RFC2911] section 6.6 with 1051 the following path: 1053 ftp.isi.edu/iana/assignments/ipp/status-codes/ 1055 The registry entry will contain the following information: 1057 Status codes: Ref. Section: 1058 successful-ok-ignored-notifications (0x0004) RFC NNNN 9.1.1 1059 client-error-ignored-all-notifications (0x0416) RFC NNNN 9.1.2 1061 14 Internationalization Considerations 1063 When the client requests Human Consumable form by supplying the 1064 "notify-text-format" operation attribute (see [ipp-ntfy]), the IPP 1065 Printer (or any Notification Service that the IPP Printer might be 1066 configured to use) supplies and localizes the text value of the 1067 "human-readable-report" attribute in the Notification according to 1068 the charset and natural language requested in the notification 1069 subscription. 1071 15 Security Considerations 1073 The IPP Model and Semantics document [RFC2911] discusses high level 1074 security requirements (Client Authentication, Server Authentication 1075 and Operation Privacy). Client Authentication is the mechanism by 1076 which the client proves its identity to the server in a secure 1077 manner. Server Authentication is the mechanism by which the server 1078 proves its identity to the client in a secure manner. Operation 1079 Privacy is defined as a mechanism for protecting operations from 1080 eavesdropping. 1082 The Notification Recipient can cancel unwanted Subscriptions created 1083 by other parties without having to be the owner of the subscription 1084 by returning the 'successful-ok-but-cancel-subscription' status code 1085 in the Send-Notifications response returned to the Printer. 1087 15.1 Security Conformance 1089 Printers (client) MAY support Digest Authentication [RFC2617]. If 1090 Digest Authentication is supported, then MD5 and MD5-sess MUST be 1091 supported, but the Message Integrity feature NEED NOT be supported. 1093 Notification Recipient (server) MAY support Digest Authentication 1094 [RFC2617]. If Digest Authentication is supported, then MD5 and MD5- 1095 sess MUST be supported, but the Message Integrity feature NEED NOT be 1096 supported. 1098 Notification Recipients MAY support TLS for client authentication, 1099 server authentication and operation privacy. If a Notification 1100 Recipient supports TLS, it MUST support the 1101 TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA cipher suite as mandated by RFC 1102 2246 [RFC2246]. All other cipher suites are OPTIONAL. Notification 1103 recipients MAY support Basic Authentication (described in HTTP/1.1 1104 [RFC2616]) for client authentication if the channel is secure. TLS 1105 with the above mandated cipher suite can provide such a secure 1106 channel. 1108 16 References 1110 [ipp-iig] 1111 Hastings, T., Manros, C., Kugler, K, Holst H., Zehler, P., 1112 "Internet Printing Protocol/1.1: draft-ietf-ipp-implementers- 1113 guide-v11-02.txt, work in progress, January 25, 2001 1115 [ipp-ntfy] 1116 Isaacson, S., Martin, J., deBry, R., Hastings, T., Shepherd, M., 1117 Bergman, R., "Internet Printing Protocol/1.1: IPP Event 1118 Notification Specification", , 1119 January 24, 2001. 1121 [IANA-MIMEREG] 1122 IANA MIME Media Types Registry. ftp://ftp.isi.edu/in- 1124 notes/iana/assignments/media-types/ 1126 [IANA-PORTREG] 1127 IANA Port Numbers Registry. ftp://ftp.isi.edu/in- 1129 notes/iana/assignments/port-numbers 1131 [RFC1900] 1132 B. Carpenter, Y. Rekhter. Renumbering Needs Work, RFC 1900, 1133 February 1996. 1135 [RFC2026] 1136 S. Bradner, "The Internet Standards Process -- Revision 3", RFC 1137 2026, October 1996. 1139 [RFC2373] 1140 R. Hinden, S. Deering. IP Version 6 Addressing Architecture, RFC 1141 2373, July 1998. 1143 [RFC2396] 1144 Berners-Lee, T. et al. Uniform Resource Identifiers (URI): Generic 1145 Syntax, RFC 2396, August 1998 1147 [RFC2565] 1148 Herriot, R., Butler, S., Moore, P., and R. Turner, "Internet 1149 Printing Protocol/1.0: Encoding and Transport", RFC 2565, April 1150 1999. 1152 [RFC2566] 1153 R. deBry, T. Hastings, R. Herriot, S. Isaacson, and P. Powell, 1154 "Internet Printing Protocol/1.0: Model and Semantics", RFC 2566, 1155 April 1999. 1157 [RFC2567] 1158 Wright, D., "Design Goals for an Internet Printing Protocol", RFC 1159 2567, April 1999. 1161 [RFC2568] 1162 Zilles, S., "Rationale for the Structure and Model and Protocol for 1163 the Internet Printing Protocol", RFC 2568, April 1999. 1165 [RFC2569] 1166 Herriot, R., Hastings, T., Jacobs, N., Martin, J., "Mapping between 1167 LPD and IPP Protocols", RFC 2569, April 1999. 1169 [RFC2616] 1170 R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. 1171 Leach, T. Berners-Lee, "Hypertext Transfer Protocol - HTTP/1.1", 1172 RFC 2616, June 1999. 1174 [RFC2617] 1175 J. Franks, P. Hallam-Baker, J. Hostetler, S. Lawrence, P. Leach, A. 1176 Luotonen, L. Stewart, "HTTP Authentication: Basic and Digest Access 1177 Authentication", RFC 2617, June 1999. 1179 [RFC2717] 1180 R. Petke and I. King, "Registration Procedures for URL Scheme 1181 Names", RFC 2717, November 1999. 1183 [RFC2732] 1184 R. Hinden, B. Carpenter, L. Masinter. Format for Literal IPv6 1185 Addresses in URL's, RFC 2732, December 1999. 1187 [RFC2910] 1188 Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing 1189 Protocol/1.1: Encoding and Transport", RFC 2910, September 2001. 1191 [RFC2911] 1192 R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell, 1193 "Internet Printing Protocol/1.1: Model and Semantics", RFC 2911, 1194 September 2001. 1196 17 Author's Addresses 1198 Hugo Parra 1199 Novell, Inc. 1200 1800 South Novell Place 1202 Provo, UT 84606 1204 Phone: 801-861-3307 1205 Fax: 801-861-2517 1206 e-mail: hparra@novell.com 1208 Tom Hastings 1209 Xerox Corporation 1210 737 Hawaii St. ESAE 231 1211 El Segundo, CA 90245 1213 Phone: 310-333-6413 1214 Fax: 310-333-5514 1215 e-mail: hastings@cp10.es.xerox.com 1217 18 Summary of Base IPP documents 1219 The base IPP documents includes: 1221 Design Goals for an Internet Printing Protocol [RFC2567] 1222 Rationale for the Structure and Model and Protocol for the 1223 Internet Printing Protocol [RFC2568] 1224 Internet Printing Protocol/1.1: Model and Semantics [RFC2911] 1225 Internet Printing Protocol/1.1: Encoding and Transport [RFC2910] 1226 Internet Printing Protocol/1.1: Implementer's Guide [ipp-iig] 1227 Mapping between LPD and IPP Protocols [RFC2569] 1228 Internet Printing Protocol (IPP): IPP Event Notification 1229 Specification [ipp-ntfy] 1231 The "Design Goals for an Internet Printing Protocol" document takes a 1232 broad look at distributed printing functionality, and it enumerates 1233 real-life scenarios that help to clarify the features that need to be 1234 included in a printing protocol for the Internet. It identifies 1235 requirements for three types of users: end users, operators, and 1236 administrators. It calls out a subset of end user requirements that 1237 are satisfied in IPP/1.0 [RFC2566, RFC2565]. A few OPTIONAL operator 1238 operations have been added to IPP/1.1 [RFC2911, RFC2910]. 1240 The "Rationale for the Structure and Model and Protocol for the 1241 Internet Printing Protocol" document describes IPP from a high level 1242 view, defines a roadmap for the various documents that form the suite 1243 of IPP specification documents, and gives background and rationale 1244 for the IETF working group's major decisions. 1246 The "Internet Printing Protocol/1.1: Model and Semantics" document 1247 describes a simplified model with abstract objects, their attributes, 1248 and their operations that are independent of encoding and transport. 1249 It introduces a Printer and a Job object. The Job object optionally 1250 supports multiple documents per Job. It also addresses security, 1251 internationalization, and directory issues. 1253 The "Internet Printing Protocol/1.1: Encoding and Transport" document 1254 is a formal mapping of the abstract operations and attributes defined 1255 in the model document onto HTTP/1.1 [RFC2616]. It defines the 1256 encoding rules for a new Internet MIME media type called 1257 "application/ipp". This document also defines the rules for 1258 transporting a message body over HTTP whose Content-Type is 1259 "application/ipp". This document defines the 'ipp' scheme for 1260 identifying IPP printers and jobs. 1262 The "Internet Printing Protocol/1.1: Implementer's Guide" document 1263 gives insight and advice to implementers of IPP clients and IPP 1264 objects. It is intended to help them understand IPP/1.1 and some of 1265 the considerations that may assist them in the design of their client 1266 and/or IPP object implementations. For example, a typical order of 1267 processing requests is given, including error checking. Motivation 1268 for some of the specification decisions is also included. 1270 The "Mapping between LPD and IPP Protocols" document gives some 1271 advice to implementers of gateways between IPP and LPD (Line Printer 1272 Daemon) implementations. 1274 The "Internet Printing Protocol (IPP): IPP Event Notification 1275 Specification" document defines an extension to IPP/1.0 [RFC2566, 1276 RFC2565] and IPP/1.1 [RFC2911, RFC2910]. This extension allows a 1277 client to subscribe to printing related Events by creating a 1278 Subscription Object and defines the semantics for delivering 1279 asynchronous Event Notifications to the specified Notification 1280 Recipient via a specified Delivery Method (i.e., protocols) defined 1281 in (separate) Delivery Method documents. 1283 19 Full Copyright Statement 1285 Copyright (C) The Internet Society (2001). All Rights Reserved. 1287 This document and translations of it may be copied and furnished to 1288 others, and derivative works that comment on or otherwise explain it 1289 or assist in its implementation may be prepared, copied, published 1290 and distributed, in whole or in part, without restriction of any 1291 kind, provided that the above copyright notice and this paragraph are 1292 included on all such copies and derivative works. However, this 1293 document itself may not be modified in any way, such as by removing 1294 the copyright notice or references to the Internet Society or other 1295 Internet organizations, except as needed for the purpose of 1296 developing Internet standards in which case the procedures for 1297 copyrights defined in the Internet Standards process must be 1298 followed, or as required to translate it into languages other than 1299 English. 1301 The limited permissions granted above are perpetual and will not be 1302 revoked by the Internet Society or its successors or assigns. 1304 This document and the information contained herein is provided on an 1305 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 1306 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 1307 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 1308 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 1309 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 1311 Acknowledgement 1313 Funding for the RFC Editor function is currently provided by the 1314 Internet Society.