draft-ietf-ipp-not-spec-05.txt   draft-ietf-ipp-not-spec-06.txt 
INTERNET-DRAFT R. Herriot (editor) INTERNET-DRAFT R. Herriot (editor)
<draft-ietf-ipp-not-spec-05.txt> Xerox Corporation <draft-ietf-ipp-not-spec-06.txt> Xerox Corporation
Category: standards track T. Hastings [Target Category: standards track] T. Hastings
Xerox Corporation Xerox Corporation
R. deBry R. deBry
Utah Valley State College Utah Valley State College
S. Isaacson S. Isaacson
Novell, Inc. Novell, Inc.
J. Martin J. Martin
Underscore Underscore
M. Shepherd M. Shepherd
Xerox Corporation Xerox Corporation
R. Bergman R. Bergman
Hitachi Koki Imaging Solutions Hitachi Koki Imaging Solutions
August 30, 2000 January 24, 2000
Internet Printing Protocol (IPP): Internet Printing Protocol (IPP):
IPP Event Notification Specification IPP Event Notification Specification
Copyright (C) The Internet Society (2001). 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
provisions of Section 10 of [RFC2026]. Internet-Drafts are working all provisions of Section 10 of [RFC2026]. Internet-Drafts are
documents of the Internet Engineering Task Force (IETF), its areas, and working documents of the Internet Engineering Task Force (IETF), its
its working groups. Note that other groups may also distribute working areas, and its working groups. Note that other groups may also
documents as Internet-Drafts. distribute working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference material time. It is inappropriate to use Internet-Drafts as reference
or to cite them other than as "work in progress". material 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
This document describes an extension to the IPP/1.0, IPP/1.1, and future This document describes an extension to the IPP/1.0, IPP/1.1, and
versions. This extension allows a client to subscribe to printing future versions. This extension allows a client to subscribe to
printing related Events. Subscriptions are modeled as Subscription
related Events. Subscriptions are modeled as Subscription Objects. The Objects. The Subscription Object specifies that when one of the
Subscription Object specifies that when one of the specified Event specified Event occurs, the Printer sends an asynchronous Event
occurs, the Printer sends an asynchronous Event Notification to the Notification to the specified Notification Recipient via the
specified Notification Recipient via the specified Delivery Method specified Delivery Method (i.e., protocol). A client associates
(i.e., protocol). A client associates Subscription Objects with a Subscription Objects with a particular Job by performing the Create-
particular Job by performing the Create-Job-Subscriptions operation or Job-Subscriptions operation or by submitting a Job with subscription
by submitting a Job with subscription information. A client associates information. A client associates Subscription Objects with the
Subscription Objects with the Printer by performing a Create-Printer- Printer by performing a Create-Printer-Subscriptions operation. Four
Subscriptions operation. Four other operations are defined for other operations are defined for Subscription Objects: Get-
Subscription Objects: Get-Subscriptions-Attributes, Get-Subscriptions, Subscriptions-Attributes, Get-Subscriptions, Renew-Subscription, and
Renew-Subscription, and Cancel-Subscription. Cancel-Subscription.
The basic set of IPP documents includes: The basic 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 [IPP-MOD] Internet Printing Protocol/1.1: Model and Semantics [RFC2911]
Internet Printing Protocol/1.1: Encoding and Transport [IPP-PRO] 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]
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
satisfied in IPP/1.0. Operator and Administrator requirements are out are satisfied in IPP/1.0. Operator and Administrator requirements
of scope for version 1.0. A few OPTIONAL Operator operations have been are out of scope for version 1.0. A few OPTIONAL Operator operations
added to IPP/1.1. have been added to IPP/1.1.
The "Rationale for the Structure and Model and Protocol for the Internet The "Rationale for the Structure and Model and Protocol for the
Printing Protocol" document describes IPP from a high level view, Internet Printing Protocol" document describes IPP from a high level
defines a roadmap for the various documents that form the suite of IPP view, defines a roadmap for the various documents that form the suite
specifications, and gives background and rationale for the IETF working of IPP specifications, and gives background and rationale for the
group's major decisions. IETF working group's major decisions.
The "Internet Printing Protocol/1.1: Model and Semantics", describes a The "Internet Printing Protocol/1.1: Model and Semantics", describes
simplified model with abstract objects, their attributes, and their a simplified model with abstract objects, their attributes, and their
operations that are independent of encoding and transport. It introduces operations that are independent of encoding and transport. It
a Printer object and a Job object. The Job object optionally supports introduces a Printer object and a Job object. The Job object
multiple documents per Job. It also addresses security, optionally supports multiple documents per Job. It also addresses
internationalization, and directory issues. security, internationalization, and directory issues.
The "Internet Printing Protocol/1.1: Encoding and Transport" document is The "Internet Printing Protocol/1.1: Encoding and Transport" document
a formal mapping of the abstract operations and attributes defined in is a formal mapping of the abstract operations and attributes defined
the model document onto HTTP/1.1. It defines the encoding rules for a in the model document onto HTTP/1.1. It defines the encoding rules
new Internet MIME media type called "application/ipp". This document for a new Internet MIME media type called "application/ipp". This
also defines the rules for transporting over HTTP a message body whose document also defines the rules for transporting over HTTP a message
Content-Type is "application/ipp". This document defines a new scheme body whose Content-Type is "application/ipp". This document defines
named 'ipp' for identifying IPP printers and jobs. Finally, this a new scheme named 'ipp' for identifying IPP printers and jobs.
document defines interoperability rules for supporting IPP/1.0 clients. Finally, this document defines interoperability rules for supporting
IPP/1.0 clients.
The "Internet Printing Protocol/1.1: Implementer's Guide" document gives The "Internet Printing Protocol/1.1: Implementer's Guide" document
insight and advice to implementers of IPP clients and IPP objects. It gives insight and advice to implementers of IPP clients and IPP
is intended to help them understand IPP/1.0 and some of the objects. It is intended to help them understand IPP/1.0 and some of
considerations that may assist them in the design of their client and/or the considerations that may assist them in the design of their client
IPP object implementations. For example, a typical order of processing and/or IPP object implementations. For example, a typical order of
requests is given, including error checking. Motivation for some of the processing requests is given, including error checking. Motivation
specification decisions is also included. for some of the 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
to implementers of gateways between IPP and LPD (Line Printer Daemon) advice to implementers of gateways between IPP and LPD (Line Printer
implementations. Daemon) implementations.
Table of Contents Table of Contents
1 Introduction .......................................................9 1 Introduction....................................................9
1.1 Notification Overview .........................................9 1.1 Notification Overview........................................9
2 Models for Notification ...........................................12
2.1 Model for Notification (Simple Case) .........................12
2.2 Model for Notification with Cascading Printers ...............13
2.3 Distributed Model for Notification ...........................13
2.4 Extended Notification Recipient ..............................14
3 Terminology .......................................................14 2 Models for Notification........................................12
3.1 Conformance Terminology ......................................14 2.1 Model for Notification (Simple Case)........................12
3.2 Other Terminology ............................................14 2.2 Model for Notification with Cascading Printers..............12
2.3 Distributed Model for Notification..........................12
2.4 Extended Notification Recipient.............................13
4 Object Relationships ..............................................17 3 Terminology....................................................13
4.1 Printer and Per-Printer Subscription Objects .................18 3.1 Conformance Terminology.....................................13
4.2 Printer, Job and Per-Job Subscription Objects ................18 3.2 Other Terminology...........................................14
5 Subscription Object ...............................................18 4 Object Relationships...........................................16
5.1 Rules for Support of Subscription Template Attributes ........19 4.1 Printer and Per-Printer Subscription Objects................16
5.2 Rules for Processing Subscription Template Attributes ........20 4.2 Printer, Job and Per-Job Subscription Objects...............16
5.3 Subscription Template Attributes .............................24
5.3.1 notify-recipient-uri (uri) ...............................25
5.3.2 notify-events (1setOf type2 keyword) .....................26
5.3.3 notify-attributes (1setOf type2 keyword) .................32
5.3.4 notify-user-data (octetString(63)) .......................34
5.3.5 notify-charset (charset) .................................34
5.3.6 notify-natural-language (naturalLanguage) ................35
5.3.7 notify-lease-duration (integer(0:67108863)) ..............35
5.3.8 notify-time-interval (integer(0:MAX)) ....................37
5.4 Subscription Description Attributes ..........................38
5.4.1 notify-subscription-id (integer (1:MAX)) ................39
5.4.2 notify-sequence-number (integer (0:MAX)) .................39
5.4.3 notify-lease-expiration-time (integer(0:MAX)) ............40
5.4.4 notify-printer-up-time (integer(1:MAX)) ..................41
5.4.5 notify-printer-uri (uri) .................................41
5.4.6 notify-job-id (integer(1:MAX)) ...........................42
5.4.7 notify-subscriber-user-name (name(MAX)) ..................42
6 Printer Description Attributes Related to Notification ............43 5 Subscription Object............................................17
6.1 printer-state-change-time (integer(1:MAX)) ...................43 5.1 Rules for Support of Subscription Template Attributes.......17
6.2 printer-state-change-date-time (dateTime) ....................44 5.2 Rules for Processing Subscription Template Attributes.......18
5.3 Subscription Template Attributes............................22
5.3.1 notify-recipient-uri (uri)..................................23
5.3.2 notify-events (1setOf type2 keyword)........................24
5.3.2.1 Standard Values for Subscribed Events ...................24
5.3.2.1.1 No Events.............................................25
5.3.2.1.2 Subscribed Printer Events.............................25
5.3.2.1.3 Subscribed Job Events.................................26
5.3.2.2 Rules for Matching of Subscribed Events .................28
5.3.2.2.1 Rules for Matching of Printer Events..................28
5.3.2.2.2 Rules for Matching of Job Events......................28
5.3.2.2.3 Special Cases for Matching Rules......................29
5.3.3 notify-attributes (1setOf type2 keyword)....................30
5.3.4 notify-user-data (octetString(63))..........................31
5.3.5 notify-charset (charset)....................................31
5.3.6 notify-natural-language (naturalLanguage)...................32
5.3.7 notify-lease-duration (integer(0:67108863)).................32
5.3.8 notify-time-interval (integer(0:MAX)).......................33
5.4 Subscription Description Attributes.........................35
5.4.1 notify-subscription-id (integer (1:MAX))...................35
5.4.2 notify-sequence-number (integer (0:MAX))....................36
5.4.3 notify-lease-expiration-time (integer(0:MAX))...............36
5.4.4 notify-printer-up-time (integer(1:MAX)).....................37
5.4.5 notify-printer-uri (uri)....................................37
5.4.6 notify-job-id (integer(1:MAX))..............................38
5.4.7 notify-subscriber-user-name (name(MAX)).....................38
7 New Values for Existing Printer Description Attributes ............44 6 Printer Description Attributes Related to Notification.........38
7.1 operations-supported (1setOf type2 enum) .....................44 6.1 printer-state-change-time (integer(1:MAX))..................39
6.2 printer-state-change-date-time (dateTime)...................39
8 Attributes Only in Event Notifications ............................45 7 New Values for Existing Printer Description Attributes.........40
8.1 notify-subscribed-event (type2 keyword) ......................45 7.1 operations-supported (1setOf type2 enum)....................40
8.2 notify-text (text(MAX)) ......................................45
9 Event Notification Content ........................................46 8 Attributes Only in Event Notifications.........................40
9.1 Content of Machine Consumable Event Notifications ............48 8.1 notify-subscribed-event (type2 keyword).....................40
9.1.1 Event Notification Content Common to All Events ..........49 8.2 notify-text (text(MAX)).....................................41
9.1.2 Additional Event Notification Content for Job Events .....50
9.1.3 Additional Event Notification Content for Printer Events .51
9.2 Content of Human Consumable Event Notification ...............52
9.2.1 Event Notification Content Common to All Events ..........53
9.2.2 Additional Event Notification Content for Job Events .....55
9.2.3 Additional Event Notification Content for Printer Events .56
10Delivery Methods ..................................................57 9 Event Notification Content.....................................41
9.1 Content of Machine Consumable Event Notifications...........43
9.1.1 Event Notification Content Common to All Events.............44
9.1.2 Additional Event Notification Content for Job Events........45
9.1.3 Additional Event Notification Content for Printer Events....46
9.2 Content of Human Consumable Event Notification..............46
9.2.1 Event Notification Content Common to All Events.............47
9.2.2 Additional Event Notification Content for Job Events........49
9.2.3 Additional Event Notification Content for Printer Events....50
11Operations for Notification .......................................60 10 Delivery Methods...............................................51
11.1 Subscription Creation Operations .............................60
11.1.1Create-Job-Subscriptions Operation .......................60
11.1.2Create-Printer-Subscriptions operation ...................63
11.1.3Job Creation Operation - Extensions for Notification .....64
11.2 Other Operations .............................................67
11.2.1Validate-Job Operation - Extensions for Notification .....67
11.2.2Get-Printer-Attributes - Extensions for Notification .....67
11.2.3Get-Subscription-Attributes operation ....................68
11.2.4Get-Subscriptions operation ..............................71
11.2.5Renew-Subscription operation .............................73
11.2.6Cancel-Subscription operation ............................76
12Conformance Requirements ..........................................78 11 Operations for Notification....................................53
11.1 Subscription Creation Operations............................53
11.1.1 Create-Job-Subscriptions Operation .......................54
11.1.1.1 Create-Job-Subscriptions Request ........................54
11.1.1.2 Create-Job-Subscriptions Response .......................55
11.1.2 Create-Printer-Subscriptions operation ...................56
11.1.2.1 Create-Printer-Subscriptions Request ....................57
11.1.2.2 Create-Printer-Subscriptions Response ...................57
11.1.3 Job Creation Operation - Extensions for Notification .....57
11.1.3.1 Job Creation Request ....................................58
11.1.3.2 Job Creation Response ...................................58
11.2 Other Operations............................................59
11.2.1 Validate-Job Operation - Extensions for Notification .....59
11.2.2 Get-Printer-Attributes - Extensions for Notification .....60
11.2.3 Get-Subscription-Attributes operation ....................60
11.2.3.1 Get-Subscription-Attributes Request .....................61
11.2.3.2 Get-Subscription-Attributes Response ....................62
11.2.4 Get-Subscriptions operation ..............................63
11.2.4.1 Get-Subscriptions Request ...............................63
11.2.4.2 Get-Subscriptions Response ..............................64
11.2.5 Renew-Subscription operation .............................65
11.2.5.1 Renew-Subscription Request ..............................66
11.2.5.2 Renew-Subscription Response .............................66
11.2.6 Cancel-Subscription operation ............................67
11.2.6.1 Cancel-Subscription Request .............................68
11.2.6.2 Cancel-Subscription Response ............................69
13IANA Considerations ...............................................79 12 Conformance Requirements.......................................69
13.1 Format and Requirements for IPP Delivery Method Registration 13 IANA Considerations............................................70
Proposals .........................................................80 13.1 Attribute Registrations.....................................70
13.2 Keyword Attribute Value Registrations.......................71
13.3 Operation Registrations.....................................71
13.4 Status code Registrations...................................72
13.5 Attribute Group tag Registrations...........................72
13.6 Format for Event Notification Delivery Method Registration
proposals.........................................................73
13.7 Format and Requirements for IPP Delivery Method Registration
Proposals.........................................................73
14Internationalization Considerations ...............................81 14 Internationalization Considerations............................73
15Security Considerations ...........................................81 15 Security Considerations........................................74
16Status Codes ......................................................82 16 Status Codes...................................................74
16.1 successful-ok-ignored-subscriptions (0x0003) .................82 16.1 successful-ok-ignored-subscriptions (0x0003)................75
16.2 client-error-ignored-all-subscriptions (0x0414) ..............82 16.2 client-error-ignored-all-subscriptions (0x0414).............75
17Status Codes in Subscription Attributes Groups ....................83 17 Status Codes in Subscription Attributes Groups.................75
17.1 client-error-uri-scheme-not-supported (0x040C) ...............83 17.1 client-error-uri-scheme-not-supported (0x040C)..............75
17.2 client-error-too-many-subscriptions (0x0415) .................83 17.2 client-error-too-many-subscriptions (0x0415)................76
17.3 successful-ok-too-many-events (0x0005) .......................83 17.3 successful-ok-too-many-events (0x0005)......................76
17.4 successful-ok-ignored-or-substituted-attributes (0x0001) .....84 17.4 successful-ok-ignored-or-substituted-attributes (0x0001)....76
18Encodings of Additional Attribute Tags ............................84 18 Encodings of Additional Attribute Tags.........................76
19References ........................................................84 19 References.....................................................76
20Author's Addresses ................................................85 20 Author's Addresses.............................................78
A.Appendix - Model for Notification with Cascading Printers .........87 A. Appendix - Model for Notification with Cascading Printers......79
B.Appendix - Distributed Model for Notification .....................88 B. Appendix - Distributed Model for Notification..................80
C.Appendix - Extended Notification Recipient ........................89 C. Appendix - Extended Notification Recipient.....................81
D.Appendix - Details about Conformance Terminology ..................90 D. Appendix - Details about Conformance Terminology...............82
E.Appendix - Object Model for Notification ..........................91 E. Appendix - Object Model for Notification.......................83
E.1 Appendix - Object relationships ..............................92 E.1 Appendix - Object relationships.............................84
E.2 Printer Object and Per-Printer Subscription Objects ..........93 E.2 Printer Object and Per-Printer Subscription Objects.........85
E.3 Job Object and Per-Job Subscription Objects ..................93 E.3 Job Object and Per-Job Subscription Objects.................85
F.Appendix - Per-Job versus Per-Printer Subscription Objects ........93 F. Appendix - Per-Job versus Per-Printer Subscription Objects.....85
G.Appendix: Full Copyright Statement ................................94 G. Appendix: Full Copyright Statement.............................86
Tables Tables
Table 1 - Subscription Template Attributes...........................25 Table 1 - Subscription Template Attributes........................23
Table 2 - Subscription Description Attributes........................38 Table 2 - Subscription Description Attributes.....................35
Table 3 - Printer Description Attributes Associated with Notification43 Table 3 - Printer Description Attributes Associated with Notification
Table 4 - Operation-id assignments...................................44 ..............................................................39
Table 5 - Attributes in Event Notification Content...................49 Table 4 - Operation-id assignments................................40
Table 6 - Additional Event Notification Content for Job Events.......50 Table 5 - Attributes in Event Notification Content................44
Table 6 - Additional Event Notification Content for Job Events....45
Table 7 - Combinations of Events and Subscribed Events for "job- Table 7 - Combinations of Events and Subscribed Events for "job-
impressions-completed" ...........................................51 impressions-completed" ........................................46
Table 8 - Additional Event Notification Content for Printer Events...51 Table 8 - Additional Event Notification Content for Printer Events46
Table 9 - Printer Name in Event Notification Content.................54 Table 9 - Printer Name in Event Notification Content..............48
Table 10 - Event Name in Event Notification Content..................54 Table 10 - Event Name in Event Notification Content...............48
Table 11 - Event Time in Event Notification Content..................55 Table 11 - Event Time in Event Notification Content...............49
Table 12 - Job Name in Event Notification Content....................55 Table 12 - Job Name in Event Notification Content.................49
Table 13 - Job State in Event Notification Content...................56 Table 13 - Job State in Event Notification Content................50
Table 14 - Printer State in Event Notification Content...............56 Table 14 - Printer State in Event Notification Content............51
Table 15 - Information about the Delivery Method.....................58 Table 15 - Information about the Delivery Method..................52
Table 16 - Conformance Requirements for Operations...................79 Table 16 - Conformance Requirements for Operations................70
Figures Figures
Figure 1 - Model for Notification....................................12 Figure 1 - Model for Notification.................................12
Figure 2 - Model for Notification with Cascading Printers............88 Figure 2 - Model for Notification with Cascading Printers.........80
Figure 3 - Opaque Use of a Notification Service Transparent to the Figure 3 - Opaque Use of a Notification Service Transparent to the
Client ...........................................................89 Client ........................................................81
Figure 4 - Use of an Extended Notification Recipient transparent to the Figure 4 - Use of an Extended Notification Recipient transparent to
Printer ..........................................................90 the Printer ...................................................82
Figure 5 - Object Model for Notification.............................92 Figure 5 - Object Model for Notification..........................84
1 Introduction 1 Introduction
This IPP notification specification is an extension to IPP/1.0 [RFC2568, This IPP notification specification is an extension to IPP/1.0
RFC2569] and IPP/1.1 [ipp-mod, ipp-pro]. This document in combination [RFC2568, RFC2569] and IPP/1.1 [RFC2911, RFC2910]. This document in
with the following documents is intended to meet the notification combination with the following documents is intended to meet the
requirements described in [ipp-not-req]: notification requirements described in [ipp-not-req]:
Internet Printing Protocol (IPP): "Job Progress Attributes" [ipp- Internet Printing Protocol (IPP): "Job Progress Attributes"
prog] [ipp-prog]
One or more Delivery Method Documents registered with IANA (see One or more Delivery Method Documents registered with IANA (see
section 13). section 13).
Note: this document does not define any Delivery Methods, but it does Note: this document does not define any Delivery Methods, but it does
define the rules for conformance for Delivery Method Documents. define the rules for conformance for Delivery Method Documents.
Refer to the Table of Contents for the layout of this document. Refer to the Table of Contents for the layout of this document.
1.1 Notification Overview 1.1 Notification Overview
This document defines operations that a client can perform in order to This document defines operations that a client can perform in order
create Subscription Objects in a Printer and carry out other operations to create Subscription Objects in a Printer and carry out other
on them. A Subscription Object represents a Subscription abstraction. operations on them. A Subscription Object represents a Subscription
The Subscription Object specifies that when one of the specified Events abstraction. The Subscription Object specifies that when one of the
occurs, the Printer sends an asynchronous Event Notification to the specified Events occurs, the Printer sends an asynchronous Event
specified Notification Recipient via the specified Delivery Method Notification to the specified Notification Recipient via the
(i.e., protocol). specified Delivery Method (i.e., protocol).
When a client (called a Subscribing Client) performs an operation that When a client (called a Subscribing Client) performs an operation
creates a Subscription Object, the operation contains one or more that creates a Subscription Object, the operation contains one or
Subscription Template Attributes Groups. Each such group holds more Subscription Template Attributes Groups. Each such group holds
information used by the Printer to initialize a newly created information used by the Printer to initialize a newly created
Subscription Object. The Printer creates one Subscription Object for Subscription Object. The Printer creates one Subscription Object for
each Subscription Template Attributes Group in the operation. This group each Subscription Template Attributes Group in the operation. This
is like the Job Template Attributes group defined in [ipp-mod]. The group is like the Job Template Attributes group defined in [RFC2911].
following is an example of the information included in a Subscription The following is an example of the information included in a
Template Attributes Group (see section 5 for details on the Subscription Subscription Template Attributes Group (see section 5 for details on
Object attributes): the Subscription Object attributes):
1. The names of Subscribed Events that are of interest to the 1. The names of Subscribed Events that are of interest to the
Notification Recipient. Notification Recipient.
2. The address (URL) of one Notification Recipient. 2. The address (URL) of one Notification Recipient.
3. The Delivery Method (i.e., the protocol) which the Printer uses to 3.The Delivery Method (i.e., the protocol) which the Printer uses
send the Event Notification. to send the Event Notification.
4. Some opaque data that the Printer sends to the Notification 4. Some opaque data that the Printer sends to the Notification
Recipient in the Event Notification. The Notification Recipient Recipient in the Event Notification. The Notification Recipient
might use this opaque data as a forwarding address for the Event might use this opaque data as a forwarding address for the Event
Notification. Notification.
5. The charset to use in text fields within an Event Notification 5. The charset to use in text fields within an Event Notification
6. The natural language to use in the text fields of the Event 6. The natural language to use in the text fields of the Event
Notification Notification
7. The requested lease time in seconds for the Subscription Object 7. The requested lease time in seconds for the Subscription Object
An operation that creates a Subscription Object is called a
An operation that creates a Subscription Object is called a Subscription Subscription Creation Operation. These operations include the
Creation Operation. These operations include the following operations following operations (see section 11.1 for further details):
(see section 11.1 for further details):
. Job Creation operation: When a client performs such an operation . Job Creation operation: When a client performs such an operation
(Print-Job, Print-URI, and Create-Job), a client can include zero (Print-Job, Print-URI, and Create-Job), a client can include
or more Subscription Template Attributes Groups in the request. zero or more Subscription Template Attributes Groups in the
The Printer creates one Subscription Object for each Subscription request. The Printer creates one Subscription Object for each
Template Attributes Group in the request, and the Printer Subscription Template Attributes Group in the request, and the
associates each such Subscription Object with the newly created Printer associates each such Subscription Object with the newly
Job. This document extends these operations' definitions in [ipp- created Job. This document extends these operations' definitions
mod] by adding Subscription Template Attributes Groups in the in [RFC2911] by adding Subscription Template Attributes Groups
request and Subscription Attributes Groups in the response. in the request and Subscription Attributes Groups in the
response.
. Create-Job-Subscriptions operation: A client can include one or . Create-Job-Subscriptions operation: A client can include one or
more Subscription Template Attributes Groups in the request. The more Subscription Template Attributes Groups in the request.
Printer creates one Subscription Object for each Subscription The Printer creates one Subscription Object for each
Template Attributes Group and associates each with the job that is Subscription Template Attributes Group and associates each with
the target of this operation. the job that is the target of this operation.
. Create-Printer-Subscriptions operation: A client can include one or . Create-Printer-Subscriptions operation: A client can include one
more Subscription Template Attributes Groups in the request. The or more Subscription Template Attributes Groups in the request.
Printer creates one Subscription Object for each Subscription The Printer creates one Subscription Object for each
Template Attributes Group and associates each with the Printer that Subscription Template Attributes Group and associates each with
is the target of this operation. the Printer that is the target of this operation.
For each of the above operations: For each of the above operations:
. the Printer associates a Subscription Object with the Printer or a . the Printer associates a Subscription Object with the Printer or
specific Job. When a Subscription Object is associated with a Job a specific Job. When a Subscription Object is associated with a
Object, it is called a Per-Job Subscription Object. When a Job Object, it is called a Per-Job Subscription Object. When a
Subscription Object is associated with a Printer Object, it is Subscription Object is associated with a Printer Object, it is
called a Per-Printer Subscription Object. called a Per-Printer Subscription Object.
. the response contains one Subscription Attributes Group for each . the response contains one Subscription Attributes Group for each
Subscription Template Attributes Group in the request and in the Subscription Template Attributes Group in the request and in the
same order. When the Printer successfully creates a Subscription same order. When the Printer successfully creates a Subscription
Object, its corresponding Subscription Attributes Group contains Object, its corresponding Subscription Attributes Group contains
the "notify-subscription-id" attribute. This attribute uniquely the "notify-subscription-id" attribute. This attribute uniquely
identifies the Subscription Object and is analogous to a "job-id" identifies the Subscription Object and is analogous to a "job-
for a Job object. Some operations described below use the "notify- id" for a Job object. Some operations described below use the
subscription-id" to identify the target Subscription Object. "notify-subscription-id" to identify the target Subscription
Object.
This document defines the following additional operations (see section This document defines the following additional operations (see
11.2 for further details): section 11.2 for further details):
. Validate-Job operation: When a client performs this operation, a . Validate-Job operation: When a client performs this operation, a
client can include zero or more Subscription Template Attributes client can include zero or more Subscription Template Attributes
Groups in the request. The Printer determines if it could create Groups in the request. The Printer determines if it could
one Subscription Object for each Subscription Template Attributes create one Subscription Object for each Subscription Template
Group in the request. This document extends this operation's Attributes Group in the request. This document extends this
definition in [ipp-mod] by adding Subscription Template Attributes operation's definition in [RFC2911] by adding Subscription
Groups in the request and Subscription Attributes Groups in the Template Attributes Groups in the request and Subscription
response. Attributes Groups in the response.
. Get-Subscription-Attributes operation: This operation allows a . Get-Subscription-Attributes operation: This operation allows a
client to obtain the specified attributes of a target Subscription client to obtain the specified attributes of a target
Object. Subscription Object.
. Get-Subscriptions operation: This operation allows a client to . Get-Subscriptions operation: This operation allows a client to
obtain the specified attributes of all Subscription Objects obtain the specified attributes of all Subscription Objects
associated with the Printer or a specified Job. associated with the Printer or a specified Job.
. Renew-Subscription operation: This operation renews the lease on . Renew-Subscription operation: This operation renews the lease on
the target Per-Printer Subscription Object before it expires. A the target Per-Printer Subscription Object before it expires. A
newly created Per-Printer Subscription Object receives an initial newly created Per-Printer Subscription Object receives an
lease. It is the duty of the client to use this operation initial lease. It is the duty of the client to use this
frequently enough to preserve a Per-Printer Subscription Object. operation frequently enough to preserve a Per-Printer
The Printer deletes a Per-Printer Subscription Object when its Subscription Object. The Printer deletes a Per-Printer
lease expires. A Per-Job Subscription Object last exactly as long Subscription Object when its lease expires. A Per-Job
as its associated Job Object and thus doesn't have a lease. Subscription Object last exactly as long as its associated Job
Object and thus doesn't have a lease.
. Cancel-Subscription operation: This operation cancels the lease on . Cancel-Subscription operation: This operation cancels the lease
the specified Per-Printer Subscription Object and thereby deletes on the specified Per-Printer Subscription Object and thereby
the Subscription Object. deletes the Subscription Object.
When an Event occurs, the Printer finds all Subscription Objects When an Event occurs, the Printer finds all Subscription Objects
listening for the Event (see section 9 for details on finding such listening for the Event (see section 9 for details on finding such
Subscription Objects). For each such Subscription Object, the Printer: Subscription Objects). For each such Subscription Object, the
Printer:
a) generates an Event Notification with information specified in a) generates an Event Notification with information specified in
section 9, AND section 9, AND
b) either: b) either:
i)delivers the Event Notification using the Delivery Method and
target address identified in the Subscription Object's "notify- i) delivers the Event Notification using the Delivery Method
recipient-uri" attribute if the Delivery Method is a "push", OR and target address identified in the Subscription Object's
"notify-recipient-uri" attribute if the Delivery Method is a
"push", OR
ii) saves Event Notification for a time period defined by the ii) saves Event Notification for a time period defined by the
Delivery Method if the Delivery Method is a "pull", i.e., the Delivery Method if the Delivery Method is a "pull", i.e., the
Notification Recipient is expected to fetch the Event Notification Recipient is expected to fetch the Event
Notifications. Notifications.
2 Models for Notification 2 Models for Notification
2.1 Model for Notification (Simple Case) 2.1 Model for Notification (Simple Case)
As part of a Subscription Creation Operation, an IPP Printer (i.e., As part of a Subscription Creation Operation, an IPP Printer (i.e.,
located in an output device or a server) creates one or more located in an output device or a server) creates one or more
Subscription Objects. In a Subscription Creation Operation, the client Subscription Objects. In a Subscription Creation Operation, the
specifies the Notification Recipient to which the Printer is to deliver client specifies the Notification Recipient to which the Printer is
Event Notifications. A Notification Recipient can be the Subscribing to deliver Event Notifications. A Notification Recipient can be the
Client or a third party. Subscribing Client or a third party.
Figure 1 shows the Notification model for a simple Client-Printer Figure 1 shows the Notification model for a simple Client-Printer
relationship. relationship.
embedded printer: embedded printer:
output device or server output device or server
PDA, desktop, or server +---------------+ PDA, desktop, or server +---------------+
+--------+ | ########### | +--------+ | ########### |
| client |-----Subscription ---------># Printer # | | client |-----Subscription ---------># Printer # |
+--------+ Creation Operation | # Object # | +--------+ Creation Operation | # Object # |
+------------+ | #####|##### | +------------+ | #####|##### |
|Notification| +-------|-------+ |Notification| +-------|-------+
|Recipient |<----IPP Event Notifications----+ |Recipient |<----IPP Event Notifications----+
+------------+ (Job and/or Printer Events) +------------+ (Job and/or Printer Events)
Figure 1 - Model for Notification Figure 1 - Model for Notification
2.2 Model for Notification with Cascading Printers 2.2 Model for Notification with Cascading Printers
With this model, there is an intervening Print server between the human With this model, there is an intervening Print server between the
user and the Printer in the output device. If the Printer in the output human user and the Printer in the output device. If the Printer in
device generates an Event, the system can be configured to send Event the output device generates an Event, the system can be configured to
Notification either send Event Notification either
. directly to the Notification Recipient specified by the Subscribing . directly to the Notification Recipient specified by the
Client or Subscribing Client or
. via the Print Server to the Notification Recipient specified by the . via the Print Server to the Notification Recipient specified by
Subscribing Client. the Subscribing Client.
See Appendix A for more details. See Appendix A for more details.
2.3 Distributed Model for Notification 2.3 Distributed Model for Notification
The preceding sections (2.1 and 2.2) assume that the Notification The preceding sections (2.1 and 2.2) assume that the Notification
software resides in the same device or Server box as the rest of the software resides in the same device or Server box as the rest of the
Printer software. In many implementations, the assumption is correct. Printer software. In many implementations, the assumption is correct.
However, the Notification model also permits a distributed However, the Notification model also permits a distributed
implementation. implementation.
For example, the software that supports both Subscription Creation For example, the software that supports both Subscription Creation
Operations and sending of Event Notifications could be on hardware that Operations and sending of Event Notifications could be on hardware
is separate from the output device. To make this work, there must be a that is separate from the output device. To make this work, there
symbiotic relationship between the output device software and the remote must be a symbiotic relationship between the output device software
Notification software. Without the remote Notification software, the and the remote Notification software. Without the remote Notification
output device software is not a complete Printer. software, the output device software is not a complete Printer.
The term "Printer" in this document includes the software on the output The term "Printer" in this document includes the software on the
device or server box as well as Notification software that is local to output device or server box as well as Notification software that is
or remote from the output device. local to or remote from the output device.
Appendix B describes this example in detail. Appendix B describes this example in detail.
2.4 Extended Notification Recipient 2.4 Extended Notification Recipient
The model allows for an extended Notification Recipient that is itself a The model allows for an extended Notification Recipient that is
Notification service that forwards each Event Notification to another itself a Notification service that forwards each Event Notification
recipient. The client contacts this Notification Recipient to arrange to another recipient. The client contacts this Notification Recipient
for forwarding by means outside the scope of this document. The Printer to arrange for forwarding by means outside the scope of this
need not be aware that the Notification Recipient forwards Event document. The Printer need not be aware that the Notification
Notifications. Recipient forwards Event Notifications.
Appendix C describes this example in detail. Appendix C describes this example in detail.
3 Terminology 3 Terminology
This section defines terminology used throughout this document. Other This section defines terminology used throughout this document. Other
terminology is defined in [ipp-mod]. terminology is defined in [RFC2911].
3.1 Conformance Terminology 3.1 Conformance Terminology
Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD
NOT, MAY, NEED NOT, and OPTIONAL, have special meaning relating to NOT, MAY, NEED NOT, and OPTIONAL, have special meaning relating to
conformance to this specification. These terms are defined in conformance to this specification. These terms are defined in
[ipp-mod section 13.1 on conformance terminology, most of which is [RFC2911 section 13.1 on conformance terminology, most of which is
taken from RFC 2119 [RFC2119]. See Appendix D for complete details. taken from RFC 2119 [RFC2119]. See Appendix D for complete details.
Note: a feature that is OPTIONAL in this document becomes REQUIRED if Note: a feature that is OPTIONAL in this document becomes REQUIRED if
the Printer implements a Delivery Method that REQUIRES the feature the Printer implements a Delivery Method that REQUIRES the feature
READ-ONLY - an adjective used in an attribute definition to indicate READ-ONLY - an adjective used in an attribute definition to indicate
that an IPP Printer MUST NOT allow the attribute's value to be that an IPP Printer MUST NOT allow the attribute's value to be
modified with the Set-Job-Attributes or Set-Printer-Attributes modified with the Set-Job-Attributes or Set-Printer-Attributes
operations (see [ipp-set]). Note: there is no Set-Subscription operations (see [ipp-set]). Note: there is no Set-Subscription
operation so this term is not used for Subscription object operation so this term is not used for Subscription object
skipping to change at page 15, line 16 skipping to change at page 14, line 21
Administrator and controls the day to day running of the print Administrator and controls the day to day running of the print
system. system.
IPP Client (or client) - The software component (PDA, desktop, or IPP Client (or client) - The software component (PDA, desktop, or
server) that performs an IPP operation directed at an IPP Printer server) that performs an IPP operation directed at an IPP Printer
(located in a server or output device). (located in a server or output device).
Job Creation operation - One of the operations that creates a Job Job Creation operation - One of the operations that creates a Job
object: Print-Job, Print-URI and Create-Job. The Validate-Job object: Print-Job, Print-URI and Create-Job. The Validate-Job
operation is not a Job Creation operation because no Job object is operation is not a Job Creation operation because no Job object is
created. Therefore, when a statement also applies to the Validate- created. Therefore, when a statement also applies to the
Job operation, it is mentioned explicitly. Validate-Job operation, it is mentioned explicitly.
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 configuration printing system of a change of state, condition, or configuration
of a Job or Printer object. An Event occurs only at one instant in of a Job or Printer object. An Event occurs only at one instant in
time and does not span the time the physical Event takes place. time and does not span the time the physical Event takes place.
For example, jam-occurred and jam-cleared are two distinct, For example, jam-occurred and jam-cleared are two distinct,
instantaneous Events, even though the jam may last for a while. instantaneous Events, even though the jam may last for a while.
Job Event - an Event caused by some change in a particular job on the Job Event - an Event caused by some change in a particular job on the
Printer, e.g., job-completed. Printer, e.g., job-completed.
skipping to change at page 16, line 22 skipping to change at page 15, line 16
that defines a Delivery Method. that defines a Delivery Method.
Compound Event Notification - two or more Event Notifications that a Compound Event Notification - two or more Event Notifications that a
Printer sends together as a single entity. The Delivery Method Printer sends together as a single entity. The Delivery Method
Document specifies whether the Delivery Method supports Compound Document specifies whether the Delivery Method supports Compound
Event Notifications. Event Notifications.
Subscription Object - An object containing a set of attributes that Subscription Object - An object containing a set of attributes that
indicate: the Notification Recipient, the Delivery Method, the indicate: the Notification Recipient, the Delivery Method, the
Subscribed Events that cause the Printer to send an Event Subscribed Events that cause the Printer to send an Event
Notification, and the information to send in an Event Notification. Notification, and the information to send in an Event
Notification.
Per-Job Subscription Object - A Subscription Object that is Per-Job Subscription Object - A Subscription Object that is
associated with a single Job. The Create-Job-Subscriptions associated with a single Job. The Create-Job-Subscriptions
operation and Job Creation operations create such an object. operation and Job Creation operations create such an object.
Per-Printer Subscription Object - A Subscription Object that is Per-Printer Subscription Object - A Subscription Object that is
associated with the Printer as a whole. The Create-Printer- associated with the Printer as a whole. The Create-Printer-
Subscriptions operation creates such an object. Subscriptions operation creates such an object.
Subscribing Client - The client that creates the Subscription Object. Subscribing Client - The client that creates the Subscription Object.
skipping to change at page 17, line 29 skipping to change at page 16, line 14
Human Consumable Event Notification - localized text for human Human Consumable Event Notification - localized text for human
consumption only. There is no standardized format and thus consumption only. There is no standardized format and thus
programs should not try to parse this text. programs should not try to parse this text.
Machine Consumable Event Notification - bytes for program Machine Consumable Event Notification - bytes for program
consumption. The bytes are formatted according to the Delivery consumption. The bytes are formatted according to the Delivery
Method document. Method document.
Printer - the software that supports an output device or print server Printer - the software that supports an output device or print server
(see IPP/1.1 [ipp-mod] which uses the terms Printer and Printer (see IPP/1.1 [RFC2911] which uses the terms Printer and Printer
object interchangeably). This document extends the IPP/1.1 Printer object interchangeably). This document extends the IPP/1.1 Printer
definition to include the software that implements Subscription definition to include the software that implements Subscription
Creation Operations and the sending of Event Notifications, even if Creation Operations and the sending of Event Notifications, even
the software for such a Printer would be distributed across a if the software for such a Printer would be distributed across a
network (see section 2.3). network (see section 2.3).
Notification - when not in the phrases 'Event Notification' and Notification - when not in the phrases 'Event Notification' and
'Notification Recipient' - the concepts of this specification, 'Notification Recipient' - the concepts of this specification,
i.e., Events, Subscription Objects, and Event Notifications. i.e., Events, Subscription Objects, and Event Notifications.
4 Object Relationships 4 Object Relationships
This section defines the object relationships between the Printer, Job, This section defines the object relationships between the Printer,
and Subscription Objects. It does not define the implementation. For an Job, and Subscription Objects. It does not define the
illustration of these relationships, see Appendix E. implementation. For an illustration of these relationships, see
Appendix E.
4.1 Printer and Per-Printer Subscription Objects 4.1 Printer and Per-Printer Subscription Objects
1. A Printer object can be associated with zero or more Per-Printer 1. A Printer object can be associated with zero or more Per-Printer
Subscription Objects. Subscription Objects.
2. Each Per-Printer Subscription Object is associated with exactly one 2.Each Per-Printer Subscription Object is associated with exactly
Printer object. one Printer object.
4.2 Printer, Job and Per-Job Subscription Objects 4.2 Printer, Job and Per-Job Subscription Objects
1. A Printer object is associated with zero or more Job objects. 1. A Printer object is associated with zero or more Job objects.
2. Each Job object is associated with exactly one Printer object. 2. Each Job object is associated with exactly one Printer object.
3. A Job object is associated with zero or more Per-Job Subscription 3. A Job object is associated with zero or more Per-Job Subscription
Objects. Objects.
4. Each Per-Job Subscription Object is associated with exactly one Job 4.Each Per-Job Subscription Object is associated with exactly one
object. Job object.
5 Subscription Object 5 Subscription Object
A Subscribing Client creates a Subscription Object with a Subscription A Subscribing Client creates a Subscription Object with a
Creation Operation in order to indicate its interest in certain Events. Subscription Creation Operation in order to indicate its interest in
See section 11 for a description of these operations. When an Event certain Events. See section 11 for a description of these operations.
occurs, the Subscription Object specifies to the Printer where to send When an Event occurs, the Subscription Object specifies to the
Event Notifications, how to send them and what to put in them. See Printer where to send Event Notifications, how to send them and what
section 9 for details on the contents of an Event Notification. to put in them. See section 9 for details on the contents of an Event
Notification.
Using the IPP Job Template attributes as a model (see [ipp-mod] section Using the IPP Job Template attributes as a model (see [RFC2911]
4.2), the attributes of a Subscription Object are divided into two section 4.2), the attributes of a Subscription Object are divided
categories: Subscription Template Attributes and Subscription into two categories: Subscription Template Attributes and
Description Attributes. Subscription Description Attributes.
Subscription Template attributes are, in turn, like the Job Template Subscription Template attributes are, in turn, like the Job Template
attributes, divided into attributes, divided into
1. Subscription Object attributes that a client can supply in a 1. Subscription Object attributes that a client can supply in a
Subscription Creation Request and Subscription Creation Request and
2. their associated Printer Object attributes that specify supported 2.their associated Printer Object attributes that specify
and default values for the Subscription Object attributes supported and default values for the Subscription Object
attributes
The remainder of this section specifies general rules for Subscription The remainder of this section specifies general rules for
Template Attributes and describes each attribute in a Subscription Subscription Template Attributes and describes each attribute in a
Object. Subscription Object.
5.1 Rules for Support of Subscription Template Attributes 5.1 Rules for Support of Subscription Template Attributes
Subscription Template Attributes are fundamental to the Notification Subscription Template Attributes are fundamental to the Notification
model described in this specification. The client supplies these model described in this specification. The client supplies these
attributes in Subscription Creation Operations and the Printer uses attributes in Subscription Creation Operations and the Printer uses
these attributes to populate a newly created Subscription Object. these attributes to populate a newly created Subscription Object.
Subscription Objects attributes that are Subscription Template Subscription Objects attributes that are Subscription Template
Attributes conform to the following rules: Attributes conform to the following rules:
1. Each attribute's name starts with the prefix string "notify-" and 1.Each attribute's name starts with the prefix string "notify-"
this document calls such attributes "notify-xxx". and this document calls such attributes "notify-xxx".
2. For each "notify-xxx" Subscription Object attribute defined in 2. For each "notify-xxx" Subscription Object attribute defined in
column 1 of Table 1 in section 5.3, Table 1 specifies corresponding column 1 of Table 1 in section 5.3, Table 1 specifies
Printer attributes: "notify-xxx-default", "notify-xxx-supported", corresponding Printer attributes: "notify-xxx-default", "notify-
"yyy-supported" and "notify-max-xxx-supported" defined in column 2 xxx-supported", "yyy-supported" and "notify-max-xxx-supported"
of Table 1. Note "xxx" stands for the same string in each case and defined in column 2 of Table 1. Note "xxx" stands for the same
"yyy" stands for some other string. string in each case and "yyy" stands for some other string.
3. If a Printer supports "notify-xxx" in column 1 of Table 1, then the 3.If a Printer supports "notify-xxx" in column 1 of Table 1, then
Printer MUST support all associated attributes specified in column the Printer MUST support all associated attributes specified in
2 of Table 1. For example, Table 1 shows that if the Printer column 2 of Table 1. For example, Table 1 shows that if the
supports "notify-events", it MUST support "notify-events-default", Printer supports "notify-events", it MUST support "notify-
"notify-events-supported" and "notify-max-events-supported". events-default", "notify-events-supported" and "notify-max-
events-supported".
4. If a Printer does not support "notify-xxx" in column 1 of Table 1, 4.If a Printer does not support "notify-xxx" in column 1 of Table
then the Printer MUST NOT support any associated "notify-yyy" 1, then the Printer MUST NOT support any associated "notify-yyy"
attributes specified in column 2 of Table 1. For example, Table 1 attributes specified in column 2 of Table 1. For example, Table
shows that if the Printer doesn't support "notify-events", it MUST 1 shows that if the Printer doesn't support "notify-events", it
NOT support "notify-events-default", "notify-events-supported" and MUST NOT support "notify-events-default", "notify-events-
"notify-max-events-supported". Note this rule does not apply to supported" and "notify-max-events-supported". Note this rule
attributes whose names do not start with the string "notify-" and does not apply to attributes whose names do not start with the
are thus defined in another object and used by other attributes. string "notify-" and are thus defined in another object and used
by other attributes.
5. Most "notify-xxx" attributes have a corresponding "yyy-supported" 5.Most "notify-xxx" attributes have a corresponding "yyy-
attribute that specifies the supported values for "notify-xxx". supported" attribute that specifies the supported values for
Column 2 of Table 1 specifies the name of each "yyy-supported" "notify-xxx". Column 2 of Table 1 specifies the name of each
attribute. The naming rules of IPP/1.1 (see [ipp-mod]) are used "yyy-supported" attribute. The naming rules of IPP/1.1 (see
when "yyy-supported" is "notify-xxx-supported". [RFC2911]) are used when "yyy-supported" is "notify-xxx-
supported".
6. Some "notify-xxx" attributes have a corresponding "notify-xxx- 6. Some "notify-xxx" attributes have a corresponding "notify-xxx-
default" attribute that specifies the value for "notify-xxx" if the default" attribute that specifies the value for "notify-xxx" if
client does not supply it. Column 2 of Table 1 specifies the name the client does not supply it. Column 2 of Table 1 specifies the
of each "notify-xxx-default" attribute. The naming rules of IPP/1.1 name of each "notify-xxx-default" attribute. The naming rules of
(see [ipp-mod]) are used. IPP/1.1 (see [RFC2911]) are used.
If a client wishes to present an end user with a list of supported If a client wishes to present an end user with a list of supported
values from which to choose, the client SHOULD query the Printer for its values from which to choose, the client SHOULD query the Printer for
supported value attributes. The client SHOULD also query the default its supported value attributes. The client SHOULD also query the
value attributes. If the client then limits selectable values to only default value attributes. If the client then limits selectable
those values that are supported, the client can guarantee that the values to only those values that are supported, the client can
values supplied by the client in the create request all fall within the guarantee that the values supplied by the client in the create
set of supported values at the Printer. When querying the Printer, the request all fall within the set of supported values at the Printer.
client MAY enumerate each attribute by name in the Get-Printer- When querying the Printer, the client MAY enumerate each attribute by
Attributes Request, or the client MAY just supply the 'subscription- name in the Get-Printer-Attributes Request, or the client MAY just
template' group name in order to get the complete set of supported supply the 'subscription-template' group name in order to get the
attributes (both supported and default attributes). complete set of supported attributes (both supported and default
attributes).
5.2 Rules for Processing Subscription Template Attributes 5.2 Rules for Processing Subscription Template Attributes
This section defines a detailed set of rules that a Printer follows when This section defines a detailed set of rules that a Printer follows
it processes Subscription Template Attributes in a Subscription Creation when it processes Subscription Template Attributes in a Subscription
Request. These rules for are similar to the rules for processing Creation Request. These rules for are similar to the rules for
Operation attributes in [ipp-mod]. That is, the Printer may or may not processing Operation attributes in [RFC2911]. That is, the Printer
support an attribute and a client may or may not supply the attribute. may or may not support an attribute and a client may or may not
Some combinations of these cases are OK. Others return warnings or supply the attribute. Some combinations of these cases are OK. Others
errors, and perhaps a list of unsupported attributes. return warnings or errors, and perhaps a list of unsupported
attributes.
A Printer MUST implement the following behavior for processing A Printer MUST implement the following behavior for processing
Subscription Template Attributes in a Subscription Creation Request: Subscription Template Attributes in a Subscription Creation Request:
1. If a client supplies a "notify-xxx" attribute from column 1 of 1. If a client supplies a "notify-xxx" attribute from column 1 of
Table 1 and the Printer supports it and its value, the Printer MUST Table 1 and the Printer supports it and its value, the Printer
populate the attribute on the created Subscription Object. MUST populate the attribute on the created Subscription Object.
2. If a client supplies a "notify-xxx" attribute from column 1 of 2. If a client supplies a "notify-xxx" attribute from column 1 of
Table 1 and the Printer doesn't support it or its value, the Table 1 and the Printer doesn't support it or its value, the
Printer MUST NOT populate the attribute on the created Subscription Printer MUST NOT populate the attribute on the created
Object with it. The Printer MUST do one of the following: Subscription Object with it. The Printer MUST do one of the
following:
a)If the value of the "notify-xxx" attribute is unsupported, the a)If the value of the "notify-xxx" attribute is unsupported, the
Printer MUST return the attribute with its value in the Printer MUST return the attribute with its value in the
Subscription Attributes Group of the response. Subscription Attributes Group of the response.
b)If "notify-xxx" is an unsupported attribute, the Printer MUST b)If "notify-xxx" is an unsupported attribute, the Printer MUST
return the attribute in the Subscription Attributes Group of the return the attribute in the Subscription Attributes Group of the
response with the 'unsupported' out-of-band value. response with the 'unsupported' out-of-band value.
Note: The rules of this step are the same as for Unsupported Note: The rules of this step are the same as for Unsupported
Attributes [ipp-mod] section 3.1.7. except that the unsupported Attributes [RFC2911] section 3.1.7. except that the unsupported
attributes are returned in the Subscription Attributes Group rather attributes are returned in the Subscription Attributes Group
than the Unsupported Attributes Group because Subscription Creation rather than the Unsupported Attributes Group because Subscription
Operations can create more than one Subscription Object). Creation Operations can create more than one Subscription Object).
3. If a client is REQUIRED to supply a "notify-xxx" attribute from 3. If a client is REQUIRED to supply a "notify-xxx" attribute from
column 1 of Table 1 and the Printer doesn't support the supplied column 1 of Table 1 and the Printer doesn't support the supplied
value, the Printer MUST NOT create a Subscription Object. The rules value, the Printer MUST NOT create a Subscription Object. The
for Unsupported Attributes in step #2 still apply. rules for Unsupported Attributes in step #2 still apply.
4. If a client does not supply a "notify-xxx" attribute from column 1 4. If a client does not supply a "notify-xxx" attribute from column 1
of Table 1 and the attribute is REQUIRED for the client to supply, of Table 1 and the attribute is REQUIRED for the client to supply,
the Printer MUST reject the Subscription Creation Operation the Printer MUST reject the Subscription Creation Operation
(including Job Creation operations) without creating a Subscription (including Job Creation operations) without creating a
Object, and MUST return in the response: Subscription Object, and MUST return in the response:
c)the status code 'client-error-bad-request' AND c)the status code 'client-error-bad-request' AND
d)no Subscription Attribute Groups. d)no Subscription Attribute Groups.
5. If a client does not supply a "notify-xxx" attribute from column 1 5. If a client does not supply a "notify-xxx" attribute from column 1
of Table 1 that is OPTIONAL for the client to supply, and column 2 of Table 1 that is OPTIONAL for the client to supply, and column 2
of Table 1 either: of Table 1 either:
a)specifies a "notify-xxx-default" attribute, the Printer MUST a)specifies a "notify-xxx-default" attribute, the Printer MUST
behave as if the client had supplied the "notify-xxx-default" behave as if the client had supplied the "notify-xxx-default"
attribute (see step #1) and populate the Subscription object attribute (see step #1) and populate the Subscription object
with the value of the "notify-xxx-default" attribute as part of with the value of the "notify-xxx-default" attribute as part of
the Subscription Creation operation (unlike Job Template the Subscription Creation operation (unlike Job Template
attributes where the Printer does not populate the Job object attributes where the Printer does not populate the Job object
with defaults - see [ipp-mod]) OR with defaults - see [RFC2911]) OR
b)does not specify a "notify-xxx-default" attribute, the Printer b)does not specify a "notify-xxx-default" attribute, the Printer
MUST populate the "notify-xxx" attribute on the Subscription MUST populate the "notify-xxx" attribute on the Subscription
Object according to the definition of the "notify-xxx" attribute Object according to the definition of the "notify-xxx" attribute
in a section 5.3. For some attributes, the "notify-xxx" is in a section 5.3. For some attributes, the "notify-xxx" is
populated with the value of some other attribute, and for populated with the value of some other attribute, and for
others, the "notify-xxx" is NOT populated on the Subscription others, the "notify-xxx" is NOT populated on the Subscription
object at all. object at all.
6. A Printer MUST create a Subscription Object for each Subscription 6. A Printer MUST create a Subscription Object for each Subscription
skipping to change at page 22, line 41 skipping to change at page 20, line 41
c)would create a Per-Printer Subscription Object when it doesn't c)would create a Per-Printer Subscription Object when it doesn't
have space for another Per-Printer Subscription Object. have space for another Per-Printer Subscription Object.
7. A response MUST contain one Subscription Attributes Group for each 7. A response MUST contain one Subscription Attributes Group for each
Subscription Template Attributes Group in the request (and in the Subscription Template Attributes Group in the request (and in the
same order) whether the Printer creates a Subscription Object from same order) whether the Printer creates a Subscription Object from
the Subscription Template Attributes Group or not. However, the the Subscription Template Attributes Group or not. However, the
attributes in each Subscription Attributes Group can be in any attributes in each Subscription Attributes Group can be in any
order. order.
8. The Printer MUST populate each Subscription Attributes Group of the 8.The Printer MUST populate each Subscription Attributes Group of
response such that each contains: the response such that each contains:
a)the "notify-subscription-id" attribute (see section 5.4.1), if a) the "notify-subscription-id" attribute (see section 0), if and
and only if the Printer creates a Subscription Object. only if the Printer creates a Subscription Object.
b)the "notify-lease-duration" attribute (see section 5.3.7), if b)the "notify-lease-duration" attribute (see section 5.3.7), if
and only if the Printer creates a Per-Printer Subscription and only if the Printer creates a Per-Printer Subscription
Object. The value of this attribute is the value of the Object. The value of this attribute is the value of the
Subscription Object's "notify-lease-duration" attribute. This Subscription Object's "notify-lease-duration" attribute. This
value MAY be different from the client-supplied value (see value MAY be different from the client-supplied value (see
section 5.3.7). If a client supplies this attribute in the section 5.3.7). If a client supplies this attribute in the
creation of a Per-Job Subscription Object, it MUST appear in creation of a Per-Job Subscription Object, it MUST appear in
this group with the out-of-band value 'unsupported' to indicate this group with the out-of-band value 'unsupported' to indicate
that the Printer doesn't support it in this context. that the Printer doesn't support it in this context.
skipping to change at page 23, line 42 skipping to change at page 21, line 34
resulting step #6a) that causes the Printer not to create resulting step #6a) that causes the Printer not to create
the Subscription Object. the Subscription Object.
'client-error-too-many-subscriptions': the Subscription 'client-error-too-many-subscriptions': the Subscription
Object was not created because the Printer has no space for Object was not created because the Printer has no space for
additional Subscription Objects. The client SHOULD try additional Subscription Objects. The client SHOULD try
again later. See section 17.2 for more details about this again later. See section 17.2 for more details about this
status code. See steps #6b) and #6c) in this section for status code. See steps #6b) and #6c) in this section for
the cases that causes this error. the cases that causes this error.
'successful-ok-too-many-events': the Subscription Object was 'successful-ok-too-many-events': the Subscription Object
created without the "notify-events" values included in this was created without the "notify-events" values included in
Subscription Attributes Group because the "notify-events" this Subscription Attributes Group because the "notify-
attribute contains too many values. See section 17.3 for events" attribute contains too many values. See section
more details about this status code. See step #2 in this 17.3 for more details about this status code. See step #2
section and section 5.3.2 for the cases that cause this in this section and section 5.3.2 for the cases that cause
status code. this status code.
'successful-ok-ignored-or-substituted-attributes' : the 'successful-ok-ignored-or-substituted-attributes' : the
Subscription Object was created but some supplied Subscription Object was created but some supplied
Subscription Template Attributes are unsupported. These Subscription Template Attributes are unsupported. These
unsupported attributes are also in the Subscription unsupported attributes are also in the Subscription
Attributes Group. See section 17.4 for more details about Attributes Group. See section 17.4 for more details about
this status code. See step #2 in this section for the cases this status code. See step #2 in this section for the cases
that cause this status code. that cause this status code.
9. The Printer MUST validate all Subscription Template Attributes and 9. The Printer MUST validate all Subscription Template Attributes and
MUST return all unsupported attributes and values in the MUST return all unsupported attributes and values in the
corresponding Subscription Attributes Group of the response (see corresponding Subscription Attributes Group of the response (see
step #2) unless it determines that it could not create additional step #2) unless it determines that it could not create additional
Subscription Objects because of condition #6b) or condition #6c). Subscription Objects because of condition #6b) or condition #6c).
Then, the Printer NEED NOT validate these additional Subscription Then, the Printer NEED NOT validate these additional Subscription
Template Attributes and the client MUST NOT expect to find Template Attributes and the client MUST NOT expect to find
unsupported attributes from step #2 in such additional Subscription unsupported attributes from step #2 in such additional
Attribute Groups. Subscription Attribute Groups.
5.3 Subscription Template Attributes 5.3 Subscription Template Attributes
This section contains the Subscription Template Attributes defined for This section contains the Subscription Template Attributes defined
the Subscription and Printer objects. for the Subscription and Printer objects.
Table 1 below shows the Subscription Template Attributes and has two Table 1 below shows the Subscription Template Attributes and has two
columns: columns:
. Attribute in Subscription Object: the name and attribute syntax of . Attribute in Subscription Object: the name and attribute syntax
each Subscription Object Attribute that is a Subscription Template of each Subscription Object Attribute that is a Subscription
Attribute Template Attribute
. Default and Supported Printer Attributes: the default attribute and . Default and Supported Printer Attributes: the default attribute
supported Printer attributes that are associated with the attribute and supported Printer attributes that are associated with the
in column 1. attribute in column 1.
A Printer MUST support all attributes in Table 1 below except for A Printer MUST support all attributes in Table 1 below except for
"notify-attributes" (and "notify-attributes-supported"). A client MUST "notify-attributes" (and "notify-attributes-supported"). A client
supply "notify-recipient-uri" and MAY omit any of the rest of the MUST supply "notify-recipient-uri" and MAY omit any of the rest of
attributes in column 1 of Table 1 in a Subscription Creation Request. the attributes in column 1 of Table 1 in a Subscription Creation
Request.
Table 1 - Subscription Template Attributes Table 1 - Subscription Template Attributes
Attribute in Subscription Default and Supported Printer Attribute in Subscription Default and Supported Printer
Object Attributes Object Attributes
notify-recipient-uri (uri) notify-schemes-supported (1setOf notify-recipient-uri (uri) notify-schemes-supported (1setOf
uriScheme) uriScheme)
notify-events (1setOf type2 notify-events-default (1setOf type2 notify-events (1setOf type2 notify-events-default (1setOf type2
skipping to change at page 25, line 33 skipping to change at page 23, line 33
notify-user-data notify-user-data
(octetString(63)) (octetString(63))
notify-charset (charset) charset-supported (1setOf charset) notify-charset (charset) charset-supported (1setOf charset)
notify-natural-languages generated-natural-language-supported notify-natural-languages generated-natural-language-supported
(naturalLanguage) (1setOf naturalLanguage) (naturalLanguage) (1setOf naturalLanguage)
notify-lease-duration notify-lease-duration-default notify-lease-duration notify-lease-duration-default
(integer(0:MAX)) (integer(0:67108863)) (integer(0:MAX)) (integer(0:67108863))
notify-lease-duration-supported (1setOf notify-lease-duration-supported
(integer(0: 67108863) | (1setOf (integer(0: 67108863) |
rangeOfInteger(0:67108863))) rangeOfInteger(0:67108863)))
notify-time-interval notify-time-interval
(integer(0:MAX)) (integer(0:MAX))
5.3.1 notify-recipient-uri (uri) 5.3.1 notify-recipient-uri (uri)
This attribute's value is a URL, which is a special case of a URI. Its This attribute's value is a URL, which is a special case of a URI.
value consists of a scheme and an address. The address specifies the Its value consists of a scheme and an address. The address specifies
Notification Recipient and the scheme specifies the Delivery Method for the Notification Recipient and the scheme specifies the Delivery
each Event Notification associated with this Subscription Object. Method for each Event Notification associated with this Subscription
Object.
A Printer MUST support this attribute. A Printer MUST support this attribute.
A client MUST supply this attribute in Subscription Creation Operation. A client MUST supply this attribute in Subscription Creation
Thus there is no need for a default attribute. Operation. Thus there is no need for a default attribute.
The "notify-schemes-supported (1setOf uriScheme)" attribute MUST specify The "notify-schemes-supported (1setOf uriScheme)" attribute MUST
the schemes supported for this attribute. specify the schemes supported for this attribute. Note: According to
[RFC1738] the ":" terminates the scheme and so is not part of the
scheme. Therefore, values of this attribute do not include the ":".
If the client supplies an unsupported scheme in the value of this If the client supplies an unsupported scheme in the value of this
attribute, then the Printer MUST not create the Subscription Object and attribute, then the Printer MUST not create the Subscription Object
MUST return the "notify-status-code" attribute with the 'client-error- and MUST return the "notify-status-code" attribute with the 'client-
uri-scheme-not-supported' value in the Subscription Attributes Group in error-uri-scheme-not-supported' value in the Subscription Attributes
the response. Group in the response.
The Printer MUST treat the address part of this attribute as opaque. The Printer MUST treat the address part of this attribute as opaque.
5.3.2 notify-events (1setOf type2 keyword) 5.3.2 notify-events (1setOf type2 keyword)
This attribute contains a set of Subscribed Events. When an Event This attribute contains a set of Subscribed Events. When an Event
occurs and it "matches" a value of this attribute, the Printer sends an occurs and it "matches" a value of this attribute, the Printer sends
Event Notification using information in the Subscription Object. The an Event Notification using information in the Subscription Object.
details of "matching" are described subsection 5.3.2.2. The details of "matching" are described subsection 5.3.2.2.
A Printer MUST support this attribute. A Printer MUST support this attribute.
A client MAY supply this attribute in a Subscription Creation Operation. A client MAY supply this attribute in a Subscription Creation
If the client does not supply this attribute in Subscription Creation Operation. If the client does not supply this attribute in
Operation, the Printer MUST populate this attribute on the Subscription Subscription Creation Operation, the Printer MUST populate this
Object with its "notify-events-default" attribute value. attribute on the Subscription Object with its "notify-events-default"
attribute value.
Each value of this attribute on a Subscription Object MUST be one of the Each value of this attribute on a Subscription Object MUST be one of
values of the "notify-events-supported (1setOf type2 keyword)" the values of the "notify-events-supported (1setOf type2 keyword)"
attribute. attribute.
The number of values of this attribute MUST NOT exceed the value of the The number of values of this attribute MUST NOT exceed the value of
"notify-max-events-supported" attribute. A Printer MUST support at least the "notify-max-events-supported" attribute. A Printer MUST support
2 values per Subscription Object. If the number of values supplied by a at least 2 values per Subscription Object. If the number of values
client in a Subscription Creation Operation exceeds the value of this supplied by a client in a Subscription Creation Operation exceeds the
attribute, the Printer MUST treat extra values as unsupported values and value of this attribute, the Printer MUST treat extra values as
MUST use the value of 'successful-ok-too-many-events' for the "notify- unsupported values and MUST use the value of 'successful-ok-too-many-
status-code" attribute in the Subscription Attributes Group of the events' for the "notify-status-code" attribute in the Subscription
response. Attributes Group of the response.
5.3.2.1Standard Values for Subscribed Events 5.3.2.1Standard Values for Subscribed Events
Each value of this attribute is a keyword and it specifies a Subscribed Each value of this attribute is a keyword and it specifies a
Event that represents certain changes. Some keywords represent a subset Subscribed Event that represents certain changes. Some keywords
of changes of another keyword, e.g., 'job-completed' is an Event value represent a subset of changes of another keyword, e.g., 'job-
which is a sub-value of 'job-state-change'. See section 5.3.2.2 for the completed' is an Event value which is a sub-value of 'job-state-
case where this attribute contains both a value and a sub-value. change'. See section 5.3.2.2 for the case where this attribute
contains both a value and a sub-value.
The values in this section are divided into three categories: No Events, The values in this section are divided into three categories: No
Job Events and Printer Events. Events, Job Events and Printer Events.
A Printer MUST support the Events indicated as "REQUIRED" and MAY A Printer MUST support the Events indicated as "REQUIRED" and MAY
support the Events indicated as "OPTIONAL". support the Events indicated as "OPTIONAL".
5.3.2.1.1 No Events 5.3.2.1.1 No Events
The standard and only keyword value for No Events is: The standard and only keyword value for No Events is:
'none': REQUIRED - no Event Notifications for any Events. As the 'none': REQUIRED - no Event Notifications for any Events. As the
sole value of "notify-events-supported", this value means that the sole value of "notify-events-supported", this value means that the
Printer does not support the sending of Event Notifications. As the Printer does not support the sending of Event Notifications. As
sole value of "notify-events-default", this value means that a the sole value of "notify-events-default", this value means that a
client MUST specify the "notify-events" attribute in order for a client MUST specify the "notify-events" attribute in order for a
Subscription Creation Operation to succeed. If the Printer receives Subscription Creation Operation to succeed. If the Printer
this value as the sole value of a Subscription Creation Operation, receives this value as the sole value of a Subscription Creation
it does not create a Subscription Object. If a Printer receives Operation, it does not create a Subscription Object. If a Printer
this value with other values of a Subscription Creation Operation, receives this value with other values of a Subscription Creation
the Printer MUST treat this value as an unsupported value. Operation, the Printer MUST treat this value as an unsupported
value.
5.3.2.1.2 Subscribed Printer Events 5.3.2.1.2 Subscribed Printer Events
The standard keyword values for Subscribed Printer Events are: The standard keyword values for Subscribed Printer Events are:
'printer-state-changed': REQUIRED - the Printer changed state from 'printer-state-changed': REQUIRED - the Printer changed state from
any state to any other state. Specifically, the value of the any state to any other state. Specifically, the value of the
Printer's "printer-state", "printer-state-reasons" or "printer-is- Printer's "printer-state", "printer-state-reasons" or "printer-is-
accepting-jobs" attributes changed. accepting-jobs" attributes changed.
This Subscribed Event value has the following sub-values: 'printer- This Subscribed Event value has the following sub-values:
restarted' and 'printer-shutdown'. A client can listen for any of 'printer-restarted' and 'printer-shutdown'. A client can listen
these sub-values if it doesn't want to listen to all printer-state for any of these sub-values if it doesn't want to listen to all
changes: printer-state changes:
'printer-restarted': OPTIONAL - when the printer is powered up . 'printer-restarted': OPTIONAL - when the printer is powered
up .
'printer-shutdown': OPTIONAL - when the device is being powered 'printer-shutdown': OPTIONAL - when the device is being
down . powered down .
'printer-stopped: REQUIRED - when the printer stops printing, i.e. 'printer-stopped: REQUIRED - when the printer stops printing,
the value of the "printer-state" Printer attribute becomes i.e. the value of the "printer-state" Printer attribute
'stopped'. becomes 'stopped'.
'printer-config-changed': OPTIONAL - when the configuration of a 'printer-config-changed': OPTIONAL - when the configuration of a
Printer has changed, i.e., the value of the "printer-message-from- Printer has changed, i.e., the value of the "printer-message-from-
operator" or any "configuration" Printer attribute has changed. A operator" or any "configuration" Printer attribute has changed. A
"configuration" Printer attribute is an attribute which can change "configuration" Printer attribute is an attribute which can change
value because of some human interaction either direct or indirect, value because of some human interaction either direct or indirect,
and which is not covered by one of the other Events in this and which is not covered by one of the other Events in this
section. Examples of "configuration" Printer attributes are any of section. Examples of "configuration" Printer attributes are any of
the Job Template attributes, such as "xxx-supported", "xxx-ready" the Job Template attributes, such as "xxx-supported", "xxx-ready"
and "xxx-default". Often, such a change is the result of a client and "xxx-default". Often, such a change is the result of a client
performing a Set-Printer-Attributes operation (see [ipp-set]) on performing a Set-Printer-Attributes operation (see [ipp-set]) on
the Printer. The client has to perform a Get-Printer-Attributes to the Printer. The client has to perform a Get-Printer-Attributes to
find out the new values of these changed attributes. This Event is find out the new values of these changed attributes. This Event
useful for GUI clients and drivers to update the available printer is useful for GUI clients and drivers to update the available
capabilities to the user. printer capabilities to the user.
This Event value has the following sub-values: 'printer-media- This Event value has the following sub-values: 'printer-media-
changed' and 'printer-finishings-changed'. A client can listen for changed' and 'printer-finishings-changed'. A client can listen for
any of these sub-values if it doesn't want to listen to all any of these sub-values if it doesn't want to listen to all
printer-configuration changes: printer-configuration changes:
'printer-media-changed': OPTIONAL - when the media loaded on a 'printer-media-changed': OPTIONAL - when the media loaded on
printer has been changed, i.e., the "media-ready" attribute has a printer has been changed, i.e., the "media-ready"
changed. This Event includes two cases: an input tray that goes attribute has changed. This Event includes two cases: an
empty and an input tray that receives additional media of the input tray that goes empty and an input tray that receives
same type or of a different type. The client must check the additional media of the same type or of a different type.
"media-ready" Printer attribute (see [ipp-mod] section 4.2.11) The client must check the "media-ready" Printer attribute
separately to find out what changed. (see [RFC2911] section 4.2.11) separately to find out what
changed.
'printer-finishings-changed': OPTIONAL - when the finisher on a 'printer-finishings-changed': OPTIONAL - when the finisher on
printer has been changed, i.e., the "finishings-ready" attribute a printer has been changed, i.e., the "finishings-ready"
has changed. This Event includes two cases: a finisher that goes attribute has changed. This Event includes two cases: a
empty and a finisher that is refilled (even if it is not full). finisher that goes empty and a finisher that is refilled
The client must check the "finishings-ready" Printer attribute (even if it is not full). The client must check the
separately to find out what changed. "finishings-ready" Printer attribute separately to find out
what changed.
'printer-queue-order-changed': OPTIONAL - the order of jobs in the 'printer-queue-order-changed': OPTIONAL - the order of jobs in the
Printer's queue has changed, so that an application that is Printer's queue has changed, so that an application that is
monitoring the queue can perform a Get-Jobs operation to determine monitoring the queue can perform a Get-Jobs operation to determine
the new order. This Event does not include when a job enters the the new order. This Event does not include when a job enters the
queue (the 'job-created' Event covers that) and does not include queue (the 'job-created' Event covers that) and does not include
when a job leaves the queue (the 'job-completed' Event covers when a job leaves the queue (the 'job-completed' Event covers
that). that).
5.3.2.1.3 Subscribed Job Events 5.3.2.1.3 Subscribed Job Events
The standard keyword values for Subscribed Job Events are: The standard keyword values for Subscribed Job Events are:
'job-state-changed': REQUIRED - the job has changed from any state 'job-state-changed': REQUIRED - the job has changed from any state
to any other state. Specifically, the Printer sends this Event to any other state. Specifically, the Printer sends this Event
whenever the value of the "job-state" attribute or "job-state- whenever the value of the "job-state" attribute or "job-state-
reasons" attribute changes. When a Job is removed from the Job reasons" attribute changes. When a Job is removed from the Job
History (see [ipp-mod] 4.3.7.1), no Event is generated. History (see [RFC2911] 4.3.7.1), no Event is generated.
This Event value has the following sub-values: 'job-created', 'job- This Event value has the following sub-values: 'job-created',
completed' and 'job-stopped'. A client can listen for any of these 'job-completed' and 'job-stopped'. A client can listen for any of
sub-values if it doesn't want to listen to all 'job-state changes'. these sub-values if it doesn't want to listen to all 'job-state
changes'.
'job-created': REQUIRED - the Printer has accepted a Job Creation 'job-created': REQUIRED - the Printer has accepted a Job
operation and the job's "time-at-creation" attribute value is Creation operation and the job's "time-at-creation"
set (see [ipp-mod] section 4.3.14.1). The Printer puts the job attribute value is set (see [RFC2911] section 4.3.14.1).
in the 'pending', 'pending-held' or 'processing' states.. The Printer puts the job in the 'pending', 'pending-held'
or 'processing' states..
'job-completed': REQUIRED - the job has reached one of the 'job-completed': REQUIRED - the job has reached one of the
completed states, i.e., the value of the job's "job-state" completed states, i.e., the value of the job's "job-state"
attribute has changed to: 'completed', 'aborted', or 'canceled'. attribute has changed to: 'completed', 'aborted', or
The Job's "time-at-completed" and "date-time-at-completed" (if 'canceled'. The Job's "time-at-completed" and "date-time-
supported) attributes are set (see [ipp-mod] section 4.3.14).. at-completed" (if supported) attributes are set (see
The Printer also sends this Event when a Job is removed with the [RFC2911] section 4.3.14).. The Printer also sends this
Purge-Job operation. In this case, the Event Notification MUST Event when a Job is removed with the Purge-Job operation.
report the 'job-state' as 'canceled'. In this case, the Event Notification MUST report the 'job-
state' as 'canceled'.
'job-stopped: OPTIONAL - when the job stops printing, i.e. the
value of the "job-state" Job attribute becomes 'processing-
stopped'.
'job-config-changed': OPTIONAL - when the configuration of a job 'job-stopped: OPTIONAL - when the job stops printing, i.e.
has changed, i.e., the value of the "job-message-from-operator" or the value of the "job-state" Job attribute becomes
any of the "configuration" Job attributes have changed. A 'processing-stopped'.
"configuration" Job attribute is an attribute that can change value
because of some human interaction either direct or indirect.
'job-config-changed': OPTIONAL - when the configuration of a job has
changed, i.e., the value of the "job-message-from-operator" or any
of the "configuration" Job attributes have changed. A
"configuration" Job attribute is an attribute that can change
value because of some human interaction either direct or indirect.
Examples of "configuration" Job attributes are any of the job Examples of "configuration" Job attributes are any of the job
template attributes and the "job-name" attribute. Often, such a template attributes and the "job-name" attribute. Often, such a
change is the result of the user or the Operator performing a Set- change is the result of the user or the Operator performing a Set-
Job-Attributes operation (see [ipp-set]) on the Job object. The Job-Attributes operation (see [ipp-set]) on the Job object. The
client performs a Get-Job-Attributes to find out the new values of client performs a Get-Job-Attributes to find out the new values of
the changed attributes. This Event is useful for GUI clients and the changed attributes. This Event is useful for GUI clients and
drivers to update the job information to the user. drivers to update the job information to the user.
'job-progress': OPTIONAL - when the Printer has completed Printing a 'job-progress': OPTIONAL - when the Printer has completed Printing a
sheet. See the separate [ipp-prog] specification for additional sheet. See the separate [ipp-prog] specification for additional
skipping to change at page 30, line 31 skipping to change at page 28, line 17
5.3.2.2Rules for Matching of Subscribed Events 5.3.2.2Rules for Matching of Subscribed Events
When an Event occurs, the Printer MUST find each Subscription object When an Event occurs, the Printer MUST find each Subscription object
whose "notify-events" attribute "matches" the Event. The rules for whose "notify-events" attribute "matches" the Event. The rules for
"matching" of Subscribed Events are described separately for Printer "matching" of Subscribed Events are described separately for Printer
Events and for Job Events. This section also describes some special Events and for Job Events. This section also describes some special
cases. cases.
5.3.2.2.1 Rules for Matching of Printer Events 5.3.2.2.1 Rules for Matching of Printer Events
Suppose that the Printer causes Printer Event E to occur. For each Per- Suppose that the Printer causes Printer Event E to occur. For each
Job or Per-Printer Subscription S in the Printer, if E equals a value of Per-Job or Per-Printer Subscription S in the Printer, if E equals a
this attribute in S or E is a sub-value of a value of this attribute in value of this attribute in S or E is a sub-value of a value of this
S, the Printer MUST generate an Event Notification. attribute in S, the Printer MUST generate an Event Notification.
Consider the example. There are three Subscription Objects each with Consider the example. There are three Subscription Objects each with
the Subscribed Printer Event 'printer-state-changed'. Subscription the Subscribed Printer Event 'printer-state-changed'. Subscription
Object A is a Per-Printer Subscription Object. Subscription Object B Object A is a Per-Printer Subscription Object. Subscription Object B
is a Per-Job Subscription Object for Job 1, and Subscription Object C is a Per-Job Subscription Object for Job 1, and Subscription Object C
is a Per-Job Subscription Object for Job 2. When the Printer enters is a Per-Job Subscription Object for Job 2. When the Printer enters
the 'stopped' state, the Printer sends an Event Notification to the the 'stopped' state, the Printer sends an Event Notification to the
Notification Recipients of Subscription Objects A, B, and C because Notification Recipients of Subscription Objects A, B, and C because
this is a Printer Event. Note if Job 1 has already completed, the this is a Printer Event. Note if Job 1 has already completed, the
Printer would not send an Event Notification for its Subscription Printer would not send an Event Notification for its Subscription
Object. Object.
5.3.2.2.2 Rules for Matching of Job Events 5.3.2.2.2 Rules for Matching of Job Events
Suppose that Job J causes Job Event E to occur. Suppose that Job J causes Job Event E to occur.
1. For each Per-Printer Subscription S in the Printer, if E equals a 1.For each Per-Printer Subscription S in the Printer, if E equals
value of this attribute in S or E is a sub-value of a value of this
attribute in S, the Printer MUST generate an Event Notification.
2. For each Per-Job Subscription S associated with Job J, if E equals
a value of this attribute in S or E is a sub-value of a value of a value of this attribute in S or E is a sub-value of a value of
this attribute in S, the Printer MUST generate an Event this attribute in S, the Printer MUST generate an Event
Notification. Notification.
3. For each Per-Job Subscription S that is NOT associated Job J, if E 2.For each Per-Job Subscription S associated with Job J, if E
equals a value of this attribute in S or E is a sub-value of a equals a value of this attribute in S or E is a sub-value of a
value of this attribute in, the Printer MUST NOT generate an Event value of this attribute in S, the Printer MUST generate an Event
Notification from S. Notification.
3.For each Per-Job Subscription S that is NOT associated Job J, if
E equals a value of this attribute in S or E is a sub-value of a
value of this attribute in, the Printer MUST NOT generate an
Event Notification from S.
Consider the example: There are three Subscription Objects listening Consider the example: There are three Subscription Objects listening
for the Job Event 'job-completed'. Subscription Object A is a Per- for the Job Event 'job-completed'. Subscription Object A is a Per-
Printer Subscription Object. Subscription Object B is a Per-Job Printer Subscription Object. Subscription Object B is a Per-Job
Subscription Object for Job 1, and Subscription Object C is a Per-Job Subscription Object for Job 1, and Subscription Object C is a Per-Job
Subscription Object for Job 2. In addition, Per-Printer Subscription Subscription Object for Job 2. In addition, Per-Printer Subscription
Object D is listening for the Job Event 'job-state-changed'. When Job Object D is listening for the Job Event 'job-state-changed'. When Job
1 completes, the Printer sends an Event Notification to the 1 completes, the Printer sends an Event Notification to the
Notification Recipient of Subscription Object A (because it is Per- Notification Recipient of Subscription Object A (because it is Per-
Printer) and Subscription Object B because it is a Per-Job Printer) and Subscription Object B because it is a Per-Job
skipping to change at page 31, line 44 skipping to change at page 29, line 27
Per-Job Subscription Object associated with some Job other than the Per-Job Subscription Object associated with some Job other than the
Job generating the Event. Job generating the Event.
5.3.2.2.3 Special Cases for Matching Rules 5.3.2.2.3 Special Cases for Matching Rules
This section contains rule for special cases. This section contains rule for special cases.
If an Event matches Subscribed Events in two different Subscription If an Event matches Subscribed Events in two different Subscription
Objects and the Printer would send two identical Event Notifications Objects and the Printer would send two identical Event Notifications
(except for the "notify-subscription-id" attribute) to the same (except for the "notify-subscription-id" attribute) to the same
Notification Recipient using the same Delivery Method, the Printer MUST Notification Recipient using the same Delivery Method, the Printer
send both Event Notifications. That is, the Printer MUST NOT try to MUST send both Event Notifications. That is, the Printer MUST NOT try
consolidate seemingly identical Event Notifications that occur in to consolidate seemingly identical Event Notifications that occur in
separate Subscription objects. Incidentally, the Printer MUST NOT reject separate Subscription objects. Incidentally, the Printer MUST NOT
Subscription Creation Operations that would create this scenario. reject Subscription Creation Operations that would create this
scenario.
If an Event matches two values of this "notify-events" attribute in a If an Event matches two values of this "notify-events" attribute in a
single Subscription object (e.g., a value and its sub-value), a Printer single Subscription object (e.g., a value and its sub-value), a
MAY send one Event Notification for each matched value in the Printer MAY send one Event Notification for each matched value in the
Subscription Object or it MAY send only one Event Notification per Subscription Object or it MAY send only one Event Notification per
Subscription Object. The rules in sections 5.3.2.2.1 and 5.3.2.2.2 are Subscription Object. The rules in sections 5.3.2.2.1 and 5.3.2.2.2
purposefully ambiguous about the number of Event Notification sent when are purposefully ambiguous about the number of Event Notification
Event E matches two or more values in a Subscription Object. sent when Event E matches two or more values in a Subscription
Object.
Consider the example: There are two Per-Printer Subscription Objects Consider the example: There are two Per-Printer Subscription Objects
when a Job completes. Subscription Object A has the Subscribed Job when a Job completes. Subscription Object A has the Subscribed Job
Event 'job-state-changed'. Subscription Object B has the Subscribed Event 'job-state-changed'. Subscription Object B has the Subscribed
Job Events 'job-state-changed' and 'job-completed'. The Printer sends Job Events 'job-state-changed' and 'job-completed'. The Printer sends
an Event Notification to the Notification Recipient of Subscription an Event Notification to the Notification Recipient of Subscription
Object A with the value of 'job-state-changed' for the "notify- Object A with the value of 'job-state-changed' for the "notify-
subscribing-event" attribute. The Printer sends either one or two subscribing-event" attribute. The Printer sends either one or two
Event Notifications to the Notification Recipient of Subscription Event Notifications to the Notification Recipient of Subscription
Object B, depending on implementation. If it sends two Event Object B, depending on implementation. If it sends two Event
Notifications, one has the value of 'job-state-changed' for the Notifications, one has the value of 'job-state-changed' for the
"notify-subscribing-event" attribute, and the other has the value of "notify-subscribing-event" attribute, and the other has the value of
'job-completed' for the "notify-subscribing-event" attribute. If it 'job-completed' for the "notify-subscribing-event" attribute. If it
sends one Event Notification, it has the value of either 'job-state- sends one Event Notification, it has the value of either 'job-state-
changed' or 'job-completed' for the "notify-subscribing-event" changed' or 'job-completed' for the "notify-subscribing-event"
attribute, depending on implementation. The algorithm for choosing attribute, depending on implementation. The algorithm for choosing
such a value is implementation dependent. such a value is implementation dependent.
5.3.3 notify-attributes (1setOf type2 keyword) 5.3.3 notify-attributes (1setOf type2 keyword)
This attribute contains a set of attribute names. When a Printer sends a This attribute contains a set of attribute names. When a Printer
Machine Consumable Event Notification, it includes a fixed set of sends a Machine Consumable Event Notification, it includes a fixed
attributes (see section 9.1). If this attribute is present and the Event set of attributes (see section 9.1). If this attribute is present and
Notification is Machine Consumable, the Printer also includes the the Event Notification is Machine Consumable, the Printer also
attributes specified by this attribute. includes the attributes specified by this attribute.
A Printer MAY support this attribute. A Printer MAY support this attribute.
A client MAY supply this attribute in a Subscription Creation Operation. A client MAY supply this attribute in a Subscription Creation
If the client does not supply this attribute in Subscription Creation Operation. If the client does not supply this attribute in
Operation or the Printer does not support this attribute, the Subscription Creation Operation or the Printer does not support this
Subscription Object MUST NOT contain the "notify-attributes" attribute. attribute, the Subscription Object MUST NOT contain the "notify-
There is no "notify-attributes-default" attribute. attributes" attribute. There is no "notify-attributes-default"
attribute.
Each keyword value of this attribute on a Subscription Object MUST be a Each keyword value of this attribute on a Subscription Object MUST be
value of the "notify-attributes-supported (1setOf type2 keyword)" a value of the "notify-attributes-supported (1setOf type2 keyword)"
attribute. The "notify-attributes-supported" MAY contain any Printer attribute. The "notify-attributes-supported" MAY contain any Printer
attribute, Job attribute or Subscription Object attribute that the attribute, Job attribute or Subscription Object attribute that the
Printer supports in an Event Notification. It MUST NOT contain any of Printer supports in an Event Notification. It MUST NOT contain any
the attributes in Section 9.1 that a Printer automatically puts in an of the attributes in Section 9.1 that a Printer automatically puts in
Event Notification; it would be redundant. If a client supplies an an Event Notification; it would be redundant. If a client supplies an
attribute in Section 9.1, the Printer MUST treat it as an unsupported attribute in Section 9.1, the Printer MUST treat it as an unsupported
attribute value of the "notify-attributes" attribute. attribute value of the "notify-attributes" attribute.
The following rules apply to each keyword value N of the "notify- The following rules apply to each keyword value N of the "notify-
attributes" attribute: If the value N names: attributes" attribute: If the value N names:
a) a Subscription attribute, the Printer MUST use the attribute N in a) a Subscription attribute, the Printer MUST use the attribute N in
the Subscription Object that is being used to generate the Event the Subscription Object that is being used to generate the Event
Notification. Notification.
b) a Job attribute and the Printer is generating an Event Notification b)a Job attribute and the Printer is generating an Event
from a Per-Job Subscription Object S, the Printer MUST use the Notification from a Per-Job Subscription Object S, the Printer
attribute N in the Job object associated with S. MUST use the attribute N in the Job object associated with S.
c) a Job attribute and the Printer is generating an Event Notification c)a Job attribute and the Printer is generating an Event
from a Per-Printer Subscription Object and the Event is: Notification from a Per-Printer Subscription Object and the Event
is:
. a Job Event, the Printer MUST use the attribute N in the Job . a Job Event, the Printer MUST use the attribute N in the Job
object that caused the Event. object that caused the Event.
. a Printer Event, the Printer MUST use the attribute N in the . a Printer Event, the Printer MUST use the attribute N in the
active Job. active Job.
If a Printer supports this attribute and a Subscription Object contains If a Printer supports this attribute and a Subscription Object
this attribute and the Delivery Method generates a Machine Consumable contains this attribute and the Delivery Method generates a Machine
Event Notification, the Printer MUST include in each Event Notification: Consumable Event Notification, the Printer MUST include in each Event
Notification:
a)the attributes specified in section 9.1 and a)the attributes specified in section 9.1 and
b)each attribute named by this attribute. b)each attribute named by this attribute.
The Printer MUST NOT use this attribute to generate a Human Consumable The Printer MUST NOT use this attribute to generate a Human
Event Notification. Consumable Event Notification.
5.3.4 notify-user-data (octetString(63)) 5.3.4 notify-user-data (octetString(63))
This attribute contains opaque data that some Delivery Methods include This attribute contains opaque data that some Delivery Methods
in each Machine Consumable Event Notification. The opaque data might include in each Machine Consumable Event Notification. The opaque
contain, for example: data might contain, for example:
. the identity of the Subscriber . the identity of the Subscriber
. a path or index to some Subscriber information . a path or index to some Subscriber information
. a key that identifies to the Notification Recipient the ultimate . a key that identifies to the Notification Recipient the ultimate
recipient of the Event Notification recipient of the Event Notification
. the id for a Notification Recipient that had previously registered . the id for a Notification Recipient that had previously
with an Instant Messaging Service registered with an Instant Messaging Service
A Printer MUST support this attribute. A Printer MUST support this attribute.
A client MAY supply this attribute in a Subscription Creation Operation. A client MAY supply this attribute in a Subscription Creation
If the client does not supply this attribute in Subscription Creation Operation. If the client does not supply this attribute in
Operation, the Subscription Object MUST NOT contain the "notify-user- Subscription Creation Operation, the Subscription Object MUST NOT
data" attribute. There is no "notify-user-data-default" attribute. contain the "notify-user-data" attribute. There is no "notify-user-
data-default" attribute.
There is no "user-data-supported" attribute. Rather, any octetString There is no "user-data-supported" attribute. Rather, any octetString
whose length does not exceed 63 octets is a supported value. If the whose length does not exceed 63 octets is a supported value. If the
length exceeds 63 octets, the Printer MUST treat it as an unsupported length exceeds 63 octets, the Printer MUST treat it as an unsupported
value. value.
5.3.5 notify-charset (charset) 5.3.5 notify-charset (charset)
This attribute specifies the charset to be used in the Event This attribute specifies the charset to be used in the Event
Notification content sent to the Notification Recipient, whether the Notification content sent to the Notification Recipient, whether the
Event Notification content is Machine Consumable or Human Consumable. Event Notification content is Machine Consumable or Human Consumable.
A Printer MUST support this attribute. A Printer MUST support this attribute.
A client MAY supply this attribute in a Subscription Creation Operation. A client MAY supply this attribute in a Subscription Creation
If the client does not supply this attribute in Subscription Creation Operation. If the client does not supply this attribute in
Subscription Creation Operation or supplies an unsupported value, the
Operation or supplies an unsupported value, the Printer MUST populate Printer MUST populate this attribute in the Subscription Object with
this attribute in the Subscription Object with the value of the the value of the "attributes-charset" operation attribute, which is a
"attributes-charset" operation attribute, which is a REQUIRED attribute REQUIRED attribute in all IPP requests (see [RFC2911]). If the value
in all IPP requests (see [ipp-mod]). If the value of the "attributes- of the "attributes-charset" attribute is unsupported, the Printer
charset" attribute is unsupported, the Printer MUST populate this MUST populate this attribute in the Subscription Object with the
attribute in the Subscription Object with the value of the Printer's value of the Printer's "charset-configured" attribute. There is no
"charset-configured" attribute. There is no "notify-charset-default" "notify-charset-default" attribute.
attribute.
The value of this attribute on a Subscription Object MUST be a value of The value of this attribute on a Subscription Object MUST be a value
the "charset-supported (1setOf charset)" attribute. of the "charset-supported (1setOf charset)" attribute.
5.3.6 notify-natural-language (naturalLanguage) 5.3.6 notify-natural-language (naturalLanguage)
This attribute specifies the natural language to be used in any human This attribute specifies the natural language to be used in any human
consumable text in the Event Notification content sent to the consumable text in the Event Notification content sent to the
Notification Recipient, whether the Event Notification content is Notification Recipient, whether the Event Notification content is
Machine Consumable or Human Consumable. Machine Consumable or Human Consumable.
A Printer MUST support this attribute. A Printer MUST support this attribute.
A client MAY supply this attribute in a Subscription Creation Operation. A client MAY supply this attribute in a Subscription Creation
If the client does not supply this attribute in Subscription Creation Operation. If the client does not supply this attribute in
Operation or supplies an unsupported value, the Printer MUST populate Subscription Creation Operation or supplies an unsupported value, the
this attribute in the Subscription Object with the value of the Printer MUST populate this attribute in the Subscription Object with
"attributes-natural-language" operation attribute, which is a REQUIRED the value of the "attributes-natural-language" operation attribute,
attribute in all IPP requests (see [ipp-mod]). If the value of the which is a REQUIRED attribute in all IPP requests (see [RFC2911]). If
"attributes-natural-language" attribute is unsupported, the Printer MUST the value of the "attributes-natural-language" attribute is
populate this attribute in the Subscription Object with the value of the unsupported, the Printer MUST populate this attribute in the
Printer's "natural-language-configured" attribute. There is no "notify- Subscription Object with the value of the Printer's "natural-
natural-language-default" attribute. language-configured" attribute. There is no "notify-natural-language-
default" attribute.
The value of this attribute on a Subscription Object MUST be a value of The value of this attribute on a Subscription Object MUST be a value
the "generated-natural-language-supported (1setOf type2 of the "generated-natural-language-supported (1setOf type2
naturalLanguage)" attribute. naturalLanguage)" attribute.
5.3.7 notify-lease-duration (integer(0:67108863)) 5.3.7 notify-lease-duration (integer(0:67108863))
This attribute specifies the duration of the lease (in seconds) This attribute specifies the duration of the lease (in seconds)
associated with the Per-Printer Subscription Object at the time the associated with the Per-Printer Subscription Object at the time the
Subscription Object was created or the lease was renewed. The duration Subscription Object was created or the lease was renewed. The
duration of the lease is infinite if the value is 0, i.e., the lease
of the lease is infinite if the value is 0, i.e., the lease never never expires.
expires.
This attribute is not present on a Per-Job Subscription Object because This attribute is not present on a Per-Job Subscription Object
the Subscription Object lasts exactly as long as the associated Job because the Subscription Object lasts exactly as long as the
object. See section 5.4.3 on "notify-lease-expiration-time associated Job object. See section 5.4.3 on "notify-lease-expiration-
(integer(0:MAX))" for more details. time (integer(0:MAX))" for more details.
A Printer MUST support this attribute. A Printer MUST support this attribute.
For a Subscription Object Creation operation of a Per-Job Subscription For a Subscription Object Creation operation of a Per-Job
Object, the client MUST NOT supply this attribute. If the client does Subscription Object, the client MUST NOT supply this attribute. If
supply this attribute, the Printer MUST treat it as an unsupported the client does supply this attribute, the Printer MUST treat it as
attribute. an unsupported attribute.
For a Subscription Creation Operation of a Per-Printer Subscription For a Subscription Creation Operation of a Per-Printer Subscription
Object or a Renew-Subscription operation, a client MAY supply this Object or a Renew-Subscription operation, a client MAY supply this
attribute. If the client does not supply this attribute, the Printer attribute. If the client does not supply this attribute, the Printer
MUST populate this attribute with its "notify-lease-duration-default" MUST populate this attribute with its "notify-lease-duration-default"
(0:67108863) attribute value. If the client supplies this attribute with (0:67108863) attribute value. If the client supplies this attribute
an unsupported value, the Printer MUST populate this attribute with a with an unsupported value, the Printer MUST populate this attribute
supported value, and this value SHOULD be as close as possible to the with a supported value, and this value SHOULD be as close as possible
value requested by the client. Note: this rule implies that a Printer to the value requested by the client. Note: this rule implies that a
doesn't assign the value of 0 (infinite) unless the client requests it. Printer doesn't assign the value of 0 (infinite) unless the client
requests it.
After the Printer has populated this attribute with a supported value, After the Printer has populated this attribute with a supported
the value represents the "granted duration" of the lease in seconds and value, the value represents the "granted duration" of the lease in
the Printer sets the value of the Subscription Object's "notify-lease- seconds and the Printer sets the value of the Subscription Object's
expiration-time" attribute as specified in section 5.4.3. "notify-lease-expiration-time" attribute as specified in section
5.4.3.
The value of this attribute on a Subscription Object MUST be a value of The value of this attribute on a Subscription Object MUST be a value
the "notify-lease-duration-supported" (1setOf (integer(0:67108863) | of the "notify-lease-duration-supported" (1setOf (integer(0:67108863)
rangeOfInteger(0:67108863))) attribute. | rangeOfInteger(0:67108863))) attribute.
A Printer MAY require authentication in order to return the value of 0 A Printer MAY require authentication in order to return the value of
(the lease never expires) as one of the values of "notify-lease- 0 (the lease never expires) as one of the values of "notify-lease-
duration-supported", and to allow 0 as a value of the "notify-lease- duration-supported", and to allow 0 as a value of the "notify-lease-
duration" attribute. duration" attribute.
Note: The maximum value 67,108,863 is 2 raised to the 26 power minus 1 Note: The maximum value 67,108,863 is 2 raised to the 26 power minus
and is about 2 years in seconds. The value is considerably less than 1 and is about 2 years in seconds. The value is considerably less
than MAX so that there is virtually no chance of an overflow when it
MAX so that there is virtually no chance of an overflow when it is added is added to "printer-up-time" to produce "notify-lease-expiration-
to "printer-up-time" to produce "notify-lease-expiration-time". time".
5.3.8 notify-time-interval (integer(0:MAX)) 5.3.8 notify-time-interval (integer(0:MAX))
The 'job-progress' Event occurs each time that a Printer completes a The 'job-progress' Event occurs each time that a Printer completes a
sheet. Some Notification Recipients do not want to receive an Event sheet. Some Notification Recipients do not want to receive an Event
Notification every time this Event occurs. This attribute allows a Notification every time this Event occurs. This attribute allows a
Subscribing Client to request how often it wants to receive Event Subscribing Client to request how often it wants to receive Event
Notifications for 'job-progress' Events. The value of this attribute MAY Notifications for 'job-progress' Events. The value of this attribute
be any nonnegative integer (0,MAX) indicating the minimum number of MAY be any nonnegative integer (0,MAX) indicating the minimum number
seconds between 'job-progress' Event Notifications. of seconds between 'job-progress' Event Notifications.
The Printer MUST support this attribute if and only if the Printer The Printer MUST support this attribute if and only if the Printer
supports the 'job-progress' Event. supports the 'job-progress' Event.
A client MAY supply this attribute in a Subscription Creation Operation. A client MAY supply this attribute in a Subscription Creation
If the client does not supply this attribute, the Printer MUST not Operation. If the client does not supply this attribute, the Printer
populate this attribute on the Subscription Object. There is no "notify- MUST not populate this attribute on the Subscription Object. There is
time-interval-default" attribute. no "notify-time-interval-default" attribute.
There is no "notify-time-interval-supported" attribute. There is no "notify-time-interval-supported" attribute.
If the 'job-progress' Event occurs and a Subscription Object contains If the 'job-progress' Event occurs and a Subscription Object contains
the 'job-progress' Event as a value of the 'notify-events' attribute, the 'job-progress' Event as a value of the 'notify-events' attribute,
there are two cases to consider: there are two cases to consider:
1. This attribute is not present on the Subscription Object or has the 1.This attribute is not present on the Subscription Object or has
value of 0. The Printer MUST generate and send an Event the value of 0. The Printer MUST generate and send an Event
Notification (as is the case with other Events). Notification (as is the case with other Events).
2. This attribute is present with a nonzero value of N: 2. This attribute is present with a nonzero value of N:
a)If the Printer has not sent an Event Notification for the 'job- a)If the Printer has not sent an Event Notification for the 'job-
progress' Event for the associated Subscription Object within progress' Event for the associated Subscription Object within
the past N seconds, the Printer MUST send an Event Notification the past N seconds, the Printer MUST send an Event Notification
for the Event that just occurred. Note when the Printer for the Event that just occurred. Note when the Printer
completes the first page of a Job, this rule implies that the completes the first page of a Job, this rule implies that the
Printer sends an Event Notification for a Per-Job Subscription Printer sends an Event Notification for a Per-Job Subscription
Objects. Objects.
b)Otherwise, the Printer MUST NOT generate or send an Event b)Otherwise, the Printer MUST NOT generate or send an Event
Notification for the associated Subscription Object. The Printer Notification for the associated Subscription Object. The Printer
MUST NOT increase the value of the "notify-sequence-number" MUST NOT increase the value of the "notify-sequence-number"
Subscription Object attribute (i.e., the sequence of values of Subscription Object attribute (i.e., the sequence of values of
the "notify-sequence-number" attribute counts the Event the "notify-sequence-number" attribute counts the Event
Notifications that the Printer sent and not the Events that do Notifications that the Printer sent and not the Events that do
not cause an Event Notification to be sent). not cause an Event Notification to be sent).
It is RECOMMENDED that a Subscribing Client use this attribute when it It is RECOMMENDED that a Subscribing Client use this attribute when
subscribes to the 'job-progress' Event, and that the value be it subscribes to the 'job-progress' Event, and that the value be
sufficiently large to limit the frequency with which the Printer sends sufficiently large to limit the frequency with which the Printer
Event Notifications requests. sends Event Notifications requests.
This attribute MUST NOT effect any Events other than 'job-progress'. This attribute MUST NOT effect any Events other than 'job-progress'.
5.4 Subscription Description Attributes 5.4 Subscription Description Attributes
Subscription Description Attributes are those attributes that a Printer Subscription Description Attributes are those attributes that a
adds to a Subscription Object at the time of its creation. Printer adds to a Subscription Object at the time of its creation.
A Printer MUST support all attributes in this Table 2. A Printer MUST support all attributes in this Table 2.
A client MUST NOT supply the attributes in Table 2 in a Subscription A client MUST NOT supply the attributes in Table 2 in a Subscription
Template Attributes Group of a Subscription Creation Operation. If the Template Attributes Group of a Subscription Creation Operation. If
client supplies them, the Printer MUST NOT set them and MUST treat them the client supplies them, the Printer MUST NOT set them and MUST
as unsupported attributes. There are no corresponding default or treat them as unsupported attributes. There are no corresponding
supported attributes. default or supported attributes.
Table 2 - Subscription Description Attributes Table 2 - Subscription Description Attributes
Subscription Object attributes: Subscription Object attributes:
notify-subscription-id (integer(1:MAX)) notify-subscription-id (integer(1:MAX))
notify-sequence-number (integer(0:MAX)) notify-sequence-number (integer(0:MAX))
notify-lease-expiration-time (integer(0:MAX)) notify-lease-expiration-time (integer(0:MAX))
notify-printer-up-time (integer(1:MAX)) notify-printer-up-time (integer(1:MAX))
Subscription Object attributes:
notify-printer-uri (uri) notify-printer-uri (uri)
notify-job-id (integer(1:MAX)) notify-job-id (integer(1:MAX))
notify-subscriber-user-name (name(MAX)) notify-subscriber-user-name (name(MAX))
5.4.1 notify-subscription-id (integer (1:MAX)) 5.4.1 notify-subscription-id (integer (1:MAX))
This attribute identifies a Subscription Object instance with a number This attribute identifies a Subscription Object instance with a
that is unique within the context of the Printer. The Printer generates number that is unique within the context of the Printer. The Printer
this value at the time it creates the Subscription Object. generates this value at the time it creates the Subscription Object.
A Printer MUST support this attribute. A Printer MUST support this attribute.
The Printer SHOULD NOT assign the value of this attribute sequentially The Printer SHOULD NOT assign the value of this attribute
as it creates Subscription Objects. Sequential assignment makes it easy sequentially as it creates Subscription Objects. Sequential
for rogue clients to guess the value of this attribute on other assignment makes it easy for rogue clients to guess the value of this
Subscription Objects. attribute on other Subscription Objects.
The Printer SHOULD avoid re-using recent values of this attribute during The Printer SHOULD avoid re-using recent values of this attribute
continuous operation of the Printer as well as across power cycles. Then during continuous operation of the Printer as well as across power
a Subscribing Client is unlikely to find that a stale reference accesses cycles. Then a Subscribing Client is unlikely to find that a stale
a new Subscription Object. reference accesses a new Subscription Object.
The 0 value is not permitted in order to allow for compatibility with The 0 value is not permitted in order to allow for compatibility with
"job-id" and with SNMP index values, which also cannot be 0. "job-id" and with SNMP index values, which also cannot be 0.
5.4.2 notify-sequence-number (integer (0:MAX)) 5.4.2 notify-sequence-number (integer (0:MAX))
The value of this attribute indicates the number of times that the The value of this attribute indicates the number of times that the
Printer has generated and attempted to send an Event Notification. When Printer has generated and attempted to send an Event Notification.
an Event Notification contains this attribute, the Notification When an Event Notification contains this attribute, the Notification
Recipient can determine whether it missed some Event Notifications Recipient can determine whether it missed some Event Notifications
(i.e., numbers skipped) or received duplicates (i.e., same number (i.e., numbers skipped) or received duplicates (i.e., same number
twice). twice).
A Printer MUST support this attribute. A Printer MUST support this attribute.
When the Printer creates a Subscription Object, it MUST set the value of When the Printer creates a Subscription Object, it MUST set the value
this attribute to 0. This value indicates that the Printer has not sent of this attribute to 0. This value indicates that the Printer has not
any Event Notifications for this Subscription Object. sent any Event Notifications for this Subscription Object.
Each time the Printer sends a newly generated Event Notification, it Each time the Printer sends a newly generated Event Notification, it
MUST increase the value of this attribute by 1. For some Delivery MUST increase the value of this attribute by 1. For some Delivery
Methods, the Printer MUST include this attribute in each Event Methods, the Printer MUST include this attribute in each Event
Notification, and the value MUST be the value after it is increased by Notification, and the value MUST be the value after it is increased
1. That is, the value of this attribute in the first Event Notification by 1. That is, the value of this attribute in the first Event
after Subscription object creation MUST be 1, the second MUST be 2, etc. Notification after Subscription object creation MUST be 1, the second
If a Delivery Method is defined such that the Notification Recipient MUST be 2, etc. If a Delivery Method is defined such that the
returns a response, the Printer can re-try sending an Event Notification Notification Recipient returns a response, the Printer can re-try
a certain number of times with the same sequence number when the sending an Event Notification a certain number of times with the same
Notification Recipient fails to return a response. sequence number when the Notification Recipient fails to return a
response.
If a Subscription Object lasts long enough to reach the value of MAX, If a Subscription Object lasts long enough to reach the value of MAX,
its next value MUST be 0, i.e., it wraps. its next value MUST be 0, i.e., it wraps.
5.4.3 notify-lease-expiration-time (integer(0:MAX)) 5.4.3 notify-lease-expiration-time (integer(0:MAX))
This attribute specifies the time in the future when the lease on the This attribute specifies the time in the future when the lease on the
Per-Printer Subscription Object will expire, i.e. the "printer-up-time" Per-Printer Subscription Object will expire, i.e. the "printer-up-
value at which the lease will expire. If the value is 0, the lease never time" value at which the lease will expire. If the value is 0, the
expires. lease never expires.
A Printer MUST support this attribute. A Printer MUST support this attribute.
When the Printer creates a Per-Job Subscription Object, this attribute When the Printer creates a Per-Job Subscription Object, this
MUST NOT be present - the Subscription Object lasts exactly as long as attribute MUST NOT be present - the Subscription Object lasts exactly
the associated Job object. as long as the associated Job object.
When the Printer creates a Per-Printer Subscription Object, it populates When the Printer creates a Per-Printer Subscription Object, it
this attribute with a value that is the sum of the values of the populates this attribute with a value that is the sum of the values
Printer's "printer-up-time" attribute and the Subscription Object's of the Printer's "printer-up-time" attribute and the Subscription
"notify-lease-duration" attribute with the following exception. If the Object's "notify-lease-duration" attribute with the following
value of the Subscription Object's "notify-lease-duration" attribute is exception. If the value of the Subscription Object's "notify-lease-
0 (i.e., no expiration time), then the value of this attribute MUST be duration" attribute is 0 (i.e., no expiration time), then the value
set to 0 (i.e., no expiration time). of this attribute MUST be set to 0 (i.e., no expiration time).
When the Printer powers up, it MUST set the value of this attribute in When the Printer powers up, it MUST set the value of this attribute
each persistent Subscription Object using the algorithm in the previous in each persistent Subscription Object using the algorithm in the
paragraph. previous paragraph.
When the "printer-up-time" equals the value of this attribute, the When the "printer-up-time" equals the value of this attribute, the
Printer MUST delete the Subscription Object. A client can extend a lease Printer MUST delete the Subscription Object. A client can extend a
of a Per-Printer Subscription Object with the Renew-Subscription lease of a Per-Printer Subscription Object with the Renew-
operation (see section 11.2.5). Subscription operation (see section 11.2.5).
Note: In order to compute the number of seconds remaining in a lease for Note: In order to compute the number of seconds remaining in a lease
a Per-Printer Subscription Object, a client can subtract the for a Per-Printer Subscription Object, a client can subtract the
Subscription's "notify-printer-up-time" attribute (see section 5.4.4) Subscription's "notify-printer-up-time" attribute (see section 5.4.4)
from the Subscription's "notify-lease-expiration-time" attribute. from the Subscription's "notify-lease-expiration-time" attribute.
5.4.4 notify-printer-up-time (integer(1:MAX)) 5.4.4 notify-printer-up-time (integer(1:MAX))
This attribute is an alias for the Printer's "printer-up-time" attribute This attribute is an alias for the Printer's "printer-up-time"
" (see [ipp-mod] section 4.4.29). attribute " (see [RFC2911] section 4.4.29).
A Printer MUST support this attribute. A Printer MUST support this attribute.
When the Printer creates a Per-Job Subscription Object, this attribute When the Printer creates a Per-Job Subscription Object, this
MUST NOT be present. When the Printer creates a Per-Printer Subscription attribute MUST NOT be present. When the Printer creates a Per-Printer
Object, this attribute MUST be present. Subscription Object, this attribute MUST be present.
Note: this attribute exists in a Per-Printer Subscription Object so that Note: this attribute exists in a Per-Printer Subscription Object so
a client using the Get-Subscription-Attributes or Get-Subscription that a client using the Get-Subscription-Attributes or Get-
operations can convert the Per-Printer Subscription's "notify-lease- Subscription operations can convert the Per-Printer Subscription's
expiration-time" attribute to wall clock time with one request. If the "notify-lease-expiration-time" attribute to wall clock time with one
value of the "notify-lease-expiration-time" attribute is not 0 (i.e., no request. If the value of the "notify-lease-expiration-time" attribute
expiration time), then the difference between the "notify-lease- is not 0 (i.e., no expiration time), then the difference between the
expiration-time" attribute and the "notify-printer-up-time" is the "notify-lease-expiration-time" attribute and the "notify-printer-up-
remaining number of seconds on the lease from the current time. time" is the remaining number of seconds on the lease from the
current time.
5.4.5 notify-printer-uri (uri) 5.4.5 notify-printer-uri (uri)
This attribute identifies the Printer object that created this This attribute identifies the Printer object that created this
Subscription Object. Subscription Object.
A Printer MUST support this attribute. A Printer MUST support this attribute.
During a Subscription Creation Operation, the Printer MUST populate this During a Subscription Creation Operation, the Printer MUST populate
attribute with the value of the "printer-uri" operation attribute in the this attribute with the value of the "printer-uri" operation
request. From the Printer URI, the client can, for example, determine attribute in the request. From the Printer URI, the client can, for
what security scheme was used. example, determine what security scheme was used.
5.4.6 notify-job-id (integer(1:MAX)) 5.4.6 notify-job-id (integer(1:MAX))
This attribute specifies whether the containing Subscription Object is a This attribute specifies whether the containing Subscription Object
Per-Job or Per-Printer Subscription Object, and for Per-Job Subscription is a Per-Job or Per-Printer Subscription Object, and for Per-Job
Objects, it specifies the associated Job. Subscription Objects, it specifies the associated Job.
A Printer MUST support this attribute. A Printer MUST support this attribute.
If this attribute is not present, the Subscription Object MUST be a Per- If this attribute is not present, the Subscription Object MUST be a
Printer Subscription. If this attribute is present, the Subscription Per-Printer Subscription. If this attribute is present, the
Object MUST be a Per-Job Subscription Object and this attribute MUST Subscription Object MUST be a Per-Job Subscription Object and this
identify the Job with which the Subscription Object is associated. attribute MUST identify the Job with which the Subscription Object is
associated.
Note: This attribute could be useful to a Notification Recipient that Note: This attribute could be useful to a Notification Recipient that
receives an Event Notification generated from a Per-Job Subscription receives an Event Notification generated from a Per-Job Subscription
Object and caused by a Printer Event. The Event Notification gives Object and caused by a Printer Event. The Event Notification gives
access to the Printer and the Subscription Object. The Event access to the Printer and the Subscription Object. The Event
Notification gives access to the associated Job only via this Notification gives access to the associated Job only via this
attribute.. attribute.
5.4.7 notify-subscriber-user-name (name(MAX)) 5.4.7 notify-subscriber-user-name (name(MAX))
This attribute contains the name of the user who performed the This attribute contains the name of the user who performed the
Subscription Creation Operation. Subscription Creation Operation.
A Printer MUST support this attribute. A Printer MUST support this attribute.
The Printer sets this attribute to the most authenticated printable name The Printer sets this attribute to the most authenticated printable
that it can obtain from the authentication service over which the name that it can obtain from the authentication service over which
Subscription Creation Operation was received. The Printer uses the same the Subscription Creation Operation was received. The Printer uses
mechanism for determining the value of this attribute as it does for a the same mechanism for determining the value of this attribute as it
Job's "job-originating-user-name" (see [ipp-mod] section 4.3.6). does for a Job's "job-originating-user-name" (see [RFC2911] section
4.3.6).
Note: To help with authentication, a Subscription Object may have Note: To help with authentication, a Subscription Object may have
additional private attributes about the user, e.g., a credential of a additional private attributes about the user, e.g., a credential of a
principal. Such private attributes are implementation-dependent and
principal. Such private attributes are implementation-dependent and not not defined in this document.
defined in this document.
6 Printer Description Attributes Related to Notification 6 Printer Description Attributes Related to Notification
This section defines the Printer Description attributes that are related This section defines the Printer Description attributes that are
to Notification. Table 3 lists the Printer Description attributes, related to Notification. Table 3 lists the Printer Description
indicates the Printer support required for conformance, and whether or attributes, indicates the Printer support required for conformance,
not the attribute is READ-ONLY (see section 3.1): and whether or not the attribute is READ-ONLY (see section 3.1):
Table 3 - Printer Description Attributes Associated with Notification Table 3 - Printer Description Attributes Associated with Notification
Printer object attributes: REQUIRED READ-ONLY Printer object attributes: REQUIRED READ-ONLY
printer-state-change-time (integer(1:MAX)) No Yes printer-state-change-time (integer(1:MAX)) No Yes
printer-state-change-date-time (dateTime) No Yes printer-state-change-date-time (dateTime) No Yes
6.1 printer-state-change-time (integer(1:MAX)) 6.1 printer-state-change-time (integer(1:MAX))
This attribute records the most recent time at which the 'printer-state- This attribute records the most recent time at which the 'printer-
changed' Printer Event occurred whether or not any Subscription objects state-changed' Printer Event occurred whether or not any Subscription
were listening for this event. This attribute helps a client or objects were listening for this event. This attribute helps a client
operator to determine how long the Printer has been in its current or operator to determine how long the Printer has been in its current
state. state.
A Printer MAY support this attribute and if so, the attribute MUST be A Printer MAY support this attribute and if so, the attribute MUST be
READ-ONLY. READ-ONLY.
On power-up, the Printer MUST set the value of this attribute to be the On power-up, the Printer MUST set the value of this attribute to be
value of its "printer-up-time" attribute, so that it always has a value. the value of its "printer-up-time" attribute, so that it always has a
Whenever the 'printer-state-changed' Printer Event occurs, the Printer value. Whenever the 'printer-state-changed' Printer Event occurs, the
MUST set this attribute to the value of the Printer's "printer-up-time" Printer MUST set this attribute to the value of the Printer's
attribute. "printer-up-time" attribute.
6.2 printer-state-change-date-time (dateTime) 6.2 printer-state-change-date-time (dateTime)
This attribute records the most recent time at which the 'printer-state- This attribute records the most recent time at which the 'printer-
changed' Printer Event occurred whether or not there were any state-changed' Printer Event occurred whether or not there were any
Subscription Objects listening for this event. This attribute helps a Subscription Objects listening for this event. This attribute helps
client or operator to determine how long the Printer has been in its a client or operator to determine how long the Printer has been in
current state. its current state.
A Printer MAY support this attribute and if so, the attribute MUST be A Printer MAY support this attribute and if so, the attribute MUST be
READ-ONLY. READ-ONLY.
On power-up, the Printer MUST set the value of this attribute to be the On power-up, the Printer MUST set the value of this attribute to be
value of its "printer-current-time" attribute, so that it always has a the value of its "printer-current-time" attribute, so that it always
value (see [ipp-mod] section 4.4.30 on "printer-current-time"). Whenever has a value (see [RFC2911] section 4.4.30 on "printer-current-time").
the 'printer-state-changed' Printer Event occurs, the Printer MUST set Whenever the 'printer-state-changed' Printer Event occurs, the
this attribute to the value of the Printer's "printer-current-time" Printer MUST set this attribute to the value of the Printer's
attribute. "printer-current-time" attribute.
7 New Values for Existing Printer Description Attributes 7 New Values for Existing Printer Description Attributes
This section contains those attributes for which additional values are This section contains those attributes for which additional values
added. are added.
7.1 operations-supported (1setOf type2 enum) 7.1 operations-supported (1setOf type2 enum)
The following "operation-id" values are added in order to support the The following "operation-id" values are added in order to support the
new operations defined in this document: new operations defined in this document:
Table 4 - Operation-id assignments Table 4 - Operation-id assignments
Value Operation Name Value Operation Name
0x0016 Create-Printer-Subscriptions 0x0016 Create-Printer-Subscriptions
0x0017 Create-Job-Subscriptions 0x0017 Create-Job-Subscriptions
0x0018 Get-Subscription-Attributes 0x0018 Get-Subscription-Attributes
Value Operation Name
0x0019 Get-Subscriptions 0x0019 Get-Subscriptions
0x001A Renew-Subscription 0x001A Renew-Subscription
0x001B Cancel-Subscription 0x001B Cancel-Subscription
8 Attributes Only in Event Notifications 8 Attributes Only in Event Notifications
This section contains those attributes that exist only in Event This section contains those attributes that exist only in Event
Notifications and do not exist in any objects. Notifications and do not exist in any objects.
8.1 notify-subscribed-event (type2 keyword) 8.1 notify-subscribed-event (type2 keyword)
This attribute indicates the Subscribed Event that caused the Printer to This attribute indicates the Subscribed Event that caused the Printer
send this Event Notification. This attribute exists only in Event to send this Event Notification. This attribute exists only in Event
Notifications. Notifications.
This attribute MUST contain one of the values of the "notify-events" This attribute MUST contain one of the values of the "notify-events"
attribute in the Subscription Object, i.e., one of the Subscribed Event attribute in the Subscription Object, i.e., one of the Subscribed
values. Its value is the Subscribed Event that "matches" the Event that Event values. Its value is the Subscribed Event that "matches" the
caused the Printer to send this Event Notification. This Subscribed Event that caused the Printer to send this Event Notification. This
Event value may be identical to the Event or the Event may be a sub- Subscribed Event value may be identical to the Event or the Event may
value of the Subscribed Event. For example, the 'job-completed' Event be a sub-value of the Subscribed Event. For example, the 'job-
(which is a sub-event of the 'job-state-changed' event) would cause the completed' Event (which is a sub-event of the 'job-state-changed'
Printer to send an Event Notification for either the 'job-completed' or event) would cause the Printer to send an Event Notification for
'job-state-changed' Subscribed Events and to send the 'job-completed' or either the 'job-completed' or 'job-state-changed' Subscribed Events
'job-state-changed' value for this attribute, respectively,. See and to send the 'job-completed' or 'job-state-changed' value for this
section 5.3.2.2 for the "matching" rules of Subscribed Events and for attribute, respectively,. See section 5.3.2.2 for the "matching"
additional examples. rules of Subscribed Events and for additional examples.
The Delivery Method Document specifies whether the Printer includes the The Delivery Method Document specifies whether the Printer includes
value of this attribute in an Event Notification. the value of this attribute in an Event Notification.
8.2 notify-text (text(MAX)) 8.2 notify-text (text(MAX))
This attribute contains a Human Consumable text message (see section This attribute contains a Human Consumable text message (see section
9.2). This message describes the Event and is encoded as plain text, 0). This message describes the Event and is encoded as plain text,
i.e., 'text/plain' with the charset specified by Subscription
i.e., 'text/plain' with the charset specified by Subscription Object's Object's "notify-charset" attribute.
"notify-charset" attribute.
The Delivery Method Document specifies whether the Printer includes this The Delivery Method Document specifies whether the Printer includes
attribute in an Event Notification. this attribute in an Event Notification.
9 Event Notification Content 9 Event Notification Content
This section defines the Event Notification content that the Printer This section defines the Event Notification content that the Printer
sends when an Event occurs. sends when an Event occurs.
When an Event occurs, the Printer MUST find each Subscription object When an Event occurs, the Printer MUST find each Subscription object
whose "notify-events" attribute "matches" the Event. See section 5.3.2.2 whose "notify-events" attribute "matches" the Event. See section
for details on "matching". For each matched Subscription Object, the 5.3.2.2 for details on "matching". For each matched Subscription
Printer MUST create an Event Notification with the content and format Object, the Printer MUST create an Event Notification with the
that the Delivery Method Document specifies. The content contains the content and format that the Delivery Method Document specifies. The
value of attributes specified by the Delivery Method Document. The content contains the value of attributes specified by the Delivery
Printer obtains the values immediately after the Event occurs. For Method Document. The Printer obtains the values immediately after the
example, if the "printer-state" attribute changes from 'idle' to Event occurs. For example, if the "printer-state" attribute changes
'processing', the Event 'printer-state-changed' occurs and the Printer from 'idle' to 'processing', the Event 'printer-state-changed' occurs
puts various attributes into the Event Notification, including "printer- and the Printer puts various attributes into the Event Notification,
up-time" and "printer-state" with the values that they have immediately including "printer-up-time" and "printer-state" with the values that
after the Event occurs, i.e., the value of "printer-state" is they have immediately after the Event occurs, i.e., the value of
'processing'. "printer-state" is 'processing'.
If two different Events occur simultaneously, or nearly so (e.g., If two different Events occur simultaneously, or nearly so (e.g.,
"printer-up-time" has the same value for both), the Printer MUST create "printer-up-time" has the same value for both), the Printer MUST
a separate Event Notification for each Event, even if the associated create a separate Event Notification for each Event, even if the
Subscription Object is the same for both Events. However, the Printer associated Subscription Object is the same for both Events. However,
MAY combine these distinct Event Notifications into a single Compound the Printer MAY combine these distinct Event Notifications into a
Event Notification if the Delivery Method supports Compound Event single Compound Event Notification if the Delivery Method supports
Notifications For example, suppose that two nearly-simultaneously Events Compound Event Notifications For example, suppose that two nearly-
represent two successive 'printer-state-changed' Events, one from 'idle' simultaneously Events represent two successive 'printer-state-
to 'processing' and another from 'processing' to 'stopped'. These two changed' Events, one from 'idle' to 'processing' and another from
Events have the same name but are different instances of the Event. Then 'processing' to 'stopped'. These two Events have the same name but
the Printer MUST create a separate Event Notification for each Event and are different instances of the Event. Then the Printer MUST create a
SHOULD accurately report the "printer-state" of the first Event as separate Event Notification for each Event and SHOULD accurately
'processing' and the second Event as 'stopped'. report the "printer-state" of the first Event as 'processing' and the
second Event as 'stopped'.
If a Subscription Object contains more than one Subscribed Event, and If a Subscription Object contains more than one Subscribed Event, and
several Events occur in quick succession each matching a different several Events occur in quick succession each matching a different
Subscribed Event in the Subscription Object, the Printer MUST NOT Subscribed Event in the Subscription Object, the Printer MUST NOT
generate a single Event Notification from several of these Events, but generate a single Event Notification from several of these Events,
MAY combine distinct Event Notifications into a single Compound Event but MAY combine distinct Event Notifications into a single Compound
Event Notification if the Delivery Method supports Compound Event
Notification if the Delivery Method supports Compound Event
Notifications. Notifications.
After the Printer has created the Event Notification, the Printer After the Printer has created the Event Notification, the Printer
delivers it via either a: delivers it via either a:
Push Delivery Method: The Printer sends the Event Notification Push Delivery Method: The Printer sends the Event Notification
shortly after an Event occurs. For some Push Delivery Methods, the shortly after an Event occurs. For some Push Delivery Methods,
Notification Recipient MUST send a response; for others it MUST NOT the Notification Recipient MUST send a response; for others it
send a response. MUST NOT send a response.
Pull Delivery Method: The Printer saves Event Notifications for Pull Delivery Method: The Printer saves Event Notifications for
some event-lease time and expects the Notification Recipient to some event-lease time and expects the Notification Recipient to
request Event Notifications. The Printer returns the Event request Event Notifications. The Printer returns the Event
Notifications in a response to such a request. Notifications in a response to such a request.
If an error that meets the following conditions occurs, the Printer MUST If an error that meets the following conditions occurs, the Printer
cancel the Subscription Object. MUST cancel the Subscription Object.
a) the error occurs during the sending of an Event Notification a) the error occurs during the sending of an Event Notification
generated from Subscription Object S AND generated from Subscription Object S AND
b) the error would continue to occur every time the Printer sends an b) the error would continue to occur every time the Printer sends an
Event Notification generated from Subscription Object S in the Event Notification generated from Subscription Object S in the
future. future.
>From example, if the address of the "notify-recipient-uri" of From example, if the address of the "notify-recipient-uri" of
Subscription Object A references a non-existent target and the Printer Subscription Object A references a non-existent target and the
determines that this fact, it MUST delete Subscription Object A. Printer determines that this fact, it MUST delete Subscription Object
A.
The next two sections describe the values that a Printer sends in the The next two sections describe the values that a Printer sends in the
content of Machine Consumable and Human Consumable Event Notifications, content of Machine Consumable and Human Consumable Event
respectively. Notifications, respectively.
The tables in the sub-sections of this section contain the following The tables in the sub-sections of this section contain the following
columns: columns:
a)Source Value: the name of the attribute that supplies the value a)Source Value: the name of the attribute that supplies the value
for the Event Notification. Asterisks in this field refer to a for the Event Notification. Asterisks in this field refer to a
note below the table. note below the table.
b)Sends: if the Printer supports the value (column 1) on the b)Sends: if the Printer supports the value (column 1) on the
Source Object (column 3) the Delivery Method MUST specify: Source Object (column 3) the Delivery Method MUST specify:
skipping to change at page 48, line 20 skipping to change at page 43, line 27
MAY: that the Printer MUST, SHOULD, MAY, MUST NOT, SHOULD NOT, MAY: that the Printer MUST, SHOULD, MAY, MUST NOT, SHOULD NOT,
or NEED NOT send the value. The Delivery Method specifies the or NEED NOT send the value. The Delivery Method specifies the
level of conformance for the Printer. level of conformance for the Printer.
c)Source Object: the object from which the source value comes. If c)Source Object: the object from which the source value comes. If
the object is "Event Notification", the Printer fabricates the the object is "Event Notification", the Printer fabricates the
value when it sends the Event Notification. See section 8. value when it sends the Event Notification. See section 8.
9.1 Content of Machine Consumable Event Notifications 9.1 Content of Machine Consumable Event Notifications
This section defines the attributes that a Delivery Method MUST mention This section defines the attributes that a Delivery Method MUST
in a Delivery Method Document when specifying the Machine Consumable mention in a Delivery Method Document when specifying the Machine
Event Notification's contents. Consumable Event Notification's contents.
This document does not define the order of attributes in Event This document does not define the order of attributes in Event
Notifications. However, Delivery Method Documents MAY define the order Notifications. However, Delivery Method Documents MAY define the
of some or all of the attributes. order of some or all of the attributes.
A Delivery Method Document MUST specify additional attributes (if any) A Delivery Method Document MUST specify additional attributes (if
that a Printer implementation sends in a Machine Consumable Event any) that a Printer implementation sends in a Machine Consumable
Notification. Event Notification.
Notification Recipients MUST be able to accept Event Notifications Notification Recipients MUST be able to accept Event Notifications
containing attributes they do not recognize. What a Notification containing attributes they do not recognize. What a Notification
Recipient does with an unrecognized attribute is implementation- Recipient does with an unrecognized attribute is implementation-
dependent. Notification Recipients MAY attempt to display unrecognized dependent. Notification Recipients MAY attempt to display
attributes anyway or MAY ignore them. unrecognized attributes anyway or MAY ignore them.
The next three sections define the attributes in Event Notification The next three sections define the attributes in Event Notification
Contents that are: Contents that are:
a)for all Events 1.for all Events
b)for Job Events only 2.for Job Events only
c)for Printer Events only
3.for Printer Events only
9.1.1 Event Notification Content Common to All Events 9.1.1 Event Notification Content Common to All Events
This section lists the attributes that a Delivery Method Document MUST This section lists the attributes that a Delivery Method Document
specify for all Events. MUST specify for all Events.
Table 5 lists potential values in each Event Notification. Table 5 lists potential values in each Event Notification.
Table 5 - Attributes in Event Notification Content Table 5 - Attributes in Event Notification Content
Source Value Sends Source Object Source Value Sends Source Object
notify-subscription-id (integer(1:MAX)) MUST Subscription notify-subscription-id (integer(1:MAX)) MUST Subscription
notify-printer-uri (uri) MUST Subscription notify-printer-uri (uri) MUST Subscription
skipping to change at page 50, line 4 skipping to change at page 44, line 45
notify-text (text) SHOULD Event notify-text (text) SHOULD Event
Notification Notification
attributes from the "notify-attributes" MAY Printer attributes from the "notify-attributes" MAY Printer
attribute *** attribute ***
attributes from the "notify-attributes" MAY Job attributes from the "notify-attributes" MAY Job
attribute *** attribute ***
attributes from the "notify-attributes" MAY Subscription attributes from the "notify-attributes" MAY Subscription
Source Value Sends Source Object
attribute *** attribute ***
*A Printer MUST send this value only if and only if it supports the *A Printer MUST send this value only if and only if it supports the
Printer's "printer-current-time" attribute. Printer's "printer-current-time" attribute.
** If the Subscription Object does not contain a "notify-user-data" ** If the Subscription Object does not contain a "notify-user-data"
attribute and the Delivery Method document REQUIRES the Printer to send attribute and the Delivery Method document REQUIRES the Printer to
the "notify-user-data" source value in the Event Notification, the send the "notify-user-data" source value in the Event Notification,
Printer MUST send an octet-string of length 0. the Printer MUST send an octet-string of length 0.
*** The last three rows represent additional attributes that a client *** The last three rows represent additional attributes that a client
MAY request via the "notify-attributes" attribute. A Printer MAY MAY request via the "notify-attributes" attribute. A Printer MAY
support the "notify-attributes" attribute. The Delivery Method MUST say support the "notify-attributes" attribute. The Delivery Method MUST
that the Printer MUST, SHOULD, MAY, MUST NOT, SHOULD NOT, or NEED NOT say that the Printer MUST, SHOULD, MAY, MUST NOT, SHOULD NOT, or NEED
support the "notify-attributes" attribute and specific values of this NOT support the "notify-attributes" attribute and specific values of
attribute. The Delivery Method MAY say that support for the "notify- this attribute. The Delivery Method MAY say that support for the
attributes" is conditioned on support of the attribute by the Printer or "notify-attributes" is conditioned on support of the attribute by the
it MAY say that Printer MUST support the "notify-attributes" attribute Printer or it MAY say that Printer MUST support the "notify-
if the Printer supports the Delivery Method. attributes" attribute if the Printer supports the Delivery Method.
9.1.2 Additional Event Notification Content for Job Events 9.1.2 Additional Event Notification Content for Job Events
This section lists the additional attributes that a Delivery Method This section lists the additional attributes that a Delivery Method
Document MUST specify for Job Events. See Table 6. Document MUST specify for Job Events. See Table 6.
Table 6 - Additional Event Notification Content for Job Events Table 6 - Additional Event Notification Content for Job Events
Source Value Sends Source Object Source Value Sends Source Object
job-id (integer(1:MAX)) MUST Job job-id (integer(1:MAX)) MUST Job
job-state (type1 enum) MUST Job job-state (type1 enum) MUST Job
job-state-reasons (1setOf type2 keyword) MUST Job job-state-reasons (1setOf type2 keyword) MUST Job
Source Value Sends Source Object job-impressions-completed (integer(0:MAX)) * MUST Job
job-impressions-completed (integer(0:MAX)) MUST Job
*
* The Printer MUST send the "job-impressions-completed" attribute in an * The Printer MUST send the "job-impressions-completed" attribute in
Event Notification only for the combinations of Events and Subscribed an Event Notification only for the combinations of Events and
Events shown in Table 7. Subscribed Events shown in Table 7.
Table 7 - Combinations of Events and Subscribed Events for "job- Table 7 - 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'
skipping to change at page 51, line 36 skipping to change at page 46, line 27
This section lists the additional attributes that a Delivery Method This section lists the additional attributes that a Delivery Method
Document MUST specify for Printer Events. See Table 8. Document MUST specify for Printer Events. See Table 8.
Table 8 - Additional Event Notification Content for Printer Events Table 8 - Additional Event Notification Content for Printer Events
Source Value Sends Source Object Source Value Sends Source Object
printer-state (type1 enum) MUST Printer printer-state (type1 enum) MUST Printer
printer-state-reasons (1setOf type2 MUST Printer printer-state-reasons (1setOf type2 keyword) MUST Printer
Source Value Sends Source Object
keyword)
printer-is-accepting-jobs (boolean) MUST Printer printer-is-accepting-jobs (boolean) MUST Printer
9.2 Content of Human Consumable Event Notification 9.2 Content of Human Consumable Event Notification
This section defines the information that a Delivery Method MUST mention This section defines the information that a Delivery Method MUST
in a Delivery Method Document when specifying the Human Consumable Event mention in a Delivery Method Document when specifying the Human
Notifications contents or the value of the "notify-text" attribute. Consumable Event Notifications contents or the value of the "notify-
text" attribute.
Such a Delivery Method MUST specify the following information and a Such a Delivery Method MUST specify the following information and a
Printer SHOULD send it: Printer SHOULD send it:
a)the Printer name (see Table 9) a)the Printer name (see Table 9)
b)the time of the Event (see Table 11) b)the time of the Event (see Table 11)
c)for Printer Events only: c)for Printer Events only:
i) the Event (see Table 10) and/or Printer state information i) the Event (see Table 10) and/or Printer state information
(see Table 14) (see Table 14)
d)for Job Events only: d)for Job Events only:
i) the job identity (see Table 12) i) the job identity (see Table 12)
ii) the Event (see Table 10) and/or Job state information (see ii) the Event (see Table 10) and/or Job state information (see
Table 13) Table 13)
The subsections of this section specify the attributes that a Printer The subsections of this section specify the attributes that a Printer
MUST use to obtain this information. MUST use to obtain this information.
skipping to change at page 52, line 33 skipping to change at page 47, line 15
i) the Event (see Table 10) and/or Printer state information i) the Event (see Table 10) and/or Printer state information
(see Table 14) (see Table 14)
d)for Job Events only: d)for Job Events only:
i) the job identity (see Table 12) i) the job identity (see Table 12)
ii) the Event (see Table 10) and/or Job state information (see ii) the Event (see Table 10) and/or Job state information (see
Table 13) Table 13)
The subsections of this section specify the attributes that a Printer The subsections of this section specify the attributes that a Printer
MUST use to obtain this information. MUST use to obtain this information.
A Delivery Method Document MUST specify additional information (if any) A Delivery Method Document MUST specify additional information (if
that a Printer implementation sends in a Human Consumable Event any) that a Printer implementation sends in a Human Consumable Event
Notification or in the "notify-text" attribute. Notification or in the "notify-text" attribute.
A client MUST NOT request additional attributes via the "notify- A client MUST NOT request additional attributes via the "notify-
attributes" attribute because this attribute works only for Machine attributes" attribute because this attribute works only for Machine
Consumable Event Notifications. Consumable Event Notifications.
Notification Recipients MUST NOT expect to be able to parse the Human Notification Recipients MUST NOT expect to be able to parse the Human
Consumable Event Notification contents or the value of the "notify-text" Consumable Event Notification contents or the value of the "notify-
attribute. text" attribute.
The next three sections define the attributes in Event Notification The next three sections define the attributes in Event Notification
Contents that are: Contents that are:
a)for all Events a)for all Events
b)for Job Events only b)for Job Events only
c)for Printer Events only c)for Printer Events only
9.2.1 Event Notification Content Common to All Events 9.2.1 Event Notification Content Common to All Events
This section lists the source of the information that a Delivery Method This section lists the source of the information that a Delivery
MUST specify for all Events. Method MUST specify for all Events.
There is a separate table for each piece of information. Each row in the There is a separate table for each piece of information. Each row in
table represents a source value for the information and the values are the table represents a source value for the information and the
listed in order of preference, with the first one being the preferred values are listed in order of preference, with the first one being
one. An implementation SHOULD use the source value from the earliest row the preferred one. An implementation SHOULD use the source value from
in each table. It MAY use the source value from another row instead, or the earliest row in each table. It MAY use the source value from
it MAY combine the source values from several rows. An implementation is another row instead, or it MAY combine the source values from several
free to determine the best way to present this information. rows. An implementation is free to determine the best way to present
this information.
In all tables of this section, all rows contain a "MAY" in order to In all tables of this section, all rows contain a "MAY" in order to
state that the Delivery Method specifies the conformance. state that the Delivery Method specifies the conformance.
Table 9 lists the source of the information for the Printer Name. The Table 9 lists the source of the information for the Printer Name. The
"printer-name" is more user-friendly unless the Notification Recipient "printer-name" is more user-friendly unless the Notification
is in a place where the Printer name is not meaningful. For example, an Recipient is in a place where the Printer name is not meaningful. For
implementation could have the intelligence to send the value of the example, an implementation could have the intelligence to send the
"printer-name" attribute to a Notification Recipient that can access the value of the "printer-name" attribute to a Notification Recipient
Printer via value of the "printer-name" attribute and otherwise send the that can access the Printer via value of the "printer-name" attribute
value of the "notify-printer-uri" attribute. and otherwise send the value of the "notify-printer-uri" attribute.
Table 9 - Printer Name in Event Notification Content Table 9 - Printer Name in Event Notification Content
Source Value Sends Source Object Source Value Sends Source Object
printer-name (name(127)) MAY Printer printer-name (name(127)) MAY Printer
notify-printer-uri (uri) MAY Subscription notify-printer-uri (uri) MAY Subscription
Table 10 lists the source of the information for the Event name. A Table 10 lists the source of the information for the Event name. A
Printer MAY combine this information with state information described Printer MAY combine this information with state information described
for Jobs in Table 13 or for Printers in Table 14. for Jobs in Table 13 or for Printers in Table 14.
Table 10 - Event Name in Event Notification Content Table 10 - Event Name in Event Notification Content
Source Value Sends Source Object Source Value Sends Source Object
notify-subscribed-event (type2 keyword) MAY Subscription notify-subscribed-event (type2 keyword) MAY Subscription
Table 11 lists the source of the information for the time that the Event Table 11 lists the source of the information for the time that the
occurred. A Printer can send this value only if it supports the Event occurred. A Printer can send this value only if it supports the
Printer's "printer-current-time" attribute. If a Printer does not Printer's "printer-current-time" attribute. If a Printer does not
support the support the "printer-current-time" attribute, it MUST NOT send the
"printer-current-time" attribute, it MUST NOT send the "printer-up-time" "printer-up-time" value instead, since it is not an allowed option
value instead, since it is not an allowed option for human consumable for human consumable information.
information.
Table 11 - Event Time in Event Notification Content Table 11 - Event Time in Event Notification Content
Source Value Sends Source Object Source Value Sends Source Object
printer-current-time (dateTime) MAY Printer printer-current-time (dateTime) MAY Printer
9.2.2 Additional Event Notification Content for Job Events 9.2.2 Additional Event Notification Content for Job Events
This section lists the source of the additional information that a This section lists the source of the additional information that a
Delivery Method MUST specify for Job Events. Delivery Method MUST specify for Job Events.
Table 12 lists the source of the information for the job name. The "job- Table 12 lists the source of the information for the job name. The
name" is likely more meaningful to a user than "job-id". "job-name" is likely more meaningful to a user than "job-id".
Table 12 - Job Name in Event Notification Content Table 12 - Job Name in Event Notification Content
Source Value Sends Source Object Source Value Sends Source Object
job-name (name(MAX)) MAY Job job-name (name(MAX)) MAY Job
job-id (integer(1:MAX)) MAY Job job-id (integer(1:MAX)) MAY Job
Table 13 lists the source of the information for the job state. If a Table 13 lists the source of the information for the job state. If a
Printer supports the "job-state-message" and "job-detailed-state- Printer supports the "job-state-message" and "job-detailed-state-
message" attributes, it SHOULD use those attributes for the job state message" attributes, it SHOULD use those attributes for the job state
information, otherwise, it should fabricate such information from the information, otherwise, it should fabricate such information from the
"job-state" and "job-state-reasons". For some Events, a Printer MAY "job-state" and "job-state-reasons". For some Events, a Printer MAY
combine this information with Event information. combine this information with Event information.
Table 13 - Job State in Event Notification Content Table 13 - Job State in Event Notification Content
Source Value Sends Source Object Source Value Sends Source
Object
job-state-message (text(MAX)) MAY Job job-state-message (text(MAX)) MAY Job
job-detailed-status-messages (1setOf MAY Job job-detailed-status-messages (1setOf text(MAX)) MAY Job
text(MAX))
job-state (type1 enum) MAY Job job-state (type1 enum) MAY Job
job-state-reasons (1setOf type2 keyword) MAY Job job-state-reasons (1setOf type2 keyword) MAY Job
9.2.3 Additional Event Notification Content for Printer Events 9.2.3 Additional Event Notification Content for Printer Events
This section lists the source of the additional information that a This section lists the source of the additional information that a
Delivery Method MUST specify for Printer Events. Delivery Method MUST specify for Printer Events.
Table 14 lists the source of the information for the printer state. If a Table 14 lists the source of the information for the printer state.
Printer supports the "printer-state-message", it SHOULD use that If a Printer supports the "printer-state-message", it SHOULD use that
attribute for the job state information, otherwise it SHOULD fabricate attribute for the job state information, otherwise it SHOULD
such information from the "printer-state" and "printer-state-reasons". fabricate such information from the "printer-state" and "printer-
For some Events, a Printer MAY combine this information with Event state-reasons". For some Events, a Printer MAY combine this
information. information with Event information.
Table 14 - Printer State in Event Notification Content Table 14 - Printer State in Event Notification Content
Source Value Sends Source Object Source Value Sends Source
Object
printer-state-message (text(MAX)) MAY Printer printer-state-message (text(MAX)) MAY Printer
printer-state (type1 enum) MAY Printer printer-state (type1 enum) MAY Printer
printer-state-reasons (1setOf type2 MAY Printer printer-state-reasons (1setOf type2 keyword) MAY Printer
keyword)
printer-is-accepting-jobs (boolean) MAY Printer printer-is-accepting-jobs (boolean) MAY Printer
10 Delivery Methods 10 Delivery Methods
A Delivery Method is the mechanism, i.e., protocol, by which the Printer A Delivery Method is the mechanism, i.e., protocol, by which the
delivers an Event Notification to a Notification Recipient. There are Printer delivers an Event Notification to a Notification Recipient.
several potential Delivery Methods for Event Notifications, There are several potential Delivery Methods for Event Notifications,
standardized, as well as proprietary. This document does not define any standardized, as well as proprietary. This document does not define
of these delivery mechanisms. Each Delivery Method MUST be defined in a any of these delivery mechanisms. Each Delivery Method MUST be
Delivery Method Document that is separate from this document. New defined in a Delivery Method Document that is separate from this
Delivery Methods will be created as needed using an extension to the document. New Delivery Methods will be created as needed using an
registration procedures defined in [ipp-mod]. Such documents are extension to the registration procedures defined in [RFC2911]. Such
registered with IANA (see section 13). documents are registered with IANA (see section 13).
The following sorts of Delivery Methods are expected: The following sorts of Delivery Methods are expected:
- The Notification Recipient polls for Event Notifications at - The Notification Recipient polls for Event Notifications at
intervals directed by the Printer intervals directed by the Printer
- The Printer sends Event Notifications to the Notification Recipient - The Printer sends Event Notifications to the Notification
using http as the transport. Recipient using http as the transport.
- The Printer sends an email message. - The Printer sends an email message.
This section specifies how to define a Delivery Method Document and what This section specifies how to define a Delivery Method Document and
to put in such a document. what to put in such a document.
A Delivery Method Document MUST contain an exact copy of the following A Delivery Method Document MUST contain an exact copy of the
paragraph, caption and table. In addition, column 2 of the table in the following paragraph, caption and table. In addition, column 2 of the
Delivery Method Document MUST contain answers to questions in column 1 table in the Delivery Method Document MUST contain answers to
for the Delivery Method. Also, the Delivery Method document MUST contain questions in column 1 for the Delivery Method. Also, the Delivery
a reference to this document and call that reference [ipp-ntfy] because Method document MUST contain a reference to this document and call
the table contains an [ipp-ntfy] reference. that reference [ipp-ntfy] because the table contains an [ipp-ntfy]
reference.
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 15 - Information about the Delivery Method Table 15 - Information about the Delivery Method
Document Method Conformance Delivery Method Realization Document Method Conformance Delivery Method Realization
Requirement Requirement
1.What is the URL scheme name 1.What is the URL scheme name for the
for the Delivery Method? Delivery Method?
2.Is the Delivery Method 2.Is the Delivery Method REQUIRED,
REQUIRED, RECOMMENDED, or RECOMMENDED, or OPTIONAL for an IPP
OPTIONAL for an IPP Printer to Printer to support?
support?
3.What transport and delivery 3.What transport and delivery
protocols does the Printer use protocols does the Printer use to
to deliver the Event deliver the Event Notification
Notification Content, i.e., Content, i.e., what is the entire
what is the entire network network stack?
stack?
4.Can several Event 4.Can several Event Notifications be
Notifications be combined into combined into a Compound Event
a Compound Event Notification? Notification?
5.Is the Delivery Method 5.Is the Delivery Method initiated by
initiated by the Notification the Notification Recipient (pull),
Recipient (pull), or by the or by the Printer (push)?
Printer (push)?
6.Is the Event Notification content
Machine Consumable or Human
Consumable?
6.Is the Event Notification
content Machine Consumable or
Human Consumable?
7.What section in this document 7.What section in this document
answers the following answers the following question? For
question? For a Machine a Machine Consumable Event
Consumable Event Notification, Notification, what is the
what is the representation and representation and encoding of
encoding of values defined in values defined in section 9.1 of
section 9.1 of [ipp-ntfy] and [ipp-ntfy] and the conformance
the conformance requirements requirements thereof? For a Human
thereof? For a Human Consumable Event Notification, what
Consumable Event Notification, is the representation and encoding
what is the representation and of pieces of information defined in
encoding of pieces of section 0 of [ipp-ntfy] and the
information defined in section conformance requirements thereof?
9.2 of [ipp-ntfy] and the
conformance requirements
thereof?
8.What are the latency and 8.What are the latency and
reliability of the transport reliability of the transport and
and delivery protocol? delivery protocol?
9.What are the security aspects 9.What are the security aspects of
of the transport and delivery the transport and delivery
protocol, e.g., how it is protocol, e.g., how it is handled
handled in firewalls? in firewalls?
10. What are the content length 10. What are the content length
restrictions? restrictions?
11. What are the additional 11. What are the additional values
values or pieces of or pieces of information that a
information that a Printer Printer sends in an Event
sends in an Event Notification Notification content and the
content and the conformance conformance requirements thereof?
requirements thereof?
12. What are the additional 12. What are the additional
Subscription Template and/or Subscription Template and/or
Subscription Description Subscription Description attributes
attributes and the conformance and the conformance requirements
requirements thereof? thereof?
13. What are the additional 13. What are the additional Printer
Printer Description attributes Description attributes and the
and the conformance conformance requirements thereof?
requirements thereof?
11 Operations for Notification 11 Operations for Notification
This section defines all of the operations for Notification. Section 7.1 This section defines all of the operations for Notification. Section
assigns the "operation-id" for each operation. The following two sub- 7.1 assigns the "operation-id" for each operation. The following two
sections define Subscription Creation Operations, and other operations. sub-sections define Subscription Creation Operations, and other
operations.
11.1Subscription Creation Operations 11.1Subscription Creation Operations
This section defines the Subscription Creation Operations. The first This section defines the Subscription Creation Operations. The first
section on Create-Job-Subscriptions gives most of the information. The section on Create-Job-Subscriptions gives most of the information.
other Subscription Creation Operations refer to the section on Create- The other Subscription Creation Operations refer to the section on
Job-Subscriptions, even though the Create-Job-Subscriptions operation is Create-Job-Subscriptions, even though the Create-Job-Subscriptions
the only OPTIONAL operation in this document (see section 12). operation is the only OPTIONAL operation in this document (see
section 12).
A Printer MUST support Create-Printer-Subscriptions and the Subscription A Printer MUST support Create-Printer-Subscriptions and the
Template Attributes Group in Job Creation operations. It MAY support Subscription Template Attributes Group in Job Creation operations. It
Create-Job-Subscriptions operations. MAY support Create-Job-Subscriptions operations.
11.1.1Create-Job-Subscriptions Operation 11.1.1Create-Job-Subscriptions Operation
The operation creates one or more Per-Job Subscription Objects. The The operation creates one or more Per-Job Subscription Objects. The
client supplies one or more Subscription Template Attributes Groups each client supplies one or more Subscription Template Attributes Groups
containing one or more of Subscription Template Attributes (defined in each containing one or more of Subscription Template Attributes
section 5.3). (defined in section 5.3).
Except for errors, the Printer MUST create exactly one Per-Job Except for errors, the Printer MUST create exactly one Per-Job
Subscription Object from each Subscription Template Attributes Group in Subscription Object from each Subscription Template Attributes Group
the request, even if the newly created Subscription Object would have in the request, even if the newly created Subscription Object would
identical behavior to some existing Subscription Object. The Printer have identical behavior to some existing Subscription Object. The
MUST associate each newly created Per-Job Subscription Object with the Printer MUST associate each newly created Per-Job Subscription Object
target Job, which is specified by the "notify-job-id" operation with the target Job, which is specified by the "notify-job-id"
attribute. operation attribute.
The Printer MUST accept the request in any of the target job's 'not- The Printer MUST accept the request in any of the target job's 'not-
completed' states, i.e., 'pending', 'pending-held', 'processing', or completed' states, i.e., 'pending', 'pending-held', 'processing', or
'processing-stopped'. The Printer MUST NOT change the job's "job-state" 'processing-stopped'. The Printer MUST NOT change the job's "job-
attribute because of this operation. If the target job is in any of the state" attribute because of this operation. If the target job is in
'completed' states, i.e., 'completed', 'canceled', or 'aborted, then the any of the 'completed' states, i.e., 'completed', 'canceled', or
Printer MUST reject the request and return the 'client-error-not- 'aborted, then the Printer MUST reject the request and return the
possible' status code; the response MUST NOT contain any Subscription 'client-error-not-possible' status code; the response MUST NOT
Attribute Groups. contain any Subscription Attribute Groups.
Access Rights: To create Per-Job Subscription Objects, the Access Rights: To create Per-Job Subscription Objects, the
authenticated user (see [IPP-MOD] section 8.3) performing this operation authenticated user (see [RFC2911] section 8.3) performing this
MUST either be the job owner or have Operator or Administrator access operation MUST either be the job owner or have Operator or
rights for this Printer (see [IPP-MOD] sections 1 and 8.5). Otherwise Administrator access rights for this Printer (see [RFC2911] sections
the Printer MUST reject the operation and return: the 'client-error- 1 and 8.5). Otherwise the Printer MUST reject the operation and
forbidden', 'client-error-not-authenticated', or 'client-error-not- return: the 'client-error-forbidden', 'client-error-not-
authorized' status code as appropriate. authenticated', or 'client-error-not-authorized' status code as
appropriate.
11.1.1.1 Create-Job-Subscriptions Request 11.1.1.1 Create-Job-Subscriptions Request
The following groups of attributes are part of the Create-Job- The following groups of attributes are part of the Create-Job-
Subscriptions Request: Subscriptions 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 [ipp-mod] section 3.1.4.1. attributes as described in [RFC2911] section 3.1.4.1.
Target: Target:
The "printer-uri" attribute which defines the target for this The "printer-uri" attribute which defines the target for this
operation as described in [ipp-mod] section 3.1.5. operation as described in [RFC2911] section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in [ipp-mod] section 8.3. client as described in [RFC2911] section 8.3.
notify-job-id (integer(1:MAX)): notify-job-id (integer(1:MAX)):
The client MUST supply this attribute and it MUST specify the Job The client MUST supply this attribute and it MUST specify the
object to associate the Per-Job Subscription with. The value of Job object to associate the Per-Job Subscription with. The
"notify-job-id" MUST be the value of the "job-id" of the associated value of "notify-job-id" MUST be the value of the "job-id" of
Job object. If the client does not supply this attribute, the the associated Job object. If the client does not supply this
Printer MUST reject this request with a 'client-error-bad-request' attribute, the Printer MUST reject this request with a 'client-
status code. error-bad-request' status code.
Group 2-N: Subscription Template Attributes Group 2-N: Subscription Template Attributes
For each occurrence of this group: For each occurrence of this group:
The client MUST supply one or more Subscription Template The client MUST supply one or more Subscription Template
Attributes in any order. See section 5.3 for a description of Attributes in any order. See section 5.3 for a description of
each such attribute. See section 5.2 for details on processing each such attribute. See section 5.2 for details on processing
these attributes. these attributes.
11.1.1.2 Create-Job-Subscriptions Response 11.1.1.2 Create-Job-Subscriptions Response
The Printer MUST return to the client the following sets of attributes The Printer MUST return to the client the following sets of
as part of a Create-Job-Subscriptions response: attributes as part of a Create-Job-Subscriptions response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
As defined in [ipp-mod]. In addition to the REQUIRED status code returned in every
response, the response OPTIONALLY includes a "status-message"
(text(255)) and/or a "detailed-status-message" (text(MAX))
operation attribute as described in [RFC2911] sections 13 and
31.6.
In this group, the Printer can return any status codes defined in In this group, the Printer can return any status codes defined
[ipp-mod] and section 16. The following is a description of the in [RFC2911] and section 16. The following is a description of
important status codes: the important status codes:
successful-ok: the Printer created all Subscription Objects successful-ok: the Printer created all Subscription Objects
requested. requested.
successful-ok-ignored-subscriptions: the Printer created some successful-ok-ignored-subscriptions: the Printer created some
Subscription Objects requested but some failed. The Subscription Objects requested but some failed. The
Subscription Attributes Groups with a "notify-status-code" Subscription Attributes Groups with a "notify-status-code"
attribute are the ones that failed. attribute are the ones that failed.
client-error-ignored-all-subscriptions: the Printer created no client-error-ignored-all-subscriptions: the Printer created no
Subscription Objects requested and all failed. The Subscription Objects requested and all failed. The
Subscription Attributes Groups with a "notify-status-code" Subscription Attributes Groups with a "notify-status-code"
attribute are the ones that failed attribute are the ones that failed
client-error-not-possible: For this operation and other Per-Job client-error-not-possible: For this operation and other Per-Job
Subscription operations, this error can occur because the Subscription operations, this error can occur because the
specified Job has already completed. specified Job has already completed.
Natural Language and Character Set: Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language" The "attributes-charset" and "attributes-natural-language"
skipping to change at page 63, line 7 skipping to change at page 56, line 15
client-error-ignored-all-subscriptions: the Printer created no client-error-ignored-all-subscriptions: the Printer created no
Subscription Objects requested and all failed. The Subscription Objects requested and all failed. The
Subscription Attributes Groups with a "notify-status-code" Subscription Attributes Groups with a "notify-status-code"
attribute are the ones that failed attribute are the ones that failed
client-error-not-possible: For this operation and other Per-Job client-error-not-possible: For this operation and other Per-Job
Subscription operations, this error can occur because the Subscription operations, this error can occur because the
specified Job has already completed. specified Job has already completed.
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 [ipp-mod] section 3.1.4.2. attributes as described in [RFC2911] section 3.1.4.2.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See [ipp-mod] section 3.1.7 for details on returning Unsupported See [RFC2911] section 3.1.7 for details on returning
Attributes. This group does not contain any unsupported Unsupported Attributes. This group does not contain any
Subscription Template Attributes; they are returned in the unsupported Subscription Template Attributes; they are returned
Subscription Attributes Group (see below). in the Subscription Attributes Group (see below).
Group 3-N: Subscription Attributes Group 3-N: Subscription Attributes
These groups MUST be returned if and only if the "status-code" These groups MUST be returned unless the Printer is unable to
parameter returned in Group 1 has the values: 'successful-ok', interpret the entire request, e.g., the "status-code" parameter
'successful-ok-ignored-subscriptions', or 'client-error-ignored- returned in Group 1 has the value: 'client-error-bad-request'.
all-subscriptions'.
See section 5.2 for details on the contents of each occurrence of "notify-status-code" (type2 enum):
this group. Indicates the status of this subscription (see section 17 for
the status code definitions). Section 5.2 defines when this
attribute MUST be present in this group.
See section 5.2 for details on the contents of each occurrence
of this group.
11.1.2Create-Printer-Subscriptions operation 11.1.2Create-Printer-Subscriptions operation
The operation is identical to Create-Job-Subscriptions with exceptions The operation is identical to Create-Job-Subscriptions with
noted in this section. exceptions noted in this section.
The operation creates Per-Printer Subscription Objects instead of Per- The operation creates Per-Printer Subscription Objects instead of
Job Subscription Objects, and associates each newly created Per-Printer Per-Job Subscription Objects, and associates each newly created Per-
Subscription Object with the Printer specified by the operation target Printer Subscription Object with the Printer specified by the
rather than with a specific Job. operation target rather than with a specific Job.
The Printer MUST accept the request in any of its states, i.e., 'idle', The Printer MUST accept the request in any of its states, i.e.,
'processing', or 'stopped'. The Printer MUST NOT change its "printer- 'idle', 'processing', or 'stopped'. The Printer MUST NOT change its
state" attribute because of this operation. "printer-state" attribute because of this operation.
Access Rights: To create Per-Printer Subscription Objects, the Access Rights: To create Per-Printer Subscription Objects, the
authenticated user (see [IPP-MOD] section 8.3) performing this operation authenticated user (see [RFC2911] section 8.3) performing this
MUST have Operator or Administrator access rights for this Printer (see operation MUST have Operator or Administrator access rights for this
[IPP-MOD] sections 1 and 8.5). Otherwise, the Printer MUST reject the Printer (see [RFC2911] sections 1 and 8.5). Otherwise, the Printer
operation and return: the 'client-error-forbidden', 'client-error-not- MUST reject the operation and return: the 'client-error-forbidden',
authenticated', or 'client-error-not-authorized' status code as 'client-error-not-authenticated', or 'client-error-not-authorized'
appropriate. status code as appropriate.
11.1.2.1 Create-Printer-Subscriptions Request 11.1.2.1 Create-Printer-Subscriptions Request
The groups are identical to the Create-Job-Subscriptions (see section The groups are identical to the Create-Job-Subscriptions (see section
11.1.1.1) except that the Operation Attributes group MUST NOT contain 11.1.1.1) except that the Operation Attributes group MUST NOT contain
the "notify-job-id" attribute. If the client does supply the "notify- the "notify-job-id" attribute. If the client does supply the
job-id" attribute, then the Printer MUST treat it as any other "notify-job-id" attribute, then the Printer MUST treat it as any
unsupported Operation attribute and MUST return it in the Unsupported other unsupported Operation attribute and MUST return it in the
Attributes group. Unsupported Attributes group.
11.1.2.2 Create-Printer-Subscriptions Response 11.1.2.2 Create-Printer-Subscriptions Response
The groups are identical to the Create-Job-Subscriptions (see section The groups are identical to the Create-Job-Subscriptions (see section
11.1.1.2). 11.1.1.2).
11.1.3Job Creation Operation - Extensions for Notification 11.1.3Job Creation Operation - Extensions for Notification
This document extends the Job Creation operations to create Subscription This document extends the Job Creation operations to create
Objects as a part of the operation. Subscription Objects as a part of the operation.
The operation is identical to Create-Job-Subscriptions with exceptions The operation is identical to Create-Job-Subscriptions with
noted in this section. exceptions noted in this section.
Unlike the Create-Job-Subscriptions operation, this operation associates Unlike the Create-Job-Subscriptions operation, this operation
the newly created Subscription Objects with the Job object created by associates the newly created Subscription Objects with the Job object
this operation. The operation succeeds if and only if the Job creation created by this operation. The operation succeeds if and only if the
succeeds. If the Printer does not create some or all of the requested Job creation succeeds. If the Printer does not create some or all of
Subscription Objects, the Printer MUST return a 'successful-ok-ignored- the requested Subscription Objects, the Printer MUST return a
subscriptions' status-code instead of a 'successful-ok' status-code, but 'successful-ok-ignored-subscriptions' status-code instead of a
the Printer MUST NOT reject the operation because of a failure to create 'successful-ok' status-code, but the Printer MUST NOT reject the
Subscription Objects. operation because of a failure to create Subscription Objects.
If the operation includes a Job Template group, the client MUST supply If the operation includes a Job Template group, the client MUST
it after the Operation Attributes group and before the first supply it after the Operation Attributes group and before the first
Subscription Template Attributes Group. Subscription Template Attributes Group.
If a Printer does not support this Notification specification, then it If a Printer does not support this Notification specification, then
MUST treat the Subscription Attributes Group like an unknown group and it MUST treat the Subscription Attributes Group like an unknown group
ignore it (see [ipp-mod] section 5.2.2). Because the Printer ignores and ignore it (see [RFC2911] section 5.2.2). Because the Printer
the Subscription Attributes Group, it doesn't return them in the ignores the Subscription Attributes Group, it doesn't return them in
the response either, thus indicating to the client that the Printer
response either, thus indicating to the client that the Printer doesn't doesn't support Notification.
support Notification.
Access Rights: To create Per-Job Subscription Objects, the Access Rights: To create Per-Job Subscription Objects, the
authenticated user (see [IPP-MOD] section 8.3) performing this operation authenticated user (see [RFC2911] section 8.3) performing this
MUST either have permission to create Jobs on the Printer. Otherwise operation MUST either have permission to create Jobs on the Printer.
the Printer MUST reject the operation and return: the 'client-error- Otherwise the Printer MUST reject the operation and return: the
forbidden', 'client-error-not-authenticated', or 'client-error-not- 'client-error-forbidden', 'client-error-not-authenticated', or
authorized' status code as appropriate. 'client-error-not-authorized' status code as appropriate.
11.1.3.1 Job Creation Request 11.1.3.1 Job Creation Request
The groups for this operation are sufficiently different from the The groups for this operation are sufficiently different from the
Create-Job-Subscriptions operation that they are all presented here. The Create-Job-Subscriptions operation that they are all presented here.
following groups of attributes are supplied as part of a Job Creation The following groups of attributes are supplied as part of a Job
Request: Creation Request:
Group 1: Operation Attributes Group 1: Operation Attributes
Same as defined in [ipp-mod] for Print-Job, Print-URI, and Create- Same as defined in [RFC2911] for Print-Job, Print-URI, and
Job requests. Create-Job requests.
Group 2: Job Template Attributes Group 2: Job Template Attributes
The client OPTIONALLY supplies a set of Job Template attributes as The client OPTIONALLY supplies a set of Job Template attributes
defined in [ipp-mod] section 4.2. as defined in [RFC2911] section 4.2.
Group 3 to N: Subscription Template Attributes Group 3 to N: Subscription Template Attributes
The same as Group 2-N in Create-Job-Subscriptions. See section The same as Group 2-N in Create-Job-Subscriptions. See section
11.1.1.1. 11.1.1.1.
Group N+1: Document Content (Print-Job only) Group N+1: Document Content (Print-Job only)
The client MUST supply the document data to be processed. The client MUST supply the document data to be processed.
11.1.3.2 Job Creation Response 11.1.3.2 Job Creation Response
The Printer MUST return to the client the following sets of attributes The Printer MUST return to the client the following sets of
as part of a Print-Job, Print-URI, and Create-Job Response: attributes as part of a Print-Job, Print-URI, and Create-Job
Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
As defined in [ipp-mod] for Print-Job, Print-URI, and Create-Job As defined in [RFC2911] for Print-Job, Print-URI, and Create-
requests. Job requests.
In this group, the Printer can return any status codes defined in In this group, the Printer can return any status codes defined
[ipp-mod] and section 16. The following is a description of the in [RFC2911] and section 16. The following is a description of
important status codes: the important status codes:
successful-ok: the Printer created the Job and all Subscription successful-ok: the Printer created the Job and all Subscription
Objects requested. Objects requested.
successful-ok-ignored-subscriptions: the Printer created the Job successful-ok-ignored-subscriptions: the Printer created the Job
and not all of the Subscription Objects requested. This and not all of the Subscription Objects requested. This
status-code hides 'successful-ok-xxx' status-codes that could status-code hides 'successful-ok-xxx' status-codes that could
reveal problems in Job creation. The Printer MUST not return reveal problems in Job creation. The Printer MUST not return
the 'client-error-ignored-all-subscriptions' status code for the 'client-error-ignored-all-subscriptions' status code for
Job Creation operations because the Printer returns an error Job Creation operations because the Printer returns an error
status-code only when it fails to create a Job. status-code only when it fails to create a Job.
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 [ipp-mod] section 3.1.4.2. attributes as described in [RFC2911] section 3.1.4.2.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See [ipp-mod] section 3.1.7 for details on returning Unsupported See [RFC2911] section 3.1.7 for details on returning
Attributes. This group does not contain any unsupported Unsupported Attributes. This group does not contain any
Subscription Template Attributes; they are returned in the unsupported Subscription Template Attributes; they are returned
Subscription Attributes Group (see below). in the Subscription Attributes Group (see below).
Group 3: Job Object Attributes Group 3: Job Object Attributes
As defined in [ipp-mod] for Print-Job, Print-URI, and Create-Job As defined in [RFC2911] for Print-Job, Print-URI, and Create-
requests. Job requests.
Group 4 to N: Subscription Attributes Group 4 to N: Subscription Attributes
These groups MUST be returned if and only if the client supplied These groups MUST be returned if and only if the client
Subscription Template Attributes and the operation was accepted. supplied Subscription Template Attributes and the operation was
accepted.
See section 5.2 for details on the contents of each occurrence of See section 5.2 for details on the contents of each occurrence
this group. of this group.
11.2Other Operations 11.2Other Operations
This section defines other operations on Subscription objects. This section defines other operations on Subscription objects.
11.2.1Validate-Job Operation - Extensions for Notification 11.2.1Validate-Job Operation - Extensions for Notification
A client can test whether one or more Subscription Objects could be A client can test whether one or more Subscription Objects could be
created using the Validate-Job operation. The client supplies one or created using the Validate-Job operation. The client supplies one or
more Subscription Template Attributes Groups (defined in section 5.3), more Subscription Template Attributes Groups (defined in section
just as in a Job Creation request. 5.3), just as in a Job Creation request.
A Printer MUST support this extension to this operation. A Printer MUST support this extension to this operation.
The Printer MUST accept requests that are identical to the Job Creation The Printer MUST accept requests that are identical to the Job
request defined in section 11.1.3.1, except that the request MUST not Creation request defined in section 11.1.3.1, except that the request
contain document data. MUST not contain document data.
The Printer MUST return the same groups and attributes as the Print-Job The Printer MUST return the same groups and attributes as the Print-
operation (section 11.1.3.1) with the following exceptions. The Printer Job operation (section 11.1.3.1) with the following exceptions. The
MUST NOT return a Job Object Attributes Group because no Job is created. Printer MUST NOT return a Job Object Attributes Group because no Job
The Printer MUST NOT return the "notify-subscription-id" attribute in is created. The Printer MUST NOT return the "notify-subscription-id"
any Subscription Attribute Group because no Subscription Object is attribute in any Subscription Attribute Group because no Subscription
created. Object is created.
If the Printer would succeed in creating a Subscription Object, the If the Printer would succeed in creating a Subscription Object, the
corresponding Subscription Attributes Group either has no 'status-code' corresponding Subscription Attributes Group either has no 'status-
attribute or a 'status-code' attribute with a value of 'successful-ok- code' attribute or a 'status-code' attribute with a value of
too-many-events' or 'successful-ok-ignored-or-substituted-attributes' 'successful-ok-too-many-events' or 'successful-ok-ignored-or-
(see sections 5.2 and 17). The status-codes have the same meaning as in substituted-attributes' (see sections 5.2 and 17). The status-codes
Job Creation except the results state what "would happen". have the same meaning as in Job Creation except the results state
what "would happen".
The Printer MUST validate Subscription Template Attributes Groups in the The Printer MUST validate Subscription Template Attributes Groups in
same manner as the Job Creation operations. the same manner as the Job Creation operations.
11.2.2Get-Printer-Attributes - Extensions for Notification 11.2.2Get-Printer-Attributes - Extensions for Notification
This operation is extended so that it returns Printer attributes defined This operation is extended so that it returns Printer attributes
in this document. defined in this document.
A Printer MUST support this extension to this operation. A Printer MUST support this extension to this operation.
In addition to the requirements of [ipp-mod] section 3.2.5, a Printer In addition to the requirements of [RFC2911] section 3.2.5, a Printer
MUST support the following additional values for the "requested- MUST support the following additional values for the "requested-
attributes" Operation attribute in this operation and return such attributes" Operation attribute in this operation and return such
attributes in the Printer Object Attributes group of its response. attributes in the Printer Object Attributes group of its response.
1. Subscription Template Attributes: Each supported attribute in 1. Subscription Template Attributes: Each supported attribute in
column 2 of Table 1. column 2 of Table 1.
2. New Printer Description Attributes: Each supported attribute in 2. New Printer Description Attributes: Each supported attribute in
section 6. section 6.
3. New Group Name: The 'subscription-template' group name, which names 3.New Group Name: The 'subscription-template' group name, which
all supported Subscription Template Attribute in column 2 of Table names all supported Subscription Template Attribute in column 2
1. This group name is also used in the Get-Subscription-Attributes of Table 1. This group name is also used in the Get-
and Get-Subscriptions operation with an analogous meaning. Subscription-Attributes and Get-Subscriptions operation with an
analogous meaning.
4. Extended Group Name: The 'all' group name, which names all Printer 4.Extended Group Name: The 'all' group name, which names all
attributes according to [ipp-mod] section 3.2.5. In this extension Printer attributes according to [RFC2911] section 3.2.5. In
'all' names all attributes specified in [ipp-mod] plus those named this extension 'all' names all attributes specified in [RFC2911]
in items 1 and 2 of this list. plus those named in items 1 and 2 of this list.
11.2.3Get-Subscription-Attributes operation 11.2.3Get-Subscription-Attributes operation
This operation allows a client to request the values of the attributes This operation allows a client to request the values of the
of a Subscription Object. attributes of a Subscription Object.
A Printer MUST support this operation. A Printer MUST support this operation.
This operation is almost identical to the Get-Job-Attributes operation This operation is almost identical to the Get-Job-Attributes
(see [ipp-mod] section 3.3.4). The only differences are that the operation (see [RFC2911] section 3.3.4). The only differences are
operation is directed at a Subscription Object rather than a Job object, that the operation is directed at a Subscription Object rather than a
and the returned attribute group contains Subscription Object attributes Job object, and the returned attribute group contains Subscription
rather than Job object attributes. Object attributes rather than Job object attributes.
11.2.3.1 Get-Subscription-Attributes Request 11.2.3.1 Get-Subscription-Attributes Request
The following groups of attributes are part of the Get-Subscription- The following groups of attributes are part of the Get-Subscription-
Attributes request: Attributes 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 section [ipp-mod] 3.1.4.1. attributes as described in section [RFC2911] 3.1.4.1.
Target: Target:
The "printer-uri" attribute which defines the target for this The "printer-uri" attribute which defines the target for this
operation as described in [ipp-mod] section 3.1.5. operation as described in [RFC2911] section 3.1.5.
"notify-subscription-id" (integer (1:MAX)): "notify-subscription-id" (integer (1:MAX)):
The client MUST supply this attribute. The Printer MUST support The client MUST supply this attribute. The Printer MUST
this attribute. This attribute specifies the Subscription Object support this attribute. This attribute specifies the
from which the client is requesting attributes. If the client omits Subscription Object from which the client is requesting
this attribute, the Printer MUST reject this request with the attributes. If the client omits this attribute, the Printer
'client-error-bad-request' status code. MUST reject this request with the 'client-error-bad-request'
status code.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in [ipp-mod] section 8.3. client as described in [RFC2911] section 8.3.
"requested-attributes" (1setOf keyword): "requested-attributes" (1setOf keyword):
The client OPTIONALLY supplies this attribute. The Printer MUST The client OPTIONALLY supplies this attribute. The Printer
support this attribute. This attribute specifies the attributes of MUST support this attribute. This attribute specifies the
the specified Subscription Object that the Printer MUST return in attributes of the specified Subscription Object that the
the response. Each value of this attribute is either an attribute Printer MUST return in the response. Each value of this
name (defined in sections 5.3 and 5.4) or an attribute group name. attribute is either an attribute name (defined in sections 5.3
The attribute group names are: and 5.4) or an attribute group name. The attribute group names
are:
- 'subscription-template': all attributes that are both defined - 'subscription-template': all attributes that are both defined
in section 5.3 and present on the specified Subscription in section 5.3 and present on the specified Subscription
Object (column 1 of Table 1). Object (column 1 of Table 1).
- 'subscription-description': all attributes that are both - 'subscription-description': all attributes that are both
defined in section 5.4 and present on the specified defined in section 5.4 and present on the specified
Subscription Object (Table 2). Subscription Object (Table 2).
- 'all': all attributes that are present on the specified - 'all': all attributes that are present on the specified
Subscription Object. Subscription Object.
A Printer MUST support all these group names. A Printer MUST support all these group names.
If the client omits this attribute, the Printer MUST respond as if If the client omits this attribute, the Printer MUST respond as
this attribute had been supplied with a value of 'all'. if this attribute had been supplied with a value of 'all'.
11.2.3.2 Get-Subscription-Attributes Response 11.2.3.2 Get-Subscription-Attributes Response
The Printer returns the following sets of attributes as part of the Get- The Printer returns the following sets of attributes as part of the
Subscription-Attributes Response: Get-Subscription-Attributes Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
Same as [ipp-mod]. Same as [RFC2911].
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 [ipp-mod] section 3.1.4.2. The attributes as described in [RFC2911] section 3.1.4.2. The
"attributes-natural-language" MAY be the natural language of the "attributes-natural-language" MAY be the natural language of
Subscription Object, rather than the one requested. the Subscription Object, rather than the one requested.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See [ipp-mod] section 3.1.7 for details on returning Unsupported See [RFC2911] section 3.1.7 for details on returning
Attributes. Unsupported Attributes.
The response NEED NOT contain the "requested-attributes" operation The response NEED NOT contain the "requested-attributes"
attribute with any supplied values (attribute keywords) that were operation attribute with any supplied values (attribute
requested by the client but are not supported by the Printer. If keywords) that were requested by the client but are not
the Printer does return unsupported attributes referenced in the supported by the Printer. If the Printer does return
"requested-attributes" operation attribute and that attribute unsupported attributes referenced in the "requested-attributes"
included group names, such as 'all', the unsupported attributes operation attribute and that attribute included group names,
MUST NOT include attributes described in the standard but not such as 'all', the unsupported attributes MUST NOT include
supported by the implementation. attributes described in the standard but not supported by the
implementation.
Group 3: Subscription Attributes Group 3: Subscription Attributes
This group contains a set of attributes with their current values. This group contains a set of attributes with their current
Each attribute in this group: values. Each attribute in this group:
a)MUST be specified by the "requested-attributes" attribute in the a)MUST be specified by the "requested-attributes" attribute
request, AND in the request, AND
b)MUST be present on the specified Subscription Object AND b)MUST be present on the specified Subscription Object AND
c)MUST NOT be restricted by the security policy in force. For c)MUST NOT be restricted by the security policy in force.
example, a Printer MAY prohibit a client who is not the creator For example, a Printer MAY prohibit a client who is not the
of a Subscription Object from seeing some or all of its creator of a Subscription Object from seeing some or all of
attributes. See [ipp-mod] section 8. its attributes. See [RFC2911] section 8.
The Printer can return the attributes of the Subscription Object in The Printer can return the attributes of the Subscription
any order. The client MUST accept the attributes in any order. Object in any order. The client MUST accept the attributes in
any order.
11.2.4Get-Subscriptions operation 11.2.4Get-Subscriptions operation
This operation allows a client to retrieve the values of attributes of This operation allows a client to retrieve the values of attributes
all Subscription Objects belonging to a Job or Printer. of all Subscription Objects belonging to a Job or Printer.
A Printer MUST supported this operation. A Printer MUST supported this operation.
This operation is similar to the Get-Subscription-Attributes operation, This operation is similar to the Get-Subscription-Attributes
except that this Get-Subscriptions operation returns attributes from operation, except that this Get-Subscriptions operation returns
possibly more than one object. attributes from possibly more than one object.
This operation is similar to the Get-Jobs operation (see [ipp-mod] This operation is similar to the Get-Jobs operation (see [RFC2911]
section 3.2.6), except that the operation returns Subscription Objects section 3.2.6), except that the operation returns Subscription
rather than Job objects. Objects rather than Job objects.
11.2.4.1 Get-Subscriptions Request 11.2.4.1 Get-Subscriptions Request
The following groups of attributes are part of the Get-Subscriptions The following groups of attributes are part of the Get-Subscriptions
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 [ipp-mod] section 3.1.4.1. attributes as described in [RFC2911] section 3.1.4.1.
Target: Target:
The "printer-uri" attribute which defines the target for this The "printer-uri" attribute which defines the target for this
operation as described in [ipp-mod] section 3.1.5. operation as described in [RFC2911] section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in [ipp-mod] section 8.3. client as described in [RFC2911] section 8.3.
"notify-job-id" (integer(1:MAX)): "notify-job-id" (integer(1:MAX)):
If the client specifies this attribute, the Printer returns the If the client specifies this attribute, the Printer returns the
specified attributes of all Per-Job Subscription Objects associated specified attributes of all Per-Job Subscription Objects
with the Job whose "job-id" attribute value equals the value of associated with the Job whose "job-id" attribute value equals
this attribute. If the client does not specify this attribute, the the value of this attribute. If the client does not specify
Printer returns the specified attributes of all Per-Printer this attribute, the Printer returns the specified attributes of
Subscription Objects. Note: there is no way to get all Per-Job all Per-Printer Subscription Objects. Note: there is no way to
Subscriptions. get all Per-Job Subscriptions.
"limit" (integer(1:MAX)): "limit" (integer(1:MAX)):
The client OPTIONALLY supplies this attribute. The Printer MUST The client OPTIONALLY supplies this attribute. The Printer
support this attribute. It is an integer value that determines the MUST support this attribute. It is an integer value that
maximum number of Subscription Objects that a client will receive determines the maximum number of Subscription Objects that a
from the Printer even if the "my-subscriptions" attribute client will receive from the Printer even if the "my-
constrains which Subscription Objects are returned. The limit is a subscriptions" attribute constrains which Subscription Objects
"stateless limit" in that if the value supplied by the client is are returned. The limit is a "stateless limit" in that if the
'N', then only the first 'N' Subscription Objects are returned in value supplied by the client is 'N', then only the first 'N'
the Get-Subscriptions Response. There is no mechanism to allow for Subscription Objects are returned in the Get-Subscriptions
the next 'M' Subscription Objects after the first 'N' Subscription Response. There is no mechanism to allow for the next 'M'
Objects. If the client does not supply this attribute, the Printer Subscription Objects after the first 'N' Subscription Objects.
If the client does not supply this attribute, the Printer
responds with all applicable Subscription Objects. responds with all applicable Subscription Objects.
"requested-attributes" (1setOf type2 keyword): "requested-attributes" (1setOf type2 keyword):
The client OPTIONALLY supplies this attribute. The Printer MUST The client OPTIONALLY supplies this attribute. The Printer
support this attribute. This attribute specifies the attributes of MUST support this attribute. This attribute specifies the
the specified Subscription Objects that the Printer MUST return in attributes of the specified Subscription Objects that the
the response. Each value of this attribute is either an attribute Printer MUST return in the response. Each value of this
name (defined in sections 5.3 and 5.4) or an attribute group name attribute is either an attribute name (defined in sections 5.3
(defined in section 11.2.3.1). If the client omits this attribute, and 5.4) or an attribute group name (defined in section
the Printer MUST respond as if the client had supplied this 11.2.3.1). If the client omits this attribute, the Printer MUST
attribute with the one value: 'notify-subscription-id'. respond as if the client had supplied this attribute with the
one value: 'notify-subscription-id'.
"my-subscriptions" (boolean): "my-subscriptions" (boolean):
The client OPTIONALLY supplies this attribute. The Printer MUST The client OPTIONALLY supplies this attribute. The Printer
support this attribute. If the value is 'false', the Printer MUST MUST support this attribute. If the value is 'false', the
consider the Subscription Objects from all users as candidates. If Printer MUST consider the Subscription Objects from all users
the value is 'true', the Printer MUST return the Subscription as candidates. If the value is 'true', the Printer MUST return
Objects created by the requesting user of this request. If the the Subscription Objects created by the requesting user of this
client does not supply this attribute, the Printer MUST respond as request. If the client does not supply this attribute, the
if the client had supplied the attribute with a value of 'false'. Printer MUST respond as if the client had supplied the
The means for authenticating the requesting user and matching the attribute with a value of 'false'. The means for
Subscription Objects is similar to that for Jobs which is described authenticating the requesting user and matching the
in [ipp-mod] section 8. Subscription Objects is similar to that for Jobs which is
described in [RFC2911] section 8.
11.2.4.2 Get-Subscriptions Response 11.2.4.2 Get-Subscriptions Response
The Printer returns the following sets of attributes as part of the Get- The Printer returns the following sets of attributes as part of the
Subscriptions Response: Get-Subscriptions Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
Same as [ipp-mod]. Same as [RFC2911].
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 [ipp-mod] section 3.1.4.2. attributes as described in [RFC2911] section 3.1.4.2.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
Same as for Get-Subscription-Attributes. Same as for Get-Subscription-Attributes.
Groups 3 to N: Subscription Attributes Groups 3 to N: Subscription Attributes
The Printer responds with one Subscription Attributes Group for The Printer responds with one Subscription Attributes Group for
each requested Subscription Object (see the "notify-job-id" each requested Subscription Object (see the "notify-job-id"
attribute in the Operation Attributes Group of this operation). attribute in the Operation Attributes Group of this operation).
The Printer returns Subscription Objects in any order. The Printer returns Subscription Objects in any order.
If the "limit" attribute is present in the Operation Attributes If the "limit" attribute is present in the Operation Attributes
group of the request, the number of Subscription Attributes Groups group of the request, the number of Subscription Attributes
in the response MUST NOT exceed the value of the "limit" attribute. Groups in the response MUST NOT exceed the value of the "limit"
attribute.
It there are no Subscription Objects associated with the specified It there are no Subscription Objects associated with the
Job or Printer, the Printer MUST return zero Subscription specified Job or Printer, the Printer MUST return zero
Attributes Groups and it MUST NOT treat this case as an error, Subscription Attributes Groups and it MUST NOT treat this case
i.e., the status-code MUST be 'successful-ok' unless something else as an error, i.e., the status-code MUST be 'successful-ok'
causes the status code to have some other value. unless something else causes the status code to have some other
value.
See the Group 3 response (Subscription Attributes Group) of the See the Group 3 response (Subscription Attributes Group) of the
Get-Subscription-Attributes operation (section 11.2.3.2) for the Get-Subscription-Attributes operation (section 11.2.3.2) for
attributes that a Printer returns in this group. the attributes that a Printer returns in this group.
11.2.5Renew-Subscription operation 11.2.5Renew-Subscription operation
This operation allows a client to request the Printer to extend the This operation allows a client to request the Printer to extend the
lease on a Per-Printer Subscription Object. lease on a Per-Printer Subscription Object.
The Printer MUST support this operation. The Printer MUST support this operation.
The Printer MUST accept this request for a Per-Printer Subscription The Printer MUST accept this request for a Per-Printer Subscription
Object in any of the target Printer's states, i.e., 'idle', Object in any of the target Printer's states, i.e., 'idle',
'processing', or 'stopped', but MUST NOT change the Printer's "printer- 'processing', or 'stopped', but MUST NOT change the Printer's
state" attribute. "printer-state" attribute.
The Printer MUST reject this request for a Per-Job Subscription Object The Printer MUST reject this request for a Per-Job Subscription
because it has no lease (see section 5.4.3). The status code returned Object because it has no lease (see section 5.4.3). The status code
MUST be 'client-error-not-possible'. returned MUST be 'client-error-not-possible'.
Access Rights: The authenticated user (see [IPP-MOD] section 8.3) Access Rights: The authenticated user (see [RFC2911] section 8.3)
performing this operation MUST either be the owner of the Per-Printer performing this operation MUST either be the owner of the Per-Printer
Subscription Object or have Operator or Administrator access rights for Subscription Object or have Operator or Administrator access rights
the Printer (see [IPP-MOD] sections 1 and 8.5). Otherwise, the Printer for the Printer (see [RFC2911] sections 1 and 8.5). Otherwise, the
MUST reject the operation and return: the 'client-error-forbidden', Printer MUST reject the operation and return: the 'client-error-
'client-error-not-authenticated', or 'client-error-not-authorized' forbidden', 'client-error-not-authenticated', or 'client-error-not-
status code as appropriate. authorized' status code as appropriate.
11.2.5.1 Renew-Subscription Request 11.2.5.1 Renew-Subscription Request
The following groups of attributes are part of the Renew-Subscription The following groups of attributes are part of the Renew-Subscription
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 [ipp-mod] section 3.1.4.1. attributes as described in [RFC2911] section 3.1.4.1.
Target: Target:
The "printer-uri" attribute which defines the target for this The "printer-uri" attribute which defines the target for this
operation as described in [ipp-mod] section 3.1.5. operation as described in [RFC2911] section 3.1.5.
"notify-subscription-id" (integer (1:MAX)): "notify-subscription-id" (integer (1:MAX)):
The client MUST supply this attribute. The Printer MUST support The client MUST supply this attribute. The Printer MUST
this attribute. This attribute specifies the Per-Printer support this attribute. This attribute specifies the Per-
Subscription Object whose lease the Printer MUST renew. If the Printer Subscription Object whose lease the Printer MUST renew.
client omits this attribute, the Printer MUST reject this request If the client omits this attribute, the Printer MUST reject
with the 'client-error-bad-request' status code. this request with the 'client-error-bad-request' status code.
Requesting User Name: Requesting User Name:
The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied The "requesting-user-name" (name(MAX)) attribute SHOULD be
by the client as described in [ipp-mod] section 8.3. supplied by the client as described in [RFC2911] section 8.3.
Group 2: Subscription Template Attributes Group 2: Subscription Template Attributes
"notify-lease-duration" (integer(0:MAX)): "notify-lease-duration" (integer(0:MAX)):
The client MAY supply this attribute. It indicates the number of The client MAY supply this attribute. It indicates the number
seconds to renew the lease for the specified Subscription Object. of seconds to renew the lease for the specified Subscription
A value of 0 requests an infinite lease (which MAY require Operator Object. A value of 0 requests an infinite lease (which MAY
access rights). If the client omits this attribute, the Printer require Operator access rights). If the client omits this
MUST use the value of the Printer's "notify-lease-duration-default" attribute, the Printer MUST use the value of the Printer's
attribute. See section 5.3.7 for more details. "notify-lease-duration-default" attribute. See section 5.3.7
for more details.
11.2.5.2 Renew-Subscription Response 11.2.5.2 Renew-Subscription Response
The Printer returns the following sets of attributes as part of the The Printer returns the following sets of attributes as part of the
Renew-Subscription Response: Renew-Subscription Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
Same as [ipp-mod]. Same as [RFC2911].
The following are some of the status codes returned: The following are some of the status codes returned:
successful-ok: The operation successfully renewed the lease on the successful-ok: The operation successfully renewed the lease on the
Subscription Object for the requested duration.. Subscription Object for the requested duration..
successful-ok-ignored-or-substituted-attributes: The operation successful-ok-ignored-or-substituted-attributes: The operation
successfully renewed the lease on the Subscription Object for successfully renewed the lease on the Subscription Object for
some duration other than the amount requested. some duration other than the amount requested.
client-error-not-possible: The operation failed because the client-error-not-possible: The operation failed because the
"notify-subscription-id" Operation attribute identified a Per- "notify-subscription-id" Operation attribute identified a Per-
Job Subscription Object. Job Subscription Object.
client-error-not-found: The operation failed because the "notify- client-error-not-found: The operation failed because the "notify-
subscription-id" Operation attribute identified a non-existent subscription-id" Operation attribute identified a non-existent
Subscription Object. Subscription Object.
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 [ipp-mod] section 3.1.4.2. The attributes as described in [RFC2911] section 3.1.4.2. The
"attributes-natural-language" MAY be the natural language of the "attributes-natural-language" MAY be the natural language of
Subscription Object, rather than the one requested. the Subscription Object, rather than the one requested.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See [ipp-mod] section 3.1.7 for details on returning Unsupported See [RFC2911] section 3.1.7 for details on returning
Attributes. Unsupported Attributes.
Group 3: Subscription Attributes Group 3: Subscription Attributes
The Printer MUST return the following Subscription Attribute: The Printer MUST return the following Subscription Attribute:
"notify-lease-duration" (integer(0:MAX)): "notify-lease-duration" (integer(0:MAX)):
The value of this attribute MUST be the number of seconds that the The value of this attribute MUST be the number of seconds that
Printer has granted for the lease of the Subscription Object (see the Printer has granted for the lease of the Subscription
section 5.3.7 for details, such as the value of this attribute when Object (see section 5.3.7 for details, such as the value of
the Printer doesn't support the requested value). this attribute when the Printer doesn't support the requested
value).
11.2.6Cancel-Subscription operation 11.2.6Cancel-Subscription operation
This operation allows a client to delete a Subscription Object and stop This operation allows a client to delete a Subscription Object and
the Printer from sending more Event Notifications. Once performed, stop the Printer from sending more Event Notifications. Once
there is no way to reference the Subscription Object. performed, there is no way to reference the Subscription Object.
A Printer MUST supported this operation. A Printer MUST supported this operation.
The Printer MUST accept this request in any of the target Printer's The Printer MUST accept this request in any of the target Printer's
states, i.e., 'idle', 'processing', or 'stopped', but MUST NOT change states, i.e., 'idle', 'processing', or 'stopped', but MUST NOT change
the Printer's "printer-state" attribute. the Printer's "printer-state" attribute.
If the specified Subscription Object is a Per-Job Subscription Object, If the specified Subscription Object is a Per-Job Subscription
the Printer MUST accept this request in any of the target Job's states, Object, the Printer MUST accept this request in any of the target
but MUST NOT change the Job's "job-state" attribute or affect the Job. Job's states, but MUST NOT change the Job's "job-state" attribute or
affect the Job.
Access Rights: The authenticated user (see [IPP-MOD] section 8.3) Access Rights: The authenticated user (see [RFC2911] section 8.3)
performing this operation MUST either be the owner of the Subscription performing this operation MUST either be the owner of the
Object or have Operator or Administrator access rights for the Printer Subscription Object or have Operator or Administrator access rights
(see [IPP-MOD] sections 1 and 8.5). Otherwise, the Printer MUST reject for the Printer (see [RFC2911] sections 1 and 8.5). Otherwise, the
the operation and return: the 'client-error-forbidden', 'client-error- Printer MUST reject the operation and return: the 'client-error-
not-authenticated', or 'client-error-not-authorized' status code as forbidden', 'client-error-not-authenticated', or 'client-error-not-
appropriate. authorized' status code as appropriate.
Note: There is no way to change any attributes on a Subscription Note: There is no way to change any attributes on a Subscription
Object, except the "notify-lease-duration" attribute (using the Renew- Object, except the "notify-lease-duration" attribute (using the
Subscription operation). In order to change other attributes, a client Renew-Subscription operation). In order to change other attributes,
performs a Subscription Creation Operation and Cancel-Subscription a client performs a Subscription Creation Operation and Cancel-
operation on the old Subscription Object. If the client wants to avoid Subscription operation on the old Subscription Object. If the client
missing Event Notifications, it performs the Subscription Creation wants to avoid missing Event Notifications, it performs the
Operation first. If this order would create too many Subscription Subscription Creation Operation first. If this order would create too
Objects on the Printer, the client reverses the order. many Subscription Objects on the Printer, the client reverses the
order.
11.2.6.1 Cancel-Subscription Request 11.2.6.1 Cancel-Subscription Request
The following groups of attributes are part of the Cancel-Subscription The following groups of attributes are part of the Cancel-
Request: Subscription 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 [ipp-mod] section 3.1.4.1. attributes as described in [RFC2911] section 3.1.4.1.
Target: Target:
The "printer-uri" attribute which defines the target for this The "printer-uri" attribute which defines the target for this
operation as described in [ipp-mod] section 3.1.5. operation as described in [RFC2911] section 3.1.5.
"notify-subscription-id" (integer (1:MAX)): "notify-subscription-id" (integer (1:MAX)):
The client MUST supply this attribute. The Printer MUST support The client MUST supply this attribute. The Printer MUST
this attribute. This attribute specifies the Subscription Object support this attribute. This attribute specifies the
that the Printer MUST cancel. If the client omits this attribute, Subscription Object that the Printer MUST cancel. If the client
the Printer MUST reject this request with the 'client-error-bad- omits this attribute, the Printer MUST reject this request with
request' status code. the 'client-error-bad-request' status code.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in [ipp-mod] section 8.3. client as described in [RFC2911] section 8.3.
11.2.6.2 Cancel-Subscription Response 11.2.6.2 Cancel-Subscription Response
The Printer returns the following sets of attributes as part of the The Printer returns the following sets of attributes as part of the
Cancel-Subscription Response: Cancel-Subscription Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
Same as [ipp-mod]. Same as [RFC2911].
The following are some of the status codes returned: The following are some of the status codes returned:
successful-ok: The operation successfully canceled (deleted) the successful-ok: The operation successfully canceled (deleted) the
Subscription Object.. Subscription Object..
client-error-not-found: The operation failed because the "notify- client-error-not-found: The operation failed because the "notify-
subscription-id" Operation attribute identified a non-existent subscription-id" Operation attribute identified a non-existent
Subscription Object. Subscription Object.
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 [ipp-mod] section 3.1.4.2. The attributes as described in [RFC2911] section 3.1.4.2. The
"attributes-natural-language" MAY be the natural language of the "attributes-natural-language" MAY be the natural language of
Subscription Object, rather than the one requested. the Subscription Object, rather than the one requested.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See [ipp-mod] section 3.1.7 for details on returning Unsupported See [RFC2911] section 3.1.7 for details on returning
Attributes. Unsupported Attributes.
12 Conformance Requirements 12 Conformance Requirements
It is OPTIONAL to implement this Event Notification specification. It is OPTIONAL to implement this Event Notification specification.
If this Event Notification specification is implemented, Printers MUST: If this Event Notification specification is implemented, Printers
MUST:
1.meet the Conformance Requirements detailed in section 5 of [ipp-mod]. 1.meet the Conformance Requirements detailed in section 5 of
[RFC2911].
2.support the Subscription Template Attributes Group in requests and 2.support the Subscription Template Attributes Group in requests
the Subscription Attributes Group in responses. and the Subscription Attributes Group in responses.
3.support all of the following attributes: 3.support all of the following attributes:
a.REQUIRED Subscription Object attributes in section 5. a.REQUIRED Subscription Object attributes in section 5.
b.REQUIRED Printer Description object attributes in section 6. b.REQUIRED Printer Description object attributes in section 6.
c. REQUIRED attributes in Event Notification content in section
c.REQUIRED attributes in Event Notification content in section 8. 8.
4.send Event Notifications that conform to the requirements of the 4.send Event Notifications that conform to the requirements of the
Delivery Method Document for each supported Delivery Method (the Delivery Method Document for each supported Delivery Method (the
conformance requirements for Delivery Method Documents is specified conformance requirements for Delivery Method Documents is
in section 10). specified in section 10).
5.support all operations as described in Table 16: 5.support all operations as described in Table 16:
Table 16 - Conformance Requirements for Operations Table 16 - Conformance Requirements for Operations
Operation Conformance requirements Operation Conformance
requirements
Create-Printer-Subscriptions REQUIRED Create-Printer-Subscriptions (section 11.1.2) REQUIRED
(section 11.1.2)
Create-Job-Subscriptions (section OPTIONAL Create-Job-Subscriptions (section 11.1.1) OPTIONAL
11.1.1)
Get-Subscription-Attributes (section REQUIRED Get-Subscription-Attributes (section 11.2.2) REQUIRED
11.2.2)
Get-Subscriptions (section 11.2.4) REQUIRED Get-Subscriptions (section 11.2.4) REQUIRED
Renew-Subscription (section 11.2.5) REQUIRED Renew-Subscription (section 11.2.5) REQUIRED
Cancel-Subscription (section 11.2.6) REQUIRED Cancel-Subscription (section 11.2.6) REQUIRED
13 IANA Considerations 13 IANA Considerations
This section describes the procedures for registering Event Notification This section contains the exact information for IANA to add to the
Delivery Method proposals with IANA to be used with this document. Such IPP Registries according to the procedures defined in RFC 2911
Delivery Method proposals can be IETF standards track documents or [RFC2911] section 6.
vendor-defined documents. In either case, they will be registered with
IANA using procedures that extend those defined in [ipp-mod] section 6
and 11.
These extension procedures are aligned with the guidelines as set forth Note to RFC Editors: Replace RFC NNNN below with the RFC number
by the IESG [IANA-CON]. Section 13.1 defines the format and content for for this document, so that it accurately reflects the content of
new registrations for consideration. IANA will reject registration the information for the IANA Registry.
proposals that leave out required information or do not follow the
appropriate format described in Section 13.1.
Implementers can, at any time, define new Event Notification Delivery 13.1 Attribute Registrations
Methods by proposing the complete specification to IANA:
iana@iana.org The attributes defined in this document will be published by IANA
according to the procedures in RFC 2911 [RFC2911] section 6.2 with
the following path:
or by filling out the appropriate form on the IANA web pages ftp.isi.edu/iana/assignments/ipp/attributes/
(http://www.iana.org).
IANA will forward the registration proposal to the IPP Designated Expert The registry entry will contain the following information:
who will review the proposal with a mailing list that the Designated
Expert keeps for this purpose. Initially, that list will be the mailing
list used by the IPP WG:
ipp@pwg.org Subscription Template attributes: Ref. Section:
notify-recipient-uri (uri) RFC NNNN 5.3.1
notify-events (1setOf type2 keyword) RFC NNNN 5.3.2
notify-attributes (1setOf type2 keyword) RFC NNNN 5.3.3
notify-user-data (octetString(63)) RFC NNNN 5.3.4
notify-charset (charset) RFC NNNN 5.3.5
notify-natural-language (naturalLanguage) RFC NNNN 5.3.6
notify-lease-duration (integer(0:67108863)) RFC NNNN 5.3.7
notify-time-interval (integer(0:MAX)) RFC NNNN 5.3.8
even after the IPP WG is disbanded as permitted by [IANA-CON]. The IPP Subscription Description Attributes:
Designated Expert is appointed by the IESG Area Director responsible for notify-subscription-id (integer (1:MAX))) RFC NNNN 5.4.1
IPP, according to [IANA-CON]. notify-sequence-number (integer (0:MAX))) RFC NNNN 5.4.2
notify-lease-expiration-time (integer(0:MAX))) RFC NNNN 5.4.3
notify-printer-up-time (integer(1:MAX))) RFC NNNN 5.4.4
notify-printer-uri (uri)) RFC NNNN 5.4.5
notify-job-id (integer(1:MAX))) RFC NNNN 5.4.6
notify-subscriber-user-name (name(MAX))) RFC NNNN 5.4.7
When a Delivery Method Document is approved, the IPP Designated Expert Printer Description Attributes:
becomes the point of contact for any future maintenance that might be printer-state-change-time (integer(1:MAX))) RFC NNNN 6.1
required for that registration. printer-state-change-date-time (dateTime)) RFC NNNN 6.2
13.1Format and Requirements for IPP Delivery Method Registration Attributes Only in Event Notifications
notify-subscribed-event (type2 keyword) RFC NNNN 8.1
notify-text (text(MAX)) RFC NNNN 8.2
13.2 Keyword Attribute Value Registrations
The keyword attribute values defined in this document will be
published by IANA according to the procedures in RFC 2911 [RFC2911]
section 6.1 with the following path:
ftp.isi.edu/iana/assignments/ipp/attribute-values/
The registry entry will contain the following information:
Keyword Attribute Values: Ref. Section:
New Values for Existing Printer Description Attributes
operations-supported (1setOf type2 enum) RFC NNNN 7.1
13.3 Operation Registrations
The operations defined in this document will be published by IANA
according to the procedures in RFC 2911 [RFC2911] section 6.4 with
the following path:
ftp.isi.edu/iana/assignments/ipp/operations/
The registry entry will contain the following information:
Operations: Ref. Section:
Create-Job-Subscriptions Operation RFC NNNN 11.1.1
Create-Printer-Subscriptions operation RFC NNNN 11.1.2
Job Creation Operations - Extensions RFC NNNN 11.1.3
Validate-Job Operation - Extensions RFC NNNN 11.2.1
Get-Printer-Attributes - Extensions RFC NNNN 11.2.2
Get-Subscription-Attributes operation RFC NNNN 11.2.3
Get-Subscriptions operation RFC NNNN 11.2.4
Renew-Subscription operation RFC NNNN 11.2.5
Cancel-Subscription operation RFC NNNN 11.2.6
13.4 Status code Registrations
The status codes defined in this document will be published by IANA
according to the procedures in RFC 2911 [RFC2911] section 6.6 with
the following path:
ftp.isi.edu/iana/assignments/ipp/status-codes/
The registry entry will contain the following information:
Status codes: Ref. Section:
successful-ok-ignored-subscriptions (0x0003) RFC NNNN 16.1
client-error-ignored-all-subscriptions (0x0414) RFC NNNN 16.2
Status Codes in Subscription Attributes Groups:
client-error-uri-scheme-not-supported (0x040C) RFC NNNN 17.1
client-error-too-many-subscriptions (0x0415) RFC NNNN 17.2
successful-ok-too-many-events (0x0005) RFC NNNN 17.3
successful-ok-ignored-or-substituted-attributes (0x0001)
RFC NNNN 17.4
13.5 Attribute Group tag Registrations
The attribute group tags defined in this document will be published
by IANA according to the procedures in RFC 2911 [RFC2911] section 6.5
with the following path:
ftp.isi.edu/iana/assignments/ipp/attribute-group-tags/
The registry entry will contain the following information:
Attribute Group Tags: Ref. Section:
subscription-attributes-tag RFC NNNN 18
event-notification-attributes-tag RFC NNNN 18
13.6 Format for Event Notification Delivery Method Registration
proposals
This section describes the procedures for registering Event
Notification Delivery Method proposals with IANA to be used with this
document. Such Delivery Method proposals that require a new URL
scheme MUST be IETF standards track documents according to RFC 2717
[RFC2717].
13.7 Format and Requirements for IPP Delivery Method Registration
Proposals Proposals
This section defines the format and requirements for an IPP Event This section defines the format and requirements for an IPP Event
Notification Delivery Method Registration Proposal. A Delivery Method Notification Delivery Method Registration Proposal. A Delivery
Registration Proposal: Method Registration Proposal:
1.MUST contain the following information: 1.MUST contain the following information:
Type of registration: IPP Event Notification Delivery Method Type of registration: IPP Event Notification Delivery Method
Name of this delivery method: Name of this delivery method:
Proposed URL scheme name of this delivery method: Proposed URL scheme name of this delivery method:
Name of proposer: Name of proposer:
Address of proposer: Address of proposer:
Email address of proposer: Email address of proposer:
Is this delivery method REQUIRED or OPTIONAL for conformance to the Is this delivery method REQUIRED or OPTIONAL for conformance to
IPP Event Notification Specification document: the IPP Event Notification Specification document:
Is this delivery method defining Machine Consumable and/or Human Is this delivery method defining Machine Consumable and/or Human
Consumable content: Consumable content:
2.MUST meet the conformance requirements for Delivery Method Documents 2.MUST meet the conformance requirements for Delivery Method
specified in section 10. Documents specified in section 10.
14 Internationalization Considerations 14 Internationalization Considerations
This IPP Notification specification continues support for the This IPP Notification specification continues support for the
internationalization of [ipp-mod] of attributes containing text strings internationalization of [RFC2911] of attributes containing text
and names. Allowing a Subscribing Client to specify a different natural strings and names. Allowing a Subscribing Client to specify a
language and charset for each Subscription Object increases the different natural language and charset for each Subscription Object
internationalization support. increases the internationalization support.
The Printer MUST be able to localize the content of Human Consumable The Printer MUST be able to localize the content of Human Consumable
Event Notifications and to localize the value of "notify-text" attribute Event Notifications and to localize the value of "notify-text"
in Machine Consumable Event Notifications that it sends to Notification attribute in Machine Consumable Event Notifications that it sends to
Recipients. For localization, the Printer MUST use the value of the Notification Recipients. For localization, the Printer MUST use the
"notify-charset" attribute and the "notify-natural-language" attribute value of the "notify-charset" attribute and the "notify-natural-
in the Subscription Object supplied by the Subscribing Client. language" attribute in the Subscription Object supplied by the
Subscribing Client.
15 Security Considerations 15 Security Considerations
By far the biggest security concern is the abuse of notification: By far the biggest security concern is the abuse of notification:
sending unwanted Event Notifications to third parties (i.e., spam). The sending unwanted Event Notifications to third parties (i.e., spam).
problem is made worse by notification addresses that may be The problem is made worse by notification addresses that may be
redistributed to multiple parties (e.g., mailing lists). There exist redistributed to multiple parties (e.g., mailing lists). There exist
scenarios where third party notification is required (see Scenario #2 scenarios where third party notification is required (see Scenario #2
and #3 in [ipp-not-req]). The fully secure solution would require and #3 in [ipp-not-req]). The fully secure solution would require
active agreement of all recipients before sending out anything. active agreement of all recipients before sending out anything.
However, requirement #9 in [ipp-req] ("There is no requirement for IPP However, requirement #9 in [ipp-req] ("There is no requirement for
Printer receiving the print request to validate the identity of an Event IPP Printer receiving the print request to validate the identity of
recipient") argues against this. Certain systems may decide to disallow an Event recipient") argues against this. Certain systems may decide
third party Event Notifications (a traditional fax model). to disallow third party Event Notifications (a traditional fax
model).
Clients submitting Notification requests to the IPP Printer has the same Clients submitting Notification requests to the IPP Printer has the
security issues as submitting an IPP/1.1 print job request. The same same security issues as submitting an IPP/1.1 print job request. The
mechanisms used by IPP/1.1 can therefore be used by the client same mechanisms used by IPP/1.1 can therefore be used by the client
Notification submission. Operations that require authentication can use Notification submission. Operations that require authentication can
the HTTP authentication. Operations that require privacy can use the use the HTTP authentication. Operations that require privacy can use
HTTP/TLS privacy. the HTTP/TLS privacy.
The Notification access control model should be similar to the IPP The Notification access control model should be similar to the IPP
access control model for Jobs. Creating a Per-Printer Subscription access control model for Jobs. Creating a Per-Printer Subscription
Object is associated with a user. Only the creator or an Operator can Object is associated with a user. Only the creator or an Operator
cancel the Subscription Object. The system may limit the listing of can cancel the Subscription Object. The system may limit the listing
items to only those items owned by the user. Some Subscription Objects of items to only those items owned by the user. Some Subscription
(e.g., those that have a lifetime longer than a job) can be done only by Objects (e.g., those that have a lifetime longer than a job) can be
privileged users (users having Operator and/or Administrator access done only by privileged users (users having Operator and/or
rights), if that is the authorization policy. Administrator access rights), if that is the authorization policy.
The standard security concerns (delivery to the right user, privacy of The standard security concerns (delivery to the right user, privacy
content, tamper proof content) apply to the Delivery Method. IPP should of content, tamper proof content) apply to the Delivery Method. IPP
use the security mechanism of the Delivery Method used. Some delivery should use the security mechanism of the Delivery Method used. Some
mechanisms are more secure than others. Therefore, sensitive Event delivery mechanisms are more secure than others. Therefore,
Notifications should use the Delivery Method that has the strongest sensitive Event Notifications should use the Delivery Method that has
security. the strongest security.
16 Status Codes 16 Status Codes
The following status codes are defined as extensions for Notification The following status codes are defined as extensions for Notification
and are returned as the value of the "status-code" parameter in the and are returned as the value of the "status-code" parameter in the
Operation Attributes Group of a response (see [ipp-mod] section Operation Attributes Group of a response (see [RFC2911] section
3.1.6.1). Operations in this document can also return the status codes 3.1.6.1). Operations in this document can also return the status
defined in section 13 of [ipp-mod]. The 'successful-ok' status code is codes defined in section 13 of [RFC2911]. The 'successful-ok' status
an example of such a status code. code is an example of such a status code.
16.1successful-ok-ignored-subscriptions (0x0003) 16.1successful-ok-ignored-subscriptions (0x0003)
The Subscription Creation Operation was unable to create all requested The Subscription Creation Operation was unable to create all
Subscription Objects. requested Subscription Objects.
For a Create-Job-Subscriptions or Create-Printer-Subscriptions For a Create-Job-Subscriptions or Create-Printer-Subscriptions
operation, this status code means that the Printer created one or more operation, this status code means that the Printer created one or
Subscription Objects, but not all requested Subscription Objects. more Subscription Objects, but not all requested Subscription
Objects.
For a Job Creation operation, this status code means that the Printer For a Job Creation operation, this status code means that the Printer
created the Job along with zero or more Subscription Objects. The created the Job along with zero or more Subscription Objects. The
Printer returns this status code even if other job attributes are Printer returns this status code even if other job attributes are
unsupported or in conflict. That is, if an IPP Printer finds a warning unsupported or in conflict. That is, if an IPP Printer finds a
that would allow it to return 'successful-ok-ignored-subscriptions' and warning that would allow it to return 'successful-ok-ignored-
either 'successful-ok-ignored-or-substituted-attributes' and/or subscriptions' and either 'successful-ok-ignored-or-substituted-
'successful-ok-conflicting-attributes', it MUST return 'successful-ok- attributes' and/or 'successful-ok-conflicting-attributes', it MUST
ignored-subscriptions'. return 'successful-ok-ignored-subscriptions'.
16.2client-error-ignored-all-subscriptions (0x0414) 16.2client-error-ignored-all-subscriptions (0x0414)
This status code is the same as 'successful-ok-ignored-subscriptions' This status code is the same as 'successful-ok-ignored-subscriptions'
except that only the Create-Job-Subscriptions and Create-Printer- except that only the Create-Job-Subscriptions and Create-Printer-
Subscriptions operation return it. They return this status code only Subscriptions operation return it. They return this status code only
when the Printer creates zero Subscription Objects. when the Printer creates zero Subscription Objects.
17 Status Codes in Subscription Attributes Groups 17 Status Codes in Subscription Attributes Groups
This section contains values of the "notify-status-code" attribute that This section contains values of the "notify-status-code" (type2 enum)
the Printer returns in a Subscription Attributes Group in a response attribute that the Printer returns in a Subscription Attributes Group
when the corresponding Subscription Object: in a response when the corresponding Subscription Object:
1. is not created or 1. is not created or
2. is created and some of the client-supplied attributes are not 2. is created and some of the client-supplied attributes are not
supported. supported.
The following sections are ordered in decreasing order of importance of The following sections are ordered in decreasing order of importance
the status-codes. of the status-codes.
17.1client-error-uri-scheme-not-supported (0x040C) 17.1client-error-uri-scheme-not-supported (0x040C)
This status code is defined in [ipp-mod]. This document extends its This status code is defined in [RFC2911]. This document extends its
meaning and allows it to be in a Subscription Attributes Group of a meaning and allows it to be in a Subscription Attributes Group of a
response. response.
The scheme of the client-supplied URI in a "notify-recipient-uri" The scheme of the client-supplied URI in a "notify-recipient-uri"
Subscription Template Attribute in a Subscription Creation Operation is Subscription Template Attribute in a Subscription Creation Operation
not supported. See section 5.3.1. is not supported. See section 0.
17.2client-error-too-many-subscriptions (0x0415) 17.2client-error-too-many-subscriptions (0x0415)
The number of Subscription Objects supported by the Printer would be The number of Subscription Objects supported by the Printer would be
exceeded if this Subscription Object were created (see section 5.2). exceeded if this Subscription Object were created (see section 5.2).
17.3successful-ok-too-many-events (0x0005) 17.3successful-ok-too-many-events (0x0005)
The client supplied more Events in the "notify-events" operation The client supplied more Events in the "notify-events" operation
attribute of a Subscription Creation Operation than the Printer attribute of a Subscription Creation Operation than the Printer
supports, as indicated in its "notify-max-events-supported" Printer supports, as indicated in its "notify-max-events-supported" Printer
attribute (see section 5.3.2). attribute (see section 5.3.2).
17.4successful-ok-ignored-or-substituted-attributes (0x0001) 17.4successful-ok-ignored-or-substituted-attributes (0x0001)
This status code is defined in [ipp-mod]. This document extends its This status code is defined in [RFC2911]. This document extends its
meaning to include unsupported Subscription Template Attributes and it meaning to include unsupported Subscription Template Attributes and
can appear in a Subscription Attributes Group. it can appear in a Subscription Attributes Group.
18 Encodings of Additional Attribute Tags 18 Encodings of Additional Attribute Tags
This section assigns values to two attributes tags as extensions to the This section assigns values to two attributes tags as extensions to
encoding defined in [ipp-pro]). the encoding defined in [RFC2910]).
The "subscription-attributes-tag" delimits Subscription Template The "subscription-attributes-tag" delimits Subscription Template
Attributes Groups in requests and Subscription Attributes Groups in Attributes Groups in requests and Subscription Attributes Groups in
responses. responses.
The "event-notification-attributes-tag" delimits Event Notifications in The "event-notification-attributes-tag" delimits Event Notifications
Delivery Methods that use an IPP-like encoding. in Delivery Methods that use an IPP-like encoding.
The following table specifies the values for the delimiter tags: The following table specifies the values for the delimiter tags:
Tag Value (Hex) Meaning Tag Value (Hex) Meaning
0x06 "subscription-attributes-tag" 0x06 "subscription-attributes-tag"
0x07 "event-notification-attributes-tag" 0x07 "event-notification-attributes-tag"
19 References 19 References
[IANA-CON] [IANA-CON]
Narte, T. and Alvestrand, H.T.: Guidelines for Writing an IANA Narte, T. and Alvestrand, H.T.: Guidelines for Writing an IANA
Considerations Section in RFCs, Work in Progress, draft-iesg-iana- Considerations Section in RFCs, Work in Progress, draft-iesg-iana-
considerations-04.txt, May 21, 1998. considerations-04.txt, May 21, 1998.
[ipp-mod]
deBry, R., , Hastings, T., Herriot, R., Isaacson, S., Powell, P.,
"Internet Printing Protocol/1.1: Model and Semantics", <draft-ietf-
ipp-model-v11-07.txt>, work in progress, May 22, 2000.
[ipp-not-req] [ipp-not-req]
deBry, R., Lewis, H., Hastings, T., "Internet Printing deBry, R., Lewis, H., Hastings, T., "Internet Printing
Protocol/1.1: Requirements for IPP Notifications", <draft-ietf-ipp- Protocol/1.1: Requirements for IPP Notifications", <draft-ietf-ipp-
not-04.txt>, work in progress, July 6, 2000. not-05.txt>, work in progress, January 23, 2001.
[ipp-pro]
Herriot, R., Butler, S., Moore, P., Tuner, R., "Internet Printing
Protocol/1.1: Encoding and Transport", <draft-ietf-ipp-protocol-
v11-06.txt>, work in progress, May 30, 2000.
[ipp-prog] [ipp-prog]
Hastings, T., Bergman, R., Lewis, H., "IPP: Job Progress Hastings, T., Bergman, R., Lewis, H., "IPP: Job Progress
Attributes", <draft-ietf-ipp-job-prog-00.txt> work in Attributes", <draft-ietf-ipp-job-prog-03.txt> work in
progress, July 6, 2000. progress, January 23, 2001.
[ipp-set] [ipp-set]
Kugler, C., Hastings, T., Herriot, R., Lewis, H, "Internet Printing Kugler, C., Hastings, T., Herriot, R., Lewis, H, "Internet Printing
Protocol (IPP): Job and Printer Set Operations", <draft-ietf-ipp- Protocol (IPP): Job and Printer Set Operations", <draft-ietf-ipp-
job-printer-set-ops-02.txt>, work in progress, March 23, 2000. job-printer-set-ops-03.txt>, work in progress, January 22, 2001.
[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
[RFC2566] [RFC2566]
skipping to change at page 85, line 45 skipping to change at page 77, line 45
2567, April 1999. 2567, April 1999.
[RFC2568] [RFC2568]
Zilles, S., "Rationale for the Structure and Model and Protocol for Zilles, S., "Rationale for the Structure and Model and Protocol for
the Internet Printing Protocol", RFC 2568, April 1999. the Internet Printing Protocol", RFC 2568, April 1999.
[RFC2569] [RFC2569]
Herriot, R., Hastings, T., Jacobs, N., Martin, J., "Mapping between Herriot, R., Hastings, T., Jacobs, N., Martin, J., "Mapping between
LPD and IPP Protocols", RFC 2569, April 1999. LPD and IPP Protocols", RFC 2569, April 1999.
[RFC2717]
R. Petke and I. King, "Registration Procedures for URL Scheme
Names", RFC 2717, November 1999.
[RFC2910]
Herriot, R., Butler, S., Moore, P., Turner, R., "Internet Printing
Protocol/1.1: Encoding and Transport", RFC 2910, September 2000.
[RFC2911]
deBry, R., , Hastings, T., Herriot, R., Isaacson, S., Powell, P.,
"Internet Printing Protocol/1.1: Model and Semantics", RFC 2911,
September 2000.
20 Author's Addresses 20 Author's Addresses
Robert Herriot Robert Herriot
Xerox Corporation Xerox Corporation
3400 Hillview Ave., Bldg #1 3400 Hillview Ave., Bldg #1
Palo Alto, CA 94304 Palo Alto, CA 94304
Phone: 650-813-7696 Phone: 650-813-7696
Fax: 650-813-6860 Fax: 650-813-6860
Email: robert.herriot@pahv.xerox.com Email: robert.herriot@pahv.xerox.com
skipping to change at page 87, line 16 skipping to change at page 79, line 27
1757 Tapo Canyon Road 1757 Tapo Canyon Road
Simi Valley, CA 93063-3394 Simi Valley, CA 93063-3394
Phone: 805-578-4421 Phone: 805-578-4421
Fax: 805-578-4001 Fax: 805-578-4001
Email: rbergma@hitachi-hkis.com Email: rbergma@hitachi-hkis.com
A. Appendix - Model for Notification with Cascading Printers A. Appendix - Model for Notification with Cascading Printers
With this model (see Figure 2), there is an intervening Print server With this model (see Figure 2), there is an intervening Print server
between the human user and the output-device. So the system effectively between the human user and the output-device. So the system
has two Printers. There are two cases to consider. effectively has two Printers. There are two cases to consider.
1. When the Printer 1 (in the server) generates Events, the system 1. When the Printer 1 (in the server) generates Events, the system
behaves like the client and Printer in Figure 1. In this case, behaves like the client and Printer in Figure 1. In this case,
Printer 1 sends Event Notifications that are shown as Event Printer 1 sends Event Notifications that are shown as Event
Notifications (A) of Figure 2,. Notifications (A) of Figure 2,.
2. When the Printer 2 (in the output-device) generates Events, there 2. When the Printer 2 (in the output-device) generates Events, there
are two possible system configurations: are two possible system configurations:
a)Printer 1 forwards the client-supplied Subscription Creation a)Printer 1 forwards the client-supplied Subscription Creation
skipping to change at page 87, line 44 skipping to change at page 80, line 7
Operations to Printer 2 with the Notification Recipient changed Operations to Printer 2 with the Notification Recipient changed
to be the Printer 1. When an Event occurs in Printer 2, Printer to be the Printer 1. When an Event occurs in Printer 2, Printer
2 sends the Event Notification (B) to Notification Recipient of 2 sends the Event Notification (B) to Notification Recipient of
Printer 1, which relays the received Event Notification (B) to Printer 1, which relays the received Event Notification (B) to
the client-supplied Notification Recipient (as Event the client-supplied Notification Recipient (as Event
Notifications(A) in the diagram). Note, when a client performs a Notifications(A) in the diagram). Note, when a client performs a
Subscription Creation Operation, Printer 1 need not forward the Subscription Creation Operation, Printer 1 need not forward the
Subscription Creation Operation to Printer 2 if it would create Subscription Creation Operation to Printer 2 if it would create
a duplicate Subscription Object on Printer 2. a duplicate Subscription Object on Printer 2.
Note: when Printer 1 is forwarding Subscription Creation Operations to Note: when Printer 1 is forwarding Subscription Creation Operations
Printer 2, it may request Printer 2 to create additional Subscription to Printer 2, it may request Printer 2 to create additional
Objects (called "piggy-backing"). Piggy-backing is useful when: Subscription Objects (called "piggy-backing"). Piggy-backing is
useful when:
. Device A is configured to accept (IPP or non-IPP) requests from . Device A is configured to accept (IPP or non-IPP) requests from
other servers. other servers.
. Server S wants to receive Job Events that the client didn't request . Server S wants to receive Job Events that the client didn't
and Server S wants these Events for jobs it submits and not for request and Server S wants these Events for jobs it submits and
other jobs. not for other jobs.
server S device A server S device A
+------------+ +------------+ +------------+ +------------+
| | | | | | | |
+--------+ Subscription | ###########| | ###########| +--------+ Subscription | ###########| | ###########|
| client |--Creation ----># Printer #| Subscription | # Printer #| | client |--Creation ----># Printer #| Subscription | # Printer #|
+--------+ Operation | # Object 1#|---Creation------|># Object 2#| +--------+ Operation | # Object 1#|---Creation------|># Object 2#|
| ###|#######| Operation | ####|#|####| | ###|#######| Operation | ####|#|####|
+----|---^---+ +-----|-|----+ +----|---^---+ +-----|-|----+
+--------+ Event | | | | +--------+ Event | | | |
|Notific-|<-Notifications(A)-+ +-- Event Notifications(B)--+ | |Notific-|<-Notifications(A)-+ +-- Event Notifications(B)--+ |
|ation Re|<-------------Event Notifications(C)-----------------+ |ation Re|<-------------Event Notifications(C)-----------------+
|cipient | |cipient |
+--------+ +--------+
Figure 2 - Model for Notification with Cascading Printers Figure 2 - Model for Notification with Cascading Printers
B. Appendix - Distributed Model for Notification B. Appendix - Distributed Model for Notification
A Printer implementation could use some other remote notification A Printer implementation could use some other remote notification
service to provide some or most of the service. For example, the remote service to provide some or most of the service. For example, the
notification service could send Event Notifications using Delivery remote notification service could send Event Notifications using
Methods that are not directly supported by the output device or server. Delivery Methods that are not directly supported by the output device
Or, the remote notification service could store Subscription Objects or server. Or, the remote notification service could store
(passed to it from the output device in response to Subscription Subscription Objects (passed to it from the output device in response
Creation requests), accept Events, format the Event Notification in the to Subscription Creation requests), accept Events, format the Event
natural language of the Notification Recipient, and send the Event Notification in the natural language of the Notification Recipient,
Notifications to the Notification Recipient(s). and send the Event Notifications to the Notification Recipient(s).
Figure 3 shows this partitioning. The interface between the output Figure 3 shows this partitioning. The interface between the output
device (or server) and the remote notification service is outside the device (or server) and the remote notification service is outside the
scope of this document and is intended to be transparent to the client scope of this document and is intended to be transparent to the
and this document. The combination of the output device (or server) and client and this document. The combination of the output device (or
the notification service together constitute an IPP Printer conforming server) and the notification service together constitute an IPP
to this Notification document. Printer conforming to this Notification document.
*********************** ***********************
* *
* Printer (including * Printer (including
* the distributed * the distributed
* Notification Service) * Notification Service)
* *
* output device or server * output device or server
* +---------------+ * +---------------+
PDA, desktop, or server * + ########### + PDA, desktop, or server * + ########### +
skipping to change at page 89, line 35 skipping to change at page 81, line 35
* +---------------+ * +---------------+
* *
************************* *************************
*** = Implementation configuration opaque boundary *** = Implementation configuration opaque boundary
Figure 3 - Opaque Use of a Notification Service Transparent to the Figure 3 - Opaque Use of a Notification Service Transparent to the
Client Client
C. Appendix - Extended Notification Recipient C. Appendix - Extended Notification Recipient
The model allows for an extended Notification Recipient that is itself a The model allows for an extended Notification Recipient that is
notification service that forwards each Event Notification to another itself a notification service that forwards each Event Notification
recipient (called the Ultimate Notification Recipient in this section). to another recipient (called the Ultimate Notification Recipient in
The Delivery Method to the Ultimate Recipient is probably different from this section). The Delivery Method to the Ultimate Recipient is
the Delivery Method used by the Printer to the extended Notification probably different from the Delivery Method used by the Printer to
Recipient. the extended Notification Recipient.
This extended Notification Recipient is transparent to the Printer but
not to the client.
When a client performs a Subscription Creation Operation, it specifies This extended Notification Recipient is transparent to the Printer
the extended Notification Recipient as it would any Notification but not to the client.
Recipient. In addition, the client specifies the Ultimate Notification
Recipient in the Subscription Creation Operation in a manner specified
by the extended Notification Recipient. Typically, it is either some
bytes in the value of "notify-user-data" or some additional parameter in When a client performs a Subscription Creation Operation, it
the value of "notify-recipient-uri". The client also subscribes directly specifies the extended Notification Recipient as it would any
with the extended Notification Recipient (by means outside this Notification Recipient. In addition, the client specifies the
document), since it is a notification service in its own right. Ultimate Notification Recipient in the Subscription Creation
Operation in a manner specified by the extended Notification
Recipient. Typically, it is either some bytes in the value of
"notify-user-data" or some additional parameter in the value of
"notify-recipient-uri". The client also subscribes directly with the
extended Notification Recipient (by means outside this document),
since it is a notification service in its own right.
The IPP Printer treats the extended Notification Recipient like any The IPP Printer treats the extended Notification Recipient like any
other Notification Recipient and the IPP Printer is not aware of the other Notification Recipient and the IPP Printer is not aware of the
forwarding. The Delivery Method that the extended Notification Recipient forwarding. The Delivery Method that the extended Notification
uses for delivering the Event Notification to the Ultimate Notification Recipient uses for delivering the Event Notification to the Ultimate
Recipient is beyond the scope of this document and is transparent to the Notification Recipient is beyond the scope of this document and is
IPP Printer. transparent to the IPP Printer.
Examples of this extended Notification Recipient are paging, immediate Examples of this extended Notification Recipient are paging,
messaging services, general notification services, and NOS vendors' immediate messaging services, general notification services, and NOS
infrastructure. Figure 4 shows this approach. vendors' infrastructure. Figure 4 shows this approach.
PDA, desktop, or server server or output device PDA, desktop, or server server or output device
+---------------+ +---------------+
+--------+ | ########### | +--------+ | ########### |
| client |---Subscription Creation -----------># Printer # | | client |---Subscription Creation -----------># Printer # |
+--------+ Operation | # Object # | +--------+ Operation | # Object # |
| #####|##### | | #####|##### |
+------------+ +------------+ IPP-defined +-------|-------+ +------------+ +------------+ IPP-defined +-------|-------+
|Ultimate | any |Notification|<--Event Notifications----+ |Ultimate | any |Notification|<--Event Notifications----+
|Notification|<----|Recipient | |Notification|<----|Recipient |
|Recipient | +------------+ |Recipient | +------------+
+------------+ (Notification Service) +------------+ (Notification Service)
Figure 4 - Use of an Extended Notification Recipient transparent to the Figure 4 - Use of an Extended Notification Recipient transparent to
Printer the Printer
D. Appendix - Details about Conformance Terminology D. Appendix - Details about Conformance Terminology
The following paragraph provide more details about conformance The following paragraph provide more details about conformance
terminology. terminology.
REQUIRED - an adjective used to indicate that a conforming IPP REQUIRED - an adjective used to indicate that a conforming IPP
Printer implementation MUST support the indicated operation, Printer implementation MUST support the indicated operation,
object, attribute, attribute value, status code, or out-of-band object, attribute, attribute value, status code, or out-of-band
value in requests and responses. See [ipp-mod] "Appendix A - value in requests and responses. See [RFC2911] "Appendix A -
Terminology for a definition of "support". Since support of this Terminology for a definition of "support". Since support of this
entire Notification specification is OPTIONAL for conformance to entire Notification specification is OPTIONAL for conformance to
IPP/1.0 or IPP/1.1, the use of the term REQUIRED in this document IPP/1.0 or IPP/1.1, the use of the term REQUIRED in this document
means "REQUIRED if this OPTIONAL Notification specification is means "REQUIRED if this OPTIONAL Notification specification is
implemented". implemented".
RECOMMENDED - an adjective used to indicate that a conforming IPP RECOMMENDED - an adjective used to indicate that a conforming IPP
Printer implementation is recommended to support the indicated Printer implementation is recommended to support the indicated
operation, object, attribute, attribute value, status code, or out- operation, object, attribute, attribute value, status code, or
of-band value in requests and responses. Since support of this out-of-band value in requests and responses. Since support of
entire Notification specification is OPTIONAL for conformance to this entire Notification specification is OPTIONAL for conformance
IPP/1.0 or IPP/1.1, the use of the term RECOMMENDED in this to IPP/1.0 or IPP/1.1, the use of the term RECOMMENDED in this
document means "RECOMMENDED if this OPTIONAL Notification document means "RECOMMENDED if this OPTIONAL Notification
specification is implemented". specification is implemented".
OPTIONAL - an adjective used to indicate that a conforming IPP OPTIONAL - an adjective used to indicate that a conforming IPP
Printer implementation MAY, but is NOT REQUIRED to, support the Printer implementation MAY, but is NOT REQUIRED to, support the
indicated operation, object, attribute, attribute value, status indicated operation, object, attribute, attribute value, status
code, or out-of-band value in requests and responses. code, or out-of-band value in requests and responses.
E. Appendix - Object Model for Notification E. Appendix - Object Model for Notification
skipping to change at page 92, line 44 skipping to change at page 84, line 44
Figure 5 - Object Model for Notification Figure 5 - Object Model for Notification
s1, s2, and s3 are Per-Printer Subscription Objects and can s1, s2, and s3 are Per-Printer Subscription Objects and can
identify Printer and/or Job Events. identify Printer and/or Job Events.
s4, s5, and s6 are Per-Job Subscription Objects and can identify s4, s5, and s6 are Per-Job Subscription Objects and can identify
Printer and/or Job Events. Printer and/or Job Events.
E.1 Appendix - Object relationships E.1 Appendix - Object relationships
This sub-section defines the object relationships between the Printer, This sub-section defines the object relationships between the
Job, and Subscription Objects by example. Whether Per-Printer Printer, Job, and Subscription Objects by example. Whether Per-
Subscription Objects are actually contained in a Printer object or are Printer Subscription Objects are actually contained in a Printer
just bi-directionally associated with them in some way is IMPLEMENTATION object or are just bi-directionally associated with them in some way
DEPENDENT and is transparent to the client. Similarly, whether Per-Job is IMPLEMENTATION DEPENDENT and is transparent to the client.
Subscription Objects are actually contained in a Job object or are just Similarly, whether Per-Job Subscription Objects are actually
bi-directionally associated with them in some way is IMPLEMENTATION contained in a Job object or are just bi-directionally associated
DEPENDENT and is transparent to the client. The object relationships with them in some way is IMPLEMENTATION DEPENDENT and is transparent
are defined as follows: to the client. The object relationships are defined as follows:
E.2 Printer Object and Per-Printer Subscription Objects E.2 Printer Object and Per-Printer Subscription Objects
1. The Printer object contains (is associated with) zero or more Per- 1.The Printer object contains (is associated with) zero or more
Printer Subscription Objects (p1 contains s1-s3 Per-Printer Per-Printer Subscription Objects (p1 contains s1-s3 Per-Printer
Subscription Objects). Subscription Objects).
2. Each Per-Printer Subscription Object (s1, s2, and s3) is contained 2.Each Per-Printer Subscription Object (s1, s2, and s3) is
in (or is associated with) exactly one Printer object (p1). contained in (or is associated with) exactly one Printer object
(p1).
E.3 Job Object and Per-Job Subscription Objects E.3 Job Object and Per-Job Subscription Objects
1. A Job object (j1, j2, j3) is associated with zero or more Per-Job 1.A Job object (j1, j2, j3) is associated with zero or more Per-
Subscription Objects (s4-s6). Job j1 is associated with Per-Job Job Subscription Objects (s4-s6). Job j1 is associated with
Subscription Object s4, Job j2 is associated with Per-Job Per-Job Subscription Object s4, Job j2 is associated with Per-
Subscription Objects s5 and s6, and Job j3 is not associated with Job Subscription Objects s5 and s6, and Job j3 is not associated
any Per-Job Subscription Object. with any Per-Job Subscription Object.
2. Each Per-Job Subscription Object is associated with exactly one Job 2.Each Per-Job Subscription Object is associated with exactly one
object. Job object.
F. Appendix - Per-Job versus Per-Printer Subscription Objects F. Appendix - Per-Job versus Per-Printer Subscription Objects
Per-Job and Per-Printer Subscription Objects are quite similar. Either Per-Job and Per-Printer Subscription Objects are quite similar.
type of Subscription Object can subscribe to Job Events, Printer Events, Either type of Subscription Object can subscribe to Job Events,
or both. Both types of Subscription Objects can be queried using the Printer Events, or both. Both types of Subscription Objects can be
Get-Subscriptions and Get-Subscription-Attributes operations and queried using the Get-Subscriptions and Get-Subscription-Attributes
canceled using the Cancel-Subscription operation. Both types of operations and canceled using the Cancel-Subscription operation.
Subscription Objects create Subscription Objects which have the same Both types of Subscription Objects create Subscription Objects which
Subscription Object attributes defined. However, there are some have the same Subscription Object attributes defined. However, there
semantic differences between Per-Job Subscription Objects and Per- are some semantic differences between Per-Job Subscription Objects
Printer Subscription Objects. A Per-Job Subscription Object is and Per-Printer Subscription Objects. A Per-Job Subscription Object
established by the client when submitting a job and after creating the is established by the client when submitting a job and after creating
job using the Create-Job-Subscriptions operation by specifying the "job- the job using the Create-Job-Subscriptions operation by specifying
id" of the Job with the "notify-job-id" attribute. A Per-Printer the "job-id" of the Job with the "notify-job-id" attribute. A Per-
Subscription Object is established between a client and a Printer using Printer Subscription Object is established between a client and a
the Create-Printer-Subscriptions operation. Some specific differences Printer using the Create-Printer-Subscriptions operation. Some
are: specific differences are:
1.A client usually creates one or more Per-Job Subscription Objects as 1.A client usually creates one or more Per-Job Subscription
part of the Job Creation operations (Create-Job, Print-Job, and Objects as part of the Job Creation operations (Create-Job,
Print-URI), rather than using the OPTIONAL Create-Job-Subscriptions Print-Job, and Print-URI), rather than using the OPTIONAL
operation, especially since Printer implementations NEED NOT support Create-Job-Subscriptions operation, especially since Printer
the Create-Job-Subscriptions operation, since it is OPTIONAL. implementations NEED NOT support the Create-Job-Subscriptions
operation, since it is OPTIONAL.
2.For Per-Job Subscription Objects, the Subscription Object is only 2.For Per-Job Subscription Objects, the Subscription Object is
valid while the job is "not-complete" (see sections 5.4.3) while for only valid while the job is "not-complete" (see sections 5.4.3)
the Per-Printer Subscription Objects, the Subscription Object is while for the Per-Printer Subscription Objects, the Subscription
valid until the time (in seconds) that the Printer returned in the Object is valid until the time (in seconds) that the Printer
"notify-lease-expiration-time" operation attribute. returned in the "notify-lease-expiration-time" operation
attribute.
3.Job Events in a Per-Job Subscription Object apply only to "one job" 3.Job Events in a Per-Job Subscription Object apply only to "one
(the Job created by the Job Creation operation or references by the job" (the Job created by the Job Creation operation or
Create-Job-Subscriptions operation) while Job Events in a Per-Printer references by the Create-Job-Subscriptions operation) while Job
Subscription Object apply to ALL jobs contained in the IPP Printer. Events in a Per-Printer Subscription Object apply to ALL jobs
contained in the IPP Printer.
G. Appendix: Full Copyright Statement G. Appendix: Full Copyright Statement
Copyright (C) The Internet Society (1998,1999,2000). All Rights Reserved Copyright (C) The Internet Society (1998,1999,2000,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 or others, and derivative works that comment on or otherwise explain it
assist in its implementation may be prepared, copied, published and or assist in its implementation may be prepared, copied, published
distributed, in whole or in part, without restriction of any kind, and distributed, in whole or in part, without restriction of any
provided that the above copyright notice and this paragraph are included kind, provided that the above copyright notice and this paragraph are
on all such copies and derivative works. However, this document itself included on all such copies and derivative works. However, this
may not be modified in any way, such as by removing the copyright notice document itself may not be modified in any way, such as by removing
or references to the Internet Society or other Internet organizations, the copyright notice or references to the Internet Society or other
except as needed for the purpose of developing Internet standards in Internet organizations, except as needed for the purpose of
which case the procedures for copyrights defined in the Internet developing Internet standards in which case the procedures for
Standards process must be followed, or as required to translate it into copyrights defined in the Internet Standards process must be
languages other than English. followed, or as required to translate it into 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
IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
FITNESS FOR A PARTICULAR PURPOSE. MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
 End of changes. 

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