draft-ietf-ipp-indp-method-00.txt   draft-ietf-ipp-indp-method-01.txt 
INTERNET-DRAFT INTERNET-DRAFT There are 4 issues
<draft-ietf-ipp-indp-method-00.txt> <draft-ietf-ipp-indp-method-01.txt>
Hugo Parra Hugo Parra
Novell, Inc. Novell, Inc.
Tom Hastings Tom Hastings
Xerox Corp. Xerox Corp.
March 9, 2000 July 6, 2000
Internet Printing Protocol (IPP): Internet Printing Protocol (IPP):
The INDP Notification Delivery Method The 'indp' Notification Delivery Method
Copyright (C) The Internet Society (2000). All Rights Reserved. Copyright (C) The Internet Society (2000). All Rights Reserved.
Status of this Memo Status of this Memo
This document is an Internet-Draft and is in full conformance with all This document is an Internet-Draft and is in full conformance with all
provisions of Section 10 of [rfc2026]. Internet-Drafts are working provisions of Section 10 of [rfc2026]. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas, and documents of the Internet Engineering Task Force (IETF), its areas, and
its working groups. Note that other groups may also distribute working its working groups. Note that other groups may also distribute working
documents as Internet-Drafts. documents as Internet-Drafts.
skipping to change at page 1, line 38 skipping to change at page 1, line 38
or to cite them other than as "work in progress". or to cite them other than as "work in progress".
The list of current Internet-Drafts can be accessed at The list of current Internet-Drafts can be accessed at
http://www.ietf.org/ietf/1id-abstracts.txt http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed as The list of Internet-Draft Shadow Directories can be accessed as
http://www.ietf.org/shadow.html. http://www.ietf.org/shadow.html.
Abstract Abstract
The IPP event notification specification [ipp-ntfy] is an OPTIONAL The IPP Event Notification specification [ipp-ntfy] is an OPTIONAL
extension to IPP/1.0, IPP/1.1, and future versions. [ipp-ntfy] requires extension to IPP/1.0, IPP/1.1, and future versions. [ipp-ntfy] requires
the definition of one or more delivery methods for dispatching the definition of one or more Delivery Methods in separate Delivery
Notifications to Notification Recipients. This document describes the Method Documents for the Printer to dispatch Event Notifications to
semantics and syntax of the INDP Notification Delivery Method that is Notification Recipients. This Delivery Method Document defines the
itself a request/response protocol. For this delivery method, an IPP semantics and syntax of the 'indp' Notification Delivery Method. For
Printer sends (pushes) IPP event Notifications to the Notification this Delivery Method, an IPP Printer sends (pushes) an IPP Event
Recipients using the IPP Notification Delivery Protocol (INDP) defined Notifications request to the Notification Recipients using the Send-
in [indp]. The Notification Recipient can either be the Ultimate Notifications operation defined in this document. The Notification
Recipient of the Notification or can be a Notification Service that Recipient returns a response to the Printer. The Send-Notifications
forwards the Notification to the Ultimate Recipient. operation uses the same Encoding and Transport as IPP itself.
Expires: Sep 9, 2000 Expires: January 6, 2001
The full set of IPP documents includes: The full 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 (this document) Internet Printing Protocol/1.1: Model and Semantics [ipp-mod]
Internet Printing Protocol/1.1: Encoding and Transport [ipp-pro] Internet Printing Protocol/1.1: Encoding and Transport [ipp-pro]
Internet Printing Protocol/1.1: Implementer's Guide [ipp-iig] Internet Printing Protocol/1.1: Implementer's Guide [ipp-iig]
Mapping between LPD and IPP Protocols [RFC2569] Mapping between LPD and IPP Protocols [RFC2569]
Internet Printing Protocol (IPP): IPP Event Notification
Specification [ipp-ntfy]
The "Design Goals for an Internet Printing Protocol" document takes a The "Design Goals for an Internet Printing Protocol" document takes a
broad look at distributed printing functionality, and it enumerates broad look at distributed printing functionality, and it enumerates
real-life scenarios that help to clarify the features that need to be real-life scenarios that help to clarify the features that need to be
included in a printing protocol for the Internet. It identifies included in a printing protocol for the Internet. It identifies
requirements for three types of users: end users, operators, and requirements for three types of users: end users, operators, and
administrators. It calls out a subset of end user requirements that are administrators. It calls out a subset of end user requirements that are
satisfied in IPP/1.0. A few OPTIONAL operator operations have been satisfied in IPP/1.0. A few OPTIONAL operator operations have been
added to IPP/1.1. added to IPP/1.1.
skipping to change at page 3, line 5 skipping to change at page 2, line 54
is intended to help them understand IPP/1.1 and some of the is intended to help them understand IPP/1.1 and some of the
considerations that may assist them in the design of their client and/or considerations that may assist them in the design of their client and/or
IPP object implementations. For example, a typical order of processing IPP object implementations. For example, a typical order of processing
requests is given, including error checking. Motivation for some of the requests is given, including error checking. Motivation for some of the
specification decisions is also included. specification decisions is also included.
The "Mapping between LPD and IPP Protocols" document gives some advice The "Mapping between LPD and IPP Protocols" document gives some advice
to implementers of gateways between IPP and LPD (Line Printer Daemon) to implementers of gateways between IPP and LPD (Line Printer Daemon)
implementations. implementations.
Expires: Sep 9, 2000 The "Internet Printing Protocol (IPP): IPP Event Notification
Specification" document defines the semantics for Subscription Creation
Operations and the requirements for other Delivery Method documents to
define a Delivery Method to carry an Event Notifications to a
Notification Recipient.
Expires: January 6, 2001
Table of Contents Table of Contents
1 Introduction ......................................................4 1 Introduction......................................................5
2 Terminology .......................................................4 2 Terminology.......................................................5
3 Model and Operation ...............................................4 3 Model and Operation...............................................5
4 Notification Operations ...........................................5 4 Summary of the 'indp' Delivery Method.............................6
4.1 SEND-NOTIFICATIONS OPERATION.....................................6
4.1.1 Send-Notifications Request ..................................6
4.1.2 Send-Notifications Response .................................7
4.2 NOTIFICATION PROTOCOL URI SCHEME.................................8
5 Encoding of the Operation Layer ...................................9 5 Subscription object attributes....................................8
5.1SUBSCRIPTION TEMPLATE ATTRIBUTE CONFORMANCE......................8
5.2SUBSCRIPTION DESCRIPTION ATTRIBUTE CONFORMANCE...................8
6 Encoding of Transport Layer .......................................9 6 Printer Description Attribute Conformance.........................9
7 IANA Considerations ...............................................9 7 New Values for Existing Printer Description Attributes............9
7.1NOTIFY-SCHEMES-SUPPORTED (1SETOF URISCHEME)......................9
7.2OPERATIONS-SUPPORTED (1SETOF TYPE2 ENUM).........................9
0X001D..............................................................9
8 Internationalization Considerations ...............................9 8 Attributes Only in Event Notifications............................9
9 Security Considerations ...........................................9 9 Operations for Notification.......................................9
9.1 SECURITY CONFORMANCE............................................10 9.1SEND-NOTIFICATIONS OPERATION....................................10
9.1.1 Send-Notifications Request.................................10
9.1.2 Send-Notifications Response................................13
9.2NOTIFICATION PROTOCOL URI SCHEME................................14
10 References .......................................................10 10 Status Codes.....................................................15
10.1 ADDITIONAL STATUS CODES.......................................15
10.1.1 successful-ok-ignored-notifications (0x0004)..............15
10.2 STATUS CODES RETURNED IN EVENT NOTIFICATION ATTRIBUTES GROUPS.15
10.2.1 client-error-not-found (0x0406)...........................15
10.2.2 successful-ok-but-cancel-subscription (0x0006)............16
11 Author's Addresses ...............................................11 11 Encoding and Transport...........................................16
11.1 ENCODING OF THE OPERATION LAYER...............................16
11.2 ENCODING OF TRANSPORT LAYER...................................16
12 Full Copyright Statement .........................................11 12 IANA Considerations..............................................16
Expires: Sep 9, 2000 13 Internationalization Considerations..............................16
14 Security Considerations..........................................17
14.1 SECURITY CONFORMANCE..........................................17
15 References.......................................................17
16 Author's Addresses...............................................18
Expires: January 6, 2001
17 Full Copyright Statement.........................................18
Tables
Table 1 - Summary of the 'indp' Delivery Method.......................6
Table 2 . Operation-id assignments....................................9
Table 3 . Attributes in Event Notification Content...................11
Table 4 . Additional Attributes in Event Notification Content for Job
Events............................................................12
Table 5 . Combinations of Events and Subscribed Events for .job-
impressions-completed............................................13
Table 6 . Additional Attributes in Event Notification Content for
Printer Events...................................................13
Expires: January 6, 2001
1 Introduction 1 Introduction
An IPP Printer that supports the OPTIONAL IPP event notification The notification extension document [ipp-ntfy] defines operations that a
extension [ipp-ntfy] is called a Notification Source which sends event client can perform in order to create Subscription Objects in a Printer
Notifications to Notification Recipients. As such, a Printer either a) and carry out other operations on them. A Subscription Object represents
accepts, stores, and uses notification Subscription objects to generate a Subscription abstraction. The Subscription Object specifies that when
event Notification and implements one or more delivery methods for one of the specified Events occurs, the Printer sends an asynchronous
notifying interested parties, or b) supports a subset of these tasks and Event Notification to the specified Notification Recipient via the
farms out the remaining tasks to a Notification Delivery Service. The specified Delivery Method (i.e., protocol).
INDP Notification Delivery Method specified in this document employs a
request/response protocol, which is a subset of the IPP Notification The notification extension document [ipp-ntfy] specifies that each
Delivery Protocol (INDP), defined in [indp]. A Notification Source may Delivery Method is defined in another document. This document is one
implement the INDP Notification Delivery Method to send (push) event such document, and it specifies the .indp. Delivery Method.
notifications to Notification Recipients using the INDP Send-
Notifications operation (see section 4.1) over HTTP. For the .indp. Delivery Method, an IPP Printer sends (pushes) a Send-
Notifications operation request containing one or more Event
Notifications to a Notification Recipient. The Notification Recipient
returns a response to the Printer. The Send-Notifications operation
uses the same Encoding and Transport as IPP itself.
2 Terminology 2 Terminology
This document uses terms such as "attributes", "keywords", and This document uses terms such as "attributes", "keywords", and
"support". These terms have special meaning and are defined in the "support". These terms have special meaning and are defined in the
model terminology [ipp-mod] section 12.2. model terminology [ipp-mod] section 12.2.
Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT,
MAY, NEED NOT, and OPTIONAL, have special meaning relating to MAY, NEED NOT, and OPTIONAL, have special meaning relating to
conformance. These terms are defined in [ipp-mod] section 12.1 on conformance. These terms are defined in [ipp-mod] section 12.1 on
conformance terminology, most of which is taken from RFC 2119 [RFC2119]. conformance terminology, most of which is taken from RFC 2119 [RFC2119].
This document uses the capitalized terms, such as Notification
Recipient, Event Notification, Printer, etc., that are defined in [ipp-
ntfy] with the same meanings and are not reproduced here.
This section defines the following additional terms that are used This section defines the following additional terms that are used
throughout this document: throughout this document:
REQUIRED: if an implementation supports the extensions described in Event Notification Attributes Group . The attributes group in a
this document, it MUST support a REQUIRED feature. request that contains Event Notification Attributes in a request or
OPTIONAL: if an implementation supports the extensions described in response.
this document, it MAY support an OPTIONAL feature.
Event Notification (Notification for short) - See [ip-ntfy]
Notification Source - See [ipp-ntfy]
Notification Recipient - See [ipp-ntfy]
Subscription object - See [ipp-ntfy]
Ultimate Notification Recipient - See [ipp-ntfy]
3 Model and Operation 3 Model and Operation
In the IPP Notification Model [ipp-ntfy], a client is able to: See [ipp-ntfy] for the description of the Event Notification Model and
Operation. This Delivery Method takes advantage of combining several
Event Notifications into a single Compound Event Notification that is
delivery by a single Send-Notification operation to a single
Notification Recipient.
Expires: Sep 9, 2000 Expires: January 6, 2001
1.supply one or more Per-Job Subscriptions in the Job Creation When creating each Subscription object, the client supplies the "notify-
operation recipient" (uri) Subscription Template attribute. The "notify-
recipient" attribute specifies both a single Notification Recipient that
is to receive the Notifications when subsequent events occur and the
method for notification delivery that the IPP Printer is to use. For
the Notification Delivery Method defined in this document, the
notification method is 'indp' and the rest of the URI is the address of
the Notification Recipient to which the IPP Printer will send the Send-
Notifications operation.
2.OPTIONALLY supply Per-Job Subscriptions as subsequent Create-Job- The 'indp' Notification Delivery Method defined in this document uses a
Subscription operations client/server protocol paradigm. The "client" in this relationship is
the Printer described in [ipp-ntfy] while the "server" is the
Notification Recipient. The Printer invokes the Send-Notifications
operation to communicate IPP Event Notification contents to the
Notification Recipient. The Notification Recipient only conveys
information to the Printer in the form of responses to the operations
initiated by the Printer.
3.Supply one Per-Printer Subscription in the Create-Printer- Printers that implement the 'indp' Notification Delivery Method will
Subscription operation. need to include an HTTP client stack while Notification Recipients that
implement this Delivery Method will need to support an HTTP server
stack. See section 11.2 for more details.
The client that creates these Subscription objects becomes the owner of 4 Summary of the 'indp' Delivery Method
the Subscription object.
When creating each Subscription object, the client supplies the "notify- Column 1 of Table 1 lists the conformance requirements for Delivery
recipient" (uri) attribute. The "notify-recipient" attribute specifies Method Documents as specified in [ipp-ntfy]. Column 2 indicates how
both a single Notification Recipient that is to receive the this Delivery Method Document meets each requirement:
Notifications when subsequent events occur and the method for
notification delivery that the IPP Printer is to use. For the
Notification delivery method defined in this document, the notification
method is 'indp' and the rest of the URI is the address of the
Notification Recipient to which the IPP Printer will send the INDP Send-
Notifications operation.
The INDP Notification Delivery Method defined in this document also uses Table 1 - Summary of the 'indp' Delivery Method
a client/server protocol paradigm. The "client" in this HTTP
relationship is the Notification Source described in [ipp-ntfy] while
the "server" is the Notification Recipient. The Notification Source
invokes the Send-Notifications operation supported in INDP to
communicate IPP event Notification contents to the Notification
Recipient. The Notification Recipient only conveys information to the
Notification Source in the form of responses to the operations initiated
by the Notification Source.
Notification Sources that implement the INDP Notification Delivery Document Method conformance 'indp' realization
Method will need to include an INDP client stack (and hence an HTTP requirement
client stack) while notification recipients that implement this delivery
method will need to support an INDP server stack (and hence an HTTP
server stack). See section 6 for more details.
4 Notification Operations 1.MUST define a URL scheme indp
name for the Delivery Method.
The Notification Source composes the information defined for an IPP 2.MUST indicate whether the OPTIONAL
Notification [ipp-ntfy] and sends it using the Sent-Notifications delivery method is REQUIRED or
operation to the Notification Recipient supplied in the Subscription OPTIONAL for an IPP Printer to
object. support if it supports Event
Notification.
Expires: Sep 9, 2000 3.MUST define the transport a complete HTTP stack [rfc2616]
and delivery protocol for the
Event Notification content that
a Printer MUST use, i.e., the
entire network stack.
INDP makes extensive use of the operations model defined by IPP 4.MUST indicate whether or not yes, see section 9.1.1
[rfc2566]. This includes, the use of a URI as the identifier for the several Event Notifications can
target of each operation, the inclusion of a version number, operation-
id, and request-id in each request, and the definition of attribute
groups. The Send-Notifications operation uses the Operation Attributes
group, but currently has no need for the Unsupported Attributes, Printer
Object Attributes, and Job-Object Attributes groups. However, it uses a
new attribute group, the Notification Attributes group (see [indp]).
4.1 Send-Notifications Operation Expires: January 6, 2001
This REQUIRED operation allows a Notification Source to send one or more Document Method conformance 'indp' realization
Notifications to a Notification Recipient using HTTP. The operation has requirement
been tailored to accommodate the current definition of IPP Notification
[ipp-ntfy].
Both Machine-Consumable and Human-Consumable notifications may be sent be combined into a compound
to a Notification Recipient through this operation. Event Notification.
4.1.1 Send-Notifications Request 5.MUST describe how the initiated by the Printer (push)
Delivery Method is initiated,
i.e., is it initiated by the
receiving user (pull), or is it
initiated by the Printer
(push).
Every operation request contains the following REQUIRED parameters (see 6.MUST indicate whether the Machine Consumable with the
Delivery Method is Machine "notify-text" attribute being
Consumable or Human Consumable. Human Consumable
7.MUST define the The representation and encoding
representation and encoding is the same as IPP. See
that a Printer MUST use for section 9.1.1
each value or piece of
information listed in [ipp-
ntfy] section 9 (9.1 for
Machine Consumable Event
Notification and/or section 9.2
for Human Consumable Event
Notification).
8.MUST specify for each See the Send-Notifications
attribute in [ipp-ntfy] section Request defined in section
9 whether a Printer MUST, 9.1.1
SHOULD, MAY, MUST NOT, SHOULD
NOT or NEED NOT send the
attribute in an Event
Notification content.
9.MUST define what frequently Frequently occurring Events
occurring Events MUST be NEED NOT be moderated because
moderated, if any, and whether the Delivery Method is an
the moderation mechanism is efficient one and because the
configurable. Also whether Printer can group multiple
Events are moderated by sending Event Notifications for the
one per time unit or one per same Notification Recipient
number of Events. into a single Send-
Notifications operations.
10. MUST discuss the latency Same as for IPP/1.0 or IPP/1.1
and reliability of the itself (see [ipp-mod]).
transport and delivery
protocol.
11. MUST discuss the security See section 14
aspects of the transport and
Expires: January 6, 2001
Document Method conformance 'indp' realization
requirement
delivery protocol, e.g., how it
is handled in firewalls.
12. MUST identify content They are the same as for
length restrictions, if any. IPP/1.0 and IPP/1.1 itself (see
[ipp-mod]).
13. MAY define additional A new Event Notifications
values or pieces of information attribute group (see section
that a Printer MUST, SHOULD or 11.1) and additional status
MAY send in a Notification codes for use in the response
content. (see section 10)
14. MAY define additional none defined
Subscription Template and/or
Subscription Description
attributes and the conformance
requirements thereof.
15. MAY define additional none defined
Printer Description attributes
and the conformance
requirements thereof.
The remaining sections of this document parallel the sections of [ipp-
ntfy].
5 Subscription object attributes
This section defines the Subscription object conformance requirements
for Printers.
5.1 Subscription Template Attribute Conformance
The 'indp' Delivery Method has the same conformance requirements for
Subscription Template attributes as defined in [ipp-ntfy]. The 'indp'
Delivery Method does not define any addition Subscription Template
attributes.
5.2 Subscription Description Attribute Conformance
The 'indp' Delivery Method has the same conformance requirements for
Subscription Description attributes as defined in [ipp-ntfy]. The
'indp' Delivery Method does not define any addition Subscription
Description attributes.
Expires: January 6, 2001
6 Printer Description Attribute Conformance
The 'indp' Delivery Method has the same conformance requirements for
Printer Description attributes as defined in [ipp-ntfy]. The 'indp'
Delivery Method does not define any addition Printer Description
attributes.
7 New Values for Existing Printer Description Attributes
This section defines additional values for existing Printer Description
attributes.
7.1 notify-schemes-supported (1setOf uriScheme)
The following .notify-schemes-supported. value is added in order to
support the new Delivery Method defined in this document:
'indp': - The IPP Notification Delivery Method defined in this
document.
7.2 operations-supported (1setOf type2 enum)
Table 2 lists the .operation-id. value added in order to support the new
operation defined in this document. The operation-id is assigned in the
same name space as other operations that a Printer supports. However, a
Printer MUST NOT include this value in its "operations-supported"
attribute unless it can accept the Send-Notifications request.
Table 2 . Operation-id assignments
Value Operation Name
0x001D Send-Notifications
8 Attributes Only in Event Notifications
No additional attributes are defined only for use in Event Notifications
besides those defined in [ipp-ntfy].
9 Operations for Notification
This section defines the operation for Event Notification using the
'indp' Delivery Method.
There is only one operation defined: Send-Notifications. Section 7.2
assigns of the .operation-id. for the Send-Notifications operation and
the following section defined the operation.
Expires: January 6, 2001
9.1 Send-Notifications operation
This REQUIRED operation allows a Printer to send one or more Event
Notifications to a Notification Recipient using HTTP.
The Printer composes the information defined for an IPP Notification
[ipp-ntfy] and sends it using the Sent-Notifications operation to the
Notification Recipient supplied in the Subscription object.
The Send-Notifications operations uses the operations model defined by
IPP [rfc2566]. This includes, the use of a URI as the identifier for
the target of each operation, the inclusion of a version number,
operation-id, and request-id in each request, and the definition of
attribute groups. The Send-Notifications operation uses the Operation
Attributes group, but currently has no need for the Unsupported
Attributes, Printer Object Attributes, and Job-Object Attributes groups.
However, it uses a new attribute group, the Event Notification
Attributes group.
The Notification Recipient MUST accept the request in any state. There
is no state defined for the Notification Recipient for this Delivery
Method.
Access Rights: To send Event Notifications to a Notification Recipient,
the authenticated user (see [IPP-MOD] section 8.3) performing this
operation MUST be the Printer that accepted a previous Subscription
Creation operation (see [ipp-ntfy]). Otherwise the Notification
Recipient MUST reject the operation and return: the .client-error-
forbidden., .client-error-not-authenticated., or .client-error-not-
authorized. status code as appropriate.
ISSUE 01: Is this what the Access Rights section should say for a Send-
Notifications request?
9.1.1 Send-Notifications Request
Every operation request MUST contains the following parameters (see
[ipp-mod] section 3.1.1): [ipp-mod] section 3.1.1):
- a "version-number" - a "version-number" ISSUE 02: What version number goes here?
- an "operation-id" - an "operation-id" - the value defined in Table 2
- a "request-id" - a "request-id" - the contents of the Subscription object's
"notify-sequence-number" after incrementing for the first try
(see [ipp-ntfy]).
The following groups of attributes are part of the Send-Notifications The following groups of attributes MUST be part of the Send-
Request: Notifications Request:
Group 1: Operation Attributes Group 1: Operation Attributes
Natural Language and Character Set: Natural Language and Character Set:
Expires: January 6, 2001
The "attributes-charset" and "attributes-natural-language" The "attributes-charset" and "attributes-natural-language"
attributes ads defined in [rfc 2566] section 3.1.4.1. attributes as defined in [ipp-mod] section 3.1.4.1.
Target: Target:
The "notification-recipient-uri" (uri) operation attribute A copy of the Subscription object's "notification-recipient-
which is the target of this operation as described in [ipp- uri" (uri) attribute which is the target of this operation as
mod] section 3.1.5, i.e., the URI of the 'indp' Notification described in [ipp-mod] section 3.1.5, i.e., the URI of the
Recipient. 'indp' Notification Recipient (see section 9.2).
Group 2 to N: Notification Attributes Requesting User Name:
Unlike the other IPP operations, the .requesting-user-name.
attribute SHOULD NOT be supplied by the client as described in
[ipp-mod] section 8.3.
ISSUE 03: Ok that "requesting-user-name" SHOULD NOT be send
in Send-Notifications?
"human-readable-report" (text) Group 2 to N: Event Notification Attributes
The 'indp' Notification Source OPTIONALLY supports this attribute.
This attribute is a text string generated by the IPP printer or
Notification Delivery Service from the contents of the IPP
Expires: Sep 9, 2000 In each group 2 to N, each attribute is encoded using the IPP rules
Notification suitable for human consumption. If the Notification for encoding attributes [ipp-pro] and may be encoded in any order.
Source supports this attribute, it MUST supply this attribute if Note: the Get-Jobs response in [ipp-mod] acts as a model for
the Subscription object contains the "notify-text-format" encoding multiple groups of attributes.
(mimeMediaType) attribute. The text value of this attribute MUST
be localized in the charset identified by the "notify-charset"
(charset) attribute and the natural language identified by the
notify-natural-language" (naturalLanguage) attribute supplied in
the associated Subscription object that generates this event
Notification. The format of the text value is specified by the
value of the "notify-text-format" (mimeMediaType) supplied in the
associated Subscription object.
"human-readable-report-format" (mime) Each Event Notification Group MUST contain all of attributes
This attribute MUST be supplied by the Notification Source whenever specified in [ipp-ntfy] section 9.1 (.Content of Machine Consumable
the "human-readable-report" attribute is present. It indicates the Event Notifications.) with exceptions denoted by asterisks in the
format, e.g., text/plain, text/html, etc. of the "human-readable- tables below.
report" attribute.
All of the REQUIRED attributes and any of the OPTIONAL attributes The tables below are copies of the tables in [ipp-ntfy] section 9.1
indicated in [ipp-ntfy] for a Push event Notification, including (.Content of Machine Consumable Event Notifications.) except that
"notify-text-format-type" (mimeMediaType), if the "human-readable- each cell in the .Sends. column is a .MUST..
report" (text) attribute is included, so that the Notification
Recipient will know the text format of the "human-readable-report"
(text) attribute value.
These attributes communicate the same information as the notification For an Event Notification for all Events, the Printer sends the
attributes by the same name described in sections 7.4, 7.5, and 7.6 following attributes.
of [ipp-ntfy]. The rules that govern when each individual attribute
MUST or MAY be included in this operation precisely mirror those
specified in [ipp-ntfy].
4.1.2 Send-Notifications Response Table 3 . Attributes in Event Notification Content
The 'indp' Notification Recipient returns a status code for the entire Source Value Sends Source Object
operation and one for each Notification Report in the request if the
operation's status code is other than "successful-ok". If the 'indp' notify-subscription-id (integer(1:MAX)) MUST Subscription
Notification Recipient receives a Notification report that it can't pair
up with a Subscription it knows about, it can return a 'client-error- notify-printer-uri (uri) MUST Subscription
unknown-subscription' error status-code to indicate that events
associated with that subscription should no longer be sent to it. notify-subscribed-event (type2 keyword) MUST Event
Alternatively, the Notification Recipient can return the 'successful-ok- Notification
but-cancel-subscription' to the Notification Source and cancel a
Subscription that is no longer wanted. printer-up-time (integer(MIN:MAX)) MUST Printer
printer-current-time (dateTime) * MUST Printer
notify-sequence-number (integer (0:MAX)) MUST Subscription
notify-charset (charset) MUST Subscription
Expires: January 6, 2001
Source Value Sends Source Object
notify-natural-language (naturalLanguage) MUST Subscription
notify-user-data (octetString(63)) ** MUST Subscription
notify-text (text) MUST Event
Notification
attributes from the .notify-attributes. MUST Printer
attribute ***
attributes from the .notify-attributes. MUST Job
attribute ***
attributes from the .notify-attributes. MUST Subscription
attribute ***
ISSUE 04: Ok that "notify-text" has been changed from MAY to MUST?
* The Printer MUST send .printer-current-time. if and only if it
supports the .printer-current-time. attribute on the Printer
object.
** If the associated Subscription Object does not contain a
.notify-user-data. attribute, the Printer MUST send an octet-string
of length 0.
*** If the .notify-attributes. attribute is present on the
Subscription Object, the Printer MUST send all attributes specified
by the .notify-attributes. attribute. Note: if the Printer doesn.t
support the .notify-attributes. attribute, it is not present on the
associated Subscription Object.
For Event Notifications for Job Events, the Printer sends the
following additional attributes shown in Table 4.
Table 4 . Additional Attributes in Event Notification Content for
Job Events
Source Value Sends Source Object
job-id (integer(1:MAX)) MUST Job
job-state (type1 enum) MUST Job
job-state-reasons (1setOf type2 keyword) MUST Job
job-impressions-completed MUST Job
(integer(0:MAX)) *
Expires: January 6, 2001
* The Printer MUST send the .job-impressions-completed. attribute
in an Event Notification only for the combinations of Events and
Subscribed Events shown in Table 5.
Table 5 . Combinations of Events and Subscribed Events for .job-
impressions-completed.
Job Event Subscribed Job Event
.job-progress. .job-progress.
.job-completed. .job-completed.
.job-completed. .job-state-changed.
For Event Notification for Printer Events, the Printer sends the
following additional attributes shown in Table 6.
Table 6 . Additional Attributes in Event Notification Content for
Printer Events
Source Value Sends Source Object
printer-state (type1 enum) MUST Printer
printer-state-reasons (1setOf type2 MUST Printer
keyword)
printer-is-accepting-jobs (boolean) MUST Printer
9.1.2 Send-Notifications Response
The Notification Recipient MUST return (to the client which is the
Printer) the following sets of attributes as part of a Send-
Notifications response:
Every operation response contains the following REQUIRED parameters (see Every operation response contains the following REQUIRED parameters (see
[ipp-mod] section 3.1.1}: [ipp-mod] section 3.1.1}:
- a "version-number" - a "version-number"
- a "status-code" - a "status-code"
Expires: Sep 9, 2000
- the "request-id" that was supplied in the corresponding request - the "request-id" that was supplied in the corresponding request
Group 1: Operation Attributes Group 1: Operation Attributes
Natural Language and Character Set: Status Message:
The "attributes-charset" and "attributes-natural-language" As defined in [ipp-mod].
attributes ads defined in [rfc 2566] section 3.1.4.1.
ISSUE 01 _ Should there be an Unsupported Attributes group to return
attributes that are not supported to the client?
Group 2 to N: Notification Attributes
"notification-report-status-code" (type2 enum) Expires: January 6, 2001
Indicates whether the 'ipp-notify-send' Notification Recipient was The Notification Recipient can return any status codes defined in
able to consume the n-th Notification Report. [ipp-mod] and section 10.1 that applies to all of the Event
Notification Attribute groups. The following is a description of
the important status codes:
The following standard enum values are defined: 'successful-ok': the Notification Recipient received all of the
Event Notification Attribute Groups and was expecting each of
them.
'successful-ok-ignored-notifications': the Notification
Recipient was able to consume some, but not all of the Event
Notification Attributes Groups sent. The Event Notification
Attributes Groups with a .notify-status-code. attribute are
the ones that were ignored or are to be canceled.
'client-error-ignored-all-notifications': the Notification
Recipient was unable to consume any of the Event Notification
Attributes Groups sent. The Event Notification Attributes
Groups with a .notify-status-code. attribute are the ones that
were ignored or are to be canceled.
'successful-ok' Natural Language and Character Set:
'successful-ok-but-cancel-subscription' The "attributes-charset" and "attributes-natural-language"
'client-error-unknown-subscription' attributes as defined in [ipp-mod] section 3.1.4.1.
'client-error-bad-request'
ISSUE 02 _ Should this use the same status code space as IP, namely: Group 2 to N: Notification Attributes
"successful" _ 0x0000 to 0x00FF
"informational" _ 0x0100 to 0x01FF
"redirection" _ 0x0400 to 0x04FF
"server-error" _ 0x0500 to 0x05FF
ISSUE 03 _ What status code from IPP can we re-use? These groups MUST be returned if and only if the "status-code"
parameter returned in Group 1 is anything but the 'successful-ok'
status code.
ISSUE 04 _ Where should the status code be defined? Here, in [indp], in "notification-status-code" (type2 enum)
[ipp-ntfy], or in [ipp-mod]? Indicates whether the Notification Recipient was able to consume
the n-th Notification Report as follows:
ISSUE 05 _ Since there is an overall status code for the entire 'successful-ok' - this Event Notification Attribute Group was
operation and one fore each Notification, what status code is returned consumed
for the overall operation, if one Notification succeeds and another 'client-error-not-found' - this Event Notification Attribute Group
fails? Do we need a status code for this such as 'client-error-some- was not able to be consumed. The Printer MUST cancel the
notifications-failed'? Subscription and MUST NOT attempt to send any further Event
Notifications from the associated Subscription object.
'successful-ok-but-cancel-subscription' - the Event Notification
Attribute Group was consumed, but the Notification Recipient
wishes to cancel the Subscription object. The Printer MUST
cancel the Subscription and MUST NOT attempt to send any further
Event Notifications from the associated Subscription object.
4.2 Notification Protocol URI Scheme 9.2 Notification Protocol URI Scheme
The INDP Notification Delivery Method uses the 'indp://' URI scheme in The INDP Notification Delivery Method uses the 'indp://' URI scheme in
the "notify-recipients" attribute in the Subscription object in order to the "notify-recipients" attribute in the Subscription object in order to
indicate the notification delivery method defined in this document. The indicate the notification Delivery Method defined in this document. The
remainder of the URI indicates the host and address of the Notification remainder of the URI indicates the host and address of the Notification
Recipient that is to receive the Send-Notification operation. Recipient that is to receive the Send-Notification operation.
Expires: Sep 9, 2000 Expires: January 6, 2001
5 Encoding of the Operation Layer 10 Status Codes
The INDP Notification Delivery Method uses the INDP operation layer This section lists status codes whose meaning have been extended and/or
encoding described in [indp]. defined for returning in Event Notification Attribute Groups as the
value of the "notification-status-code" operation attribute. The code
values are allocated in the same space as the status codes in [ipp-mod].
6 Encoding of Transport Layer 10.1 Additional Status Codes
The INDP Notification Delivery Method uses the INDP transport layer The following status codes are defined as extensions for Notification
encoding described in [indp]. and are returned as the value of the .status-code. parameter in the
Operation Attributes Group of a response (see [ipp-mod] section
3.1.6.1). Operations in this document can also return the status codes
defined in section 13 of [ipp-mod]. The .successful-ok. status code is
an example of such a status code.
10.1.1 successful-ok-ignored-notifications (0x0004)
The Notification Recipient was able to consume some, but not all, of the
Event Notifications Attributes Groups sent by the Printer in the Send-
Notifications request. See section 9.1.2 for further details.
10.2 Status Codes returned in Event Notification Attributes Groups
This section contains values of the .notify-status-code. attribute that
the Notification Recipient returns in a Event Notification Attributes
Group in a response when the corresponding Event Notification Attributes
Group in the request:
1. was not consumed OR
2. was consumed, but the Notification Recipient wants to cancel the
corresponding Subscription object
The following sections are ordered in decreasing order of importance of
the status-codes.
10.2.1 client-error-not-found (0x0406)
This status code is defined in [ipp-mod]. This document extends its
meaning and allows it to be returned in an Event Notification Attributes
Group of a response.
The Notification Recipient was unable to consume this Event Notification
Attributes Group because it was not expected. See section 9.1.2 for
further details.
Expires: January 6, 2001
10.2.2 successful-ok-but-cancel-subscription (0x0006)
The Notification Recipient was able to consume this Event Notification
Attributes Group that the Printer sent, but wants the corresponding
Subscription object to be canceled none-the-less. See section 9.1.2 for
further details.
11 Encoding and Transport
This section defines the encoding and transport used by the 'indp'
Delivery Method.
11.1 Encoding of the Operation Layer
The 'indp' Delivery Method uses the IPP operation layer encoding
described in [ipp-pro] and the following Event Notification Attributes
Group tag allocated by [ipp-ntfy]:
Tag Value (Hex) Meaning
0x07 .event-notification-attributes-tag.
11.2 Encoding of Transport Layer
The 'indp' Notification Delivery Method uses the IPP transport layer
encoding described in [ipp-pro].
It is REQUIRED that an 'indp' Notification Recipient implementation It is REQUIRED that an 'indp' Notification Recipient implementation
support HTTP over the IANA assigned Well Known Port XXX (the INDP support HTTP over the IANA assigned Well Known Port assigned to the
default port), though a notification recipient implementation MAY 'indp' Delivery Method as its default port by IANA (see section 12),
support HTTP over some other port as well. though a Notification Recipient implementation MAY support HTTP over
some other port as well.
7 IANA Considerations 12 IANA Considerations
The 'indp://' URL scheme and the IDNP default fort will be registered The 'indp://' URL scheme for the 'indp' Delivery Method will be
with IANA. registered with IANA. IANA will assign a default port to use with the
'indp' Delivery Method.
8 Internationalization Considerations 13 Internationalization Considerations
When the client requests Human Consumable form by supplying the "notify- When the client requests Human Consumable form by supplying the "notify-
text-format" operation attribute (see [ipp-ntfy]), the IPP Printer (or text-format" operation attribute (see [ipp-ntfy]), the IPP Printer (or
any Notification Service that the IPP Printer might be configured to any Notification Service that the IPP Printer might be configured to
use) supplies and localizes the text value of the "human-readable- use) supplies and localizes the text value of the "human-readable-
report" attribute in the Notification according to the charset and report" attribute in the Notification according to the charset and
natural language requested in the notification subscription. natural language requested in the notification subscription.
9 Security Considerations Expires: January 6, 2001
14 Security Considerations
The IPP Model and Semantics document [ipp-mod] discusses high level The IPP Model and Semantics document [ipp-mod] discusses high level
security requirements (Client Authentication, Server Authentication and security requirements (Client Authentication, Server Authentication and
Operation Privacy). Client Authentication is the mechanism by which the Operation Privacy). Client Authentication is the mechanism by which the
client proves its identity to the server in a secure manner. Server client proves its identity to the server in a secure manner. Server
Authentication is the mechanism by which the server proves its identity Authentication is the mechanism by which the server proves its identity
to the client in a secure manner. Operation Privacy is defined as a to the client in a secure manner. Operation Privacy is defined as a
mechanism for protecting operations from eavesdropping. mechanism for protecting operations from eavesdropping.
The Notification Recipient can cancel unwanted Subscriptions created by The Notification Recipient can cancel unwanted Subscriptions created by
other parties without having to be the owner of the subscription by other parties without having to be the owner of the subscription by
returning the 'successful-ok-but-cancel-subscription' status code in the returning the 'successful-ok-but-cancel-subscription' status code in the
Send-Notifications response returned to the Notification Source. Send-Notifications response returned to the Printer.
Expires: Sep 9, 2000
9.1 Security Conformance 14.1 Security Conformance
Notification Sources (client) MAY support Digest Authentication Printers (client) MAY support Digest Authentication [rfc2617]. If
[rfc2617]. If Digest Authentication is supported, then MD5 and MD5-sess Digest Authentication is supported, then MD5 and MD5-sess MUST be
MUST be supported, but the Message Integrity feature NEED NOT be supported, but the Message Integrity feature NEED NOT be supported.
supported.
Notification Recipient (server) MAY support Digest Authentication Notification Recipient (server) MAY support Digest Authentication
[rfc2617]. If Digest Authentication is supported, then MD5 and MD5-sess [rfc2617]. If Digest Authentication is supported, then MD5 and MD5-sess
MUST be supported, but the Message Integrity feature NEED NOT be MUST be supported, but the Message Integrity feature NEED NOT be
supported. supported.
Notification Recipients MAY support TLS for client authentication, Notification Recipients MAY support TLS for client authentication,
server authentication and operation privacy. If a notification recipient server authentication and operation privacy. If a Notification Recipient
supports TLS, it MUST support the TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA supports TLS, it MUST support the TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
cipher suite as mandated by RFC 2246 [rfc2246]. All other cipher suites cipher suite as mandated by RFC 2246 [rfc2246]. All other cipher suites
are OPTIONAL. Notification recipients MAY support Basic Authentication are OPTIONAL. Notification recipients MAY support Basic Authentication
(described in HTTP/1.1 [rfc2616]) for client authentication if the (described in HTTP/1.1 [rfc2616]) for client authentication if the
channel is secure. TLS with the above mandated cipher suite can provide channel is secure. TLS with the above mandated cipher suite can provide
such a secure channel. such a secure channel.
10 References 15 References
[indp] [indp]
Parra, H., T. Hastings, "Internet Printing Protocol (IPP): IPP Parra, H., T. Hastings, "Internet Printing Protocol (IPP): IPP
Notification Delivery Protocol (INDP)", <draft-ietf-indp-00.txt>, Notification Delivery Protocol (INDP)", <draft-ietf-indp-00.txt>,
February 29, 2000. February 29, 2000.
[ipp-mod] [ipp-mod]
R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell, R. deBry, T. Hastings, R. Herriot, S. Isaacson, P. Powell,
"Internet Printing Protocol/1.0: Model and Semantics", <draft-ietf- "Internet Printing Protocol/1.0: Model and Semantics", <draft-ietf-
ipp-model-v11-06.txt>, March 1, 2000. ipp-model-v11-07.txt>, May 22, 2000.
[ipp-ntfy] [ipp-ntfy]
Isaacson, S., Martin, J., deBry, R., Hastings, T., Shepherd, M., Isaacson, S., Martin, J., deBry, R., Hastings, T., Shepherd, M.,
Bergman, R., "Internet Printing Protocol/1.1: IPP Event Bergman, R., "Internet Printing Protocol/1.1: IPP Event
Notification Specification", <draft-ietf-ipp-not-spec-02.txt>, Notification Specification", <draft-ietf-ipp-not-spec-03.txt>, June
February 2, 2000. 30, 2000.
Expires: January 6, 2001
[ipp-pro] [ipp-pro]
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", draft-ietf-ipp-protocol-v11- Protocol/1.1: Encoding and Transport", draft-ietf-ipp-protocol-v11-
05.txt, March 1, 2000. 06.txt, May 30, 2000.
[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.
Expires: Sep 9, 2000
[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.
[rfc2617] [rfc2617]
J. Franks, P. Hallam-Baker, J. Hostetler, S. Lawrence, P. Leach, A. J. Franks, P. Hallam-Baker, J. Hostetler, S. Lawrence, P. Leach, A.
Luotonen, L. Stewart, "HTTP Authentication: Basic and Digest Access Luotonen, L. Stewart, "HTTP Authentication: Basic and Digest Access
Authentication", RFC 2617, June 1999. Authentication", RFC 2617, June 1999.
11 Author's Addresses 16 Author's Addresses
Hugo Parra Hugo Parra
Novell, Inc. Novell, Inc.
1800 South Novell Place 1800 South Novell Place
Provo, UT 84606 Provo, UT 84606
Phone: 801-861-3307 Phone: 801-861-3307
Fax: 801-861-2517 Fax: 801-861-2517
e-mail: hparra@novell.com e-mail: hparra@novell.com
Tom Hastings Tom Hastings
Xerox Corporation Xerox Corporation
737 Hawaii St. ESAE 231 737 Hawaii St. ESAE 231
El Segundo, CA 90245 El Segundo, CA 90245
Phone: 310-333-6413 Phone: 310-333-6413
Fax: 310-333-5514 Fax: 310-333-5514
e-mail: hastings@cp10.es.xerox.com e-mail: hastings@cp10.es.xerox.com
12 Full Copyright Statement 17 Full Copyright Statement
Copyright (C) The Internet Society (2000). All Rights Reserved. Copyright (C) The Internet Society (2000). 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 or others, and derivative works that comment on or otherwise explain it or
assist in its implementation may be prepared, copied, published and assist in its implementation may be prepared, copied, published and
distributed, in whole or in part, without restriction of any kind, distributed, in whole or in part, without restriction of any kind,
provided that the above copyright notice and this paragraph are included provided that the above copyright notice and this paragraph are included
on all such copies and derivative works. However, this document itself on all such copies and derivative works. However, this document itself
may not be modified in any way, such as by removing the copyright notice may not be modified in any way, such as by removing the copyright notice
or references to the Internet Society or other Internet organizations, or references to the Internet Society or other Internet organizations,
except as needed for the purpose of developing Internet standards in except as needed for the purpose of developing Internet standards in
Expires: January 6, 2001
which case the procedures for copyrights defined in the Internet which case the procedures for copyrights defined in the Internet
Standards process must be followed, or as required to translate it into Standards process must be followed, or as required to translate it into
languages other than English. languages other than 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.
This document and the information contained herein is provided on an "AS This document and the information contained herein is provided on an "AS
IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK
Expires: Sep 9, 2000
FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT
LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT
INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
FITNESS FOR A PARTICULAR PURPOSE. FITNESS FOR A PARTICULAR PURPOSE.
Expires: Sep 9, 2000 Expires: January 6, 2001
 End of changes. 

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