draft-ietf-ipp-notify-get-05.txt   draft-ietf-ipp-notify-get-06.txt 
Internet Printing Protocol WG Robert Herriot (editor) Internet Printing Protocol WG Robert Herriot (editor)
INTERNET-DRAFT Xerox Corp. INTERNET-DRAFT Thomas N. Hastings
<draft-ietf-ipp-notify-get-05.txt> Carl Kugler <draft-ietf-ipp-notify-get-06.txt> Xerox Corp.
Updates: RFC 2911 Harry Lewis Updates: RFC 2911 Carl Kugler
[Target category: standards track] IBM, Corp. [Target category: standards track] Harry Lewis
Expires: April 17, 2002 October 17, 2001 IBM, Corp.
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
skipping to change at page 1, line 44 skipping to change at page 1, line 44
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 Notifications and Subscriptions" specification [ipp-ntfy]. "IPP Event Notifications and Subscriptions" specification [ipp-ntfy].
When IPP Notification [ipp-ntfy] is supported, the Delivery Method When IPP Notification [ipp-ntfy] is supported, the Delivery Method
defined in this document is one of the RECOMMENDED Delivery Methods defined in this document is one of the RECOMMENDED Delivery Methods
for Printers to support. for Printers to support.
The 'ippget' Delivery Method is a 'pull' Delivery Method with aspects The 'ippget' Delivery Method is a Pull Delivery Method. When an Event
of a 'push' method as well. That is, when an Event occurs, the occurs, the Printer saves the Event Notification for a period of time
Printer saves the Event Notification for a period of time called the called the Event Life. The Notification Recipient fetches (pulls)
Event Life. The Notification Recipient fetches (pulls) Event Event Notifications using the Get-Notifications operation. If the
Notifications using the Get-Notifications operation. If the
Notification Recipient has selected the Event Wait Mode option to Notification Recipient has selected the Event Wait Mode option to
wait for additional Event Notifications, the Printer continues to wait for additional Event Notifications, the Printer continues to
return (similar to push) Event Notifications to the Notification
Recipient as Get-Notification responses as Events occur. This push INTERNET-DRAFT IPP: The 'ippget' Delivery Method
aspect is not a true 'push', since the Printer does not open the
connect, but rather continues to return responses as Events occur return Event Notifications to the Notification Recipient as Get-
using the connection originated by the Notification Recipient. Notification responses as Events occur using the connection
originated by the Notification Recipient.
Either the Notification Recipient or the Printer can terminate Event Either the Notification Recipient or the Printer can terminate Event
Wait Mode without closing the connection. Wait Mode without closing the connection.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
Table of Contents Table of Contents
1 Introduction.....................................................5 1 Introduction.....................................................5
2 Terminology......................................................6 2 Terminology......................................................6
3 Model and Operation..............................................7 3 Model and Operation..............................................7
4 General Information..............................................9 4 General Information..............................................8
5 Get-Notifications operation.....................................10 5 Get-Notifications operation......................................9
5.1 Get-Notifications Request.....................................12 5.1 Get-Notifications Request.....................................11
5.1.1 "notify-subscription-ids" (1setOf integer(1:MAX)):..........12 5.1.1 notify-subscription-ids (1setOf integer(1:MAX)).............11
5.1.2 notify-sequence-numbers (1setOf integer(1:MAX)).............13 5.1.2 notify-sequence-numbers (1setOf integer(1:MAX)).............11
5.1.3 "notify-wait" (boolean):....................................14 5.1.3 notify-wait (boolean).......................................12
5.2 Get-Notifications Response....................................14 5.2 Get-Notifications Response....................................13
5.2.1 "notify-get-interval" (integer(0:MAX))......................17 5.2.1 notify-get-interval (integer(0:MAX))........................16
5.2.2 "printer-up-time" (integer(1:MAX)):.........................19 5.2.2 printer-up-time (integer(1:MAX))............................18
5.2.3 "redirect-uri" (uri):.......................................19 5.2.3 redirect-uri (uri)..........................................18
6 Additional Information about Subscription Template Attributes...23 6 Additional Information about Subscription Template Attributes...22
6.1 notify-recipient-uri (uri)....................................23 6.1 notify-pull-method (type2 keyword)............................22
7 Subscription Description Attributes.............................24 7 Subscription Description Attributes.............................23
8 Additional Printer Description Attributes.......................24 8 Additional Printer Description Attributes.......................23
8.1 ippget-event-life (integer(15:MAX))...........................24 8.1 ippget-event-life (integer(15:MAX))...........................23
9 New Values for Existing Printer Description Attributes..........25 9 New Values for Existing Printer Description Attributes..........24
9.1 notify-schemes-supported (1setOf uriScheme)...................25 9.1 notify-pull-method-supported (1setOf type2 keyword)...........24
9.2 operations-supported (1setOf type2 enum)......................26 9.2 operations-supported (1setOf type2 enum)......................24
10 New Status Codes...............................................26 10 New Status Codes...............................................25
10.1 successful-ok-events-complete (0x0007).......................26 10.1 successful-ok-events-complete (0x0007).......................25
10.2 redirection-other-site (0x0300)..............................26 10.2 redirection-other-site (0x0300)..............................25
11 The IPPGET URL Scheme..........................................27 11 Encoding and Transport.........................................25
11.1 The IPPGET URL Scheme Applicability and Intended Usage.......27
11.2 The IPPGET URL Scheme Associated Port........................27
11.3 The IPPGET URL Scheme Associated MIME Type...................27
11.4 The IPPGET URL Scheme Character Encoding.....................28
11.5 The IPPGET URL Scheme Syntax in ABNF.........................28
11.5.1 IPPGET URL Examples........................................29
11.5.2 IPPGET URL Comparisons.....................................30
12 Encoding and Transport.........................................30 12 Conformance Requirements.......................................27
13 Conformance Requirements.......................................31 12.1 Conformance for IPP Printers.................................27
13.1 Conformance for IPP Printers.................................31 12.2 Conformance for IPP Clients..................................28
13.2 Conformance for IPP Clients..................................32
14 IANA Considerations............................................33 13 IANA Considerations............................................28
14.1 Additional attribute value registrations for existing attributes 13.1 Additional attribute value registrations for existing attributes
33 29
14.1.1 Additional values for the "notify-schemes-supported" Printer
attribute..............................................33
14.1.2 Additional values for the "operations-supported" Printer
attribute..............................................34
14.2 Operation Registrations......................................34
14.3 Attribute Registrations......................................35
14.4 Status code Registrations....................................35
15 Internationalization Considerations............................35 INTERNET-DRAFT IPP: The 'ippget' Delivery Method
16 Security Considerations........................................35 13.1.1 Additional values for the "notify-pull-method-supported"
Printer attribute......................................29
13.1.2 Additional values for the "operations-supported" Printer
attribute..............................................29
13.2 Operation Registrations......................................30
13.3 Attribute Registrations......................................30
13.4 Status code Registrations....................................30
17 References.....................................................36 14 Internationalization Considerations............................31
18 Authors' Addresses.............................................38 15 Security Considerations........................................31
19 Description of Base IPP documents..............................39 16 References.....................................................31
20 Full Copyright Statement.......................................40 17 Authors' Addresses.............................................33
18 Description of Base IPP documents..............................34
19 Full Copyright Statement.......................................35
Table of Tables Table of Tables
Table 1 - Information about the Delivery Method....................9 Table 1 - Information about the Delivery Method....................8
Table 2 - Combinations of "notify-wait", "status-code", and "notify- Table 2 - Combinations of "notify-wait", "status-code", and "notify-
get-interval" .................................................18 get-interval" .................................................17
Table 3 - Attributes in Event Notification Content................21 Table 3 - Attributes in Event Notification Content................20
Table 4 - Additional Attributes in Event Notification Content for Job Table 4 - Additional Attributes in Event Notification Content for Job
Events ........................................................22 Events ........................................................21
Table 5 - Combinations of Events and Subscribed Events for "job- Table 5 - Combinations of Events and Subscribed Events for "job-
impressions-completed" ........................................23 impressions-completed" ........................................22
Table 6 - Additional Attributes in Event Notification Content for Table 6 - Additional Attributes in Event Notification Content for
Printer Events ................................................23 Printer Events ................................................22
Table 7 - Operation-id assignments................................26 Table 7 - Operation-id assignments................................25
Table 8 - The "event-notification-attributes-tag" value...........31 Table 8 - The "event-notification-attributes-tag" value...........27
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
1 Introduction 1 Introduction
The "IPP Event Notifications and Subscriptions" document [ipp-ntfy] The "IPP Event Notifications and Subscriptions" document [ipp-ntfy]
defines an OPTIONAL 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]. For a description [RFC2566, RFC2565] and IPP/1.1 [RFC2911, RFC2910]. For a description
of the base IPP documents, see section 19. The [ipp-ntfy] extension of the base IPP documents, see section 18. 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
skipping to change at page 5, line 33 skipping to change at page 5, line 35
Notification Recipient via the specified Delivery Method (i.e., Notification Recipient via the specified Delivery Method (i.e.,
protocol). protocol).
The "IPP Event Notifications and Subscriptions" 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. When IPP Notification [ipp-ntfy] is supported, the delivery method. When IPP Notification [ipp-ntfy] is supported, the
Delivery Method defined in this document is one of the RECOMMENDED Delivery Method defined in this document is one of the RECOMMENDED
Delivery Methods for Printers to support. Delivery Methods for Printers to support.
The 'ippget' Delivery Method is a 'pull' Delivery Method with aspects The 'ippget' Delivery Method is a Pull Delivery Method. When an
of a 'push' method as well. That is, when an Event occurs, the Event occurs, the Printer saves the Event Notification for a period
Printer saves the Event Notification for a period of time called the of time called the Event Life. The Notification Recipient fetches
Event Life. The Notification Recipient fetches (pulls) the Event (pulls) the Event Notifications using the Get-Notifications
Notifications using the Get-Notifications operation. This operation operation. This operation causes the Printer to return all Event
causes the Printer to return all Event Notifications held for the Notifications held for the specified Subscription object(s). If the
specified Subscription object(s). If the Notification Recipient has Notification Recipient has selected the Event Wait Mode option to
selected the Event Wait Mode option to wait for additional Event wait for additional Event Notifications, the Printer continues to
Notifications, the Printer continues to return (similar to push) return Event Notifications to the Notification Recipient as Get-
Event Notifications to the Notification Recipient as Get-Notification Notification responses as Events occur using the transaction
responses as Events occur. This push aspect is not a true 'push', originated by the Notification Recipient.
since the Printer does not open the transaction, but rather continues
to return responses as Events occur using the transaction originated
by the Notification Recipient.
The Notification Recipient can terminate Event Wait Mode (without The Notification Recipient can terminate Event Wait Mode (without
closing the connection) by supplying the "notify-wait" attribute with closing the connection) by supplying the "notify-wait" (boolean)
a 'false' value in a subsequent Get-Notifications request. attribute with a 'false' value in a subsequent Get-Notifications
Similarly, the Printer can terminate Event Wait Mode (without closing request. Similarly, the Printer can terminate Event Wait Mode
the connection) by returning the "notify-get-interval" operation (without closing the connection) by returning the "notify-get-
attribute in a Get-Notifications response which tells the interval" (integer) operation attribute in a Get-Notifications
Notification Recipient how long to wait before trying again. response which tells the Notification Recipient how long to wait
before trying again.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
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 This document uses the same terminology as [RFC2911], such as
"client", "Printer", "Job", "attribute", "attribute value", "client", "Printer", "Job", "attribute", "attribute value",
"keyword", "operation", "request", "response", and "support". "keyword", "operation", "request", "response", and "support".
skipping to change at page 6, line 28 skipping to change at page 6, line 28
conformance as defined in RFC 2119 [RFC2119] and [RFC2911] section conformance as defined in RFC 2119 [RFC2119] and [RFC2911] section
12.1. If an implementation supports the extension defined in this 12.1. If an implementation supports the extension defined in this
document, then these terms apply; otherwise, they do not. These document, then these terms apply; otherwise, they do not. These
terms define conformance to this document only; they do not affect terms define conformance to this document only; they do not affect
conformance to other documents, unless explicitly stated otherwise. conformance to other documents, unless explicitly stated otherwise.
Event Life: The length of time in seconds after an Event occurs Event Life: The length of time in seconds after an Event occurs
during which the Printer will return that Event in a Event during which the Printer will return that Event in a Event
Notification in a Get-Notifications response. After the Event Notification in a Get-Notifications response. After the Event
Life expires, the Printer will no longer return an Event Life expires, the Printer will no longer return an Event
Notification for that Even in a Get-Notifications response. Notification for that Event in a Get-Notifications response.
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.
Event Wait Mode: The mode requested by a Notification Recipient Event Wait Mode: The mode requested by a Notification Recipient
client in its Get-Notifications Request and granted by a Printer client in its Get-Notifications Request and granted by a Printer
to keep the connection open where the Printer sends subsequent to keep the connection open where the Printer sends subsequent
Event Notifications to the Notification Recipient as they occur Event Notifications to the Notification Recipient as they occur
as additional Get-Notification Responses. as additional Get-Notification Responses.
skipping to change at page 7, line 7 skipping to change at page 7, line 5
terms are reproduced here: terms are reproduced here:
Event - some occurrence (either expected or unexpected) within the Event - some occurrence (either expected or unexpected) within the
printing system of a change of state, condition, or printing system of a change of state, condition, or
configuration of a Job or Printer object. An Event occurs only configuration of a Job or Printer object. An Event occurs only
at one instant in time and does not span the time the physical at one instant in time and does not span the time the physical
Event takes place. For example, jam-occurred and jam-cleared Event takes place. For example, jam-occurred and jam-cleared
are two distinct, instantaneous Events, even though the jam may are two distinct, instantaneous Events, even though the jam may
last for a while. last for a while.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
Event Notification - the information about an Event that the Printer Event Notification - the information about an Event that the Printer
sends when an Event occurs. sends when an Event occurs.
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 "notify-pull-method"
recipient-uri" attribute has the scheme 'ippget', the client is attribute is present and has the 'ippget' keyword value, the client
requesting that the Printer use the 'ippget' Delivery Method for the is requesting that the Printer use the 'ippget' Pull Delivery Method
Event Notifications associated with the new Subscription Object. The for the Event Notifications associated with the new Subscription
client SHOULD choose a value for the address part of the "notify- Object.
recipient-uri" attribute that uniquely identifies the Notification
Recipient.
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 Life. The Printer MUST hold an Event and MUST assign it the Event Life. The Printer MUST hold an Event
Notification for its assigned Event Life. Notification for its assigned Event Life.
When a Notification Recipient wants to receive Event Notifications When a Notification Recipient wants to receive Event Notifications
for a Subscription object, it performs the Get-Notifications for a Subscription object, it performs the Get-Notifications
operation supplying the Subscription object's subscription-id, which operation supplying the Subscription object's subscription-id, which
causes the Printer to return all un-expired Event Notifications held causes the Printer to return all un-expired Event Notifications held
for that Subscription object. If the Notification Recipient has for that Subscription object. If the Notification Recipient has
skipping to change at page 7, line 44 skipping to change at page 7, line 42
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
MUST save Event Notifications for at least 15 seconds (see section MUST save Event Notifications for at least 15 seconds (see section
8.1), the Notification Recipient is unlikely to miss any Event 8.1), the Notification Recipient is unlikely to miss any Event
Notifications that occur between the Subscription Creation and the Notifications that occur between the Subscription Creation and the
Get-Notifications operation. Get-Notifications operation.
ISSUE 01: Although we agreed to extend Job Creation operations to
support Event Wait Mode, it seems to be an unnecessary complication,
since the Printer MUST keep events for at least 15 seconds. So OK
NOT to add the "notify-wait" (boolean) operation attribute to Job
Creation operations and NOT have to have Job Creation responses
return Event Notification Groups (in addition to returning
Subscription Attribute Groups).
The 'ippget' Delivery Method is designed primarily for (1) a client The 'ippget' Delivery Method is designed primarily for (1) a client
that wants to get Events (from the job's per-Job Subscription object) that wants to get Events (from the job's per-Job Subscription object)
for a job that it has submitted and (2) for a privileged client that for a job that it has submitted and (2) for a privileged client that
wants to get all job or printer Events from a per-Printer wants to get all job or printer Events from a per-Printer
Subscription object. If several groups of users expect to receive Subscription object. If several groups of users expect to receive
jobs from other users (FAX paradigm) and each group has a different jobs from other users (FAX paradigm) and each group has a different
designated person, say, a secretary, to receive job completion designated person, say, a secretary, to receive job completion
Events, the Printer should be configured to support multiple URLs, Events, the Printer should be configured to support multiple URLs,
one for each group. Then the designated person can run an one for each group. Then the designated (privileged) person can run
application that gets the events for jobs submitted to that URL from an application that gets the events for jobs submitted to that URL
the per-Printer Subscription object that the application creates. from the per-Printer Subscription object that the application
creates.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
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 Requirement Delivery Method Document Method Conformance Requirement Delivery Method
Realization Realization
1. What is the URL scheme name for the ippget 1. What is the URL scheme name for the
Delivery Method? Push Delivery Method or the keyword
method name for the Pull Delivery
Method? ippget
2. Is the Delivery Method REQUIRED, RECOMMENDED 2. Is the Delivery Method REQUIRED,
RECOMMENDED or OPTIONAL for an IPP RECOMMENDED or OPTIONAL for an IPP
Printer to support? Printer to support? RECOMMENDED
3. What transport and delivery protocols IPP with one new 3. What transport and delivery protocols IPP with one new
does the Printer use to deliver the operation. does the Printer use to deliver the operation.
Event Notification Content, i.e., what Event Notification Content, i.e., what
is the entire network stack? is the entire network stack?
4. Can several Event Notifications be Yes. 4. Can several Event Notifications be Yes.
combined into a Compound Event combined into a Compound Event
Notification? Notification?
skipping to change at page 9, line 48 skipping to change at page 9, line 4
6. Is the Event Notification content Machine Consumable 6. Is the Event Notification content Machine Consumable
Machine Consumable or Human Machine Consumable or Human
Consumable? Consumable?
7. What section in this document answers Section 5 7. What section in this document answers Section 5
the following question? For a Machine the following question? For a Machine
Consumable Event Notification, what is Consumable Event Notification, what is
the representation and encoding of the representation and encoding of
values defined in section 9.1 of [ipp- values defined in section 9.1 of [ipp-
ntfy] and the conformance requirements ntfy] and the conformance requirements
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
ntfy] and the conformance requirements
thereof? For a Human Consumable Event thereof? For a Human Consumable Event
Notification, what is the Notification, what is the
Notification, what is the
representation and encoding of pieces representation and encoding of pieces
of information defined in section 9.2 of information defined in section 9.2
of [ipp-ntfy] and the conformance of [ipp-ntfy] and the conformance
requirements thereof? requirements thereof?
8. What are the latency and reliability Same as IPP and the 8. What are the latency and reliability Same as IPP and the
of the transport and delivery underlying HTTP of the transport and delivery underlying HTTP
protocol? transport protocol? transport
9. What are the security aspects of the Same as IPP and the 9. What are the security aspects of the Same as IPP and the
transport and delivery protocol, e.g., underlying HTTP transport and delivery protocol, e.g., underlying HTTP
how it is handled in firewalls? transport and in the how it is handled in firewalls? transport and in the
same direction, so no same direction, so no
new firewall new firewall
considerations. considerations.
10.What are the content length None 10.What are the content length None
restrictions? restrictions?
11.What are the additional values or 11.What are the additional values or None
pieces of information that a Printer pieces of information that a Printer
sends in an Event Notification content sends in an Event Notification content
and the conformance requirements and the conformance requirements
thereof? None thereof?
12.What are the additional Subscription None 12.What are the additional Subscription None
Template and/or Subscription Template and/or Subscription
Description attributes and the Description attributes and the
conformance requirements thereof? conformance requirements thereof?
13.What are the additional Printer "ipp-event-life" 13.What are the additional Printer "ipp-event-life"
Description attributes and the (integer (15: MAX)) Description attributes and the (integer (15: MAX))
conformance requirements thereof? conformance requirements thereof?
5 Get-Notifications operation 5 Get-Notifications operation
This operation is issued by a client acting in the role of a This operation is issued by a client acting in the role of a
Notification Recipient requesting the Printer to return all Event Notification Recipient requesting the Printer to return all Event
Notifications held for the identified Subscription object(s). Notifications held for the identified Subscription object(s).
A Printer MUST support this operation. A Printer MUST support this operation.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
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-subscription-id" 1. Whose associated Subscription Object's "notify-subscription-id"
Subscription Description attribute equals one of the values of Subscription Description attribute equals one of the values of
the "notify-subscription-ids" (1setOf integer(1:MAX)) operation the "notify-subscription-ids" (1setOf integer(1:MAX)) operation
attribute AND attribute AND
2. Whose associated Subscription Object's "notify-recipient-uri" 2. Whose associated Subscription Object's contains the "notify-
attribute matches the scheme value of 'ippget' using the (case- pull-method" attribute and it has the 'ippget' keyword value AND
insensitive) matching rules in section 11.5.2 AND
3. Whose "notify-sequence-number" is equal to or greater than the 3. Whose "notify-sequence-number" is equal to or greater than the
corresponding value of the "notify-sequence-numbers (1setOf corresponding value of the "notify-sequence-numbers (1setOf
integer(1:MAX)) operation attribute, if supplied AND integer(1:MAX)) operation attribute, if supplied AND
4. Whose Event Life has not yet expired AND 4. Whose Event Life has not yet expired AND
5. 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 identified Subscription Object. access rights to the identified Subscription Object.
skipping to change at page 12, line 7 skipping to change at page 11, line 5
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 be the owner of [RFC2911] section 8.3) performing this operation MUST be the owner of
each Subscription Object identified by the "notify-subscription-ids" each Subscription Object identified by the "notify-subscription-ids"
operation attribute (as returned during a Subscription Creation operation attribute (as returned during a Subscription Creation
Operation) or an operator or administrator of the Printer (see Operation) or an operator or administrator of the Printer (see
[RFC2911] Sections 1 and 8.5). Otherwise, the IPP object MUST reject [RFC2911] Sections 1 and 8.5). Otherwise, the IPP object MUST reject
the operation and return: 'client-error-forbidden', 'client-error- the operation and return: 'client-error-forbidden', 'client-error-
not-authenticated', or 'client-error-not-authorized' status code as not-authenticated', or 'client-error-not-authorized' status code as
appropriate. appropriate.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
5.1 Get-Notifications Request 5.1 Get-Notifications Request
The following groups of attributes are part of the Get-Notifications The following groups of attributes are part of the Get-Notifications
Request: Request:
Group 1: Operation Attributes Group 1: Operation Attributes
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.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.
5.1.1 "notify-subscription-ids" (1setOf integer(1:MAX)): 5.1.1 notify-subscription-ids (1setOf integer(1:MAX))
This attribute identifies one or more Subscription objects for This attribute identifies one or more Subscription objects for
which Events are requested. The client MUST supply this which Events are requested. The client MUST supply this
attribute with at least one value. The Printer object MUST attribute with at least one value. The Printer object MUST
support this attribute with multiple values. support this attribute with multiple values.
If no Subscription Object exists with the supplied identifier, If no Subscription Object exists with the supplied identifier
or the identified Subscription Object does not contain the
"notify-pull-method" attribute with the 'ippget' keyword value,
the Printer MUST return the 'client-error-not-found' status the Printer MUST return the 'client-error-not-found' status
code. code.
If an identified Subscription Object does not have a "notify-
recipients-uri" Subscription attribute with 'ippget' scheme
(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.
Note: The name of both the "notify-subscription-ids" and Note: The name of both the "notify-subscription-ids" and
"notify-sequence-numbers" end in 's', since they are "notify-sequence-numbers" end in 's', since they are
multi-valued. However, there are other occurrences of multi-valued. However, there are other occurrences of
these attribute names without the 's' that are single these attribute names without the 's' that are single
valued. valued.
5.1.2 notify-sequence-numbers (1setOf integer(1:MAX)) 5.1.2 notify-sequence-numbers (1setOf integer(1:MAX))
This attribute specifies one or more lowest Event Notification This attribute specifies one or more lowest Event Notification
sequence number values for the Subscription objects identified sequence number values for the Subscription objects identified
by the corresponding values of the "notify-subscription-ids" by the corresponding values of the "notify-subscription-ids"
operation attribute. The Notification Recipient SHOULD supply operation attribute. The Notification Recipient SHOULD supply
this attribute and the number of values SHOULD be the same as this attribute and the number of values SHOULD be the same as
the number of values of the "notify-subscriptions-ids" the number of values of the "notify-subscriptions-ids"
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
attribute. The Printer MUST support this attribute with attribute. The Printer MUST support this attribute with
multiple values. multiple values.
The Printer MUST NOT return Notification Events with lower The Printer MUST NOT return Notification Events with lower
sequence numbers for the corresponding Subscription object. sequence numbers for the corresponding Subscription object.
Therefore, by supplying the proper values for this attribute Therefore, by supplying the proper values for this attribute
the Notification Recipient can prevent getting the same Event the Notification Recipient can prevent getting the same Event
Notifications from a Subscription object that were returned on Notifications from a Subscription object that were returned on
a previous Get-Notifications request. The Notification a previous Get-Notifications request. The Notification
Recipient SHOULD remember the highest "notify-sequence-number" Recipient SHOULD remember the highest "notify-sequence-number"
skipping to change at page 14, line 5 skipping to change at page 12, line 45
the first Event Notification in the second Get-Notifications the first Event Notification in the second Get-Notifications
Response may be less than the time stamp of the last Event Response may be less than the time stamp of the last Event
Notification in the first Get-Notification Response. This Notification in the first Get-Notification Response. This
happens because the Printer sends all unexpired Event happens because the Printer sends all unexpired Event
Notification with a sequence number equal or higher according Notification with a sequence number equal or higher according
to the ordering specified in [ipp-ntfy] and some Event to the ordering specified in [ipp-ntfy] and some Event
Notifications from the first Get-Notifications operation may Notifications from the first Get-Notifications operation may
not have expired by the time the second Get-Notifications not have expired by the time the second Get-Notifications
operation occurs. operation occurs.
5.1.3 "notify-wait" (boolean): 5.1.3 notify-wait (boolean)
This value indicates whether or not the Notification Recipient This value indicates whether or not the Notification Recipient
wants Event Wait Mode. The client MAY supply this attribute. wants Event Wait Mode. The client MAY supply this attribute.
The Printer object MUST support both values of this attribute. The Printer object MUST support both values of this attribute.
If the client supplies the 'false' value or omits this If the client supplies the 'false' value or omits this
attribute, the client is not requesting Event Wait Mode. If attribute, the client is not requesting Event Wait Mode. If
the value is 'true', the client is requesting Event Wait Mode. the value is 'true', the client is requesting Event Wait Mode.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
See the beginning of section 5.2 for the rules for Event Wait See the beginning of section 5.2 for the rules for Event Wait
Mode. Mode.
5.2 Get-Notifications Response 5.2 Get-Notifications Response
The Printer has the following options for responding to a Get- The Printer has the following options for responding to a Get-
Notifications Request: Notifications Request:
1. The Printer can reject the request and return the 'server-error- 1. The Printer can reject the request and return the 'server-error-
busy' status code, if the Printer is too busy to accept this busy' status code, if the Printer is too busy to accept this
skipping to change at page 15, line 13 skipping to change at page 14, line 4
attribute. This attribute indicates that the Printer wishes to attribute. This attribute indicates that the Printer wishes to
leave Event Wait Mode and the number of seconds in the future leave Event Wait Mode and the number of seconds in the future
that the Notification Recipient SHOULD try the Get-Notifications that the Notification Recipient SHOULD try the Get-Notifications
operation again. The Notification Recipient MUST accept this operation again. The Notification Recipient MUST accept this
response and MUST disconnect. If the Notification Recipient response and MUST disconnect. If the Notification Recipient
does not disconnect, the Printer SHOULD do so. does not disconnect, the Printer SHOULD do so.
From the Notification Recipient's view, the response appears as an From the Notification Recipient's view, the response appears as an
initial burst of data, which includes the Operation Attributes Group initial burst of data, which includes the Operation Attributes Group
and one Event Notification Attributes Group per Event Notification and one Event Notification Attributes Group per Event Notification
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
that the Printer is holding. After the initial burst of data, if the that the Printer is holding. After the initial burst of data, if the
Notification Recipient has selected the Event Wait Mode option to Notification Recipient has selected the Event Wait Mode option to
wait for additional Event Notifications, the Notification Recipient wait for additional Event Notifications, the Notification Recipient
receives occasional Event Notification Attribute Groups. Proxy receives occasional Event Notification Attribute Groups. Proxy
servers may delay some Event Notifications or cause time-outs to servers may delay some Event Notifications or cause time-outs to
occur. The client MUST be prepared to perform the Get-Notifications occur. The client MUST be prepared to perform the Get-Notifications
operation again when time-outs occur. operation again when time-outs occur.
Each attribute is encoded using the IPP rules for encoding attributes Each attribute is encoded using the IPP rules for encoding attributes
[RFC2910] and MAY be encoded in any order. Note: the Get-Jobs [RFC2910] and MAY be encoded in any order. Note: the Get-Jobs
response in [RFC2911] acts as a model for encoding multiple groups of response in [RFC2911] acts as a model for encoding multiple groups of
attributes. See section 12 for the encoding and transport rules. attributes. See section 11 for the encoding and transport rules.
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))
skipping to change at page 16, line 12 skipping to change at page 15, line 4
is the last return for all Subscription objects that is the last return for all Subscription objects that
match the request, whether or not there are Event match the request, whether or not there are Event
Notifications being returned. This condition occurs for Notifications being returned. This condition occurs for
Event Wait Mode with Notification Recipients waiting for Event Wait Mode with Notification Recipients waiting for
responses when the Subscription Object is: (1) canceled responses when the Subscription Object is: (1) canceled
with a Cancel-Subscription operation, (2) deleted when with a Cancel-Subscription operation, (2) deleted when
the Per-Printer Subscription lease time expires, or (3) the Per-Printer Subscription lease time expires, or (3)
when the 'job-completed' event occurs for a Per-Job when the 'job-completed' event occurs for a Per-Job
Subscription. This condition also occurs for a Get- Subscription. This condition also occurs for a Get-
Notifications request that a Notification Recipient makes Notifications request that a Notification Recipient makes
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
after the job completes, but before the Event Life after the job completes, but before the Event Life
expires. See section 10.1. expires. See section 10.1.
client-error-not-found: The Printer has no Subscription client-error-not-found: The Printer has no Subscription
Object's whose "notify-subscription-id" attribute equals Object's whose "notify-subscription-id" attribute equals
any of the values of the "notify-subscription-ids" any of the values of the "notify-subscription-ids"
operation attribute supplied. operation attribute supplied or the identified
Subscription Object does not contain the "notify-pull-
method" attribute with the 'ippget' keyword value.
server-error-busy: The Printer is too busy to accept this server-error-busy: The Printer is too busy to accept this
operation. The Printer SHOULD return the "notify-get- operation. The Printer SHOULD return the "notify-get-
interval" operation attribute in the Operation Attributes interval" operation attribute in the Operation Attributes
of the response, then the Notification Recipient SHOULD of the response, then the Notification Recipient SHOULD
wait for the number of seconds specified by the "notify- wait for the number of seconds specified by the "notify-
get-interval" operation attribute before performing this get-interval" operation attribute before performing this
operation again. If the "notify-get-interval" Operation operation again. If the "notify-get-interval" Operation
Attribute is not present, the Notification Recipient Attribute is not present, the Notification Recipient
SHOULD use the normal network back-off algorithms for SHOULD use the normal network back-off algorithms for
determining when to perform this operation again. determining when to perform this operation again.
skipping to change at page 17, line 7 skipping to change at page 16, line 5
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.
5.2.1 "notify-get-interval" (integer(0:MAX)) INTERNET-DRAFT IPP: The 'ippget' Delivery Method
5.2.1 notify-get-interval (integer(0:MAX))
The value of this operation attribute is the number of seconds The value of this operation attribute is the number of seconds
that the Notification Recipient SHOULD wait before trying the that the Notification Recipient SHOULD wait before trying the
Get-Notifications operation again. The Printer MUST return Get-Notifications operation again. The Printer MUST return
this operation attribute if: (1) it is too busy to return this operation attribute if: (1) it is too busy to return
events, (2) the Notification Recipient client did not request events, (2) the Notification Recipient client did not request
Event Wait Mode, or (3) the Printer is terminating Event Wait Event Wait Mode, or (3) the Printer is terminating Event Wait
Mode. The client MUST accept this attribute and SHOULD re- Mode. The client MUST accept this attribute and SHOULD re-
issue the Get-Notifications operation (with or without "notify- issue the Get-Notifications operation (with or without "notify-
wait" = 'true') the indicated number of seconds in the future wait" = 'true') the indicated number of seconds in the future
skipping to change at page 18, line 5 skipping to change at page 17, line 5
If the Printer wants to remain in Event Wait Mode, then the If the Printer wants to remain in Event Wait Mode, then the
Printer MUST NOT return this attribute in the response. Printer MUST NOT return this attribute in the response.
Here is a complete table of combinations of "notify-wait", Here is a complete table of combinations of "notify-wait",
"status-code", "notify-get-interval", and Event Notification "status-code", "notify-get-interval", and Event Notification
Attributes Groups for Get-Notification initial (Wait and No Attributes Groups for Get-Notification initial (Wait and No
Wait) Responses and subsequent Event Wait Mode Responses (which Wait) Responses and subsequent Event Wait Mode Responses (which
may be staying in Event Wait Mode or may be requesting the may be staying in Event Wait Mode or may be requesting the
Notification Recipient to leave Event Wait Mode): Notification Recipient to leave Event Wait Mode):
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
Table 2 - Combinations of "notify-wait", "status-code", and "notify- Table 2 - Combinations of "notify-wait", "status-code", and "notify-
get-interval" get-interval"
client sends: Printer Event client sends: Printer returns: Printer Event
returns: returns: Notification returns: Notification
"notify-wait" "status-code" "notify-get- Attribute "notify-wait" "status-code" "notify-get- Attribute
interval" Groups interval" Groups
1. 'successful- MUST return N maybe 1. 'false'* 'successful-ok' MUST return N maybe
'false'/omitte ok'
d
2. 'not-found' MUST NOT MUST NOT 2. 'false'* 'not-found' MUST NOT MUST NOT
'false'/omitte
d
3. 'busy' MUST return N MUST NOT 3. 'false'* 'busy' MUST return N MUST NOT
'false'/omitte
d
4. 'events- MUST NOT 'job- 4. 'false'* 'events- 'job-
'false'/omitte complete' completed' complete' MUST NOT completed'
d
5. 'true' 'successful- MUST NOT MUST 5. 'true' 'successful-ok' MUST NOT MUST
ok'
6. 'true' 'successful- MUST return N maybe 6. 'true' 'successful-ok' MUST return N maybe
ok'
7. 'true' 'not-found' MUST NOT MUST NOT 7. 'true' 'not-found' MUST NOT MUST NOT
8. 'true' 'busy' MUST return N MUST NOT 8. 'true' 'busy' MUST return N MUST NOT
9. 'true' 'events- MUST NOT 'job- 9. 'true' 'events- MUST NOT 'job-
complete' completed' or complete' completed' or
maybe other maybe other
* 'false' or client omits the "notify-wait" attribute.
Explanation: Explanation:
1-4: client does not request Event Wait Mode 1-4: client does not request Event Wait Mode
5-9: client requests Event Wait Mode 5-9: client requests Event Wait Mode
2,7: Subscription object not found, or was canceled earlier; 2,7: Subscription object not found, or was canceled earlier;
client should NOT try again. client should NOT try again.
3,8: server busy, tells client to try later; client should try 3,8: server busy, tells client to try later; client should try
again in N seconds. again in N seconds.
4: client polled after job completed, but before Event Life 4: client polled after job completed, but before Event Life
expired, and got the 'job-completed' event, so the client expired, and got the 'job-completed' event, so the client
shouldn't bother trying again; client should NOT try again shouldn't bother trying again; client should NOT try again
later. later.
5: Printer returns one or more Event Notifications and is OK 5: Printer returns one or more Event Notifications and is OK
to stay in Event Wait Mode; the client waits for more Event to stay in Event Wait Mode; the client waits for more Event
Notifications to be returned. Notifications to be returned.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
6: Printer wants to leave Event Wait mode. Can happen on the 6: Printer wants to leave Event Wait mode. Can happen on the
first response (with or without Event Notifications) or happen first response (with or without Event Notifications) or happen
on a subsequent response with or without Event Notifications; on a subsequent response with or without Event Notifications;
the client SHOULD try again in N seconds. the client SHOULD try again in N seconds.
9: Printer either (1) returns 'job-completed' event or (2) the 9: Printer either (1) returns 'job-completed' event or (2) the
Subscription Object was canceled by either a Cancel-Job or a Subscription Object was canceled by either a Cancel-Job or a
Per-Printer Subscription expired without being renewed. For Per-Printer Subscription expired without being renewed. For
case (1), at least one Event Notification MUST be returned, case (1), at least one Event Notification MUST be returned,
while for case (2), it is unlikely that any Event Notifications while for case (2), it is unlikely that any Event Notifications
are returned; the client should NOT try again. are returned; the client should NOT try again.
5.2.2 "printer-up-time" (integer(1:MAX)): 5.2.2 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. The attribute at the time the Printer sends this response. The
Printer MUST return this attribute. Because each Event Printer MUST return this attribute. Because each Event
Notification also contains the value of this attribute when the Notification also contains the value of this attribute when the
event occurred, the value of this attribute lets a Notification event occurred, the value of this attribute lets a Notification
Recipient know when each Event Notification occurred relative Recipient know when each Event Notification occurred relative
to the time of this response. to the time of this response.
5.2.3 "redirect-uri" (uri): 5.2.3 redirect-uri (uri)
The value of this attribute is the uri that the Notification The value of this attribute is the uri that the Notification
Recipient MUST use for a subsequent Get-Notifications Recipient MUST use for a subsequent Get-Notifications
operation. The Printer MAY support this attribute. This operation. The Printer MAY support this attribute. This
attribute MUST be returned in the Operation Attributes Group if attribute MUST be returned in the Operation Attributes Group if
and only if the Printer returns the 'redirection-other-site' and only if the Printer returns the 'redirection-other-site'
status code (see section 10.2). status code (see section 10.2).
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.
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 entire response is Group per matched Event Notification. The entire response is
considered a single Compound Event Notification (see [ipp- considered a single Compound Event Notification (see [ipp-
ntfy]). The matched Event Notifications are all un-expired ntfy]). The matched Event Notifications are all un-expired
Event Notification associated with the matched Subscription Event Notification associated with the matched Subscription
skipping to change at page 20, line 15 skipping to change at page 19, line 4
Unsupported Attributes. Unsupported Attributes.
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 entire response is Group per matched Event Notification. The entire response is
considered a single Compound Event Notification (see [ipp- considered a single Compound Event Notification (see [ipp-
ntfy]). The matched Event Notifications are all un-expired ntfy]). The matched Event Notifications are all un-expired
Event Notification associated with the matched Subscription Event Notification associated with the matched Subscription
Objects and MUST follow the "Event Notification Ordering" Objects and MUST follow the "Event Notification Ordering"
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
requirements for Event Notifications within a Compound Event requirements for Event Notifications within a Compound Event
Notification specified in [ipp-ntfy] section 9. In other Notification specified in [ipp-ntfy] section 9. In other
words, the Printer MUST order these Event Notification groups words, the Printer MUST order these Event Notification groups
in ascending time stamp (and sequence number) order for a in ascending time stamp (and sequence number) order for a
Subscription object. If Event Notifications for multiple Subscription object. If Event Notifications for multiple
Subscription objects are being returned, the Notification Subscription objects are being returned, the Notification
Events for the next Subscription object follow in ascending Events for the next Subscription object follow in ascending
time stamp order, etc. time stamp order, etc.
Each Event Notification Group MUST contain all of attributes Each Event Notification Group MUST contain all of attributes
skipping to change at page 21, line 5 skipping to change at page 20, line 5
ntfy] except that each cell in the "Sends" column is a "MUST". ntfy] except that each cell in the "Sends" column is a "MUST".
If more than one Event Notification is being returned and the If more than one Event Notification is being returned and the
status of each is not the same, then the Printer MUST return a status of each is not the same, then the Printer MUST return a
"notify-status-code" attribute in each Event Notification "notify-status-code" attribute in each Event Notification
Attributes group to indicate the differing status values. Attributes group to indicate the differing status values.
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 3. the attributes shown in Table 3.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
Table 3 - Attributes in Event Notification Content Table 3 - Attributes in Event Notification Content
Source Value Sends Source Source Value Sends Source
Object 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
skipping to change at page 22, line 5 skipping to change at page 21, line 5
* As specified in [ipp-ntfy] section 9, the value of the * As specified in [ipp-ntfy] section 9, the value of the
"printer-up-time" attribute sent in each Event Notification "printer-up-time" attribute sent in each Event Notification
MUST be the time at which the Event occurred, not the time at MUST be the time at which the Event occurred, not the time at
which the Event Notification was sent. which the Event Notification was sent.
** The Printer MUST send the "printer-current-time" attribute ** The Printer MUST send the "printer-current-time" attribute
if and only if it supports the "printer-current-time" attribute if and only if it supports the "printer-current-time" attribute
on the Printer object. on the Printer object.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
*** 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.
**** 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.
skipping to change at page 23, line 5 skipping to change at page 22, line 5
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 5. Events and Subscribed Events shown in Table 5.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
Table 5 - Combinations of Events and Subscribed Events for "job- Table 5 - 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'
skipping to change at page 23, line 40 skipping to change at page 22, line 42
6 Additional Information about Subscription Template Attributes 6 Additional Information about Subscription Template Attributes
The 'ippget' Delivery Method does not define any addition The 'ippget' Delivery Method does not define any addition
Subscription Template attributes. The 'ippget' Delivery Method has Subscription Template attributes. The 'ippget' Delivery Method has
the same conformance requirements for Subscription Template the same conformance requirements for Subscription Template
attributes as defined in [ipp-ntfy]. This section defines additional attributes as defined in [ipp-ntfy]. This section defines additional
information about Subscription Template attributes defined in [ipp- information about Subscription Template attributes defined in [ipp-
ntfy]. ntfy].
6.1 notify-recipient-uri (uri) 6.1 notify-pull-method (type2 keyword)
This section describes the syntax of the value of this attribute for This Subscription Template attribute identifies the Pull Delivery
the 'ippget' Delivery Method. The syntax for values of this Method to be used for the Subscription Object (see [ipp-ntfy]). In
attribute for other Delivery Method is defined in other Delivery order to support the 'ippget' Pull Delivery Method defined in this
Method Documents.
In order to support the 'ippget' Delivery Method and Protocol, the INTERNET-DRAFT IPP: The 'ippget' Delivery Method
Printer MUST support the following syntax:
The 'ippget://' URI scheme. The remainder of the URI indicates document, the Printer MUST support this attribute with the following
something unique about the Notification Recipient, such as its host keyword value:
name or host address (and optional path). However, the remainder
of the URI is not used by the Printer in any way. Its value MAY be 'ippget': indicates that the IPPGET Pull Delivery Method is to be
useful to Notification Recipients who are not the Subscription used for this Subscription Object.
Creation clients. See section 11 for a complete definition of the
syntax of the IPPGET URL.
7 Subscription Description Attributes 7 Subscription Description Attributes
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.
8 Additional Printer Description Attributes 8 Additional Printer Description Attributes
skipping to change at page 25, line 16 skipping to change at page 24, line 5
Subscription Object associated with the 'ippget' Delivery Subscription Object associated with the 'ippget' Delivery
Method, AND 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 such that the client is connected N Notifications operation such that the client is connected N
seconds after the Job Creation operation. seconds after the Job Creation operation.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
Then, if N is less than the value of this attribute, the client(s) 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. Note: The client MUST initiate the Get- in the Printer. Note: The client MUST initiate the Get-
Notifications a time that is sufficiently less that N seconds to Notifications a time that is sufficiently less that N seconds to
account for network latency so that it is connected to the Printer account for network latency so that it is connected to the Printer
before N seconds elapses. before N seconds elapses.
If a Printer supports the 'ippget' Delivery Method, it MUST keep If a Printer supports the 'ippget' Delivery Method, it MUST keep
'completed', 'canceled', or 'aborted' Job objects in the Job 'completed', 'canceled', or 'aborted' Job objects in the Job
Retention and/or Job History phases for at least as long as this Retention and/or Job History phases for at least as long as this
attribute's value. The Printer MAY retain jobs longer that this attribute's value. The Printer MAY retain jobs longer that this
value. See [RFC2911] section 4.3.7.1 and the discussion in [ipp- value. See [RFC2911] section 4.3.7.1 and the discussion in [ipp-
ntfy] 'job-completed' event) that explains that a Notification ntfy] 'job-completed' event) that explains that a Notification
Recipients can query the Job after receiving a 'job-completed' Event Recipients can query the Job after receiving a 'job-completed' Event
Notification in order to find out other information about the job Notification in order to find out other information about the job
that is 'completed', 'aborted', or 'canceled'. However, this that is 'completed', 'aborted', or 'canceled'. However, this
attribute has no effect on the Cancel-Subscription operation which attribute has no effect on the Cancel-Subscription operation which
deletes the Subscription object immediately, whether or not it deletes the Subscription object immediately, whether or not it
contain the 'ippget' scheme. Immediately thereafter, subsequent Get- contain the "notify-pull-method" attribute with the 'ippget' keyword
Notifications Responses MUST NOT contain Event Notifications value. Immediately thereafter, subsequent Get-Notifications
associated with the canceled Subscription object. Responses MUST NOT contain Event Notifications associated with the
canceled Subscription object.
9 New Values for Existing Printer Description Attributes 9 New Values for Existing Printer Description Attributes
This section defines additional values for existing Printer This section defines additional values for existing Printer
Description attributes defined in [ipp-ntfy]. Description attributes defined in [ipp-ntfy].
9.1 notify-schemes-supported (1setOf uriScheme) 9.1 notify-pull-method-supported (1setOf type2 keyword)
The following value for the "notify-schemes-supported" attribute is The following keyword value for the "notify-pull-method-supported"
added in order to support the new Delivery Method defined in this attribute is added in order to support the new Delivery Method
document: defined in this document:
'ippget' - The IPP Notification Delivery Method defined in this 'ippget' - The IPP Notification Pull Delivery Method defined in
document. this document.
9.2 operations-supported (1setOf type2 enum) 9.2 operations-supported (1setOf type2 enum)
Table 7 lists the "operation-id" value defined in order to support Table 7 lists the "operation-id" value defined in order to support
the new Get-Notifications operation defined in this document. the new Get-Notifications operation defined in this document.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
Table 7 - Operation-id assignments Table 7 - Operation-id assignments
Value Operation Name Value Operation Name
0x001C Get-Notifications 0x001C Get-Notifications
10 New Status Codes 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 in Group 1 or Group 3 to N.
10.1 successful-ok-events-complete (0x0007) 10.1 successful-ok-events-complete (0x0007)
The Printer MUST return the 'successful-ok-events-complete' status The Printer MUST return the 'successful-ok-events-complete' status
code to indicate when this Get-Notifications response is the last code to indicate when this Get-Notifications response is the last
response for a Subscription object, whether or not there are Event response for a Subscription object, whether or not there are Event
Notifications being returned. This condition occurs for Event Wait Notifications being returned. This condition occurs for Event Wait
Mode with Notification Recipients waiting for responses when the Mode with Notification Recipients waiting for responses when the
Subscription Object is: (1) canceled with a Cancel-Subscription Subscription Object is: (1) canceled with a Cancel-Subscription
operation, (2) deleted when the Per-Printer Subscription lease time operation, (2) deleted when the Per-Printer Subscription lease time
skipping to change at page 27, line 4 skipping to change at page 25, line 39
Subscription. This condition also occurs for a Get-Notifications Subscription. This condition also occurs for a Get-Notifications
request that a Notification Recipient makes after the job completes, request that a Notification Recipient makes after the job completes,
but before the Event Life expires. but before the Event Life expires.
10.2 redirection-other-site (0x0300) 10.2 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 "redirect-uri" operation Notifications operation and that the "redirect-uri" operation
attribute in the response contains the uri that the Notification attribute in the response contains the uri that the Notification
Recipient MUST use for performing the Get-Notifications operation. Recipient MUST use for performing the Get-Notifications operation.
If the client issues subsequent Get-Notifications operations, it MUST If the client issues subsequent Get-Notifications operations, it MUST
use the value of the "redirect-uri" operation attribute returned by use the value of the "redirect-uri" operation attribute returned by
the Printer as the target of the operation. the Printer as the target of the operation.
11 The IPPGET URL Scheme 11 Encoding and Transport
This section defines the 'ippget' URL and the conformance
requirements for using it.
11.1 The IPPGET URL Scheme Applicability and Intended Usage
This section is intended for use in registering the 'ippget' URL
scheme with IANA and fully conforms to the requirements in [RFC2717].
This document defines the 'ippget'" URL (Uniform Resource Locator)
scheme for specifying a unique identifier for an IPP Client which
implements the IPP Get-Notifications operation specified in this
document (see section 5).
ISSUE 02: How unique do we need now that the Printer doesn't use
anything but the scheme?
The intended usage of the 'ippget' URL scheme is COMMON.
11.2 The IPPGET URL Scheme Associated Port
None.
An 'ippget' URL behaves as a unique identifier for IPP Clients and is
NOT used to initiate any over-the-wire protocol associations.
See: IANA Port Numbers Registry [IANA-PORTREG].
11.3 The IPPGET URL Scheme Associated MIME Type
All IPP Get-Notifications operations (requests and responses) MUST be
conveyed in an 'application/ipp' MIME media type as registered in
[IANA-MT]. An 'ippget' URL MUST uniquely identify an IPP Client that
support this 'application/ipp' MIME media type.
See: IANA MIME Media Types Registry [IANA-MT].
11.4 The IPPGET URL Scheme Character Encoding
The 'ippget' URL scheme defined in this document is based on the ABNF
for the URI Generic Syntax [RFC2396] and further updated by [RFC2732]
and [RFC2373] (for IPv6 addresses in URLs). The 'ippget' URL scheme
is case-insensitive in the scheme and 'authority' part as in
[RFC2396]; however, the 'abs_path' part is case-sensitive, as in
[RFC2396]. Code points outside [US-ASCII] MUST be hex escaped by the
mechanism specified in [RFC2396].
11.5 The IPPGET URL Scheme Syntax in ABNF
This document is intended for use in registering the 'ippget' URL
scheme with IANA and fully conforms to the requirements in [RFC2717].
This document defines the 'ippget' URL (Uniform Resource Locator)
scheme for specifying a unique identifier for an IPP Client which
implements IPP 'Get-Notifications' operation specified in this
document.
The intended usage of the 'ippget' URL scheme is COMMON.
The value of an 'ippget' URI MUST NOT exceed 255 octets (see section
8.1), since the URI is for identification rather than for identifying
the location of a network resource. An IPP Printer MUST return the
'client-error-request-value-too-long' status code (see section
13.1.4.10 in [RFC2911]) when a URI received in a request is too long.
An 'ippget' URL MUST be represented in absolute form. Absolute URLs
always begin with a scheme name followed by a colon. For definitive
information on URL syntax and semantics, see "Uniform Resource
Identifiers (URI): Generic Syntax and Semantics" [RFC2396]. This
specification adopts the definitions of "authority", "abs_path",
"query", "reg_name", "server", "userinfo", and "hostport" from
[RFC2396], as updated by [RFC2732] and [RFC2373] (for IPv6 addresses
in URLs).
The 'ippget' URL scheme syntax in ABNF is as follows:
ippget_URL = "ippget:" "//" authority [ abs_path [ "?" query ]]
authority = server | reg_name
reg_name = 1*( unreserved | escaped | "$" | "," |
";" | ":" | "@" | "&" | "=" | "+" )
server = [ [ userinfo "@" ] hostport ]
userinfo = *( unreserved | escaped |
";" | ":" | "&" | "=" | "+" | "$" | "," )
hostport = host [ ":" port ]
abs_path = "/" path_segments
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
Client that will retrieve IPP event notifications via the IPP Get-
Notifications operation.
Note: The use of IP addresses in URLs SHOULD be avoided whenever
possible (see [RFC1900]).
11.5.1 IPPGET URL Examples
The following are examples of valid 'ippget' URLs for IPP Clients
(using DNS host names):
ippget://abc.com
ippget://abc.com/listener
ippget://bob@abc.com
ippget://bob@abc.com/listener/1232
Note: The use of IP addresses in URLs SHOULD be avoided whenever
possible (see [RFC1900]).
The IPP Client that creates the Subscription object and the
Notification Recipient have to agree on a unique IPPGET URL value in
order for the Get-Notifications operations to retrieve the proper
Event Notifications. Therefore, the choice of 'userinfo@hostport'
versus the simpler 'hostport' production in an 'ippget' URL may be
influenced by the intended usage.
If a given IPP Client creates an IPP Subscription object for event
notifications intended for retrieval by the same IPP Client, then the
simple 'hostport' production may be most appropriate. In this case,
the IPP Client and the Notification Recipient both know the
'hostport' of the client.
On the other hand, if a given IPP Client creates an IPP Subscription
object for event notifications intended for retrieval by a different
IPP Client, then the 'userinfo@hostport' production (using, for
example, the right-hand side of a 'mailto:' URL, see [RFC2368]) may
be most appropriate. For this case, a mail address serves as the
prior agreement on the IPPGET URL value between the IPP Client and
the Notification Recipient.
11.5.2 IPPGET URL Comparisons
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 defined
for HTTP URI comparisons in [RFC2616].
12 Encoding and Transport
This section defines the encoding and transport considerations for This section defines the encoding and transport considerations for
this Delivery Method based on [RFC2910]. this Delivery Method based on [RFC2910].
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
The encoding of a Get-Notifications Response is modeled the Get-Jobs The encoding of a Get-Notifications Response is modeled the Get-Jobs
Response (see [RFC2911]). In a Get-Notifications Response, each Response (see [RFC2911]). In a Get-Notifications Response, each
Event Notification Attributes Group MUST start with an 'event- Event Notification Attributes Group MUST start with an 'event-
notification-attributes-tag' (see the section "Encodings of notification-attributes-tag' (see the section "Encodings of
Additional Attribute Tags" in [ipp-ntfy]), and end with an 'end-of- Additional Attribute Tags" in [ipp-ntfy]), and end with an 'end-of-
attributes-tag'. In addition, for Event Wait Mode the multi- attributes-tag'. In addition, for Event Wait Mode the multi-
part/related is used to separate each multiple response (in time) to part/related is used to separate each multiple response (in time) to
a single Get-Notifications Request. a single Get-Notifications Request.
The Printer returns Get-Notification Response as follows: The Printer returns Get-Notification Response as follows:
skipping to change at page 31, line 17 skipping to change at page 27, line 4
later wishes to leave Event Wait Mode, the Printer MUST return later wishes to leave Event Wait Mode, the Printer MUST return
the "notify-get-interval" operation attribute (see section the "notify-get-interval" operation attribute (see section
5.2.1). The Printer returns the response as an application/ipp 5.2.1). The Printer returns the response as an application/ipp
part which MUST be inside an multi-part/related type. part which MUST be inside an multi-part/related type.
Note: All of the above is without either the Printer or the Note: All of the above is without either the Printer or the
Notification Recipient closing the connection. In fact, the Notification Recipient closing the connection. In fact, the
connection SHOULD remain open for any subsequent IPP operations. connection SHOULD remain open for any subsequent IPP operations.
However, either the Notification Recipient or the Printer can However, either the Notification Recipient or the Printer can
abnormally terminate by closing the connection. But, if the Printer abnormally terminate by closing the connection. But, if the Printer
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
closes the connection too soon after returning the response, the closes the connection too soon after returning the response, the
client may not receive the response. client may not receive the response.
The Printer MAY chunk the responses, but this has no significance to The Printer MAY chunk the responses, but this has no significance to
the IPP semantics. the IPP semantics.
Note: While HTTP/1.1 allows a proxy to collect chunked responses Note: While HTTP/1.1 allows a proxy to collect chunked responses
over a period of time and return them back as a single un-chunked over a period of time and return them back as a single un-chunked
response (with a Content Length instead). However, in practice no response (with a Content Length instead). However, in practice no
proxy wants to have an infinite buffer. Also no proxy want to hold proxy wants to have an infinite buffer. Also no proxy want to hold
skipping to change at page 31, line 39 skipping to change at page 27, line 29
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 the following [RFC2910] for the Get-Notifications operation with the following
extension allocated in [ipp-ntfy]: extension allocated in [ipp-ntfy]:
Table 8 - The "event-notification-attributes-tag" value Table 8 - The "event-notification-attributes-tag" value
Tag Value (Hex) Meaning Tag Value (Hex) Meaning
0x07 "event-notification-attributes-tag" 0x07 "event-notification-attributes-tag"
13 Conformance Requirements 12 Conformance Requirements
The 'ippget' Delivery Method is RECOMMEND for Printers to support. The 'ippget' Delivery Method is RECOMMEND for Printers to support.
13.1 Conformance for IPP Printers 12.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] for
a Pull Delivery Method;
2. MUST support the Get-Notifications operation defined in section 2. MUST support the Get-Notifications operation defined in section
5, including Event Wait Mode; 5, including Event Wait Mode;
3. MUST support the Subscription Template object attributes as 3. MUST support the Subscription Template object attributes as
defined in section 6; defined in section 6;
4. MUST support the Subscription Description object attributes as 4. MUST support the Subscription Description object attributes as
defined in section 7; defined in section 7;
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
5. MUST support the "ippget-event-life" Printer Description 5. MUST support the "ippget-event-life" Printer Description
attribute defined in section 8.1, including retaining jobs in attribute defined in section 8.1, including retaining jobs in
the Job Retention and/or Job History phases for at least as long the Job Retention and/or Job History phases for at least as long
as the value specified by the Printer's "ippget-event-life"; as the value specified by the Printer's "ippget-event-life";
6. MUST support the additional values for IPP/1.1 Printer 6. MUST support the additional values for IPP/1.1 Printer
Description attributes defined in section 9; Description attributes defined in section 9;
7. MUST support the 'successful-ok-events-complete' status code as 7. MUST support the 'successful-ok-events-complete' status code as
described in section 10.1; described in section 10.1;
skipping to change at page 32, line 38 skipping to change at page 28, line 29
10.2, if it redirects Get-Notifications operations; 10.2, if it redirects Get-Notifications operations;
9. MUST listen for the IPP Get-Notifications operation requests on 9. 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;
10. SHOULD NOT listen for IPP Get-Notifications operation requests 10. 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.
13.2 Conformance for IPP Clients 12.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 that 1.MUST create Subscription Objects containing the "notify-pull-
conform to the ABNF specified in section 11.5 of this document; method" attribute (as opposed to the "notify-recipient-uri"
attribute) using the 'ippget' keyword value;
2.;MUST send IPP Get-Notifications operation requests via the port 2.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;
3.MUST convert the associated 'ipp' URLs for use in IPP Get- 3.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 13 IANA Considerations
for IPP Clients; it is a non-conformant implementation error.
14 IANA Considerations
IANA shall register the 'ippget' URL scheme as defined in section 11 This section contains the exact information for IANA to add to the
according to the procedures of [RFC2717]. IPP Registries according to the procedures defined in RFC 2911
[RFC2911] section 6.
The rest of this section contains the exact information for IANA to INTERNET-DRAFT IPP: The 'ippget' Delivery Method
add to the IPP Registries according to the procedures defined in RFC
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.
14.1 Additional attribute value registrations for existing attributes 13.1 Additional attribute value registrations for existing attributes
This section lists additional attribute value registrations for use This section lists additional attribute value registrations for use
with existing attributes defined in other documents. with existing attributes defined in other documents.
14.1.1 Additional values for the "notify-schemes-supported" Printer 13.1.1 Additional values for the "notify-pull-method-supported" Printer
attribute attribute
The following table lists the uriScheme value defined in this The following table lists the keyword value defined in this document
document as an additional uriScheme value for use with the "notify- as an additional keyword value for use with the "notify-pull-method-
schemes-supported" Printer attribute defined in [ipp-ntfy]. This supported" Printer attribute defined in [ipp-ntfy]. This is to be
is to be registered according to the procedures in RFC 2911 [RFC2911] registered according to the procedures in RFC 2911 [RFC2911] section
section 6.1. 6.1.
uriScheme Attribute Values: Ref. Section: keyword Attribute Values: Ref. Section:
ippget RFC NNNN 9.1 ippget RFC NNNN 9.1
The resulting URI scheme attribute value registrations will be
The resulting keyword method attribute value registrations will be
published in the published in the
ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attribute- ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attribute-
values/notify-schemes-supported/ values/notify-pull-method-supported/
area. area.
14.1.2 Additional values for the "operations-supported" Printer 13.1.2 Additional values for the "operations-supported" Printer
attribute attribute
The following table lists the enum attribute value defined in this The following table lists the enum attribute value defined in this
document as an additional type2 enum value for use with the document as an additional type2 enum value for use with the
"operations-supported" Printer attribute defined in [RFC2911]. This "operations-supported" Printer attribute defined in [RFC2911]. This
is to be registered according to the procedures in RFC 2911 [RFC2911] is to be registered according to the procedures in RFC 2911 [RFC2911]
section 6.1. section 6.1.
type2 enum Attribute Values: Value Ref. Section: type2 enum Attribute Values: Value Ref. Section:
Get-Notifications 0x001C RFC NNNN 9.2 Get-Notifications 0x001C RFC NNNN 9.2
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
The resulting enum attribute value registration will be published in The resulting enum attribute value registration will be published in
the the
ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attribute- ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attribute-
values/operations-supported/ values/operations-supported/
area. area.
14.2 Operation Registrations 13.2 Operation Registrations
The following table lists the operation defined in this document. The following table lists the operation defined in this document.
This is to be registered according to the procedures in RFC 2911 This is to be registered according to the procedures in RFC 2911
[RFC2911] section 6.4. [RFC2911] section 6.4.
Operations: Ref. Section: Operations: Ref. Section:
Get-Notifications operation RFC NNNN 5 Get-Notifications operation RFC NNNN 5
The resulting operation registration will be published in the The resulting operation registration will be published in the
ftp://ftp.iana.org/in-notes/iana/assignments/ipp/operations/ ftp://ftp.iana.org/in-notes/iana/assignments/ipp/operations/
area. area.
14.3 Attribute Registrations 13.3 Attribute Registrations
The following table lists the attribute defined in this document. The following table lists the attribute defined in this document.
This is to be registered according to the procedures in RFC 2911 This is to be registered according to the procedures in RFC 2911
[RFC2911] section 6.2. [RFC2911] section 6.2.
Printer Description attributes: Ref. Section: Printer Description attributes: Ref. Section:
ippget-event-life (integer(15:MAX)) RFC NNNN 8.1 ippget-event-life (integer(15:MAX)) RFC NNNN 8.1
The resulting attribute registration will be published in the The resulting attribute registration will be published in the
ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attributes/ ftp://ftp.iana.org/in-notes/iana/assignments/ipp/attributes/
area. area.
14.4 Status code Registrations 13.4 Status code Registrations
The following table lists the status code defined in this document. The following table lists the status code defined in this document.
This is to be registered according to the procedures in RFC 2911 This is to be registered according to the procedures in RFC 2911
[RFC2911] section 6.6. [RFC2911] section 6.6.
Status codes: Ref. Section: Status codes: Ref. Section:
successful-ok-events-complete (0x0007) RFC NNNN 10.1 successful-ok-events-complete (0x0007) RFC NNNN 10.1
redirection-other-site (0x0300) RFC NNNN 10.2 redirection-other-site (0x0300) RFC NNNN 10.2
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
The resulting status code registration will be published in the The resulting status code registration will be published in the
ftp://ftp.iana.org/in-notes/iana/assignments/ipp/status-codes/ ftp://ftp.iana.org/in-notes/iana/assignments/ipp/status-codes/
area. area.
15 Internationalization Considerations 14 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.
16 Security Considerations 15 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.
skipping to change at page 36, line 19 skipping to change at page 31, line 44
this document, the Notification Recipient is the client who initiates this document, the Notification Recipient is the client who initiates
the Get-Notifications operation. Therefore, there is no chance of the Get-Notifications operation. Therefore, there is no chance of
"spam" notifications with this method. Furthermore, such a client "spam" notifications with this method. Furthermore, such a client
can close down the HTTP channel at any time, and so can avoid future can close down the HTTP channel at any time, and so can avoid future
unwanted Event Notifications at any time. unwanted Event Notifications at any time.
Because the Get-Notifications operation is sent in the same direction Because the Get-Notifications operation is sent in the same direction
as Job Creation operations, this Event Notification Delivery Method as Job Creation operations, this Event Notification Delivery Method
poses no additional firewall or port assignment issues. poses no additional firewall or port assignment issues.
17 References 16 References
[IANA-MT]
IANA Registry of Media Types: ftp://ftp.iana.orgisi.edu/in-
notes/iana/assignments/media-types/
[IANA-PORTREG]
IANA Port Numbers Registry. ftp://ftp.isi.edu/in-
notes/iana/assignments/port-numbers
[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-03.txt, work in progress, July 17, 2001 guide-v11-03.txt, work in progress, July 17, 2001
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
[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 Notifications and Subscriptions", <draft-ietf-ipp-not-spec- Event Notifications and Subscriptions", <draft-ietf-ipp-not-spec-
07.txt>, August 20, 2001. 08.txt>, November 19, 2001.
[RFC1900]
B. Carpenter, Y. Rekhter. Renumbering Needs Work, RFC 1900,
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]
S. Bradner, "Key words for use in RFCs to Indicate Requirement S. Bradner, "Key words for use in RFCs to Indicate Requirement
Levels", RFC 2119 , March 1997 Levels", RFC 2119 , March 1997
[RFC2368]
P. Hoffman, L. Masinter, J. Zawinski. The "mailto" URL Scheme, RFC
2368, July 1998.
[RFC2373]
R. Hinden, S. Deering. IP Version 6 Addressing Architecture, RFC
2373, July 1998.
[RFC2396]
Berners-Lee, T. et al. Uniform Resource Identifiers (URI): Generic
Syntax, RFC 2396, August 1998
[RFC2565] [RFC2565]
Herriot, R., Butler, S., Moore, P., and R. Turner, "Internet Herriot, R., Butler, S., Moore, P., and R. Turner, "Internet
Printing Protocol/1.0: Encoding and Transport", RFC 2565, April Printing Protocol/1.0: Encoding and Transport", RFC 2565, April
1999. 1999.
[RFC2566] [RFC2566]
R. deBry, T. Hastings, R. Herriot, S. Isaacson, and P. Powell, R. deBry, T. Hastings, R. Herriot, S. Isaacson, and P. Powell,
"Internet Printing Protocol/1.0: Model and Semantics", RFC 2566, "Internet Printing Protocol/1.0: Model and Semantics", RFC 2566,
April 1999. April 1999.
skipping to change at page 37, line 47 skipping to change at page 32, line 52
[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.
[RFC2707] [RFC2707]
Bergman, R., Hastings, T., Isaacson, S., and H. Lewis, "Job Bergman, R., Hastings, T., Isaacson, S., and H. Lewis, "Job
Monitoring MIB - V1.0", November 1999. Monitoring MIB - V1.0", November 1999.
[RFC2717]
R. Petke and I. King, "Registration Procedures for URL Scheme
Names", RFC 2717, November 1999.
[RFC2732]
R. Hinden, B. Carpenter, L. Masinter. Format for Literal IPv6
Addresses in URL's, RFC 2732, December 1999.
[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.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
[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.
18 Authors' Addresses 17 Authors' Addresses
Robert Herriot Robert Herriot
Xerox Corp. 706 Colorado Ave.
3400 Hill View Ave, Building 1 Palo Alto, CA 94303
Palo Alto, CA 94304
Phone: 650-813-7696 Phone: 650-327-4466
Fax: 650-813-6860 Fax: 650-327-4466
e-mail: robert.herriot@pahv.xerox.com email: bob@herriot.com
Thomas N. Hastings
Xerox Corporation
737 Hawaii St. ESAE 231
El Segundo CA 90245
Phone: 310-333-6413
Fax: 310-333-5514
email: hastings@cp10.es.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
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
IPP Web Page: http://www.pwg.org/ipp/ IPP Web Page: http://www.pwg.org/ipp/
IPP Mailing List: ipp@pwg.org IPP Mailing List: ipp@pwg.org
To subscribe to the ipp mailing list, send the following email: To subscribe to the ipp mailing list, send the following email:
1) send it to majordomo@pwg.org 1) send it to majordomo@pwg.org
2) leave the subject line blank 2) leave the subject line blank
3) put the following two lines in the message body: 3) put the following two lines in the message body:
subscribe ipp subscribe ipp
end end
Implementers of this specification document are encouraged to join Implementers of this specification document are encouraged to join
the IPP Mailing List in order to participate in any discussions of the IPP Mailing List in order to participate in any discussions of
clarification issues and review of registration proposals for clarification issues and review of registration proposals for
additional attributes and values. In order to reduce spam the additional attributes and values. In order to reduce spam the
mailing list rejects mail from non-subscribers, so you must subscribe 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 to the mailing list in order to send a question or comment to the
mailing list. mailing list.
19 Description of Base IPP documents 18 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]
skipping to change at page 40, line 5 skipping to change at page 35, line 5
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.
The "Rationale for the Structure and Model and Protocol for the The "Rationale for the Structure and Model and Protocol for the
Internet Printing Protocol" document describes IPP from a high level Internet Printing Protocol" document describes IPP from a high level
view, defines a roadmap for the various documents that form the suite view, defines a roadmap for the various documents that form the suite
of IPP specification documents, and gives background and rationale of IPP specification documents, and gives background and rationale
for the IETF working group's major decisions. for the IETF working group's major decisions.
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
The "Internet Printing Protocol/1.1: Model and Semantics" document The "Internet Printing Protocol/1.1: Model and Semantics" document
describes a simplified model with abstract objects, their attributes, describes a simplified model with abstract objects, their attributes,
and their operations that are independent of encoding and transport. and their operations that are independent of encoding and transport.
It introduces a Printer and a Job object. The Job object optionally It introduces a Printer and a Job object. The Job object optionally
supports multiple documents per Job. It also addresses security, supports multiple documents per Job. It also addresses security,
internationalization, and directory issues. internationalization, and directory issues.
The "Internet Printing Protocol/1.1: Encoding and Transport" document The "Internet Printing Protocol/1.1: Encoding and Transport" document
is a formal mapping of the abstract operations and attributes defined is a formal mapping of the abstract operations and attributes defined
in the model document onto HTTP/1.1 [RFC2616]. It defines the in the model document onto HTTP/1.1 [RFC2616]. It defines the
encoding rules for a new Internet MIME media type called encoding rules for a new Internet MIME media type called
"application/ipp". This document also defines the rules for "application/ipp". This document also defines the rules for
transporting over HTTP a message body whose Content-Type is transporting over HTTP a message body whose Content-Type is
"application/ipp". This document defines the 'ippget' scheme for "application/ipp". This document defines the 'ipp' scheme for
identifying IPP printers and jobs. identifying IPP printers and jobs.
The "Internet Printing Protocol/1.1: Implementer's Guide" document The "Internet Printing Protocol/1.1: Implementer's Guide" document
gives insight and advice to implementers of IPP clients and IPP gives insight and advice to implementers of IPP clients and IPP
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.
skipping to change at page 40, line 41 skipping to change at page 35, line 43
Daemon) implementations. Daemon) implementations.
The "IPP Event Notifications and Subscriptions" 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.
20 Full Copyright Statement 19 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
INTERNET-DRAFT IPP: The 'ippget' Delivery Method
the copyright notice or references to the Internet Society or other the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of Internet organizations, except as needed for the purpose of
developing Internet standards in which case the procedures for developing Internet standards in which case the procedures for
copyrights defined in the Internet Standards process must be copyrights defined in the Internet Standards process must be
followed, or as required to translate it into languages other than followed, or as required to translate it into languages other than
English. English.
The limited permissions granted above are perpetual and will not be The limited permissions granted above are perpetual and will not be
revoked by the Internet Society or its successors or assigns. revoked by the Internet Society or its successors or assigns.
 End of changes. 

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