draft-ietf-ipp-notify-get-03.txt   draft-ietf-ipp-notify-get-04.txt 
INTERNET-DRAFT Robert Herriot (editor) Internet Printing Protocol WG Robert Herriot (editor)
<draft-ietf-ipp-notify-get-03.txt> Xerox Corp. INTERNET-DRAFT Xerox Corp.
[Target category: standards track] Carl Kugler <draft-ietf-ipp-notify-get-04.txt> Carl Kugler
IBM, Corp. Updates: RFC 2911 Harry Lewis
Harry Lewis [Target category: standards track] IBM, Corp.
IBM, Corp. Expires: January 17, 2002 July 17, 2001
April 5, 2001
Internet Printing Protocol (IPP): Internet Printing Protocol (IPP):
The 'ippget' Delivery Method for Event Notifications The 'ippget' Delivery Method for Event Notifications
Copyright (C) The Internet Society (2001). All Rights Reserved. Copyright (C) The Internet Society (2001). All Rights Reserved.
Status of this Memo: Status of this Memo:
This document is an Internet-Draft and is in full conformance with This document is an Internet-Draft and is in full conformance with
all provisions of Section 10 of [rfc2026]. Internet-Drafts are all provisions of Section 10 of [rfc2026]. Internet-Drafts are
working documents of the Internet Engineering Task Force (IETF), its working documents of the Internet Engineering Task Force (IETF), its
skipping to change at page 1, line 39 skipping to change at page 1, line 39
http://www.ietf.org/ietf/1id-abstracts.txt http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed as The list of Internet-Draft Shadow Directories can be accessed as
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
Abstract Abstract
This document describes an extension to the Internet Printing This document describes an extension to the Internet Printing
Protocol/1.0 (IPP) [RFC2566, RFC2565] and IPP/1.1 [RFC2911, RFC2910]. Protocol/1.0 (IPP) [RFC2566, RFC2565] and IPP/1.1 [RFC2911, RFC2910].
This document specifies the 'ippget' Delivery Method for use with the This document specifies the 'ippget' Delivery Method for use with the
IPP Event Notification Specification [ipp-ntfy].The 'ippget' Delivery "IPP Event Notifications and Subscriptions" specification [ipp-ntfy].
Method is a 'pull and push' Delivery Method. That is, when an Event When IPP Notification [ipp-ntfy] is supported, the Delivery Method
occurs, the Printer saves the Event Notification for a period of time defined in this document is one of the RECOMMENDED Delivery Methods
called the Event Notification Lease Time. The Notification Recipient for Printers to support.
fetches (pulls) Event Notifications using the Get-Notifications
operation. If the Notification Recipient has selected the option to
wait for additional Event Notifications, the Printer continues to
return (push) Event Notifications to the Notification Recipient as
Get-Notification responses as Events occur.
Table of Contents
1 Introduction....................................................4
2 Terminology.....................................................4
3 Model and Operation.............................................5
4 General Information.............................................6
5 Get-Notifications operation.....................................8 The 'ippget' Delivery Method is a 'pull' Delivery Method with aspects
5.1 Get-Notifications Request...................................10 of a 'push' method as well. That is, when an Event occurs, the
5.2 Get-Notifications Response..................................11 Printer saves the Event Notification for a period of time called the
Event Notification Lease Time. The Notification Recipient fetches
(pulls) Event Notifications using the Get-Notifications operation.
If the Notification Recipient has selected the option to wait for
additional Event Notifications, the Printer continues to return
6 Subscription Template Attributes...............................16 #@# this page exceeds 58 lines: 59
6.1 Subscription Template Attribute Conformance.................16 (similar to push) Event Notifications to the Notification Recipient
6.2 Additional Information about Subscription Template Attributes16 as Get-Notification responses as Events occur. This push aspect is
6.2.1 notify-recipient-uri (uri)................................16 not a true 'push', since the Printer does not open the connect, but
6.3 Subscription Description Attribute Conformance..............17 rather continues to return responses as Events occur using the
connection originated by the Notification Recipient.
7 Additional Printer Description Attributes......................17 Table of Contents
7.1 Printer Description Attribute Conformance...................17
7.2 New Values for Existing Printer Description Attributes......17
7.2.1 notify-schemes-supported (1setOf uriScheme)...............17
7.2.2 operations-supported (1setOf type2 enum)..................17
7.3 begin-to-expire-time-interval (integer(0:MAX))..............18
8 New Status Codes...............................................18 1 Introduction.....................................................5
8.1 redirection-other-site (0x300)..............................19
9 The IPPGET URL Scheme..........................................19 2 Terminology......................................................5
9.1 The IPPGET URL Scheme Applicability and Intended Usage......19
9.2 The IPPGET URL Scheme Associated Port.......................19
9.3 The IPPGET URL Scheme Associated MIME Type..................19
9.4 The IPPGET URL Scheme Character Encoding....................20
9.5 The IPPGET URL Scheme Syntax in ABNF........................20
9.5.1 IPPGET URL Examples.......................................21
9.5.2 IPPGET URL Comparisons....................................22
10 Encoding.......................................................22 3 Model and Operation..............................................6
11 Conformance Requirements.......................................22 4 General Information..............................................8
11.1 Conformance for IPP Printers................................22
11.2 Conformance for IPP Clients.................................23
12 IANA Considerations............................................23 5 Get-Notifications operation......................................9
12.1 Operation Registrations.....................................24 5.1 Get-Notifications Request.....................................11
12.2 Additional values of existing attributes....................24 5.2 Get-Notifications Response....................................13
12.2.1 Additional values for the "notify-schemes-supported" Printer
attribute..............................................24
12.2.2 Additional values for the "operations-supported" Printer
attribute..............................................24
12.3 Attribute Registrations.....................................25
12.4 Status code Registrations...................................25
13 Internationalization Considerations............................25 6 Subscription Template Attributes................................18
6.1 Subscription Template Attribute Conformance...................18
6.2 Additional Information about Subscription Template Attributes.18
6.2.1 notify-recipient-uri (uri)..................................18
6.3 Subscription Description Attribute Conformance................19
14 Security Considerations........................................25 7 Attributes only in Event Notifications..........................19
7.1 "notify-get-interval" (integer(0:MAX))........................19
15 References.....................................................26 8 Additional Printer Description Attributes.......................20
8.1 ippget-event-time-to-live (integer(0:MAX))....................20
16 Authors' Addresses.............................................28 9 New Values for Existing Printer Description Attributes..........21
9.1 notify-schemes-supported (1setOf uriScheme)...................21
9.2 operations-supported (1setOf type2 enum)......................21
17 Description of Base IPP documents..............................28 10 New Status Codes...............................................21
10.1 redirection-other-site (0x0300)..............................21
18 Full Copyright Statement.......................................30 11 The IPPGET URL Scheme..........................................22
11.1 The IPPGET URL Scheme Applicability and Intended Usage.......22
11.2 The IPPGET URL Scheme Associated Port........................22
11.3 The IPPGET URL Scheme Associated MIME Type...................22
11.4 The IPPGET URL Scheme Character Encoding.....................22
11.5 The IPPGET URL Scheme Syntax in ABNF.........................23
11.5.1 IPPGET URL Examples........................................24
11.5.2 IPPGET URL Comparisons.....................................24
Table of Tables 12 Encoding and Transport.........................................25
Table 1 - Information about the Delivery Method....................7 13 Conformance Requirements.......................................26
13.1 Conformance for IPP Printers.................................26
13.2 Conformance for IPP Clients..................................27
Table 2 - Attributes in Event Notification Content................14 14 IANA Considerations............................................28
14.1 Operation Registrations......................................28
14.2 Additional attribute value registrations for existing attributes
28
14.2.1 Additional values for the "notify-schemes-supported" Printer
attribute..............................................28
14.2.2 Additional values for the "operations-supported" Printer
attribute..............................................29
14.3 Attribute Registrations......................................29
14.4 Status code Registrations....................................29
Table 3 - Additional Attributes in Event Notification Content for Job 15 Internationalization Considerations............................30
Events ........................................................15 16 Security Considerations........................................30
Table 4 - Combinations of Events and Subscribed Events for "job- 17 References.....................................................30
impressions-completed" ........................................15 18 Authors' Addresses.............................................32
Table 5 - Additional Attributes in Event Notification Content for 19 Description of Base IPP documents..............................33
Printer Events ................................................16 20 Full Copyright Statement.......................................35
Table 6 - Operation-id assignments................................18 Table of Tables
Table 7 - The "event-notification-attributes-tag" value...........22 Table 1 " Information about the Delivery Method....................8
Table 2 " Attributes in Event Notification Content................16
Table 3 " Additional Attributes in Event Notification Content for Job
Events........................................................17
Table 4 " Combinations of Events and Subscribed Events for "job-
impressions-completed"........................................17
Table 5 " Additional Attributes in Event Notification Content for
Printer Events................................................18
Table 6 " Operation-id assignments................................21
Table 7 " The "event-notification-attributes-tag" value...........26
1 Introduction 1 Introduction
The "IPP Event Notification Specification" document [ipp-ntfy] The "IPP Event Notifications and Subscriptions" document [ipp-ntfy]
defines an extension to Internet Printing Protocol/1.0 (IPP) defines an OPTIONAL extension to Internet Printing Protocol/1.0 (IPP)
[RFC2566, RFC2565] and IPP/1.1 [RFC2911, RFC2910]. This extension [RFC2566, RFC2565] and IPP/1.1 [RFC2911, RFC2910]. For a description
of the base IPP documents, see section 19. The [ipp-ntfy] extension
defines operations that a client can perform in order to create defines operations that a client can perform in order to create
Subscription Objects in a Printer and carry out other operations on Subscription Objects in a Printer and carry out other operations on
them. A Subscription Object represents a Subscription abstraction. them. A Subscription Object represents a Subscription abstraction.
A client associates Subscription Objects with a particular Job by A client associates Subscription Objects with a particular Job by
performing the Create-Job-Subscriptions operation or by submitting a performing the Create-Job-Subscriptions operation or by submitting a
Job with subscription information. A client associates Subscription Job with subscription information. A client associates Subscription
Objects with the Printer by performing a Create-Printer-Subscriptions Objects with the Printer by performing a Create-Printer-Subscriptions
operation. Four other operations are defined for Subscription operation. Four other operations are defined for Subscription
Objects: Get-Subscriptions-Attributes, Get-Subscriptions, Renew- Objects: Get-Subscriptions-Attributes, Get-Subscriptions, Renew-
Subscription, and Cancel-Subscription. The Subscription Object Subscription, and Cancel-Subscription. The Subscription Object
specifies that when one of the specified Events occurs, the Printer specifies that when one of the specified Events occurs, the Printer
sends an asynchronous Event Notification to the specified sends an asynchronous Event Notification to the specified
Notification Recipient via the specified Delivery Method (i.e., Notification Recipient via the specified Delivery Method (i.e.,
protocol). protocol).
The "IPP Event Notification Specification" document [ipp-ntfy] The "IPP Event Notifications and Subscriptions" document [ipp-ntfy]
specifies that each Delivery Method is defined in another document. specifies that each Delivery Method is defined in another document.
This document is one such document, and it specifies the 'ippget' This document is one such document, and it specifies the 'ippget'
delivery method. delivery method. When IPP Notification [ipp-ntfy] is supported, the
Delivery Method defined in this document is one of the RECOMMENDED
Delivery Methods for Printers to support.
The 'ippget' Delivery Method is a 'pull and push' Delivery Method. The 'ippget' Delivery Method is a 'pull' Delivery Method with aspects
That is, when an Event occurs, the Printer saves the Event of a 'push' method as well. That is, when an Event occurs, the
Notification for a period of time called the Event Notification Lease Printer saves the Event Notification for a period of time called the
Time. The Notification Recipient fetches (pulls) the Event Event Notification Lease Time. The Notification Recipient fetches
Notifications using the Get-Notifications operation. This operation (pulls) the Event Notifications using the Get-Notifications
causes the Printer to return all Event Notifications held for the operation. This operation causes the Printer to return all Event
Notification Recipient. If the Notification Recipient has selected Notifications held for the Notification Recipient. If the
the option to wait for additional Event Notifications, the Printer Notification Recipient has selected the option to wait for additional
continues to return (push) Event Notifications to the Notification Event Notifications, the Printer continues to return (similar to
Recipient as Get-Notification responses as Events occur. push) Event Notifications to the Notification Recipient as Get-
Notification responses as Events occur. This push aspect is not a
true 'push', since the Printer does not open the connect, but rather
continues to return responses as Events occur using the connection
originated by the Notification Recipient.
2 Terminology 2 Terminology
This section defines the following terms that are used throughout This section defines the following terms that are used throughout
this document: this document:
This document uses the same terminology as [RFC2911], such as
"client", "Printer", "Job", "attribute", "attribute value",
"keyword", "operation", "request", "response", and "support".
Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD
NOT, MAY, NEED NOT, and OPTIONAL, have special meaning relating to NOT, MAY, NEED NOT, and OPTIONAL, have special meaning relating to
conformance to this specification. These terms are defined in conformance as defined in RFC 2119 [RFC2119] and [RFC2911] section
[RFC2911 section 13.1 on conformance terminology, most of which is 12.1. If an implementation supports the extension defined in this
taken from RFC 2119 [RFC2119]. document, then these terms apply; otherwise, they do not. These
terms define conformance to this document only; they do not affect
conformance to other documents, unless explicitly stated otherwise.
Event Notification Lease: The lease that is associated with an Event Event Notification Lease: The lease that is associated with an Event
Notification. When the lease expires, the Printer discards the Notification. When the lease expires, the Printer discards the
associated Event Notification. associated Event Notification.
Event Notification Lease Time: The expiration time assigned to a Event Notification Lease Time: The expiration time assigned to a
lease that is associated with an Event Notification. lease that is associated with an Event Notification.
Event Notification Attributes Group: The attributes group in a Event Notification Attributes Group: The attributes group in a
response that contains attributes that are part of an Event response that contains attributes that are part of an Event
Notification. Notification.
For other capitalized terms that appear in this document, see [ipp- Event Wait Mode: The mode requested by a Notification Recipient
ntfy]. client in its Get-Notifications Request and granted by a Printer to
keep the connection open where the Printer sends subsequent Event
Notifications to the Notification Recipient as they occur as
additional Get-Notification Responses.
Other capitalized terms, such as Notification Recipient, Event
Notification, Compound Event Notification, Printer, etc., are
defined in [ipp-ntfy], have the same meanings, and are not reproduced
here.
3 Model and Operation 3 Model and Operation
In a Subscription Creation Operation, when the value of the "notify- In a Subscription Creation Operation, when the value of the "notify-
recipient-uri" attribute has the scheme 'ippget', the client is recipient-uri" attribute has the scheme 'ippget', the client is
requesting that the Printer use the 'ippget' Delivery Method for the requesting that the Printer use the 'ippget' Delivery Method for the
Event Notifications associated with the new Subscription Object. The Event Notifications associated with the new Subscription Object. The
client SHOULD choose a value for the address part of the "notify- client SHOULD choose a value for the address part of the "notify-
recipient-uri" attribute that uniquely identifies the Notification recipient-uri" attribute that uniquely identifies the Notification
Recipient. Recipient.
skipping to change at page 5, line 39 skipping to change at page 7, line 15
When an Event occurs, the Printer MUST generate an Event Notification When an Event occurs, the Printer MUST generate an Event Notification
and MUST assign it the Event Notification Lease Time. The Printer and MUST assign it the Event Notification Lease Time. The Printer
MUST hold an Event Notification for its assigned Event Notification MUST hold an Event Notification for its assigned Event Notification
Lease Time. The Printer MUST assign the same Event Notification Lease Time. The Printer MUST assign the same Event Notification
Lease Time to each Event Notification. Lease Time to each Event Notification.
When a Notification Recipient wants to receive Event Notifications, When a Notification Recipient wants to receive Event Notifications,
it performs the Get-Notifications operation, which causes the Printer it performs the Get-Notifications operation, which causes the Printer
to return all un-expired Event Notifications held for the to return all un-expired Event Notifications held for the
Notification Recipient. If the Notification Recipient has selected Notification Recipient. If the Notification Recipient has selected
the option to wait for additional Event Notifications, the response the Event Wait Mode option to wait for additional Event
to the Get-Notifications request continues indefinitely as the Notifications, the response to the Get-Notifications request
Printer continues to send Event Notifications in the response as continues indefinitely as the Printer continues to send Event
Events occur. For the Get-Notification operation, the Printer sends Notifications in the response as Events occur. For the Get-
only those Event Notifications that are generated from Subscription Notification operation, the Printer sends only those Event
Objects whose "notify-recipient-uri" attribute value equals the value Notifications that are generated from Subscription Objects whose
of the "notify-recipient-uri" Operation Attribute in the Get- "notify-recipient-uri" attribute value equals the value of the
Notifications operation. "notify-recipient-uri" Operation Attribute in the Get-Notifications
operation.
If a Notification Recipient performs the Get-Notifications operation If a Notification Recipient performs the Get-Notifications operation
twice in quick succession, it will receive nearly the same Event twice in quick succession, it will receive nearly the same Event
Notification both times because most of the Event Notifications are Notification both times because most of the Event Notifications are
those that the Printer saves for a few seconds after the Event those that the Printer saves for a few seconds after the Event
occurs. There are two possible differences. Some old Event occurs. There are two possible differences. Some old Event
Notifications may not be present in the second response because their Notifications may not be present in the second response because their
Event Notification Leases have expired. Some new Event Notifications Event Notification Leases have expired. Some new Event Notifications
may be present in the second response but not the first response. may be present in the second response but not the first response,
because they occurred after the first response.
When the Notification Recipient requests Event Notifications for per- When the Notification Recipient requests Event Notifications for per-
Job Subscription Objects, the Notification Recipient typically Job Subscription Objects, the Notification Recipient typically
performs the Get-Notifications operation within a second of performs the Get-Notifications operation within a second of
performing the Subscription Creation operation. Because the Printer performing the Subscription Creation operation. Because the Printer
is likely to save Event Notifications for several seconds, the is likely to save Event Notifications for several seconds, the
Notification Recipient is unlikely to miss any Event Notifications Notification Recipient is unlikely to miss any Event Notifications
that occur between the Subscription Creation and the Get- that occur between the Subscription Creation and the Get-
Notifications operation. Notifications operation.
4 General Information 4 General Information
If a Printer supports this Delivery Method, the following are its If a Printer supports this Delivery Method, the following are its
characteristics. characteristics.
Table 1 - Information about the Delivery Method Table 1 " Information about the Delivery Method
Document Method Conformance Delivery Method Realization
Requirement
1. What is the URL scheme name ippget
for the Delivery Method?
2. Is the Delivery Method RECOMMENDED
REQUIRED, RECOMMENDED or
OPTIONAL for an IPP Printer
to support?
3. What transport and delivery IPP with one new operation. Document Method Conformance Requirement Delivery Method
protocols does the Printer Realization
use to deliver the Event
Notification Content, i.e.,
what is the entire network
stack?
4. Can several Event Yes. 1. What is the URL scheme name for the ippget
Notifications be combined Delivery Method?
into a Compound Event 2. Is the Delivery Method REQUIRED, RECOMMENDED
RECOMMENDED or OPTIONAL for an IPP
Printer to support?
3. What transport and delivery protocols IPP with one new
does the Printer use to deliver the Event operation.
Notification Content, i.e., what is the
entire network stack?
4. Can several Event Notifications be Yes.
combined into a Compound Event
Notification? Notification?
5. Is the Delivery Method initiated by the This Delivery Method
5. Is the Delivery Method This Delivery Method is a pull Notification Recipient (pull), or by the is a pull method
initiated by the Notification and a push. Printer (push)? with aspects of a
Recipient (pull), or by the push method, though
Printer (push)? the Printer does not
initiate the
6. Is the Event Notification Machine Consumable connection.
content Machine Consumable or 6. Is the Event Notification content Machine Machine Consumable
Human Consumable? Consumable or Human Consumable?
7. What section in this document answers the Section 5
7. What section in this document Section 5 following question? For a Machine
answers the following Consumable Event Notification, what is
question? For a Machine the representation and encoding of values
Consumable Event defined in section 9.1 of [ipp-ntfy] and
Notification, what is the the conformance requirements thereof? For
representation and encoding a Human Consumable Event Notification,
of values defined in section what is the representation and encoding
9.1 of [ipp-ntfy] and the of pieces of information defined in
conformance requirements section 9.2 of [ipp-ntfy] and the
thereof? For a Human conformance requirements thereof?
Consumable Event 8. What are the latency and reliability of Same as IPP and the
Notification, what is the the transport and delivery protocol? underlying HTTP
representation and encoding transport
of pieces of information 9. What are the security aspects of the Same as IPP and the
defined in section 9.2 of transport and delivery protocol, e.g., underlying HTTP
[ipp-ntfy] and the how it is handled in firewalls? transport
conformance requirements 10. What are the content length restrictions? None
thereof? 11. What are the additional values or pieces None
of information that a Printer sends in an
8. What are the latency and Same as IPP and the underlying Event Notification content and the
reliability of the transport HTTP transport conformance requirements thereof?
and delivery protocol? 12. What are the additional Subscription None
Template and/or Subscription Description
9. What are the security aspects Same as IPP and the underlying attributes and the conformance
of the transport and delivery HTTP transport requirements thereof?
protocol, e.g., how it is 13. What are the additional Printer None
handled in firewalls? Description attributes and the
conformance requirements thereof?
10. What are the content length None
restrictions?
11. What are the additional None
values or pieces of
information that a Printer
sends in an Event
Notification content and the
conformance requirements
thereof?
12. What are the additional None
Subscription Template and/or
Subscription Description
attributes and the
conformance requirements
thereof?
13. What are the additional None
Printer Description
attributes and the
conformance requirements
thereof?
5 Get-Notifications operation 5 Get-Notifications operation
This operation causes the Printer to return all Event Notifications This operation is issued by a client acting in the role of a
held for the Notification Recipient. Notification Recipient and causes the Printer to return all Event
Notifications held for the Notification Recipient.
A Printer MUST support this operation. A Printer MUST support this operation.
When a Printer performs this operation, it MUST return all and only When a Printer performs this operation, it MUST return all and only
those Event Notifications: those Event Notifications:
1. Whose associated Subscription Object's "notify-recipient-uri" 1. Whose associated Subscription Object's "notify-subscription-id"
attribute equals the "notify-subscription-id" Operation
attribute if supplied AND
2. Whose associated Subscription Object's "notify-recipient-uri"
attribute equals the "notify-recipient-uri" Operation attribute attribute equals the "notify-recipient-uri" Operation attribute
AND AND
2. Whose associated Subscription Object's "notify-recipient-uri" 3. Whose associated Subscription Object's "notify-recipient-uri"
attribute has a scheme value of 'ippget' AND attribute matches the scheme value of 'ippget' using the
matching rules in section 11.5.2 AND
3. Whose Event Notification Lease Time has not yet expired AND 4. Whose Event Notification Lease Time has not yet expired AND
4. Where the Notification Recipient is the owner of or has read- 5. Where the Notification Recipient is the owner of or has read-
access rights to the associated Subscription Object. access rights to the associated Subscription Object.
The Printer MUST respond to this operation immediately with whatever The Printer has the following options for responding to a Get-
Event Notifications it currently holds. If the Notification Recipient Notifications Request:
has selected the option to wait for additional Event Notifications,
the Printer MUST continue to send Event Notifications as they occur
until all of the associated Subscription Objects are cancelled. A
Subscription Object is cancelled either via the Cancel-Subscription
operation or by the Printer (e.g. the Subscription Object is
cancelled when the associated Job completes).
Note, the Printer terminates the operation in the same way that it #@# next line is > 72 characters: 73
normally terminates IPP operations. For example, if the Printer is 1. The Printer can reject the request and return the 'server-error-
sending chunked data, it can send a 0 length chunk to denote the end busy' status code, if the Printer is too busy to accept this
of the operation or it can close the connection. If the Notification operation at this time. In this case, the Printer MUST return
Recipient wishes to terminate the Get-Notifications operation, it can the "get-notify-interval" attribute to indicate when the client
close the connection. should try again.
2. If the Notification Recipient did not request Event Wait Mode,
the Printer MUST respond to this operation immediately with
whatever Event Notifications it currently holds and return the
"notify-get-interval" attribute with number of seconds from now
at which the Notification Recipient MAY repeat the Get-
Notifications Request to get future Event Notifications.
3. If the Notification Recipient requested Event Wait Mode, the
Printer MUST respond to this operation immediately with whatever
Event Notifications it currently holds MUST continue to send
Event Notifications as they occur until all of the associated
Subscription Objects are cancelled. A Subscription Object is
cancelled either via the Cancel-Subscription operation or by the
Printer (e.g., the Subscription Object is cancelled when the
associated Job completes and is no longer in the Job Retention
or Job History phase - see the "ippget-event-time-to-live
(integer(0:MAX))" attribute discussion in section 8.1).
However, the Printer MAY decide to terminate Event Wait Mode at
any time, including in the first response. In this case the
Printer MUST return an additional Event Notification Attributes
Group that contains the single "notify-get-interval" attribute.
This attribute indicates that the Printer wishes to leave Event
Wait Mode and the number of seconds in the future that the
Notification Recipient SHOULD try the Get-Notifications
operation again. The Notification Recipient MUST accept this
response and MUST disconnect. If the Notification Recipient
does not disconnect, the Printer SHOULD do so.
If the Notification Recipient wishes to terminate the Get-
Notifications operation, it can close the connection. See section 12
for the encoding and transport rules for the Get-Notifications
Response for the Event Wait Mode.
The Printer MUST accept the request in any state (see [RFC2911] The Printer MUST accept the request in any state (see [RFC2911]
"printer-state" and "printer-state-reasons" attributes) and MUST "printer-state" and "printer-state-reasons" attributes) and MUST
remain in the same state with the same "printer-state-reasons" remain in the same state with the same "printer-state-reasons"
values. values.
Access Rights: If the policy of the Printer is to allow all users to Access Rights: If the policy of the Printer is to allow all users to
access all Event Notifications, then the Printer MUST accept this access all Event Notifications, then the Printer MUST accept this
operation from any user. Otherwise, the authenticated user (see operation from any user. Otherwise, the authenticated user (see
[RFC2911] section 8.3) performing this operation MUST either be the [RFC2911] section 8.3) performing this operation MUST either be the
skipping to change at page 10, line 24 skipping to change at page 11, line 31
attributes as described in [RFC2911] section 3.1.4.1. attributes as described in [RFC2911] section 3.1.4.1.
Target: Target:
The "printer-uri" (uri) operation attribute which is the target The "printer-uri" (uri) operation attribute which is the target
for this operation as described in [RFC2911] section 3.1.5. for this operation as described in [RFC2911] section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" (name(MAX)) attribute SHOULD be The "requesting-user-name" (name(MAX)) attribute SHOULD be
supplied by the client as described in [RFC2911] section 8.3. supplied by the client as described in [RFC2911] section 8.3.
"notify-recipient-uri" (url): "notify-subscription-id" (integer(1:MAX)):
The client MUST supply this attribute. The Printer object MUST The client SHOULD supply this attribute, if known, and the
support this attribute. The Printer matches the value of this client is only monitoring a single Subscription object. The
attribute (byte for byte with no case conversion) against the Printer object MUST support this attribute. If supplied, but
value of the "notify-recipient-uri" in each Subscription Object no Subscription Object exists with this identifier, the Printer
in the Printer. If there are no matches, the IPP Printer MUST MUST return the 'client-error-not-found' status code.
return the 'client-error-not-found' status code. For each
matched Subscription Object, the IPP Printer MUST return all If supplied and the identified Subscription Object exists, the
unexpired Event Notifications associated with it. The Printer Printer MUST check that the Subscription Object's "notify-
MUST send additional Event Notifications as Events occur if and recipients-uri" attribute scheme is 'ippget' (case insensitive-
only if the value of the "notify-no-wait" attribute is 'false' match - see section 11.5.2). If the scheme does not match
or not supplied by the client (see the next attribute below). 'ippget', the Printer MUST reject the request and return the
'client-error-uri-scheme-not-supported' status code.
Note: If Notification Recipients supplies this attribute, if
known, then the Event Notifications will be sent in time stamp
order since only one Subscription object is involved (see
"Event Notification Ordering" requirements in [ipp-ntfy]
section 9). Supplying this attribute also reduces the Event
processing time on the Printer since the Printer doesn't have
to search all of the Subscription Objects in order to match the
"notify-recipient-uri" operation attribute (see next
attribute).
"notify-recipient-uri" (uri(255)):
The client MAY supply this attribute whether or not it also
supplies the "notify-subscription-id" operation attribute. The
Printer object MUST support this attribute. If the client
supplies neither the "notify-subscription-id" nor the "notify-
recipient-uri", the Printer MUST reject the request and return
the 'client-error-bad-request' status code.
If the supplied scheme is not ippget (case insensitive-match -
see section 11.5.2), the Printer MUST reject the request and
return the 'client-error-uri-scheme-not-supported' status code.
If the client also supplied the "notify-subscription-id"
attribute, then the value of this attribute MUST match the
"notify-recipient-uri" Subscription Description attribute for
the identified Subscription object. If they do not match, the
Printer MUST return the 'client-error-not-found' status code.
If the client did not supply the "notify-subscription-id"
operation attribute, the Printer matches the value of this
"notify-recipient-uri" attribute against the value of the
"notify-recipient-uri" Subscription Description attribute in
each Subscription Object in the Printer using the URI matching
rules specified in section 11.5.2. If there are no matches, the
IPP Printer MUST return the 'client-error-not-found' status
code.
The value of this attribute is defined to be shorter (255
octets) than the 'uri' attribute syntax (1023 octets) in
[RFC2911], since this uri is used for identification, not for
locating a network resource.
The [ipp-ntfy] specification REQUIRES that Subscription
Object's "notify-recipient-uri" attribute be returned in any
operation with the identical representation as supplied by the
original Subscribing Client in the Subscription Creation
Request. Therefore the Printer implementation MUST use other
means to perform the URI match than changing the Subscription
Object's original "notify-recipient-uri" value to a canonical
form.
Note: this attribute allows a subscribing client to pick URLs Note: this attribute allows a subscribing client to pick URLs
that are unique, e.g. the client's own URL or a friend's URL, that are unique, e.g. the client's own URL or a friend's URL,
which in both cases is likely the URL of the person's host. An which in both cases is likely the URL of the person's host. An
application could make a URL unique for each application. application could make a URL unique for each application.
"notify-no-wait" (boolean): "notify-wait" (boolean):
The client MAY supply this attribute. The Printer object MUST The client MAY supply this attribute. The Printer object MUST
support this attribute. If the value of this attribute is support both values of this attribute. If the value is 'true',
'false', the Printer MUST send all un-expired Event the client is requesting Event Wait Mode. See the beginning of
Notifications (as defined in the previous attribute) and it section 5 for the rules for Event Wait Mode.
MUST continue to send responses for as long as the Subscription
Objects associated with the specified "notify-recipient-uri"
continue to exist. If the value of this attribute is 'true',
the Printer MUST send all un-expired Event Notifications (as
defined in the previous attribute) and the Printer MUST
conclude the operation without waiting for any additional
Events to occur. If the client doesn't supply this attribute,
the Printer MUST behave as if the client had supplied this
attribute with the value of 'false'.
5.2 Get-Notifications Response 5.2 Get-Notifications Response
The following groups of attributes are part of the Get-Notifications The following groups of attributes are part of the Get-Notifications
Response: Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
In addition to the REQUIRED status code returned in every In addition to the REQUIRED status code returned in every
response, the response OPTIONALLY includes a "status-message" response, the response OPTIONALLY includes a "status-message"
(text(255)) and/or a "detailed-status-message" (text(MAX)) (text(255)) and/or a "detailed-status-message" (text(MAX))
operation attribute as described in [RFC2911] sections 13 and operation attribute as described in [RFC2911] sections 13 and
3.1.6. 3.1.6.
The Printer can return any status codes defined in [RFC2911]. The Printer can return any status codes defined in [RFC2911].
If the status code is not 'successful-', the Printer MUST NOT If the status code is not 'successful-xxx', the Printer MUST
return any Event Notification Attribute groups. The following NOT return any Event Notification Attribute groups. The
is a description of the important status codes: following is a description of the important status codes:
successful-ok: the response contains all Event Notification successful-ok: the response contains all Event Notification
associated with the specified "notify-recipient-uri". If associated with the specified "notify-recipient-uri". If
the specified Subscription Objects have no associated the specified Subscription Objects have no associated
Event Notification, the response MUST contain zero Event Event Notification, the response MUST contain zero Event
Notifications. Notifications.
client-error-not-found: The Printer has no Subscription client-error-not-found: The Printer has no Subscription
Object's whose "notify-recipient-uri" attribute equals Object's whose "notify-recipient-uri" attribute equals
the "notify-recipient-uri" Operation attribute. the "notify-recipient-uri" Operation attribute, if
supplied or whose "notify-subscription-id" attribute
equals the "notify-subscription-id" Operation attribute,
if supplied.
server-error-busy: The Printer is too busy to accept this server-error-busy: The Printer is too busy to accept this
operation. If the "suggested-ask-again-time-interval" operation. If the "notify-get-interval" operation
operation attribute is present in the Operation attribute is present in the Operation Attributes of the
Attributes of the response, then the Notification response, then the Notification Recipient SHOULD wait for
Recipient SHOULD wait for the number of seconds specified the number of seconds specified by the "notify-get-
by the "suggested-ask-again-time-interval" attribute interval" attribute before performing this operation
before performing this operation again. If the again. If the "notify-get-interval" Operation Attribute
"suggested-ask-again-time-interval" Operation Attribute is not present, the Notification Recipient SHOULD use the
is not present, the Notification Recipient should use the
normal network back-off algorithms for determining when normal network back-off algorithms for determining when
to perform this operation again. to perform this operation again.
redirection-other-site: The Printer does not handle this redirection-other-site: The Printer does not handle this
operation and requests the Notification Recipient to operation and requests the Notification Recipient to
perform the operation with the uri specified by the perform the operation again with the uri specified by the
"notify-ippget-redirect" Operation Attribute in the "redirect-uri" Operation Attribute in the response.
response.
Natural Language and Character Set: Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language" The "attributes-charset" and "attributes-natural-language"
attributes as described in [RFC2911] section 3.1.4.2. attributes as described in [RFC2911] section 3.1.4.2.
The Printer MUST use the values of "notify-charset" and The Printer MUST use the values of "notify-charset" and
"notify-natural-language", respectively, from one Subscription "notify-natural-language", respectively, from one Subscription
Object associated with the Event Notifications in this Object associated with the Event Notifications in this
response. response.
skipping to change at page 12, line 22 skipping to change at page 14, line 32
attributes is the same in all Subscription Objects. If not, the attributes is the same in all Subscription Objects. If not, the
Printer MUST pick one Subscription Object from which to obtain Printer MUST pick one Subscription Object from which to obtain
the value of these attributes. The algorithm for picking the the value of these attributes. The algorithm for picking the
Subscription Object is implementation dependent. The choice of Subscription Object is implementation dependent. The choice of
natural language is not critical because 'text' and 'name' natural language is not critical because 'text' and 'name'
values can override the "attributes-natural-language" Operation values can override the "attributes-natural-language" Operation
attribute. The Printer's choice of charset is critical because attribute. The Printer's choice of charset is critical because
a bad choice may leave it unable to send some 'text' and 'name' a bad choice may leave it unable to send some 'text' and 'name'
values accurately. values accurately.
"printer-up-time" (integer(0:MAX)): "printer-up-time" (integer(1:MAX)):
The value of this attribute is the Printer's "printer-up-time" The value of this attribute is the Printer's "printer-up-time"
attribute at the time the Printer sends this response. Because attribute at the time the Printer sends this response. Because
each Event Notification also contains the value of this each Event Notification also contains the value of this
attribute when the event occurred, the value of this attribute attribute when the event occurred, the value of this attribute
lets a Notification Recipient know when each Event Notification lets a Notification Recipient know when each Event Notification
occurred relative to the time of this response. occurred relative to the time of this response.
"suggested-ask-again-time-interval" (integer(0:MAX)): "redirect-uri" (uri):
The value of this attribute is the number of seconds that the The value of this attribute is the uri that the Notification
Notification Recipient SHOULD wait before trying this operation Recipient MUST use for a subsequent Get-Notifications
again when operation. This attribute is returned in the Operation
a) the Printer returns the 'server-error-busy' status code Attributes Group if and only if the status code has the value
OR 'redirection-other-site'.
b) the Printer returns the 'successful-ok' status code and
the client supplied the "notify-no-wait" attribute with a
value of 'true'.
This value is intended to help the client be a good network
citizen.
"notify-ippget-redirect" (uri):
The value of this attribute is uri that the Notification
Recipient MUST use for the Get-Notifications operation. This
attribute is present in the Operation Attributes if and only if
the status code has the value 'redirection-other-site'.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See [RFC2911] section 3.1.7 for details on returning See [RFC2911] section 3.1.7 for details on returning
Unsupported Attributes. Unsupported Attributes.
If the "subscription-ids" attribute contained subscription-ids
that do not exist, the Printer returns them in this group as
value of the "subscription-ids" attribute.
Group 3 through N: Event Notification Attributes Group 3 through N: Event Notification Attributes
The Printer responds with one Event Notification Attributes The Printer responds with one Event Notification Attributes
Group per matched Event Notification. The initial matched Event Group per matched Event Notification. The entire response is
Notifications are all un-expired Event Notification associated considered a single Compound Event Notification (see [ipp-
with the matched Subscription Objects. If the Notification ntfy]). The last Event Notification Attributes Group MAY
Recipient has selected the option to wait for additional Event contain a single "notify-get-interval" (see section 7.1 and
Notifications, the Printer the subsequent Event Notifications 12), in which case the Printer will return no future responses.
in the response are Event Notifications associated with the The initial matched Event Notifications are all un-expired
matched Subscription Objects as the corresponding Event occurs. Event Notification associated with the matched Subscription
Objects and MUST follow the "Event Notification Ordering"
requirements for Event Notifications within a Compound Event
Notification specified in [ipp-ntfy] section 9.
If the Notification Recipient has selected the Event Wait Mode
option to wait for additional Event Notifications (the "notify-
wait" attribute was set to 'true'), the Printer sends
subsequent Event Notifications in the response each time it
processes additional Events. Each time the Printer sends such
Event Notifications, their ordering MUST follow the "Event
Notification Ordering" requirements in [ipp-ntfy] section 9.
Note: If a Notification Recipient performs two consecutive Get-
Notifications operations, the time stamp of the first Event
Notification in the second Get-Notifications Response may be
less than the time stamp of the last Event Notification in the
first Get-Notification Response. This happens because the
Printer sends all unexpired Event Notification according to the
ordering specified in [ipp-ntfy] and some Event Notifications
from the first Get-Notifications operation may not have expired
by the time the second Get-Notifications operation occurs.
From the Notification Recipient's view, the response appears as From the Notification Recipient's view, the response appears as
an initial burst of data, which includes the Operation an initial burst of data, which includes the Operation
Attributes Group and one Event Notification Attributes Groups Attributes Group and one Event Notification Attributes Group
per Event Notification that the Printer is holding. After the per Event Notification that the Printer is holding. After the
initial burst of data, if the Notification Recipient has initial burst of data, if the Notification Recipient has
selected the option to wait for additional Event Notifications, selected the Event Wait Mode option to wait for additional
the Notification Recipient receives occasional Event Event Notifications, the Notification Recipient receives
Notification Attribute Groups. Proxy servers may delay some occasional Event Notification Attribute Groups. Proxy servers
Event Notifications or cause time-outs to occur. The client may delay some Event Notifications or cause time-outs to occur.
MUST be prepared to perform the Get-Notifications operation The client MUST be prepared to perform the Get-Notifications
again when time-outs occur. operation again when time-outs occur.
Each Event Notification Group MUST start with an 'event-
notification-attributes-tag' (see the section "Encodings of
Additional Attribute Tags" in [ipp-ntfy]).
Each attribute is encoded using the IPP rules for encoding Each attribute is encoded using the IPP rules for encoding
attributes [RFC2910] and may be encoded in any order. Note: attributes [RFC2910] and MAY be encoded in any order. Note:
the Get-Jobs response in [RFC2911] acts as a model for encoding the Get-Jobs response in [RFC2911] acts as a model for encoding
multiple groups of attributes. multiple groups of attributes. See section 12 for the encoding
and transport rules.
Each Event Notification Group MUST contain all of attributes Each Event Notification Group MUST contain all of attributes
specified in section 9.1 ("Content of Machine Consumable Event specified in section 9.1 ("Content of Machine Consumable Event
Notifications") of [ipp-ntfy] with exceptions denoted by Notifications") of [ipp-ntfy] with exceptions denoted by
asterisks in the tables below. asterisks in the tables below.
The tables below are copies of the tables in section 9.1 The tables below are copies of the tables in section 9.1
("Content of Machine Consumable Event Notifications") of [ipp- ("Content of Machine Consumable Event Notifications") of [ipp-
ntfy] except that each cell in the "Sends" column is a "MUST". ntfy] except that each cell in the "Sends" column is a "MUST".
For an Event Notification for all Events, the Printer includes For an Event Notification for all Events, the Printer includes
the attributes shown in Table 2. the attributes shown in Table 2.
Table 2 - Attributes in Event Notification Content Table 2 " Attributes in Event Notification Content
Source Value Sends Source Object Source Value Sends Source Object
notify-subscription-id (integer(1:MAX)) MUST Subscription notify-subscription-id (integer(1:MAX)) MUST Subscription
notify-printer-uri (uri) MUST Subscription notify-printer-uri (uri) MUST Subscription
notify-subscribed-event (type2 keyword) MUST Event notify-subscribed-event (type2 keyword) MUST Event
Notification Notification
printer-up-time (integer(1:MAX)) MUST Printer
printer-up-time (integer(MIN:MAX)) MUST Printer
printer-current-time (dateTime) MUST * Printer printer-current-time (dateTime) MUST * Printer
notify-sequence-number (integer (0:MAX)) MUST Subscription notify-sequence-number (integer (0:MAX)) MUST Subscription
notify-charset (charset) MUST Subscription notify-charset (charset) MUST Subscription
notify-natural-language (naturalLanguage) MUST Subscription notify-natural-language (naturalLanguage) MUST Subscription
notify-user-data (octetString(63)) MUST ** Subscription notify-user-data (octetString(63)) MUST ** Subscription
notify-text (text) MUST Event notify-text (text) MUST Event
Notification Notification
attributes from the "notify-attributes" MUST *** Printer attributes from the "notify-attributes" MUST *** Printer
attribute attribute
attributes from the "notify-attributes" MUST *** Job attributes from the "notify-attributes" MUST *** Job
attribute attribute
attributes from the "notify-attributes" MUST *** Subscription attributes from the "notify-attributes" MUST *** Subscription
attribute attribute
* The Printer MUST send the "printer-current-time" attribute if * The Printer MUST send the "printer-current-time" attribute if
and only if it supports the "printer-current-time" attribute on and only if it supports the "printer-current-time" attribute on
the Printer object. the Printer object.
** If the associated Subscription Object does not contain a ** If the associated Subscription Object does not contain a
"notify-user-data" attribute, the Printer MUST send an octet- "notify-user-data" attribute, the Printer MUST send an octet-
string of length 0. string of length 0.
skipping to change at page 15, line 10 skipping to change at page 17, line 14
*** If the "notify-attributes" attribute is present on the *** If the "notify-attributes" attribute is present on the
Subscription Object, the Printer MUST send all attributes Subscription Object, the Printer MUST send all attributes
specified by the "notify-attributes" attribute. Note: if the specified by the "notify-attributes" attribute. Note: if the
Printer doesn't support the "notify-attributes" attribute, it Printer doesn't support the "notify-attributes" attribute, it
is not present on the associated Subscription Object. is not present on the associated Subscription Object.
For Event Notifications for Job Events, the Printer includes For Event Notifications for Job Events, the Printer includes
the additional attributes shown in Table 3. the additional attributes shown in Table 3.
Table 3 - Additional Attributes in Event Notification Content for Table 3 " Additional Attributes in Event Notification Content for
Job Events Job Events
Source Value Sends Source Source Value Sends Source
Object Object
job-id (integer(1:MAX)) MUST Job job-id (integer(1:MAX)) MUST Job
job-state (type1 enum) MUST Job job-state (type1 enum) MUST Job
job-state-reasons (1setOf type2 keyword) MUST Job job-state-reasons (1setOf type2 keyword) MUST Job
job-impressions-completed (integer(0:MAX)) MUST * Job job-impressions-completed (integer(0:MAX)) MUST * Job
* The Printer MUST send the "job-impressions-completed" * The Printer MUST send the "job-impressions-completed"
attribute in an Event Notification only for the combinations of attribute in an Event Notification only for the combinations of
Events and Subscribed Events shown in Table 4. Events and Subscribed Events shown in Table 4.
Table 4 - Combinations of Events and Subscribed Events for "job- Table 4 " Combinations of Events and Subscribed Events for "job-
impressions-completed" impressions-completed"
Job Event Subscribed Job Event Job Event Subscribed Job Event
'job-progress' 'job-progress' 'job-progress' 'job-progress'
'job-completed' 'job-completed' 'job-completed' 'job-completed'
'job-completed' 'job-state-changed' 'job-completed' 'job-state-changed'
For Event Notification for Printer Events, the Printer includes For Event Notification for Printer Events, the Printer includes
the additional attributes shown in Table 5. the additional attributes shown in Table 5.
Table 5 - Additional Attributes in Event Notification Content for Table 5 " Additional Attributes in Event Notification Content for
Printer Events Printer Events
Source Value Sends Source Source Value Sends Source
Object Object
printer-state (type1 enum) MUST Printer printer-state (type1 enum) MUST Printer
printer-state-reasons (1setOf type2 keyword) MUST Printer printer-state-reasons (1setOf type2 keyword) MUST Printer
printer-is-accepting-jobs (boolean) MUST Printer printer-is-accepting-jobs (boolean) MUST Printer
6 Subscription Template Attributes 6 Subscription Template Attributes
This section defines the Subscription object conformance requirements This section defines the Subscription object conformance requirements
for Printers. for Printers.
6.1 Subscription Template Attribute Conformance 6.1 Subscription Template Attribute Conformance
The 'ippget' Delivery Method has the same conformance requirements The 'ippget' Delivery Method has the same conformance requirements
skipping to change at page 17, line 4 skipping to change at page 18, line 46
attribute for other Delivery Method is defined in other Delivery attribute for other Delivery Method is defined in other Delivery
Method Documents. Method Documents.
In order to support the 'ippget' Delivery Method and Protocol, the In order to support the 'ippget' Delivery Method and Protocol, the
Printer MUST support the following syntax: Printer MUST support the following syntax:
The 'ippget://' URI scheme. The remainder of the URI indicates The 'ippget://' URI scheme. The remainder of the URI indicates
something unique about the Notification Recipient, such as its host something unique about the Notification Recipient, such as its host
name or host address (and optional path) that the Printer uses to name or host address (and optional path) that the Printer uses to
match the "notify-recipient-uri" Operation attribute supplied in match the "notify-recipient-uri" Operation attribute supplied in
the Get-Notifications request. See section 9 for a complete the Get-Notifications request. See section 11 for a complete
definition of the syntax of the IPPGET URL. definition of the syntax of the IPPGET URL.
6.3 Subscription Description Attribute Conformance 6.3 Subscription Description Attribute Conformance
The 'ippget' Delivery Method has the same conformance requirements The 'ippget' Delivery Method has the same conformance requirements
for Subscription Description attributes as defined in [ipp-ntfy]. for Subscription Description attributes as defined in [ipp-ntfy].
The 'ippget' Delivery Method does not define any addition The 'ippget' Delivery Method does not define any addition
Subscription Description attributes. Subscription Description attributes.
7 Additional Printer Description Attributes 7 Attributes only in Event Notifications
This section defines the Printer Description Attributes conformance
requirements for Printers.
7.1 Printer Description Attribute Conformance
The 'ippget' Delivery Method has the same conformance requirements
for Printer Description attributes as defined in [ipp-ntfy]. The
'ippget' Delivery Method does not define any addition Printer
Description attributes.
7.2 New Values for Existing Printer Description Attributes
This section defines additional values for existing Printer This section defines attributes that exist only in Event
Description attributes. Notifications and do no exist in any IPP-defined objects.
7.2.1 notify-schemes-supported (1setOf uriScheme) 7.1 "notify-get-interval" (integer(0:MAX))
The following value for the "notify-schemes-supported" attribute is The Printer returns this attribute to give the client an indication
added in order to support the new Delivery Method defined in this of when to try another Get-Notifications request in the future. The
document: value of this attribute is the number of seconds that the
Notification Recipient SHOULD wait before trying the Get-
Notifications operation again. This value is intended to help the
client be a good network citizen.
'ippget' - The IPP Notification Delivery Method defined in this The Printer MUST return this attribute by itself in a separate Event
document. Notification Attributes Group. The Printer MUST return this
attribute if and only if:
7.2.2 operations-supported (1setOf type2 enum) 1. Printer busy case: the Printer returns the 'server-error-busy'
status code OR
Table 6 lists the "operation-id" value defined in order to support 2. No wait case: the Printer returns the 'successful-ok' status
the new Get-Notifications operation defined in this document. code and the client either (1) supplied the "notify-wait"
attribute with a value of 'false' or (2) omitted the attribute
entirely OR
Table 6 - Operation-id assignments 3. Printer leaves Event Wait Mode: the Printer returns the
'successful-ok' status code and the client supplied the "notify-
wait" attribute with the 'true value (Event Wait Mode) but the
Printer wants the client to disconnect (no wait), instead of
staying connected. The client MUST accept this response and
MUST disconnect. If the client does not disconnect, the Printer
SHOULD do so. The Printer returns this attribute for this case
only if the implementation does not want to keep the connection
open at this time. If the Printer wants the client to keep the
connection open and remain in Event Wait Mode, then the Printer
MUST NOT return this attribute in the response.
Value Operation Name 8 Additional Printer Description Attributes
0x001C Get-Notifications This section defines additional Printer Description attributes for
use with the 'ippget' Delivery Method.
7.3 begin-to-expire-time-interval (integer(0:MAX)) 8.1 ippget-event-time-to-live (integer(0:MAX))
This Printer Description attribute specifies the number of seconds This Printer Description attribute specifies the number of seconds
that a Printer keeps an Event Notification that is associated with that a Printer keeps an Event Notification that is associated with
the 'ippget' Delivery Method. the 'ippget' Delivery Method.
The Printer MUST support this attribute if it supports the 'ippget' The Printer MUST support this attribute if it supports the 'ippget'
Delivery Method. Delivery Method.
The value of this attribute is the minimum number of seconds that The value of this attribute is the minimum number of seconds that
MUST elapse between the time the Printer creates an Event MUST elapse between the time the Printer creates an Event
skipping to change at page 18, line 37 skipping to change at page 20, line 36
1.a client performs a Job Creation operation that creates a 1.a client performs a Job Creation operation that creates a
Subscription Object associated with this Delivery Method, AND Subscription Object associated with this Delivery Method, AND
2.an Event associated with the new Job occurs immediately after 2.an Event associated with the new Job occurs immediately after
the Subscription Object is created, AND the Subscription Object is created, AND
3.the same client or some other client performs a Get- 3.the same client or some other client performs a Get-
Notifications operation N seconds after the Job Creation Notifications operation N seconds after the Job Creation
operation. operation.
Then, if N is less than the value of this attribute, the client Then, if N is less than the value of this attribute, the client(s)
performing the Get-Notifications operations can expect not to miss performing the Get-Notifications operations can expect not to miss
any Event-Notifications, barring some unforeseen lack of memory space any Event-Notifications, barring some unforeseen lack of memory space
in the Printer. in the Printer.
8 New Status Codes The value of this attribute also specifies the minimum number of
seconds that the Printer, if supporting the ippget Delivery Method,
MUST keep 'completed', 'canceled', or 'aborted' Job objects in the
Job Retention and/or Job History phases. See [RFC2911] section
4.3.7.1 and the discussion in [ipp-ntfy] 'job-completed' event) that
explains that a Notification Recipients can query the Job after
receiving a 'job-completed' Event Notification in order to find out
other information about the job that is completing. However, this
attribute has no effect on the Cancel-Subscription operation which
deletes the object immediately, whether or not it contain the ippget
scheme. Immediately thereafter, subsequent Get-Notifications
Responses MUST NOT contain Event Notifications associated with the
cancelled Subscription object.
9 New Values for Existing Printer Description Attributes
This section defines additional values for existing Printer
Description attributes define in [ipp-ntfy].
9.1 notify-schemes-supported (1setOf uriScheme)
The following value for the "notify-schemes-supported" attribute is
added in order to support the new Delivery Method defined in this
document:
'ippget' - The IPP Notification Delivery Method defined in this
document.
9.2 operations-supported (1setOf type2 enum)
Table 6 lists the "operation-id" value defined in order to support
the new Get-Notifications operation defined in this document.
Table 6 " Operation-id assignments
Value Operation Name
0x001C Get-Notifications
10 New Status Codes
The following status codes are defined as extensions for this The following status codes are defined as extensions for this
Delivery Method and are returned as the status code of the Get- Delivery Method and are returned as the status code of the Get-
Notifications operation. Notifications operation.
8.1 redirection-other-site (0x300) 10.1 redirection-other-site (0x0300)
This status code means that the Printer doesn't perform that Get- This status code means that the Printer doesn't perform that Get-
Notifications operation and that the "notify-ippget-redirect" Notifications operation and that the "redirect-uri" Operation
Operation Attribute in the response contains the uri that the Attribute in the response contains the uri that the Notification
Notification Recipient MUST use for performing the Get-Notifications Recipient MUST use for performing the Get-Notifications operation.
operation.
9 The IPPGET URL Scheme 11 The IPPGET URL Scheme
This section defines the 'ippget' URL and the conformance This section defines the 'ippget' URL and the conformance
requirements for using it. requirements for using it.
9.1 The IPPGET URL Scheme Applicability and Intended Usage 11.1 The IPPGET URL Scheme Applicability and Intended Usage
This section is intended for use in registering the 'ippget' URL This section is intended for use in registering the 'ippget' URL
scheme with IANA and fully conforms to the requirements in [RFC2717]. scheme with IANA and fully conforms to the requirements in [RFC2717].
This document defines the 'ippget'" URL (Uniform Resource Locator) This document defines the 'ippget'" URL (Uniform Resource Locator)
scheme for specifying a unique identifier for an IPP Client which scheme for specifying a unique identifier for an IPP Client which
implements the IPP Get-Notifications operation specified in this implements the IPP Get-Notifications operation specified in this
document (see section 5). document (see section 5).
The intended usage of the 'ippget' URL scheme is COMMON. The intended usage of the 'ippget' URL scheme is COMMON.
9.2 The IPPGET URL Scheme Associated Port 11.2 The IPPGET URL Scheme Associated Port
None. None.
An 'ippget' URL behaves as a unique identifier for IPP Clients and is An 'ippget' URL behaves as a unique identifier for IPP Clients and is
NOT used to initiate any over-the-wire protocol associations. NOT used to initiate any over-the-wire protocol associations.
See: IANA Port Numbers Registry [IANA-PORTREG]. See: IANA Port Numbers Registry [IANA-PORTREG].
9.3 The IPPGET URL Scheme Associated MIME Type 11.3 The IPPGET URL Scheme Associated MIME Type
All IPP Get-Notifications operations (requests and responses) MUST be All IPP Get-Notifications operations (requests and responses) MUST be
conveyed in an 'application/ipp' MIME media type as registered in conveyed in an 'application/ipp' MIME media type as registered in
[IANA-MIMEREG]. An 'ippget' URL MUST uniquely identify an IPP Client [IANA-MIMEREG]. An 'ippget' URL MUST uniquely identify an IPP Client
that support this 'application/ipp' MIME media type. that support this 'application/ipp' MIME media type.
See: IANA MIME Media Types Registry [IANA-MIMEREG]. See: IANA MIME Media Types Registry [IANA-MIMEREG].
9.4 The IPPGET URL Scheme Character Encoding 11.4 The IPPGET URL Scheme Character Encoding
The 'ippget' URL scheme defined in this document is based on the ABNF The 'ippget' URL scheme defined in this document is based on the ABNF
for the URI Generic Syntax [RFC2396] and further updated by [RFC2732] for the URI Generic Syntax [RFC2396] and further updated by [RFC2732]
and [RFC2373] (for IPv6 addresses in URLs). The 'ippget' URL scheme and [RFC2373] (for IPv6 addresses in URLs). The 'ippget' URL scheme
is case-insensitive in the scheme and 'authority' part; however, the is case-insensitive in the scheme and 'authority' part; however, the
'abs_path' part is case-sensitive, as in [RFC2396]. Code points 'abs_path' part is case-sensitive, as in [RFC2396]. Code points
outside [US-ASCII] MUST be hex escaped by the mechanism specified in outside [US-ASCII] MUST be hex escaped by the mechanism specified in
[RFC2396]. [RFC2396].
9.5 The IPPGET URL Scheme Syntax in ABNF 11.5 The IPPGET URL Scheme Syntax in ABNF
This document is intended for use in registering the 'ippget' URL This document is intended for use in registering the 'ippget' URL
scheme with IANA and fully conforms to the requirements in [RFC2717]. scheme with IANA and fully conforms to the requirements in [RFC2717].
This document defines the 'ippget' URL (Uniform Resource Locator) This document defines the 'ippget' URL (Uniform Resource Locator)
scheme for specifying a unique identifier for an IPP Client which scheme for specifying a unique identifier for an IPP Client which
implements IPP 'Get-Notifications' operation specified in this implements IPP 'Get-Notifications' operation specified in this
document. document.
The intended usage of the 'ippget' URL scheme is COMMON. The intended usage of the 'ippget' URL scheme is COMMON.
skipping to change at page 21, line 15 skipping to change at page 24, line 8
abs_path = "/" path_segments abs_path = "/" path_segments
If the port is empty or not given, then no port is assumed. The If the port is empty or not given, then no port is assumed. The
semantics are that the 'ippget' URL is a unique identifier for an IPP semantics are that the 'ippget' URL is a unique identifier for an IPP
Client that will retrieve IPP event notifications via the IPP Get- Client that will retrieve IPP event notifications via the IPP Get-
Notifications operation. Notifications operation.
Note: The use of IP addresses in URLs SHOULD be avoided whenever Note: The use of IP addresses in URLs SHOULD be avoided whenever
possible (see [RFC1900]). possible (see [RFC1900]).
9.5.1 IPPGET URL Examples 11.5.1 IPPGET URL Examples
The following are examples of valid 'ippget' URLs for IPP Clients The following are examples of valid 'ippget' URLs for IPP Clients
(using DNS host names): (using DNS host names):
ippget://abc.com ippget://abc.com
ippget://abc.com/listener ippget://abc.com/listener
ippget://bob@abc.com/listener/1232 ippget://bob@abc.com/listener/1232
Note: The use of IP addresses in URLs SHOULD be avoided whenever Note: The use of IP addresses in URLs SHOULD be avoided whenever
possible (see [RFC1900]). possible (see [RFC1900]).
skipping to change at page 22, line 5 skipping to change at page 24, line 41
'hostport' of the client. 'hostport' of the client.
On the other hand, if a given IPP Client creates an IPP Subscription On the other hand, if a given IPP Client creates an IPP Subscription
object for event notifications intended for retrieval by a different object for event notifications intended for retrieval by a different
IPP Client, then the 'userinfo@hostport' production (using, for IPP Client, then the 'userinfo@hostport' production (using, for
example, the right-hand side of a 'mailto:' URL, see [RFC2368]) may example, the right-hand side of a 'mailto:' URL, see [RFC2368]) may
be most appropriate. For this case, a mail address serves as the be most appropriate. For this case, a mail address serves as the
prior agreement on the IPPGET URL value between the IPP Client and prior agreement on the IPPGET URL value between the IPP Client and
the Notification Recipient. the Notification Recipient.
9.5.2 IPPGET URL Comparisons 11.5.2 IPPGET URL Comparisons
When comparing two 'ippget' URLs to decide if they match or not, When comparing two 'ippget' URLs to decide if they match or not,
an IPP Client or IPP Printer MUST use the same rules as those an IPP Client or IPP Printer MUST use the same rules as those
defined for HTTP URI comparisons in [RFC2616]. defined for HTTP URI comparisons in [RFC2616].
10 Encoding 12 Encoding and Transport
This section defines the encoding and transport considerations for
this Delivery Method based on [RFC2910].
The encoding of a Get-Notifications Response is modeled the Get-Jobs
Response (see [RFC2911]). In a Get-Notifications Response, each
Event Notification Attributes Group MUST start with an 'event-
notification-attributes-tag' (see the section "Encodings of
Additional Attribute Tags" in [ipp-ntfy]), but only the last group
ends with an 'end-of-attributes-tag'. In addition, for Event Wait
Mode the multi-part/related is used to separate each multiple
response (in time) to a single Get-Notifications Request.
The Printer returns Get-Notification Response as follows:
1. If the Notification Recipient client did not request Event Wait
Mode ("notify-wait" = 'false' or omitted), the Printer ends the
response with an 'end-of-attributes-tag' (see [RFC2911] Get-Jobs
encoding) as with any operation response. The Notification
Recipient is expected to close the connection.
2. If the Notification Recipient client requests Event Wait Mode
("notify-wait" = 'true') and the Printer wishes to honor the
request, the Printer ends the Response without an 'end-of-
attributes-tag' and MUST return the response as an
application/ipp part inside a multi-part/related MIME media
type. Neither the Notification Recipient nor the Printer close
the connection. When one or more additional Events occur, the
Printer returns each as an additional Event Notification Group
using a separate application/ipp part under the multi-
part/related type.
3. If the client requested Event Wait Mode ("notify-wait" =
'true'), but the Printer does not wish to honor the request in
the initial response but wants the client to disconnect, the
Printer MUST return the "notify-get-interval" attribute (see
section 7.1) as the last Event Notifications Attributes Group -
see section 5.2), the Printer ends the Response with an 'end-of-
attributes-tag'. The Printer returns the response as an
application/ipp part which MAY be inside an multi-part/related
type. The client MUST accept this response and MUST disconnect.
If the client does not disconnect, the Printer SHOULD do so.
4. If the client requested Event Wait Mode ("notify-wait" =
'true'), and the Printer initially honored the request, but
later wishes to leave Event Wait Mode, the Printer MUST return
the "notify-get-interval" attribute (see section 7.1) as the
last Event Notifications Attributes Group - see section 5.2),
the Printer ends the Response with an 'end-of-attributes-tag'.
The Printer returns the response as an application/ipp part
which MUST be inside an multi-part/related type.
ISSUE: Should we use application/multiplexed (draft-herriot-
application-multiplexed-03.txt) which can chunk mime types using
content lengths, instead of multi-part/related, which uses boundary
strings?
Note: either the Notification Recipient or the Printer can abnormally
terminate by closing the connection. However, if the Printer closes
the connection too soon after returning the response, the client may
not receive the response.
The Printer MAY chunk the responses, but this has no significance to
the IPP semantics.
This notification delivery method uses the IPP transport and encoding This notification delivery method uses the IPP transport and encoding
[RFC2910] for the Get-Notifications operation with one extension [RFC2910] for the Get-Notifications operation with one extension
allocated in [ipp-ntfy]: allocated in [ipp-ntfy]:
Table 7 - The "event-notification-attributes-tag" value Table 7 " The "event-notification-attributes-tag" value
Tag Value (Hex) Meaning Tag Value (Hex) Meaning
0x07 "event-notification-attributes-tag" 0x07 "event-notification-attributes-tag"
11 Conformance Requirements 13 Conformance Requirements
11.1 Conformance for IPP Printers The 'ippget' Delivery Method is RECOMMEND for Printers to support.
13.1 Conformance for IPP Printers
IPP Printers that conform to this specification: IPP Printers that conform to this specification:
1. MUST meet the conformance requirements defined in [ipp-ntfy]; 1. MUST meet the conformance requirements defined in [ipp-ntfy];
2. MUST support the Get-Notifications operation defined in section 2. MUST support the Get-Notifications operation defined in section
5; 5;
3. MUST support the Subscription object attributes as defined in 3. MUST support the Subscription object attributes as defined in
section 6; section 6;
skipping to change at page 22, line 36 skipping to change at page 27, line 4
IPP Printers that conform to this specification: IPP Printers that conform to this specification:
1. MUST meet the conformance requirements defined in [ipp-ntfy]; 1. MUST meet the conformance requirements defined in [ipp-ntfy];
2. MUST support the Get-Notifications operation defined in section 2. MUST support the Get-Notifications operation defined in section
5; 5;
3. MUST support the Subscription object attributes as defined in 3. MUST support the Subscription object attributes as defined in
section 6; section 6;
4. MUST support the additional values for IPP/1.1 Printer 4. MUST support the additional values for IPP/1.1 Printer
Description attributes defined in section 7.2; Description attributes defined in section 9;
5. MUST support the "begin-to-expire-time-interval" Printer #@# next line is > 72 characters: 73
Description attribute defined in section 7.3; 5. MUST support the "ippget-event-time-to-live" Printer Description
attribute defined in section 8.1;
6. MUST support the "redirection-other-site" status code defined 6. MUST support the "redirection-other-site" status code defined
8.1; 10.1, if it redirects Get-Notifications operations;
7. SHOULD reject received 'ippget' URLs in 'application/ipp' 7. SHOULD reject received 'ippget' URLs in 'application/ipp'
request bodies (e.g., in the "notify-recipient-uri" attribute in request bodies (e.g., in the "notify-recipient-uri" attribute in
a Get-Notifications request) that do not conform to the ABNF for a Get-Notifications request) that do not conform to the ABNF for
'ippget' URLs specified in section 9.5 of this document; 'ippget' URLs specified in section 11.5 of this document;
8. MUST listen for the IPP Get-Notifications operation requests on 8. MUST listen for the IPP Get-Notifications operation requests on
IANA-assigned well-known port 631, unless explicitly configured IANA-assigned well-known port 631, unless explicitly configured
by system administrators or site policies; by system administrators or site policies;
9. SHOULD NOT listen for IPP Get-Notifications operation requests 9. SHOULD NOT listen for IPP Get-Notifications operation requests
on any other port, unless explicitly configured by system on any other port, unless explicitly configured by system
administrators or site policies. administrators or site policies.
11.2 Conformance for IPP Clients 13.2 Conformance for IPP Clients
IPP Clients that conform to this specification: IPP Clients that conform to this specification:
1.MUST create unambiguously unique 'ippget' URLs in all cases; 1.MUST create unambiguously unique 'ippget' URLs in all cases;
2.MUST send 'ippget' URLs (e.g., in the "notify-recipient-uri" 2.MUST send 'ippget' URLs (e.g., in the "notify-recipient-uri"
attribute in a Get-Notifications request) that conform to the attribute in a Get-Notifications request) that conform to the
ABNF specified in section 9.5 of this document; ABNF specified in section 11.5 of this document;
3.MUST send IPP Get-Notifications operation requests via the port 3.MUST send IPP Get-Notifications operation requests via the port
specified in the associated 'ipp' URL (if present) or otherwise specified in the associated 'ipp' URL (if present) or otherwise
via IANA assigned well-known port 631; via IANA assigned well-known port 631;
4.MUST convert the associated 'ipp' URLs for use in IPP Get- 4.MUST convert the associated 'ipp' URLs for use in IPP Get-
Notifications operation to their corresponding 'http' URL forms Notifications operation to their corresponding 'http' URL forms
for use in the HTTP layer according to the rules in section 5 for use in the HTTP layer according to the rules in section 5
"IPP URL Scheme" in [RFC2910]. "IPP URL Scheme" in [RFC2910].
Note: The use of ambiguous 'ippget' URLs is NOT an optional feature Note: The use of ambiguous 'ippget' URLs is NOT an optional feature
for IPP Clients; it is a non-conformant implementation error. for IPP Clients; it is a non-conformant implementation error.
12 IANA Considerations 14 IANA Considerations
IANA is requested to register the 'ippget' URL scheme as defined in IANA shall register the 'ippget' URL scheme as defined in section 11
section 9 according to the procedures of [RFC2717]. according to the procedures of [RFC2717].
The rest of this section contains the exact information for The rest of this section contains the exact information for IANA to
additional IPP entities for IANA to add to the IPP Registries add to the IPP Registries according to the procedures defined in RFC
according to the procedures defined in RFC 2911 [RFC2911] section 6. 2911 [RFC2911] section 6.
Note to RFC Editors: Replace RFC NNNN below with the RFC number Note to RFC Editors: Replace RFC NNNN below with the RFC number
for this document, so that it accurately reflects the content of for this document, so that it accurately reflects the content of
the information for the IANA Registry. the information for the IANA Registry.
12.1 Operation Registrations 14.1 Operation Registrations
The operations defined in this document will be published by IANA
according to the procedures in RFC 2911 [RFC2911] section 6.4 with
the following path:
ftp.isi.edu/iana/assignments/ipp/operations/
The registry entry will contain the following information: The following table lists the operation defined in this document.
This is to be registered according to the procedures in RFC 2911
[RFC2911] section 6.4.
Operations: Ref. Section: Operations: Ref. Section:
Get-Notifications operation RFC NNNN 5 Get-Notifications operation RFC NNNN 5
12.2 Additional values of existing attributes The resulting operation registration will be published in the
ftp://ftp.iana.org/in-notes/iana/assignments/ipp/operations/
12.2.1 Additional values for the "notify-schemes-supported" Printer area.
attribute
The "notify-schemes-supported" 'uriScheme' attribute value defined in
this document will be published by IANA according to the procedures
in RFC 2911 [RFC2911] section 6.1 with the following path:
ftp.isi.edu/iana/assignments/ipp/attribute-values/notify-schemes-
supported/
The registry entry will contain the following information: 14.2 Additional attribute value registrations for existing attributes
Ref. Section: This section lists additional attribute value registrations for use
ippget RFC NNNN 7.2.1 with existing attributes defined in other documents.
12.2.2 Additional values for the "operations-supported" Printer 14.2.1 Additional values for the "notify-schemes-supported" Printer
attribute attribute
The "operations-supported" type2 enum attribute value defined in this The following table lists the uriScheme value defined in this
document will be published by IANA according to the procedures in RFC document as an additional uriScheme value for use with the "notify-
2911 [RFC2911] section 6.1 with the following path: schemes-supported" Printer attribute defined in [ipp-ntfy]. This
is to be registered according to the procedures in RFC 2911 [RFC2911]
section 6.1.
ftp.isi.edu/iana/assignments/ipp/attribute-values/operations- uriScheme Attribute Values: Ref. Section:
supported/ ippget RFC NNNN 9.1
The resulting URI scheme attribute value registrations will be
published in the
ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attribute-
values/notify-schemes-supported/
area.
The registry entry will contain the following information: 14.2.2 Additional values for the "operations-supported" Printer
attribute
Value Ref. Section: The following table lists the enum attribute value defined in this
Get-Notifications 0x001C RFC NNNN 7.2.2 document as an additional type2 enum value for use with the
"operations-supported" Printer attribute defined in [RFC2911]. This
is to be registered according to the procedures in RFC 2911 [RFC2911]
section 6.1.
12.3 Attribute Registrations type2 enum Attribute Values: Value Ref. Section:
Get-Notifications 0x001C RFC NNNN 9.2
The attributes defined in this document will be published by IANA The resulting enum attribute value registration will be published in
according to the procedures in RFC 2911 [RFC2911] section 6.2 with the
the following path: ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attribute-
values/operations-supported/
area.
ftp.isi.edu/iana/assignments/ipp/attributes/ 14.3 Attribute Registrations
The registry entry will contain the following information: The following table lists the attribute defined in this document.
This is to be registered according to the procedures in RFC 2911
[RFC2911] section 6.2.
Printer Description attributes: Ref. Section: Printer Description attributes: Ref. Section:
begin-to-expire-time-interval (integer(0:MAX)) RFC NNNN 7.3 ippget-event-time-to-live (integer(0:MAX)) RFC NNNN 8.1
12.4 Status code Registrations
The status codes defined in this document will be published by IANA The resulting attribute registration will be published in the
according to the procedures in RFC 2911 [RFC2911] section 6.6 with ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attributes/
the following path: area.
ftp.isi.edu/iana/assignments/ipp/status-codes/ 14.4 Status code Registrations
The registry entry will contain the following information: The following table lists the status code defined in this document.
This is to be registered according to the procedures in RFC 2911
[RFC2911] section 6.6.
Status codes: Ref. Section: Status codes: Ref. Section:
redirection-other-site (0x300) RFC NNNN 8.1 redirection-other-site (0x0300) RFC NNNN 10.1
The resulting status code registration will be published in the
ftp://ftp.iana.org/in-notes/iana/assignments/ipp/status-codes/
area.
13 Internationalization Considerations 15 Internationalization Considerations
The IPP Printer MUST localize the "notify-text" attribute as The IPP Printer MUST localize the "notify-text" attribute as
specified in section 14 of [ipp-ntfy]. specified in section 14 of [ipp-ntfy].
In addition, when the client receives the Get-Notifications response, In addition, when the client receives the Get-Notifications response,
it is expected to localize the attributes that have the 'keyword' it is expected to localize the attributes that have the 'keyword'
attribute syntax according to the charset and natural language attribute syntax according to the charset and natural language
requested in the Get-Notifications request. requested in the Get-Notifications request.
14 Security Considerations 16 Security Considerations
The IPP Model and Semantics document [RFC2911] discusses high-level The IPP Model and Semantics document [RFC2911] discusses high-level
security requirements (Client Authentication, Server Authentication security requirements (Client Authentication, Server Authentication
and Operation Privacy). Client Authentication is the mechanism by and Operation Privacy). Client Authentication is the mechanism by
which the client proves its identity to the server in a secure which the client proves its identity to the server in a secure
manner. Server Authentication is the mechanism by which the server manner. Server Authentication is the mechanism by which the server
proves its identity to the client in a secure manner. Operation proves its identity to the client in a secure manner. Operation
Privacy is defined as a mechanism for protecting operations from Privacy is defined as a mechanism for protecting operations from
eavesdropping. eavesdropping.
Unlike other Event Notification delivery methods in which the IPP Unlike other Event Notification delivery methods in which the IPP
Printer initiates the Event Notification, with the method defined in Printer initiates the Event Notification, with the method defined in
this document, the Notification Recipient is the client who s the this document, the Notification Recipient is the client who s the
Get-Notifications operation. Therefore, there is no chance of "spam" Get-Notifications operation. Therefore, there is no chance of "spam"
notifications with this method. Furthermore, such a client can close notifications with this method. Furthermore, such a client can close
down the HTTP channel at any time, and so can avoid future unwanted down the HTTP channel at any time, and so can avoid future unwanted
Event Notifications at any time. Event Notifications at any time.
15 References 17 References
[ipp-iig] [ipp-iig]
Hastings, T., Manros, C., Kugler, K, Holst H., Zehler, P., Hastings, T., Manros, C., Kugler, K, Holst H., Zehler, P.,
"Internet Printing Protocol/1.1: draft-ietf-ipp-implementers- "Internet Printing Protocol/1.1: draft-ietf-ipp-implementers-
guide-v11-02.txt, work in progress, January 25, 2001 guide-v11-03.txt, work in progress, July 17, 2001
[ipp-ntfy] [ipp-ntfy]
R. Herriot, Hastings, T., Isaacson, S., Martin, J., deBry, R., R. Herriot, Hastings, T., Isaacson, S., Martin, J., deBry, R.,
Shepherd, M., Bergman, R., "Internet Printing Protocol/1.1: IPP Shepherd, M., Bergman, R., "Internet Printing Protocol/1.1: IPP
Event Notification Specification", <draft-ietf-ipp-not-spec- Event Notifications and Subscriptions", <draft-ietf-ipp-not-spec-
06.txt>, February 24, 2001. 07.txt>, July 17, 2001.
[RFC1900] [RFC1900]
B. Carpenter, Y. Rekhter. Renumbering Needs Work, RFC 1900, B. Carpenter, Y. Rekhter. Renumbering Needs Work, RFC 1900,
February 1996. February 1996.
[RFC2026] [RFC2026]
S. Bradner, "The Internet Standards Process -- Revision 3", RFC S. Bradner, "The Internet Standards Process -- Revision 3", RFC
2026, October 1996. 2026, October 1996.
[RFC2119] [RFC2119]
skipping to change at page 27, line 22 skipping to change at page 32, line 9
2567, April 1999. 2567, April 1999.
[RFC2568] [RFC2568]
Zilles, S., "Rationale for the Structure and Model and Protocol for Zilles, S., "Rationale for the Structure and Model and Protocol for
the Internet Printing Protocol", RFC 2568, April 1999. the Internet Printing Protocol", RFC 2568, April 1999.
[RFC2569] [RFC2569]
Herriot, R., Hastings, T., Jacobs, N., Martin, J., "Mapping between Herriot, R., Hastings, T., Jacobs, N., Martin, J., "Mapping between
LPD and IPP Protocols", RFC 2569, April 1999. LPD and IPP Protocols", RFC 2569, April 1999.
[RFC2567]
Wright, D., "Design Goals for an Internet Printing Protocol", RFC
2567, April 1999.
[RFC2568]
Zilles, S., "Rationale for the Structure and Model and Protocol for
the Internet Printing Protocol", RFC 2568, April 1999.
[RFC2569]
Herriot, R., Hastings, T., Jacobs, N., Martin, J., "Mapping between
LPD and IPP Protocols", RFC 2569, April 1999.
[RFC2616] [RFC2616]
R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P. R. Fielding, J. Gettys, J. Mogul, H. Frystyk, L. Masinter, P.
Leach, T. Berners-Lee, "Hypertext Transfer Protocol - HTTP/1.1", Leach, T. Berners-Lee, "Hypertext Transfer Protocol - HTTP/1.1",
RFC 2616, June 1999. RFC 2616, June 1999.
[RFC2717] [RFC2717]
R. Petke and I. King, "Registration Procedures for URL Scheme R. Petke and I. King, "Registration Procedures for URL Scheme
Names", RFC 2717, November 1999. Names", RFC 2717, November 1999.
[RFC2732] [RFC2732]
skipping to change at page 28, line 5 skipping to change at page 32, line 31
[RFC2910] [RFC2910]
Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing
Protocol/1.1: Encoding and Transport", RFC 2910, September 2000. Protocol/1.1: Encoding and Transport", RFC 2910, September 2000.
[RFC2911] [RFC2911]
R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell, R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell,
"Internet Printing Protocol/1.1: Model and Semantics", RFC 2911, "Internet Printing Protocol/1.1: Model and Semantics", RFC 2911,
September 2000. September 2000.
16 Authors' Addresses 18 Authors' Addresses
Robert Herriot Robert Herriot
Xerox Corp. Xerox Corp.
3400 Hill View Ave, Building 1 3400 Hill View Ave, Building 1
Palo Alto, CA 94304 Palo Alto, CA 94304
Phone: 650-813-7696 Phone: 650-813-7696
Fax: 650-813-6860 Fax: 650-813-6860
e-mail: robert.herriot@pahv.xerox.com e-mail: robert.herriot@pahv.xerox.com
skipping to change at page 28, line 24 skipping to change at page 33, line 4
e-mail: robert.herriot@pahv.xerox.com e-mail: robert.herriot@pahv.xerox.com
Carl Kugler Carl Kugler
IBM IBM
P.O. Box 1900 P.O. Box 1900
Boulder, CO 80301-9191 Boulder, CO 80301-9191
Phone: Phone:
Fax: Fax:
e-mail: kugler@us.ibm.com e-mail: kugler@us.ibm.com
Harry Lewis Harry Lewis
IBM IBM
P.O. Box 1900 P.O. Box 1900
Boulder, CO 80301-9191 Boulder, CO 80301-9191
Phone: 303-924-5337 Phone: 303-924-5337
FAX: FAX:
e-mail: harryl@us.ibm.com e-mail: harryl@us.ibm.com
17 Description of Base IPP documents IPP Web Page: http://www.pwg.org/ipp/
IPP Mailing List: ipp@pwg.org
To subscribe to the ipp mailing list, send the following email:
1) send it to majordomo@pwg.org
2) leave the subject line blank
3) put the following two lines in the message body:
subscribe ipp
end
Implementers of this specification document are encouraged to join
the IPP Mailing List in order to participate in any discussions of
clarification issues and review of registration proposals for
additional attributes and values. In order to reduce spam the
mailing list rejects mail from non-subscribers, so you must subscribe
to the mailing list in order to send a question or comment to the
mailing list.
19 Description of Base IPP documents
The base set of IPP documents includes: The base set of IPP documents includes:
Design Goals for an Internet Printing Protocol [RFC2567] Design Goals for an Internet Printing Protocol [RFC2567]
Rationale for the Structure and Model and Protocol for the Internet Rationale for the Structure and Model and Protocol for the Internet
Printing Protocol [RFC2568] Printing Protocol [RFC2568]
Internet Printing Protocol/1.1: Model and Semantics [RFC2911] Internet Printing Protocol/1.1: Model and Semantics [RFC2911]
Internet Printing Protocol/1.1: Encoding and Transport [RFC2910] Internet Printing Protocol/1.1: Encoding and Transport [RFC2910]
Internet Printing Protocol/1.1: Implementer's Guide [ipp-iig] Internet Printing Protocol/1.1: Implementer's Guide [ipp-iig]
Mapping between LPD and IPP Protocols [RFC2569] Mapping between LPD and IPP Protocols [RFC2569]
Internet Printing Protocol (IPP): IPP Event Notification Internet Printing Protocol (IPP): IPP Event Notifications and
Specification [ipp-ntfy] Subscriptions [ipp-ntfy]
The "Design Goals for an Internet Printing Protocol" document takes a The "Design Goals for an Internet Printing Protocol" document takes a
broad look at distributed printing functionality, and it enumerates broad look at distributed printing functionality, and it enumerates
real-life scenarios that help to clarify the features that need to be real-life scenarios that help to clarify the features that need to be
included in a printing protocol for the Internet. It identifies included in a printing protocol for the Internet. It identifies
requirements for three types of users: end users, operators, and requirements for three types of users: end users, operators, and
administrators. It calls out a subset of end user requirements that administrators. It calls out a subset of end user requirements that
are satisfied in IPP/1.0. A few OPTIONAL operator operations have are satisfied in IPP/1.0. A few OPTIONAL operator operations have
been added to IPP/1.1. been added to IPP/1.1.
skipping to change at page 30, line 9 skipping to change at page 34, line 42
objects. It is intended to help them understand IPP/1.1 and some of objects. It is intended to help them understand IPP/1.1 and some of
the considerations that may assist them in the design of their client the considerations that may assist them in the design of their client
and/or IPP object implementations. For example, a typical order of and/or IPP object implementations. For example, a typical order of
processing requests is given, including error checking. Motivation processing requests is given, including error checking. Motivation
for some of the specification decisions is also included. for some of the specification decisions is also included.
The "Mapping between LPD and IPP Protocols" document gives some The "Mapping between LPD and IPP Protocols" document gives some
advice to implementers of gateways between IPP and LPD (Line Printer advice to implementers of gateways between IPP and LPD (Line Printer
Daemon) implementations. Daemon) implementations.
The "IPP Event Notification Specification" document defines an The "IPP Event Notifications and Subscriptions" document defines an
extension to IPP/1.0 [RFC2566, RFC2565] and IPP/1.1 [RFC2911, extension to IPP/1.0 [RFC2566, RFC2565] and IPP/1.1 [RFC2911,
RFC2910]. This extension allows a client to subscribe to printing RFC2910]. This extension allows a client to subscribe to printing
related Events and defines the semantics for delivering asynchronous related Events and defines the semantics for delivering asynchronous
Event Notifications to the specified Notification Recipient via a Event Notifications to the specified Notification Recipient via a
specified Delivery Method (i.e., protocols) defined in (separate) specified Delivery Method (i.e., protocols) defined in (separate)
Delivery Method documents. Delivery Method documents.
18 Full Copyright Statement 20 Full Copyright Statement
Copyright (C) The Internet Society (2001). All Rights Reserved. Copyright (C) The Internet Society (2001). All Rights Reserved.
This document and translations of it may be copied and furnished to This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph are kind, provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing document itself may not be modified in any way, such as by removing
 End of changes. 

This html diff was produced by rfcdiff 1.25, available from http://www.levkowetz.com/ietf/tools/rfcdiff/