draft-ietf-ipp-model-v11-06.txt   rfc2911.txt 
INTERNET-DRAFT Network Working Group T. Hastings, Editor
draft-ietf-ipp-model-v11-06.txt R. deBry Request for Comments: 2911 R. Herriot
Obsoletes: 2566 Xerox Corporation
Category: Standards Track R. deBry
Utah Valley State College Utah Valley State College
T. Hastings (editor)
Xerox Corporation
R. Herriot
Xerox Corporation
S. Isaacson S. Isaacson
Novell, Inc. Novell, Inc.
P. Powell P. Powell
Astart Technologies Astart Technologies
March 1, 2000 September 2000
Internet Printing Protocol/1.1: Model and Semantics Internet Printing Protocol/1.1: Model and Semantics
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 specifies an Internet standards track protocol for the
provisions of Section 10 of [RFC2026]. Internet-Drafts are working Internet community, and requests discussion and suggestions for
documents of the Internet Engineering Task Force (IETF), its areas, and improvements. Please refer to the current edition of the "Internet
its working groups. Note that other groups may also distribute working Official Protocol Standards" (STD 1) for the standardization state
documents as Internet-Drafts. and status of this protocol. Distribution of this memo is unlimited.
Internet-Drafts are draft documents valid for a maximum of six months Copyright Notice
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference material
or to cite them other than as "work in progress".
The list of current Internet-Drafts can be accessed at Copyright (C) The Internet Society (2000). All Rights Reserved.
http://www.ietf.org/ietf/1id-abstracts.txt
The list of Internet-Draft Shadow Directories can be accessed as Abstract
http://www.ietf.org/shadow.html.
Abstract This document is one of a set of documents, which together describe
all aspects of a new Internet Printing Protocol (IPP). IPP is an
application level protocol that can be used for distributed printing
using Internet tools and technologies. This document describes a
simplified model consisting of abstract objects, their attributes,
and their operations that is independent of encoding and transport.
The model consists of a Printer and a Job object. A Job optionally
supports multiple documents. IPP 1.1 semantics allow end-users and
operators to query printer capabilities, submit print jobs, inquire
about the status of print jobs and printers, cancel, hold, release,
and restart print jobs. IPP 1.1 semantics allow operators to pause,
resume, and purge (jobs from) Printer objects. This document also
addresses security, internationalization, and directory issues.
This document is one of a set of documents, which together describe all The full set of IPP documents includes:
aspects of a new Internet Printing Protocol (IPP). IPP is an
application level protocol that can be used for distributed printing
using Internet tools and technologies. This document describes a
simplified model consisting of abstract objects, their attributes, and
their operations that is independent of encoding and transport. The
model consists of a Printer and a Job object. A Job optionally supports
multiple documents. IPP 1.1 semantics allow end-users and operators to
query printer capabilities, submit print jobs, inquire about the status
of print jobs and printers, cancel, hold, release, and restart print
jobs. IPP 1.1 semantics allow operators to pause, resume, and purge
(jobs from) Printer objects. This document also addresses security,
internationalization, and directory issues.
Expires September 1, 2000 Design Goals for an Internet Printing Protocol [RFC2567]
The full set of IPP documents includes: Rationale for the Structure and Model and Protocol for the Internet
Design Goals for an Internet Printing Protocol [RFC2567]
Rationale for the Structure and Model and Protocol for the Internet
Printing Protocol [RFC2568] Printing Protocol [RFC2568]
Internet Printing Protocol/1.1: Model and Semantics (this document) Internet Printing Protocol/1.1: Model and Semantics (this document)
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
broad look at distributed printing functionality, and it enumerates
real-life scenarios that help to clarify the features that need to be
included in a printing protocol for the Internet. It identifies
requirements for three types of users: end users, operators, and
administrators. It calls out a subset of end user requirements that are
satisfied in IPP/1.0. A few OPTIONAL operator operations have been
added to IPP/1.1.
The "Rationale for the Structure and Model and Protocol for the Internet
Printing Protocol" document describes IPP from a high level view,
defines a roadmap for the various documents that form the suite of IPP
specification documents, and gives background and rationale for the IETF
working group's major decisions.
The "Internet Printing Protocol/1.1: Encoding and Transport" document is
a formal mapping of the abstract operations and attributes defined in
the model document onto HTTP/1.1 [RFC2616]. It defines the encoding
rules for a new Internet MIME media type called "application/ipp". This
document also defines the rules for transporting over HTTP a message
body whose Content-Type is "application/ipp". This document defines a
new scheme named 'ipp' for identifying IPP printers and jobs.
The "Internet Printing Protocol/1.1: Implementer's Guide" document gives
insight and advice to implementers of IPP clients and IPP objects. It
is intended to help them understand IPP/1.1 and some of the
considerations that may assist them in the design of their client and/or
IPP object implementations. For example, a typical order of processing
requests is given, including error checking. Motivation for some of the
specification decisions is also included.
The "Mapping between LPD and IPP Protocols" document gives some advice
to implementers of gateways between IPP and LPD (Line Printer Daemon)
implementations.
Expires September 1, 2000
Table of Contents
1. Introduction.....................................................9
1.1 Simplified Printing Model....................................10
2. IPP Objects.....................................................12
2.1 Printer Object...............................................13
2.2 Job Object...................................................15
2.3 Object Relationships.........................................16
2.4 Object Identity..............................................17
3. IPP Operations..................................................20
3.1 Common Semantics.............................................20
3.1.1 Required Parameters......................................21
3.1.2 Operation IDs and Request IDs............................21
3.1.3 Attributes...............................................21
3.1.4 Character Set and Natural Language Operation Attributes..23
3.1.4.1 Request Operation Attributes..........................24
3.1.4.2 Response Operation Attributes.........................27
3.1.5 Operation Targets........................................28
3.1.6 Operation Response Status Codes and Status Messages......29
3.1.6.1 "status-code" (type2 enum)............................29
3.1.6.2 "status-message" (text(255))..........................30
3.1.6.3 "detailed-status-message" (text(MAX)).................31
3.1.6.4 "document-access-error" (text(MAX))...................31
3.1.7 Unsupported Attributes...................................31
3.1.8 Versions.................................................33
3.1.9 Job Creation Operations..................................35
3.2 Printer Operations...........................................37
3.2.1 Print-Job Operation......................................37
3.2.1.1 Print-Job Request.....................................37
3.2.1.2 Print-Job Response....................................41
3.2.2 Print-URI Operation......................................43
3.2.3 Validate-Job Operation...................................44
3.2.4 Create-Job Operation.....................................45
3.2.5 Get-Printer-Attributes Operation.........................45
3.2.5.1 Get-Printer-Attributes Request........................46
3.2.5.2 Get-Printer-Attributes Response.......................48
3.2.6 Get-Jobs Operation.......................................49
3.2.6.1 Get-Jobs Request......................................49
3.2.6.2 Get-Jobs Response.....................................50
3.2.7 Pause-Printer Operation..................................52
3.2.7.1 Pause-Printer Request.................................53
3.2.7.2 Pause-Printer Response................................53
3.2.8 Resume-Printer Operation.................................54
3.2.9 Purge-Jobs Operation.....................................55
3.3 Job Operations...............................................55
3.3.1 Send-Document Operation..................................55
3.3.1.1 Send-Document Request.................................57
3.3.1.2 Send-Document Response................................58
3.3.2 Send-URI Operation.......................................58
3.3.3 Cancel-Job Operation.....................................59
3.3.3.1 Cancel-Job Request....................................60
Expires September 1, 2000
3.3.3.2 Cancel-Job Response...................................60
3.3.4 Get-Job-Attributes Operation.............................61
3.3.4.1 Get-Job-Attributes Request............................62
3.3.4.2 Get-Job-Attributes Response...........................62
3.3.5 Hold-Job Operation.......................................63
3.3.5.1 Hold-Job Request......................................64
3.3.5.2 Hold-Job Response.....................................65
3.3.6 Release-Job Operation....................................65
3.3.7 Restart-Job Operation....................................66
3.3.7.1 Restart-Job Request...................................67
3.3.7.2 Restart-Job Response..................................68
4. Object Attributes...............................................68
4.1 Attribute Syntaxes...........................................69
4.1.1 'text'...................................................70
4.1.1.1 'textWithoutLanguage'.................................70
4.1.1.2 'textWithLanguage'....................................71
4.1.2 'name'...................................................71
4.1.2.1 'nameWithoutLanguage'.................................72
4.1.2.2 'nameWithLanguage'....................................72
4.1.2.3 Matching 'name' attribute values......................73
4.1.3 'keyword'................................................73
4.1.4 'enum'...................................................74
4.1.5 'uri'....................................................75
4.1.6 'uriScheme'..............................................75
4.1.7 'charset'................................................75
4.1.8 'naturalLanguage'........................................76
4.1.9 'mimeMediaType'..........................................76
4.1.9.1 Application/octet-stream -- Auto-Sensing the document
format 77
4.1.10 'octetString'............................................78
4.1.11 'boolean'................................................78
4.1.12 'integer'................................................78
4.1.13 'rangeOfInteger'.........................................78
4.1.14 'dateTime'...............................................78
4.1.15 'resolution'.............................................79
4.1.16 '1setOf X'..............................................79
4.2 Job Template Attributes......................................79
4.2.1 job-priority (integer(1:100))............................83
4.2.2 job-hold-until (type3 keyword | name (MAX))..............84
4.2.3 job-sheets (type3 keyword | name(MAX))...................84
4.2.4 multiple-document-handling (type2 keyword)...............85
4.2.5 copies (integer(1:MAX))..................................86
4.2.6 finishings (1setOf type2 enum)...........................86
4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))..............88
4.2.8 sides (type2 keyword)....................................89
4.2.9 number-up (integer(1:MAX))...............................90
4.2.10 orientation-requested (type2 enum).......................90
4.2.11 media (type3 keyword | name(MAX))........................92
4.2.12 printer-resolution (resolution)..........................92
4.2.13 print-quality (type2 enum)...............................92
4.3 Job Description Attributes...................................93
4.3.1 job-uri (uri)............................................95
4.3.2 job-id (integer(1:MAX))..................................95
Expires September 1, 2000
4.3.3 job-printer-uri (uri)....................................95
4.3.4 job-more-info (uri)......................................96
4.3.5 job-name (name(MAX)).....................................96
4.3.6 job-originating-user-name (name(MAX))....................96
4.3.7 job-state (type1 enum)...................................96
4.3.7.1 Forwarding Servers....................................99
4.3.7.2 Partitioning of Job States............................99
4.3.8 job-state-reasons (1setOf type2 keyword)...............100
4.3.9 job-state-message (text(MAX))...........................104
4.3.10 job-detailed-status-messages (1setOf text(MAX)).........104
4.3.11 job-document-access-errors (1setOf text(MAX))...........104
4.3.12 number-of-documents (integer(0:MAX))....................104
4.3.13 output-device-assigned (name(127))......................105
4.3.14 Event Time Job Description Attributes...................105
4.3.14.1 time-at-creation (integer(MIN:MAX))..................106
4.3.14.2 time-at-processing (integer(MIN:MAX))................106
4.3.14.3 time-at-completed (integer(MIN:MAX)).................106
4.3.14.4 job-printer-up-time (integer(1:MAX)).................106
4.3.14.5 date-time-at-creation (dateTime).....................106
4.3.14.6 date-time-at-processing (dateTime)...................107
4.3.14.7 date-time-at-completed (dateTime)....................107
4.3.15 number-of-intervening-jobs (integer(0:MAX)).............107
4.3.16 job-message-from-operator (text(127))...................107
4.3.17 Job Size Attributes.....................................107
4.3.17.1 job-k-octets (integer(0:MAX))........................107
4.3.17.2 job-impressions (integer(0:MAX)).....................108
4.3.17.3 job-media-sheets (integer(0:MAX))....................108
4.3.18 Job Progress Attributes.................................108
4.3.18.1 job-k-octets-processed (integer(0:MAX))..............109
4.3.18.2 job-impressions-completed (integer(0:MAX))...........109
4.3.18.3 job-media-sheets-completed (integer(0:MAX))..........109
4.3.19 attributes-charset (charset)............................109
4.3.20 attributes-natural-language (naturalLanguage)...........110
4.4 Printer Description Attributes..............................110
4.4.1 printer-uri-supported (1setOf uri)......................112
4.4.2 uri-authentication-supported (1setOf type2 keyword).....112
4.4.3 uri-security-supported (1setOf type2 keyword)...........113
4.4.4 printer-name (name(127))................................115
4.4.5 printer-location (text(127))............................115
4.4.6 printer-info (text(127))................................115
4.4.7 printer-more-info (uri).................................115
4.4.8 printer-driver-installer (uri)..........................115
4.4.9 printer-make-and-model (text(127))......................115
4.4.10 printer-more-info-manufacturer (uri)....................116
4.4.11 printer-state (type1 enum)..............................116
4.4.12 printer-state-reasons (1setOf type2 keyword)............116
4.4.13 printer-state-message (text(MAX)).......................119
4.4.14 ipp-versions-supported (1setOf type2 keyword)...........119
4.4.15 operations-supported (1setOf type2 enum)................119
4.4.16 multiple-document-jobs-supported (boolean)..............120
4.4.17 charset-configured (charset)............................120
4.4.18 charset-supported (1setOf charset)......................121
4.4.19 natural-language-configured (naturalLanguage)...........121
Expires September 1, 2000
4.4.20 generated-natural-language-supported (1setOf naturalLanguage)
121
4.4.21 document-format-default (mimeMediaType).................122
4.4.22 document-format-supported (1setOf mimeMediaType)........122
4.4.23 printer-is-accepting-jobs (boolean).....................122
4.4.24 queued-job-count (integer(0:MAX)).......................122
4.4.25 printer-message-from-operator (text(127))...............122
4.4.26 color-supported (boolean)...............................122
4.4.27 reference-uri-schemes-supported (1setOf uriScheme)......123
4.4.28 pdl-override-supported (type2 keyword)..................123
4.4.29 printer-up-time (integer(1:MAX))........................123
4.4.30 printer-current-time (dateTime).........................124
4.4.31 multiple-operation-time-out (integer(1:MAX))............124
4.4.32 compression-supported (1setOf type3 keyword)............125
4.4.33 job-k-octets-supported (rangeOfInteger(0:MAX))..........125
4.4.34 job-impressions-supported (rangeOfInteger(0:MAX)).......125
4.4.35 job-media-sheets-supported (rangeOfInteger(0:MAX))......125
4.4.36 pages-per-minute (integer(0:MAX)).......................126
4.4.37 pages-per-minute-color (integer(0:MAX)).................126
5. Conformance....................................................126
5.1 Client Conformance Requirements.............................127
5.2 IPP Object Conformance Requirements.........................128
5.2.1 Objects.................................................128
5.2.2 Operations..............................................128
5.2.3 IPP Object Attributes...................................129
5.2.4 Versions................................................129
5.2.5 Extensions..............................................130
5.2.6 Attribute Syntaxes......................................130
5.2.7 Security................................................130
5.3 Charset and Natural Language Requirements...................131
6. IANA Considerations............................................131
6.1 Typed 'keyword' and 'enum' Extensions.......................132
6.2 Attribute Extensibility.....................................134
6.3 Attribute Syntax Extensibility..............................134
6.4 Operation Extensibility.....................................135
6.5 Attribute Group Extensibility...............................135
6.6 Status Code Extensibility...................................135
6.7 Out-of-band Attribute Value Extensibility...................136
6.8 Registration of MIME types/sub-types for document-formats...136
6.9 Registration of charsets for use in 'charset' attribute values136
7. Internationalization Considerations............................137
8. Security Considerations........................................140
8.1 Security Scenarios..........................................141
8.1.1 Client and Server in the Same Security Domain...........141
8.1.2 Client and Server in Different Security Domains.........141
8.1.3 Print by Reference......................................141
8.2 URIs in Operation, Job, and Printer attributes..............141
8.3 URIs for each authentication mechanisms.....................142
8.4 Restricted Queries..........................................143
8.5 Operations performed by operators and system administrators.143
Expires September 1, 2000
8.6 Queries on jobs submitted using non-IPP protocols...........143
9. References.....................................................144
10.Author's Address..............................................147
11.Formats for IPP Registration Proposals........................151
11.1Type2 keyword attribute values registration.................151
11.2Type3 keyword attribute values registration.................151
11.3Type2 enum attribute values registration....................151
11.4Type3 enum attribute values registration....................152
11.5Attribute registration......................................152
11.6Attribute Syntax registration...............................153
11.7Operation registration......................................153
11.8Attribute Group registration................................153
11.9Status code registration....................................154
11.10 Out-of-band Attribute Value registration.............154
12.APPENDIX A: Terminology.......................................154
12.1Conformance Terminology.....................................154
12.1.1 NEED NOT................................................154
12.2Model Terminology...........................................155
12.2.1 Keyword.................................................155
12.2.2 Attributes..............................................155
12.2.2.1 Attribute Name.......................................155
12.2.2.2 Attribute Group Name.................................155
12.2.2.3 Attribute Value......................................155
12.2.2.4 Attribute Syntax.....................................156
12.2.3 Supports................................................156
12.2.4 print-stream page.......................................158
12.2.5 impression..............................................158
13.APPENDIX B: Status Codes and Suggested Status Code Messages..158 The "Design Goals for an Internet Printing Protocol" document takes a
13.1Status Codes................................................159 broad look at distributed printing functionality, and it enumerates
13.1.1 Informational...........................................159 real-life scenarios that help to clarify the features that need to be
13.1.2 Successful Status Codes.................................159 included in a printing protocol for the Internet. It identifies
13.1.2.1 successful-ok (0x0000)...............................159 requirements for three types of users: end users, operators, and
13.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001)159 administrators. It calls out a subset of end user requirements that
13.1.2.3 successful-ok-conflicting-attributes (0x0002)........160 are satisfied in IPP/1.0. A few OPTIONAL operator operations have
13.1.3 Redirection Status Codes................................160 been added to IPP/1.1.
13.1.4 Client Error Status Codes...............................160
13.1.4.1 client-error-bad-request (0x0400)....................160
13.1.4.2 client-error-forbidden (0x0401)......................160
13.1.4.3 client-error-not-authenticated (0x0402)..............161
13.1.4.4 client-error-not-authorized (0x0403).................161
13.1.4.5 client-error-not-possible (0x0404)...................161
13.1.4.6 client-error-timeout (0x0405)........................161
13.1.4.7 client-error-not-found (0x0406)......................161
13.1.4.8 client-error-gone (0x0407)...........................162
13.1.4.9 client-error-request-entity-too-large (0x0408).......162
13.1.4.10client-error-request-value-too-long (0x0409).........162
13.1.4.11client-error-document-format-not-supported (0x040A)..163
13.1.4.12client-error-attributes-or-values-not-supported (0x040B)163
13.1.4.13client-error-uri-scheme-not-supported (0x040C).......163
Expires September 1, 2000 The "Rationale for the Structure and Model and Protocol for the
13.1.4.14client-error-charset-not-supported (0x040D)..........163 Internet Printing Protocol" document describes IPP from a high level
13.1.4.15client-error-conflicting-attributes (0x040E).........164 view, defines a roadmap for the various documents that form the suite
13.1.4.16client-error-compression-not-supported (0x040F)......164 of IPP specification documents, and gives background and rationale
13.1.4.17client-error-compression-error (0x0410)..............164 for the IETF working group's major decisions.
13.1.4.18client-error-document-format-error (0x0411)..........164
13.1.4.19client-error-document-access-error (0x0412)..........164
13.1.5 Server Error Status Codes...............................165
13.1.5.1 server-error-internal-error (0x0500).................165
13.1.5.2 server-error-operation-not-supported (0x0501)........165
13.1.5.3 server-error-service-unavailable (0x0502)............165
13.1.5.4 server-error-version-not-supported (0x0503)..........165
13.1.5.5 server-error-device-error (0x0504)...................166
13.1.5.6 server-error-temporary-error (0x0505)................166
13.1.5.7 server-error-not-accepting-jobs (0x0506).............166
13.1.5.8 server-error-busy (0x0507)...........................166
13.1.5.9 server-error-job-canceled (0x0508)...................167
13.1.5.10server-error-multiple-document-jobs-not-supported (0x0509)
167
13.2Status Codes for IPP Operations.............................168
14.APPENDIX C: "media" keyword values...........................170 The "Internet Printing Protocol/1.1: Encoding and Transport" document
is a formal mapping of the abstract operations and attributes defined
in the model document onto HTTP/1.1 [RFC2616]. It defines the
encoding rules for a new Internet MIME media type called
"application/ipp". This document also defines the rules for
transporting over HTTP a message body whose Content-Type is
"application/ipp". This document defines a new scheme named 'ipp'
for identifying IPP printers and jobs.
15.APPENDIX D: Processing IPP Attributes.........................191 The "Internet Printing Protocol/1.1: Implementer's Guide" document
15.1Fidelity....................................................191 gives insight and advice to implementers of IPP clients and IPP
15.2Page Description Language (PDL) Override....................192 objects. It is intended to help them understand IPP/1.1 and some of
15.3Using Job Template Attributes During Document Processing....194 the considerations that may assist them in the design of their client
and/or IPP object implementations. For example, a typical order of
processing requests is given, including error checking. Motivation
for some of the specification decisions is also included.
16.APPENDIX E: Generic Directory Schema..........................195 The "Mapping between LPD and IPP Protocols" document gives some
advice to implementers of gateways between IPP and LPD (Line Printer
Daemon) implementations.
17.APPENDIX F: Differences between the IPP/1.0 and IPP/1.1 "Model and Table of Contents
Semantics" Documents..............................................198
18.Full Copyright Statement......................................204 1. Introduction 9
1.1 Simplified Printing Model 10
2. IPP Objects 12
2.1 Printer Object 13
2.2 Job Object 15
2.3 Object Relationships 16
2.4 Object Identity 17
3. IPP Operations 20
3.1 Common Semantics 21
3.1.1 Required Parameters 21
3.1.2 Operation IDs and Request IDs 22
3.1.3 Attributes 22
3.1.4 Character Set and Natural Language Operation Attribute 24
3.1.4.1 Request Operation Attributes 25
3.1.4.2 Response Operation Attributes 29
3.1.5 Operation Targets 30
3.1.6 Operation Response Status Codes and Status Messages 32
3.1.6.1 "status-code" (type2 enum) 32
3.1.6.2 "status-message" (text(255)) 33
3.1.6.3 "detailed-status-message" (text(MAX)) 33
3.1.6.4 "document-access-error" (text(MAX)) 34
3.1.7 Unsupported Attributes 34
3.1.8 Versions 36
3.1.9 Job Creation Operations 38
3.2 Printer Operations 41
3.2.1 Print-Job Operation 41
3.2.1.1 Print-Job Request 41
3.2.1.2 Print-Job Response 46
3.2.2 Print-URI Operation 48
3.2.3 Validate-Job Operation 49
3.2.4 Create-Job Operation 49
3.2.5 Get-Printer-Attributes Operation 50
3.2.5.1 Get-Printer-Attributes Request 51
3.2.5.2 Get-Printer-Attributes Response 53
3.2.6 Get-Jobs Operation 54
3.2.6.1 Get-Jobs Request 54
3.2.6.2 Get-Jobs Response 56
3.2.7 Pause-Printer Operation 57
3.2.7.1 Pause-Printer Request 59
3.2.7.2 Pause-Printer Response 60
3.2.8 Resume-Printer Operation 60
3.2.9 Purge-Jobs Operation 61
3.3 Job Operations 62
3.3.1 Send-Document Operation 62
3.3.1.1 Send-Document Request 64
3.3.1.2 Send-Document Response 65
3.3.2 Send-URI Operation 66
3.3.3 Cancel-Job Operation 66
3.3.3.1 Cancel-Job Request 67
3.3.3.2 Cancel-Job Response 68
3.3.4 Get-Job-Attributes Operation 69
3.3.4.1 Get-Job-Attributes Request 69
3.3.4.2 Get-Job-Attributes Response 70
3.3.5 Hold-Job Operation 71
3.3.5.1 Hold-Job Request 72
3.3.5.2 Hold-Job Response 73
3.3.6 Release-Job Operation 74
3.3.7 Restart-Job Operation 75
3.3.7.1 Restart-Job Request 76
3.3.7.2 Restart-Job Response 78
4. Object Attributes 78
4.1 Attribute Syntaxes 78
4.1.1 'text' 79
4.1.1.1 'textWithoutLanguage' 80
4.1.1.2 'textWithLanguage' 80
4.1.2 'name' 81
4.1.2.1 'nameWithoutLanguage' 82
4.1.2.2 'nameWithLanguage' 82
4.1.2.3 Matching 'name' attribute values 83
4.1.3 'keyword' 84
4.1.4 'enum' 85
4.1.5 'uri' 85
4.1.6 'uriScheme' 86
4.1.7 'charset' 86
4.1.8 'naturalLanguage' 87
4.1.9 'mimeMediaType' 87
4.1.9.1 Application/octet-stream -- Auto-Sensing 88
the document format
4.1.10 'octetString' 89
4.1.11 'boolean' 89
4.1.12 'integer' 89
4.1.13 'rangeOfInteger' 90
4.1.14 'dateTime' 90
4.1.15 'resolution' 90
4.1.16 '1setOf X' 90
4.2 Job Template Attributes 91
4.2.1 job-priority (integer(1:100)) 94
4.2.2 job-hold-until (type3 keyword | name (MAX)) 95
4.2.3 job-sheets (type3 keyword | name(MAX)) 96
4.2.4 multiple-document-handling (type2 keyword) 96
4.2.5 copies (integer(1:MAX)) 98
4.2.6 finishings (1setOf type2 enum) 98
4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX)) 101
4.2.8 sides (type2 keyword) 102
4.2.9 number-up (integer(1:MAX)) 102
4.2.10 orientation-requested (type2 enum) 103
4.2.11 media (type3 keyword | name(MAX)) 104
4.2.12 printer-resolution (resolution) 105
4.2.13 print-quality (type2 enum) 105
4.3 Job Description Attributes 106
4.3.1 job-uri (uri) 107
4.3.2 job-id (integer(1:MAX)) 108
4.3.3 job-printer-uri (uri) 108
4.3.4 job-more-info (uri) 108
4.3.5 job-name (name(MAX)) 108
4.3.6 job-originating-user-name (name(MAX)) 109
4.3.7 job-state (type1 enum) 109
4.3.7.1 Forwarding Servers 112
4.3.7.2 Partitioning of Job States 112
4.3.8 job-state-reasons (1setOf type2 keyword) 113
4.3.9 job-state-message (text(MAX)) 118
4.3.10 job-detailed-status-messages (1setOf text(MAX)) 118
4.3.11 job-document-access-errors (1setOf text(MAX)) 118
4.3.12 number-of-documents (integer(0:MAX)) 119
4.3.13 output-device-assigned (name(127)) 119
4.3.14 Event Time Job Description Attributes 119
4.3.14.1 time-at-creation (integer(MIN:MAX)) 120
4.3.14.2 time-at-processing (integer(MIN:MAX)) 120
4.3.14.3 time-at-completed (integer(MIN:MAX)) 120
4.3.14.4 job-printer-up-time (integer(1:MAX)) 120
4.3.14.5 date-time-at-creation (dateTime) 121
4.3.14.6 date-time-at-processing (dateTime) 121
4.3.14.7 date-time-at-completed (dateTime) 121
4.3.15 number-of-intervening-jobs (integer(0:MAX)) 121
4.3.16 job-message-from-operator (text(127)) 121
4.3.17 Job Size Attributes 121
4.3.17.1 job-k-octets (integer(0:MAX)) 122
4.3.17.2 job-impressions (integer(0:MAX)) 122
4.3.17.3 job-media-sheets (integer(0:MAX)) 123
4.3.18 Job Progress Attributes 123
4.3.18.1 job-k-octets-processed (integer(0:MAX)) 123
4.3.18.2 job-impressions-completed (integer(0:MAX)) 123
4.3.18.3 job-media-sheets-completed (integer(0:MAX)) 124
4.3.19 attributes-charset (charset) 124
4.3.20 attributes-natural-language (naturalLanguage) 124
4.4 Printer Description Attributes 124
4.4.1 printer-uri-supported (1setOf uri) 126
4.4.2 uri-authentication-supported (1setOf type2 keyword) 127
4.4.3 uri-security-supported (1setOf type2 keyword) 128
4.4.4 printer-name (name(127)) 129
4.4.5 printer-location (text(127)) 129
4.4.6 printer-info (text(127)) 130
4.4.7 printer-more-info (uri) 130
4.4.8 printer-driver-installer (uri) 130
4.4.9 printer-make-and-model (text(127)) 130
4.4.10 printer-more-info-manufacturer (uri) 130
4.4.11 printer-state (type1 enum) 131
4.4.12 printer-state-reasons (1setOf type2 keyword) 131
4.4.13 printer-state-message (text(MAX)) 134
4.4.14 ipp-versions-supported (1setOf type2 keyword) 134
4.4.15 operations-supported (1setOf type2 enum) 135
4.4.16 multiple-document-jobs-supported (boolean) 136
4.4.17 charset-configured (charset) 136
4.4.18 charset-supported (1setOf charset) 137
4.4.19 natural-language-configured (naturalLanguage) 137
4.4.20 generated-natural-language-supported
(1setOf naturalLanguage) 137
4.4.21 document-format-default (mimeMediaType) 138
4.4.22 document-format-supported (1setOf mimeMediaType) 138
4.4.23 printer-is-accepting-jobs (boolean) 138
4.4.24 queued-job-count (integer(0:MAX)) 138
4.4.25 printer-message-from-operator (text(127)) 139
4.4.26 color-supported (boolean) 139
4.4.27 reference-uri-schemes-supported (1setOf uriScheme) 139
4.4.28 pdl-override-supported (type2 keyword) 139
4.4.29 printer-up-time (integer(1:MAX)) 140
4.4.30 printer-current-time (dateTime) 140
4.4.31 multiple-operation-time-out (integer(1:MAX)) 141
4.4.32 compression-supported (1setOf type3 keyword) 141
4.4.33 job-k-octets-supported (rangeOfInteger(0:MAX)) 142
4.4.34 job-impressions-supported (rangeOfInteger(0:MAX)) 142
4.4.35 job-media-sheets-supported (rangeOfInteger(0:MAX)) 142
4.4.36 pages-per-minute (integer(0:MAX)) 142
4.4.37 pages-per-minute-color (integer(0:MAX)) 142
5. Conformance 143
5.1 Client Conformance Requirements 143
5.2 IPP Object Conformance Requirements 145
5.2.1 Objects 145
5.2.2 Operations 145
5.2.3 IPP Object Attributes 146
5.2.4 Versions 146
5.2.5 Extensions 147
5.2.6 Attribute Syntaxes 147
5.2.7 Security 148
5.3 Charset and Natural Language Requirements 148
6. IANA Considerations 148
6.1 Typed 'keyword' and 'enum' Extensions 149
6.2 Attribute Extensibility 151
6.3 Attribute Syntax Extensibility 152
6.4 Operation Extensibility 152
6.5 Attribute Group Extensibility 153
6.6 Status Code Extensibility 153
6.7 Out-of-band Attribute Value Extensibility 154
6.8 Registration of MIME types/sub-types for document-formats 154
6.9 Registration of charsets for use in 'charset'
attribute values 154
7. Internationalization Considerations 154
8. Security Considerations 158
8.1 Security Scenarios 159
8.1.1 Client and Server in the Same Security Domain 159
8.1.2 Client and Server in Different Security Domains 159
8.1.3 Print by Reference 160
8.2 URIs in Operation, Job, and Printer attributes 160
8.3 URIs for each authentication mechanisms 160
8.4 Restricted Queries 161
8.5 Operations performed by operators and system
administrators 161
8.6 Queries on jobs submitted using non-IPP protocols 162
9. References 162
10. Authors' Addresses 166
11. Formats for IPP Registration Proposals 168
11.1 Type2 keyword attribute values registration 169
11.2 Type3 keyword attribute values registration 169
11.3 Type2 enum attribute values registration 169
11.4 Type3 enum attribute values registration 170
11.5 Attribute registration 170
11.6 Attribute Syntax registration 171
11.7 Operation registration 171
11.8 Attribute Group registration 171
11.9 Status code registration 172
11.10 Out-of-band Attribute Value registration 172
12. APPENDIX A: Terminology 173
12.1 Conformance Terminology 173
12.1.1 NEED NOT 173
12.2 Model Terminology 173
12.2.1 Keyword 173
12.2.2 Attributes 173
12.2.2.1 Attribute Name 173
12.2.2.2 Attribute Group Name 174
12.2.2.3 Attribute Value 174
12.2.2.4 Attribute Syntax 174
12.2.3 Supports 174
12.2.4 print-stream page 176
12.2.5 impression 177
13. APPENDIX B: Status Codes and Suggested Status Code Messages 177
13.1 Status Codes 178
13.1.1 Informational 178
13.1.2 Successful Status Codes 178
13.1.2.1 successful-ok (0x0000) 178
13.1.2.2 successful-ok-ignored-or-substituted-attributes
(0x0001) 179
13.1.2.3 successful-ok-conflicting-attributes (0x0002) 179
13.1.3 Redirection Status Codes 179
13.1.4 Client Error Status Codes 179
13.1.4.1 client-error-bad-request (0x0400) 180
13.1.4.2 client-error-forbidden (0x0401) 180
13.1.4.3 client-error-not-authenticated (0x0402) 180
13.1.4.4 client-error-not-authorized (0x0403) 180
13.1.4.5 client-error-not-possible (0x0404) 180
13.1.4.6 client-error-timeout (0x0405) 181
13.1.4.7 client-error-not-found (0x0406) 181
13.1.4.8 client-error-gone (0x0407) 181
13.1.4.9 client-error-request-entity-too-large (0x0408) 182
13.1.4.10 client-error-request-value-too-long (0x0409) 182
13.1.4.11 client-error-document-format-not-supported (0x040A) 182
13.1.4.12 client-error-attributes-or-values-not-supported
(0x040B) 183
13.1.4.13 client-error-uri-scheme-not-supported (0x040C) 183
13.1.4.14 client-error-charset-not-supported (0x040D) 183
13.1.4.15 client-error-conflicting-attributes (0x040E) 183
13.1.4.16 client-error-compression-not-supported (0x040F) 184
13.1.4.17 client-error-compression-error (0x0410) 184
13.1.4.18 client-error-document-format-error (0x0411) 184
13.1.4.19 client-error-document-access-error (0x0412) 184
13.1.5 Server Error Status Codes 185
13.1.5.1 server-error-internal-error (0x0500) 185
13.1.5.2 server-error-operation-not-supported (0x0501) 185
13.1.5.3 server-error-service-unavailable (0x0502) 185
13.1.5.4 server-error-version-not-supported (0x0503) 185
13.1.5.5 server-error-device-error (0x0504) 186
13.1.5.6 server-error-temporary-error (0x0505) 186
13.1.5.7 server-error-not-accepting-jobs (0x0506) 187
13.1.5.8 server-error-busy (0x0507) 187
13.1.5.9 server-error-job-canceled (0x0508) 187
13.1.5.10 server-error-multiple-document-jobs-not-supported
(0x0509) 187
13.2 Status Codes for IPP Operations 187
14. APPENDIX C: "media" keyword values 190
15. APPENDIX D: Processing IPP Attributes 208
15.1 Fidelity 209
15.2 Page Description Language (PDL) Override 210
15.3 Using Job Template Attributes During Document Processing 212
16. APPENDIX E: Generic Directory Schema 214
17. APPENDIX F: Differences between the IPP/1.0 and IPP/1.1
"Model and Semantics" Documents 215
18. Full Copyright Statement 224
Expires September 1, 2000
1. Introduction 1. Introduction
The Internet Printing Protocol (IPP) is an application level protocol The Internet Printing Protocol (IPP) is an application level protocol
that can be used for distributed printing using Internet tools and that can be used for distributed printing using Internet tools and
technologies. IPP version 1.1 (IPP/1.1) focuses primarily on end user technologies. IPP version 1.1 (IPP/1.1) focuses primarily on end
functionality with a few administrative operations included. This user functionality with a few administrative operations included.
document is just one of a suite of documents that fully define IPP. The This document is just one of a suite of documents that fully define
full set of IPP documents includes: IPP. The full set of IPP documents includes:
Design Goals for an Internet Printing Protocol [RFC2567] Design Goals for an Internet Printing Protocol [RFC2567]
Rationale for the Structure and Model and Protocol for the Internet Rationale for the Structure and Model and Protocol for the Internet
Printing Protocol [RFC2568] Printing Protocol [RFC2568]
Internet Printing Protocol/1.1: Model and Semantics (this document) Internet Printing Protocol/1.1: Model and Semantics (this document)
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]
Anyone reading these documents for the first time is strongly encouraged Anyone reading these documents for the first time is strongly
to read the IPP documents in the above order. encouraged to read the IPP documents in the above order.
This document is laid out as follows: This document is laid out as follows:
- The rest of Section 1 is an introduction to the IPP simplified - The rest of Section 1 is an introduction to the IPP simplified
model for distributed printing. model for distributed printing.
- Section 2 introduces the object types covered in the model with - Section 2 introduces the object types covered in the model with
their basic behaviors, attributes, and interactions. their basic behaviors, attributes, and interactions.
- Section 3 defines the operations included in IPP/1.1. IPP - Section 3 defines the operations included in IPP/1.1. IPP
operations are synchronous, therefore, for each operation, there is operations are synchronous, therefore, for each operation, there is
a both request and a response. a both request and a response.
- Section 4 defines the attributes (and their syntaxes) that are used - Section 4 defines the attributes (and their syntaxes) that are used
in the model. in the model.
- Sections 5 - 6 summarizes the implementation conformance - Sections 5 - 6 summarizes the implementation conformance
requirements for objects that support the protocol and IANA requirements for objects that support the protocol and IANA
considerations, respectively. considerations, respectively.
- Sections 7 - 11 cover the Internationalization and Security - Sections 7 - 11 cover the Internationalization and Security
considerations as well as References, Author contact information, considerations as well as References, Author contact information,
and Formats for Registration Proposals. and Formats for Registration Proposals.
- Sections 12 - 14 are appendices that cover Terminology, Status - Sections 12 - 14 are appendices that cover Terminology, Status
Codes and Messages, and "media" keyword values. Codes and Messages, and "media" keyword values.
Note: This document uses terms such as "attributes", Note: This document uses terms such as "attributes", "keywords",
"keywords", and "support". These terms have special meaning and "support". These terms have special meaning and are defined
and are defined in the model terminology section 12.2. in the model terminology section 12.2. Capitalized terms, such
Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD, as MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, MAY, NEED NOT,
SHOULD NOT, MAY, NEED NOT, and OPTIONAL, have special meaning and OPTIONAL, have special meaning relating to conformance.
relating to conformance. These terms are defined in section These terms are defined in section 12.1 on conformance
12.1 on conformance terminology, most of which is taken from terminology, most of which is taken from RFC 2119 [RFC2119].
RFC 2119 [RFC2119].
- Section 15 is an appendix that helps to clarify the effects of - Section 15 is an appendix that helps to clarify the effects of
interactions between related attributes and their values. interactions between related attributes and their values.
- Section 16 is an appendix that enumerates the subset of Printer - Section 16 is an appendix that enumerates the subset of Printer
attributes that form a generic directory schema. These attributes attributes that form a generic directory schema. These attributes
are useful when registering a Printer so that a client can find the are useful when registering a Printer so that a client can find the
Printer not just by name, but by filtered searches as well. Printer not just by name, but by filtered searches as well.
- Section 17 is an appendix summarizing the additions and changes
Expires September 1, 2000
- Section 17 is an appendix summarizing the additions and changes
from the IPP/1.0 "Model and Semantics" document [RFC2566] to make from the IPP/1.0 "Model and Semantics" document [RFC2566] to make
this IPP/1.1 document. this IPP/1.1 document.
- Section 18 is the full copyright notice. - Section 18 is the full copyright notice.
1.1 Simplified Printing Model 1.1 Simplified Printing Model
In order to achieve its goal of realizing a workable printing protocol In order to achieve its goal of realizing a workable printing
for the Internet, the Internet Printing Protocol (IPP) is based on a protocol for the Internet, the Internet Printing Protocol (IPP) is
simplified printing model that abstracts the many components of real based on a simplified printing model that abstracts the many
world printing solutions. The Internet is a distributed computing components of real world printing solutions. The Internet is a
environment where requesters of print services (clients, applications, distributed computing environment where requesters of print services
printer drivers, etc.) cooperate and interact with print service (clients, applications, printer drivers, etc.) cooperate and interact
providers. This model and semantics document describes a simple, with print service providers. This model and semantics document
abstract model for IPP even though the underlying configurations may be describes a simple, abstract model for IPP even though the underlying
complex "n-tier" client/server systems. An important simplifying step configurations may be complex "n-tier" client/server systems. An
in the IPP model is to expose only the key objects and interfaces important simplifying step in the IPP model is to expose only the key
required for printing. The model described in this model document does objects and interfaces required for printing. The model described in
not include features, interfaces, and relationships that are beyond the this model document does not include features, interfaces, and
scope of the first version of IPP (IPP/1.1). IPP/1.1 incorporates many relationships that are beyond the scope of the first version of IPP
of the relevant ideas and lessons learned from other specification and (IPP/1.1). IPP/1.1 incorporates many of the relevant ideas and
development efforts [HTPP] [ISO10175] [LDPA] [P1387.4] [PSIS] [RFC1179] lessons learned from other specification and development efforts
[SWP]. IPP is heavily influenced by the printing model introduced in [HTPP] [ISO10175] [LDPA] [P1387.4] [PSIS] [RFC1179] [SWP]. IPP is
the Document Printing Application (DPA) [ISO10175] standard. Although heavily influenced by the printing model introduced in the Document
DPA specifies both end user and administrative features, IPP version 1.1 Printing Application (DPA) [ISO10175] standard. Although DPA
(IPP/1.1) focuses primarily on end user functionality with a few specifies both end user and administrative features, IPP version 1.1
additional OPTIONAL operator operations. (IPP/1.1) focuses primarily on end user functionality with a few
additional OPTIONAL operator operations.
The IPP/1.1 model encapsulates the important components of distributed
printing into two object types:
- Printer (Section 2.1) The IPP/1.1 model encapsulates the important components of
- Job (Section 2.2) distributed printing into two object types:
Each object type has an associated set of operations (see section 3) and - Printer (Section 2.1)
attributes (see section 4). - Job (Section 2.2)
It is important, however, to understand that in real system Each object type has an associated set of operations (see section 3)
implementations (which lie underneath the abstracted IPP/1.1 model), and attributes (see section 4).
there are other components of a print service which are not explicitly
defined in the IPP/1.1 model. The following figure illustrates where
IPP/1.1 fits with respect to these other components.
Expires September 1, 2000 It is important, however, to understand that in real system
+--------------+ implementations (which lie underneath the abstracted IPP/1.1 model),
| Application | there are other components of a print service which are not
o +. . . . . . . | explicitly defined in the IPP/1.1 model. The following figure
\|/ | Spooler | illustrates where IPP/1.1 fits with respect to these other
/ \ +. . . . . . . | +---------+ components.
End-User | Print Driver |---| File |
+-----------+ +-----+ +------+-------+ +----+----+
| Browser | | GUI | | |
+-----+-----+ +--+--+ | |
| | | |
| +---+------------+---+ |
N D S | | IPP Client |------------+
O I E | +---------+----------+
T R C | |
I E U |
F C R -------------- Transport ------------------
I T I
C O T | --+
A R Y +--------+--------+ |
T Y | IPP Server | |
I +--------+--------+ |
O | |
N +-----------------+ | IPP Printer
| Print Service | |
+-----------------+ |
| --+
+-----------------+
| Output Device(s)|
+-----------------+
An IPP Printer object encapsulates the functions normally associated +--------------+
with physical output devices along with the spooling, scheduling and | Application |
multiple device management functions often associated with a print o +. . . . . . . |
server. Printer objects are optionally registered as entries in a \|/ | Spooler |
directory where end users find and select them based on some sort of / \ +. . . . . . . | +---------+
filtered and context based searching mechanism (see section 16). The End-User | Print Driver |---| File |
directory is used to store relatively static information about the +-----------+ +-----+ +------+-------+ +----+----+
Printer, allowing end users to search for and find Printers that match | Browser | | GUI | | |
their search criteria, for example: name, context, printer capabilities, +-----+-----+ +--+--+ | |
etc. The more dynamic information, such as state, currently loaded and | | | |
ready media, number of jobs at the Printer, errors, warnings, and so | +---+------------+---+ |
forth, is directly associated with the Printer object itself rather than N D S | | IPP Client |------------+
with the entry in the directory which only represents the Printer O I E | +---------+----------+
object. T R C | |
I E U |
F C R -------------- Transport ------------------
I T I
C O T | --+
A R Y +--------+--------+ |
T Y | IPP Server | |
I +--------+--------+ |
O | |
N +-----------------+ | IPP Printer
| Print Service | |
+-----------------+ |
| --+
+-----------------+
| Output Device(s)|
+-----------------+
IPP clients implement the IPP protocol on the client side and give end An IPP Printer object encapsulates the functions normally associated
users (or programs running on behalf of end users) the ability to query with physical output devices along with the spooling, scheduling and
Printer objects and submit and manage print jobs. An IPP server is just multiple device management functions often associated with a print
that part of the Printer object that implements the server-side server. Printer objects are optionally registered as entries in a
protocol. The rest of the Printer object implements (or gateways into) directory where end users find and select them based on some sort of
the application semantics of the print service itself. The Printer filtered and context based searching mechanism (see section 16). The
directory is used to store relatively static information about the
Printer, allowing end users to search for and find Printers that
match their search criteria, for example: name, context, printer
capabilities, etc. The more dynamic information, such as state,
currently loaded and ready media, number of jobs at the Printer,
errors, warnings, and so forth, is directly associated with the
Printer object itself rather than with the entry in the directory
which only represents the Printer object.
Expires September 1, 2000 IPP clients implement the IPP protocol on the client side and give
objects may be embedded in an output device or may be implemented on a end users (or programs running on behalf of end users) the ability to
host on the network that communicates with an output device. query Printer objects and submit and manage print jobs. An IPP
server is just that part of the Printer object that implements the
server-side protocol. The rest of the Printer object implements (or
gateways into) the application semantics of the print service itself.
The Printer objects may be embedded in an output device or may be
implemented on a host on the network that communicates with an output
device.
When a job is submitted to the Printer object and the Printer object When a job is submitted to the Printer object and the Printer object
validates the attributes in the submission request, the Printer object validates the attributes in the submission request, the Printer
creates a new Job object. The end user then interacts with this new Job object creates a new Job object. The end user then interacts with
object to query its status and monitor the progress of the job. An end this new Job object to query its status and monitor the progress of
user can also cancel their print jobs by using the Job object's Cancel- the job. An end user can also cancel their print jobs by using the
Job operation. An end-user can also hold, release, and restart their Job object's Cancel-Job operation. An end-user can also hold,
print jobs using the Job object's OPTIONAL Hold-Job, Release-Job, and release, and restart their print jobs using the Job object's OPTIONAL
Restart-Job operations, if implemented. Hold-Job, Release-Job, and Restart-Job operations, if implemented.
A privileged operator or administrator of a Printer object can cancel, A privileged operator or administrator of a Printer object can
hold, release, and restart any user's job using the REQUIRED Cancel-Job cancel, hold, release, and restart any user's job using the REQUIRED
and the OPTIONAL Hold-Job, Release-Job, and Restart-Job operations. In Cancel-Job and the OPTIONAL Hold-Job, Release-Job, and Restart-Job
additional privileged operator or administrator of a Printer object can operations. In additional privileged operator or administrator of a
pause, resume, or purge (jobs from) a Printer object using the OPTIONAL Printer object can pause, resume, or purge (jobs from) a Printer
Pause-Printer, Resume-Printer, and Purge-Jobs operations, if object using the OPTIONAL Pause-Printer, Resume-Printer, and Purge-
implemented. Jobs operations, if implemented.
The notification service is out of scope for this IPP/1.1 document, but The notification service is out of scope for this IPP/1.1 document,
using such a notification service, the end user is able to register for but using such a notification service, the end user is able to
and receive Printer specific and Job specific events. An end user can register for and receive Printer specific and Job specific events.
query the status of Printer objects and can follow the progress of Job An end user can query the status of Printer objects and can follow
objects by polling using the Get-Printer-Attributes, Get-Jobs, and Get- the progress of Job objects by polling using the Get-Printer-
Job-Attributes operations. Attributes, Get-Jobs, and Get-Job-Attributes operations.
2. IPP Objects 2. IPP Objects
The IPP/1.1 model introduces objects of type Printer and Job. Each type The IPP/1.1 model introduces objects of type Printer and Job. Each
of object models relevant aspects of a real-world entity such as a real type of object models relevant aspects of a real-world entity such as
printer or real print job. Each object type is defined as a set of a real printer or real print job. Each object type is defined as a
possible attributes that may be supported by instances of that object set of possible attributes that may be supported by instances of that
type. For each object (instance), the actual set of supported object type. For each object (instance), the actual set of supported
attributes and values describe a specific implementation. The object's attributes and values describe a specific implementation. The
attributes and values describe its state, capabilities, realizable object's attributes and values describe its state, capabilities,
features, job processing functions, and default behaviors and realizable features, job processing functions, and default behaviors
characteristics. For example, the Printer object type is defined as a and characteristics. For example, the Printer object type is defined
set of attributes that each Printer object potentially supports. In the as a set of attributes that each Printer object potentially supports.
same manner, the Job object type is defined as a set of attributes that In the same manner, the Job object type is defined as a set of
are potentially supported by each Job object. attributes that are potentially supported by each Job object.
Each attribute included in the set of attributes defining an object type Each attribute included in the set of attributes defining an object
is labeled as: type is labeled as:
- "REQUIRED": each object MUST support the attribute. - "REQUIRED": each object MUST support the attribute.
- "RECOMMENDED": each object SHOULD support the attribute. - "RECOMMENDED": each object SHOULD support the attribute.
- "OPTIONAL": each object MAY support the attribute. - "OPTIONAL": each object MAY support the attribute.
Some definitions of attribute values indicate that an object MUST or Some definitions of attribute values indicate that an object MUST or
SHOULD support the value; otherwise, support of the value is OPTIONAL. SHOULD support the value; otherwise, support of the value is
OPTIONAL.
Expires September 1, 2000 However, if an implementation supports an attribute, it MUST support
However, if an implementation supports an attribute, it MUST support at at least one of the possible values for that attribute.
least one of the possible values for that attribute.
2.1 Printer Object 2.1 Printer Object
The major component of the IPP/1.1 model is the Printer object. A The major component of the IPP/1.1 model is the Printer object. A
Printer object implements the server-side of the IPP/1.1 protocol. Printer object implements the server-side of the IPP/1.1 protocol.
Using the protocol, end users may query the attributes of the Printer Using the protocol, end users may query the attributes of the Printer
object and submit print jobs to the Printer object. The actual object and submit print jobs to the Printer object. The actual
implementation components behind the Printer abstraction may take on implementation components behind the Printer abstraction may take on
different forms and different configurations. However, the model different forms and different configurations. However, the model
abstraction allows the details of the configuration of real components abstraction allows the details of the configuration of real
to remain opaque to the end user. Section 3 describes each of the components to remain opaque to the end user. Section 3 describes
Printer operations in detail. each of the Printer operations in detail.
The capabilities and state of a Printer object are described by its The capabilities and state of a Printer object are described by its
attributes. Printer attributes are divided into two groups: attributes. Printer attributes are divided into two groups:
- "job-template" attributes: These attributes describe supported job - "job-template" attributes: These attributes describe supported job
processing capabilities and defaults for the Printer object. (See processing capabilities and defaults for the Printer object. (See
section 4.2) section 4.2)
- "printer-description" attributes: These attributes describe the - "printer-description" attributes: These attributes describe the
Printer object's identification, state, location, references to Printer object's identification, state, location, references to
other sources of information about the Printer object, etc. (see other sources of information about the Printer object, etc. (see
section 4.4) section 4.4)
Since a Printer object is an abstraction of a generic document output Since a Printer object is an abstraction of a generic document output
device and print service provider, a Printer object could be used to device and print service provider, a Printer object could be used to
represent any real or virtual device with semantics consistent with the represent any real or virtual device with semantics consistent with
Printer object, such as a fax device, an imager, or even a CD writer. the Printer object, such as a fax device, an imager, or even a CD
writer.
Some examples of configurations supporting a Printer object include:
1) An output device with no spooling capabilities
2) An output device with a built-in spooler
3) A print server supporting IPP with one or more associated output
devices
3a) The associated output devices may or may not be capable of
spooling jobs
3b) The associated output devices may or may not support IPP
The following figures show some examples of how Printer objects can be Some examples of configurations supporting a Printer object include:
realized on top of various distributed printing configurations. The
embedded case below represents configurations 1 and 2. The hosted and
fan-out figures below represent configurations 3a and 3b.
In this document the term "client" refers to a software entity that 1) An output device with no spooling capabilities
sends IPP operation requests to an IPP Printer object and accepts IPP 2) An output device with a built-in spooler
operation responses. A client MAY be: 3) A print server supporting IPP with one or more associated
output devices
3a) The associated output devices may or may not be capable of
spooling jobs
3b) The associated output devices may or may not support IPP
1. contained within software controlled by an end user, e.g. activated The following figures show some examples of how Printer objects can
by the "Print" menu item in an application or be realized on top of various distributed printing configurations.
The embedded case below represents configurations 1 and 2. The hosted
and fan-out figures below represent configurations 3a and 3b.
Expires September 1, 2000 In this document the term "client" refers to a software entity that
sends IPP operation requests to an IPP Printer object and accepts IPP
operation responses. A client MAY be:
2. the print server component that sends IPP requests to either an 1. contained within software controlled by an end user, e.g.
output device or another "downstream" print server. activated by the "Print" menu item in an application or
The term "IPP Printer" is a network entity that accepts IPP operation 2. the print server component that sends IPP requests to either an
requests and returns IPP operation responses. As such, an IPP object output device or another "downstream" print server.
MAY be:
1. an (embedded) device component that accepts IPP requests and The term "IPP Printer" is a network entity that accepts IPP operation
controls the device or requests and returns IPP operation responses. As such, an IPP object
MAY be:
2. a component of a print server that accepts IPP requests (where the 1. an (embedded) device component that accepts IPP requests and
print server controls one or more networked devices using IPP or controls the device or
other protocols).
Expires September 1, 2000 2. a component of a print server that accepts IPP requests (where
the print server controls one or more networked devices using
IPP or other protocols).
Legend: Legend:
##### indicates a Printer object which is ##### indicates a Printer object which is
either embedded in an output device or is either embedded in an output device or is
hosted in a server. The Printer object hosted in a server. The Printer object
might or might not be capable of queuing/spooling. might or might not be capable of queuing/spooling.
any indicates any network protocol or direct any indicates any network protocol or direct
connect, including IPP connect, including IPP
embedded printer: embedded printer:
output device output device
+---------------+ +---------------+
O +--------+ | ########### | O +--------+ | ########### |
/|\ | client |------------IPP------------># Printer # | /|\ | client |------------IPP------------># Printer # |
/ \ +--------+ | # Object # | / \ +--------+ | # Object # |
| ########### | | ########### |
+---------------+ +---------------+
hosted printer: hosted printer:
+---------------+ +---------------+
O +--------+ ########### | | O +--------+ ########### | |
/|\ | client |--IPP--># Printer #-any->| output device | /|\ | client |--IPP--># Printer #-any->| output device |
/ \ +--------+ # Object # | | / \ +--------+ # Object # | |
########### +---------------+ ########### +---------------+
+---------------+ +---------------+
fan out: | | fan out: | |
+-->| output device | +-->| output device |
any/ | | any/ | |
O +--------+ ########### / +---------------+ O +--------+ ########### / +---------------+
/|\ | client |-IPP-># Printer #--* /|\ | client |-IPP-># Printer #--*
/ \ +--------+ # Object # \ +---------------+ / \ +--------+ # Object # \ +---------------+
########### any\ | | ########### any\ | |
+-->| output device | +-->| output device |
| | | |
+---------------+ +---------------+
2.2 Job Object 2.2 Job Object
A Job object is used to model a print job. A Job object contains A Job object is used to model a print job. A Job object contains
documents. The information required to create a Job object is sent in a documents. The information required to create a Job object is sent
create request from the end user via an IPP Client to the Printer in a create request from the end user via an IPP Client to the
object. The Printer object validates the create request, and if the Printer object. The Printer object validates the create request, and
Printer object accepts the request, the Printer object creates the new if the Printer object accepts the request, the Printer object creates
Job object. Section 3 describes each of the Job operations in detail. the new Job object. Section 3 describes each of the Job operations
in detail.
Expires September 1, 2000 The characteristics and state of a Job object are described by its
The characteristics and state of a Job object are described by its attributes. Job attributes are grouped into two groups as follows:
attributes. Job attributes are grouped into two groups as follows:
- "job-template" attributes: These attributes can be supplied by the - "job-template" attributes: These attributes can be supplied by
client or end user and include job processing instructions which the client or end user and include job processing instructions
are intended to override any Printer object defaults and/or which are intended to override any Printer object defaults
instructions embedded within the document data. (See section 4.2) and/or instructions embedded within the document data. (See
- "job-description" attributes: These attributes describe the Job section 4.2)
object's identification, state, size, etc. The client supplies some
of these attributes, and the Printer object generates others. (See
section 4.3)
An implementation MUST support at least one document per Job object. An - "job-description" attributes: These attributes describe the Job
implementation MAY support multiple documents per Job object. A object's identification, state, size, etc. The client supplies
document is either: some of these attributes, and the Printer object generates
others. (See section 4.3)
- a stream of document data in a format supported by the Printer An implementation MUST support at least one document per Job object.
object (typically a Page Description Language - PDL), or An implementation MAY support multiple documents per Job object. A
- a reference to such a stream of document data document is either:
In IPP/1.1, a document is not modeled as an IPP object, therefore it has - a stream of document data in a format supported by the Printer
no object identifier or associated attributes. All job processing object (typically a Page Description Language - PDL), or
instructions are modeled as Job object attributes. These attributes are - a reference to such a stream of document data
called Job Template attributes and they apply equally to all documents
within a Job object. In IPP/1.1, a document is not modeled as an IPP object, therefore it
has no object identifier or associated attributes. All job
processing instructions are modeled as Job object attributes. These
attributes are called Job Template attributes and they apply equally
to all documents within a Job object.
2.3 Object Relationships 2.3 Object Relationships
IPP objects have relationships that are maintained persistently along IPP objects have relationships that are maintained persistently along
with the persistent storage of the object attributes. with the persistent storage of the object attributes.
A Printer object can represent either one or more physical output A Printer object can represent either one or more physical output
devices or a logical device which "processes" jobs but never actually devices or a logical device which "processes" jobs but never actually
uses a physical output device to put marks on paper. Examples of uses a physical output device to put marks on paper. Examples of
logical devices include a Web page publisher or a gateway into an online logical devices include a Web page publisher or a gateway into an
document archive or repository. A Printer object contains zero or more online document archive or repository. A Printer object contains
Job objects. zero or more Job objects.
A Job object is contained by exactly one Printer object, however the A Job object is contained by exactly one Printer object, however the
identical document data associated with a Job object could be sent to identical document data associated with a Job object could be sent to
either the same or a different Printer object. In this case, a second either the same or a different Printer object. In this case, a
Job object would be created which would be almost identical to the first second Job object would be created which would be almost identical to
Job object, however it would have new (different) Job object identifiers the first Job object, however it would have new (different) Job
(see section 2.4). object identifiers (see section 2.4).
A Job object is either empty (before any documents have been added) or A Job object is either empty (before any documents have been added)
contains one or more documents. If the contained document is a stream or contains one or more documents. If the contained document is a
of document data, that stream can be contained in only one document. stream of document data, that stream can be contained in only one
However, there can be identical copies of the stream in other documents document. However, there can be identical copies of the stream in
in the same or different Job objects. If the contained document is just other documents in the same or different Job objects. If the
a reference to a stream of document data, other documents (in the same contained document is just a reference to a stream of document data,
or different Job object(s)) may contain the same reference. other documents (in the same or different Job object(s)) may contain
the same reference.
Expires September 1, 2000
2.4 Object Identity 2.4 Object Identity
All Printer and Job objects are identified by a Uniform Resource All Printer and Job objects are identified by a Uniform Resource
Identifier (URI) [RFC2396] so that they can be persistently and Identifier (URI) [RFC2396] so that they can be persistently and
unambiguously referenced. The notion of a URI is a useful concept, unambiguously referenced. Since every URL is a specialized form of a
however, until the notion of URI is more stable (i.e., defined more URI, even though the more generic term URI is used throughout the
completely and deployed more widely), it is expected that the URIs used rest of this document, its usage is intended to cover the more
for IPP objects will actually be URLs [RFC2396]. Since every URL is a specific notion of URL as well.
specialized form of a URI, even though the more generic term URI is used
throughout the rest of this document, its usage is intended to cover the
more specific notion of URL as well.
An administrator configures Printer objects to either support or not
support authentication and/or message privacy using Transport Layer
Security (TLS) [RFC2246] (the mechanism for security configuration is
outside the scope of this IPP/1.1 document). In some situations, both
types of connections (both authenticated and unauthenticated) can be
established using a single communication channel that has some sort of
negotiation mechanism. In other situations, multiple communication
channels are used, one for each type of security configuration. Section
8 provides a full description of all security considerations and
configurations.
If a Printer object supports more than one communication channel, some
or all of those channels might support and/or require different security
mechanisms. In such cases, an administrator could expose the
simultaneous support for these multiple communication channels as
multiple URIs for a single Printer object where each URI represents one
of the communication channels to the Printer object. To support this
flexibility, the IPP Printer object type defines a multi-valued
identification attribute called the "printer-uri-supported" attribute.
It MUST contain at least one URI. It MAY contain more than one URI.
That is, every Printer object will have at least one URI that identifies
at least one communication channel to the Printer object, but it may
have more than one URI where each URI identifies a different
communication channel to the Printer object. The "printer-uri-
supported" attribute has two companion attributes, the "uri-security-
supported" attribute and the "uri-authentication-supported". Both have
the same cardinality as "printer-uri-supported". The purpose of the
"uri-security-supported" attribute is to indicate the security
mechanisms (if any) used for each URI listed in "printer-uri-supported".
The purpose of the "uri-authentication-supported" attribute is to
indicate the authentication mechanisms (if any) used for each URI listed
in "printer-uri-supported". These three attributes are fully described
in sections 4.4.1, 4.4.2, and 4.4.3.
When a job is submitted to the Printer object via a create request, the An administrator configures Printer objects to either support or not
client supplies only a single Printer object URI. The client supplied support authentication and/or message privacy using Transport Layer
Printer object URI MUST be one of the values in the "printer-uri- Security (TLS) [RFC2246] (the mechanism for security configuration is
supported" Printer attribute. outside the scope of this IPP/1.1 document). In some situations,
both types of connections (both authenticated and unauthenticated)
can be established using a single communication channel that has some
sort of negotiation mechanism. In other situations, multiple
communication channels are used, one for each type of security
configuration. Section 8 provides a full description of all security
considerations and configurations.
IPP/1.1 does not specify how the client obtains the client supplied URI, If a Printer object supports more than one communication channel,
but it is RECOMMENDED that a Printer object be registered as an entry in some or all of those channels might support and/or require different
security mechanisms. In such cases, an administrator could expose
the simultaneous support for these multiple communication channels as
multiple URIs for a single Printer object where each URI represents
one of the communication channels to the Printer object. To support
this flexibility, the IPP Printer object type defines a multi-valued
identification attribute called the "printer-uri-supported"
attribute. It MUST contain at least one URI. It MAY contain more
than one URI. That is, every Printer object will have at least one
URI that identifies at least one communication channel to the Printer
object, but it may have more than one URI where each URI identifies a
different communication channel to the Printer object. The
"printer-uri-supported" attribute has two companion attributes, the
"uri-security-supported" attribute and the "uri-authentication-
supported". Both have the same cardinality as "printer-uri-
supported". The purpose of the "uri-security-supported" attribute is
to indicate the security mechanisms (if any) used for each URI listed
in "printer-uri-supported". The purpose of the "uri-authentication-
supported" attribute is to indicate the authentication mechanisms (if
any) used for each URI listed in "printer-uri-supported". These
three attributes are fully described in sections 4.4.1, 4.4.2, and
4.4.3.
Expires September 1, 2000 When a job is submitted to the Printer object via a create request,
a directory service. End-users and programs can then interrogate the the client supplies only a single Printer object URI. The client
directory searching for Printers. Section 16 defines a generic schema supplied Printer object URI MUST be one of the values in the
for Printer object entries in the directory service and describes how "printer-uri-supported" Printer attribute.
the entry acts as a bridge to the actual IPP Printer object. The entry
in the directory that represents the IPP Printer object includes the
possibly many URIs for that Printer object as values in one its
attributes.
When a client submits a create request to the Printer object, the IPP/1.1 does not specify how the client obtains the client supplied
Printer object validates the request and creates a new Job object. The URI, but it is RECOMMENDED that a Printer object be registered as an
Printer object assigns the new Job object a URI which is stored in the entry in a directory service. End-users and programs can then
"job-uri" Job attribute. This URI is then used by clients as the target interrogate the directory searching for Printers. Section 16 defines
for subsequent Job operations. The Printer object generates a Job URI a generic schema for Printer object entries in the directory service
based on its configured security policy and the URI used by the client and describes how the entry acts as a bridge to the actual IPP
in the create request. Printer object. The entry in the directory that represents the IPP
Printer object includes the possibly many URIs for that Printer
object as values in one its attributes.
For example, consider a Printer object that supports both a When a client submits a create request to the Printer object, the
communication channel secured by the use of SSL3 (using HTTP over SSL3 Printer object validates the request and creates a new Job object.
with an "https" schemed URI) and another open communication channel that The Printer object assigns the new Job object a URI which is stored
is not secured with SSL3 (using a simple "http" schemed URI). If a in the "job-uri" Job attribute. This URI is then used by clients as
client were to submit a job using the secure URI, the Printer object the target for subsequent Job operations. The Printer object
would assign the new Job object a secure URI as well. If a client were generates a Job URI based on its configured security policy and the
to submit a job using the open-channel URI, the Printer would assign the URI used by the client in the create request.
new Job object an open-channel URI.
In addition, the Printer object also populates the Job object's "job- For example, consider a Printer object that supports both a
printer-uri" attribute. This is a reference back to the Printer object communication channel secured by the use of SSL3 (using HTTP over
that created the Job object. If a client only has access to a Job SSL3 with an "https" schemed URI) and another open communication
object's "job-uri" identifier, the client can query the Job's "job- channel that is not secured with SSL3 (using a simple "http" schemed
printer-uri" attribute in order to determine which Printer object URI). If a client were to submit a job using the secure URI, the
created the Job object. If the Printer object supports more than one Printer object would assign the new Job object a secure URI as well.
URI, the Printer object picks the one URI supplied by the client when If a client were to submit a job using the open-channel URI, the
creating the job to build the value for and to populate the Job's "job- Printer would assign the new Job object an open-channel URI.
printer-uri" attribute.
Allowing Job objects to have URIs allows for flexibility and In addition, the Printer object also populates the Job object's
scalability. For example, in some implementations, the Printer object "job-printer-uri" attribute. This is a reference back to the Printer
might create Jobs that are processed in the same local environment as object that created the Job object. If a client only has access to a
the Printer object itself. In this case, the Job URI might just be a Job object's "job-uri" identifier, the client can query the Job's
composition of the Printer's URI and some unique component for the Job "job-printer-uri" attribute in order to determine which Printer
object, such as the unique 32-bit positive integer mentioned later in object created the Job object. If the Printer object supports more
this paragraph. In other implementations, the Printer object might be a than one URI, the Printer object picks the one URI supplied by the
central clearing-house for validating all Job object creation requests, client when creating the job to build the value for and to populate
but the Job object itself might be created in some environment that is the Job's "job-printer-uri" attribute.
remote from the Printer object. In this case, the Job object's URI may
have no physical-location relationship at all to the Printer object's
URI. Again, the fact that Job objects have URIs allows for flexibility
and scalability, however, many existing printing systems have local
models or interface constraints that force print jobs to be identified
using only a 32-bit positive integer rather than an independent URI.
This numeric Job ID is only unique within the context of the Printer
object to which the create request was originally submitted. Therefore,
in order to allow both types of client access to IPP Job objects (either
by Job URI or by numeric Job ID), when the Printer object successfully
Expires September 1, 2000 Allowing Job objects to have URIs allows for flexibility and
processes a create request and creates a new Job object, the Printer scalability. For example, in some implementations, the Printer
object MUST generate both a Job URI and a Job ID. The Job ID (stored in object might create Jobs that are processed in the same local
the "job-id" attribute) only has meaning in the context of the Printer environment as the Printer object itself. In this case, the Job URI
object to which the create request was originally submitted. This might just be a composition of the Printer's URI and some unique
requirement to support both Job URIs and Job IDs allows all types of component for the Job object, such as the unique 32-bit positive
clients to access Printer objects and Job objects no matter the local integer mentioned later in this paragraph. In other implementations,
constraints imposed on the client implementation. the Printer object might be a central clearing-house for validating
all Job object creation requests, but the Job object itself might be
created in some environment that is remote from the Printer object.
In this case, the Job object's URI may have no physical-location
relationship at all to the Printer object's URI. Again, the fact
that Job objects have URIs allows for flexibility and scalability,
however, many existing printing systems have local models or
interface constraints that force print jobs to be identified using
only a 32-bit positive integer rather than an independent URI. This
numeric Job ID is only unique within the context of the Printer
object to which the create request was originally submitted.
Therefore, in order to allow both types of client access to IPP Job
objects (either by Job URI or by numeric Job ID), when the Printer
object successfully processes a create request and creates a new Job
object, the Printer object MUST generate both a Job URI and a Job ID.
The Job ID (stored in the "job-id" attribute) only has meaning in the
context of the Printer object to which the create request was
originally submitted. This requirement to support both Job URIs and
Job IDs allows all types of clients to access Printer objects and Job
objects no matter the local constraints imposed on the client
implementation.
In addition to identifiers, Printer objects and Job objects have names In addition to identifiers, Printer objects and Job objects have
("printer-name" and "job-name"). An object name NEED NOT be unique names ("printer-name" and "job-name"). An object name NEED NOT be
across all instances of all objects. A Printer object's name is chosen unique across all instances of all objects. A Printer object's name
and set by an administrator through some mechanism outside the scope of is chosen and set by an administrator through some mechanism outside
this IPP/1.1 document. A Job object's name is optionally chosen and the scope of this IPP/1.1 document. A Job object's name is
supplied by the IPP client submitting the job. If the client does not optionally chosen and supplied by the IPP client submitting the job.
supply a Job object name, the Printer object generates a name for the If the client does not supply a Job object name, the Printer object
new Job object. In all cases, the name only has local meaning. generates a name for the new Job object. In all cases, the name only
has local meaning.
To summarize: To summarize:
- Each Printer object is identified with one or more URIs. The - Each Printer object is identified with one or more URIs. The
Printer's "printer-uri-supported" attribute contains the URI(s). Printer's "printer-uri-supported" attribute contains the URI(s).
- The Printer object's "uri-security-supported" attribute identifies - The Printer object's "uri-security-supported" attribute
the communication channel security protocols that may or may not identifies the communication channel security protocols that may
have been configured for the various Printer object URIs (e.g., or may not have been configured for the various Printer object
'tls' or 'none'). URIs (e.g., 'tls' or 'none').
- The Printer object's "uri-authentication-supported" attribute - The Printer object's "uri-authentication-supported" attribute
identifies the authentication mechanisms that may or may not have identifies the authentication mechanisms that may or may not
been configured for the various Printer object URIs (e.g., 'digest' have been configured for the various Printer object URIs (e.g.,
or 'none'). 'digest' or 'none').
- Each Job object is identified with a Job URI. The Job's "job-uri" - Each Job object is identified with a Job URI. The Job's "job-
attribute contains the URI. uri" attribute contains the URI.
- Each Job object is also identified with Job ID which is a 32-bit, - Each Job object is also identified with Job ID which is a 32-
positive integer. The Job's "job-id" attribute contains the Job bit, positive integer. The Job's "job-id" attribute contains
ID. The Job ID is only unique within the context of the Printer the Job ID. The Job ID is only unique within the context of the
object which created the Job object. Printer object which created the Job object.
- Each Job object has a "job-printer-uri" attribute which contains
the URI of the Printer object that was used to create the Job
object. This attribute is used to determine the Printer object
that created a Job object when given only the URI for the Job
object. This linkage is necessary to determine the languages,
charsets, and operations which are supported on that Job (the basis
for such support comes from the creating Printer object).
- Each Printer object has a name (which is not necessarily unique).
The administrator chooses and sets this name through some mechanism
outside the scope of this IPP/1.1 document. The Printer object's
"printer-name" attribute contains the name.
- Each Job object has a name (which is not necessarily unique). The
client optionally supplies this name in the create request. If the
client does not supply this name, the Printer object generates a
name for the Job object. The Job object's "job-name" attribute
contains the name.
Expires September 1, 2000 - Each Job object has a "job-printer-uri" attribute which contains
the URI of the Printer object that was used to create the Job
object. This attribute is used to determine the Printer object
that created a Job object when given only the URI for the Job
object. This linkage is necessary to determine the languages,
charsets, and operations which are supported on that Job (the
basis for such support comes from the creating Printer object).
- Each Printer object has a name (which is not necessarily
unique). The administrator chooses and sets this name through
some mechanism outside the scope of this IPP/1.1 document. The
Printer object's "printer-name" attribute contains the name.
- Each Job object has a name (which is not necessarily unique).
The client optionally supplies this name in the create request.
If the client does not supply this name, the Printer object
generates a name for the Job object. The Job object's "job-name"
attribute contains the name.
3. IPP Operations 3. IPP Operations
IPP objects support operations. An operation consists of a request and IPP objects support operations. An operation consists of a request
a response. When a client communicates with an IPP object, the client and a response. When a client communicates with an IPP object, the
issues an operation request to the URI for that object. Operation client issues an operation request to the URI for that object.
requests and responses have parameters that identify the operation. Operation requests and responses have parameters that identify the
Operations also have attributes that affect the run-time characteristics operation. Operations also have attributes that affect the run-time
of the operation (the intended target, localization information, etc.). characteristics of the operation (the intended target, localization
These operation-specific attributes are called operation attributes (as information, etc.). These operation-specific attributes are called
compared to object attributes such as Printer object attributes or Job operation attributes (as compared to object attributes such as
object attributes). Each request carries along with it any operation Printer object attributes or Job object attributes). Each request
attributes, object attributes, and/or document data required to perform carries along with it any operation attributes, object attributes,
the operation. Each request requires a response from the object. Each and/or document data required to perform the operation. Each request
response indicates success or failure of the operation with a status requires a response from the object. Each response indicates success
code as a response parameter. The response contains any operation or failure of the operation with a status code as a response
attributes, object attributes, and/or status messages generated during parameter. The response contains any operation attributes, object
the execution of the operation request. attributes, and/or status messages generated during the execution of
the operation request.
This section describes the semantics of the IPP operations, both This section describes the semantics of the IPP operations, both
requests and responses, in terms of the parameters, attributes, and requests and responses, in terms of the parameters, attributes, and
other data associated with each operation. other data associated with each operation.
The IPP/1.1 Printer operations are: The IPP/1.1 Printer operations are:
Print-Job (section 3.2.1) Print-Job (section 3.2.1)
Print-URI (section 3.2.2) Print-URI (section 3.2.2)
Validate-Job (section 3.2.3) Validate-Job (section 3.2.3)
Create-Job (section 3.2.4) Create-Job (section 3.2.4)
Get-Printer-Attributes (section 3.2.5) Get-Printer-Attributes (section 3.2.5)
Get-Jobs (section 3.2.6) Get-Jobs (section 3.2.6)
Pause-Printer (section 3.3.5) Pause-Printer (section 3.3.5)
Resume-Printer (section 3.3.6) Resume-Printer (section 3.3.6)
Purge-Jobs (section 3.3.7) Purge-Jobs (section 3.3.7)
The Job operations are: The Job operations are:
Send-Document (section 3.3.1) Send-Document (section 3.3.1)
Send-URI (section 3.3.2) Send-URI (section 3.3.2)
Cancel-Job (section 3.3.3) Cancel-Job (section 3.3.3)
Get-Job-Attributes (section 3.3.4) Get-Job-Attributes (section 3.3.4)
Hold-Job (section 3.3.5) Hold-Job (section 3.3.5)
Release-Job (section 3.3.6) Release-Job (section 3.3.6)
Restart-Job (section 3.3.7) Restart-Job (section 3.3.7)
The Send-Document and Send-URI Job operations are used to add a new The Send-Document and Send-URI Job operations are used to add a new
document to an existing multi-document Job object created using the document to an existing multi-document Job object created using the
Create-Job operation. Create-Job operation.
3.1 Common Semantics 3.1 Common Semantics
All IPP operations require some common parameters and operation All IPP operations require some common parameters and operation
attributes. These common elements and their semantic characteristics attributes. These common elements and their semantic characteristics
are defined and described in more detail in the following sections. are defined and described in more detail in the following sections.
Expires September 1, 2000
3.1.1 Required Parameters 3.1.1 Required Parameters
Every operation request contains the following REQUIRED parameters: Every operation request contains the following REQUIRED parameters:
- a "version-number", - a "version-number",
- an "operation-id", - an "operation-id",
- a "request-id", and - a "request-id", and
- the attributes that are REQUIRED for that type of request. - the attributes that are REQUIRED for that type of request.
Every operation response contains the following REQUIRED parameters: Every operation response contains the following REQUIRED parameters:
- a "version-number", - a "version-number",
- a "status-code", - a "status-code",
- the "request-id" that was supplied in the corresponding request, - the "request-id" that was supplied in the corresponding request,
and and
- the attributes that are REQUIRED for that type of response. - the attributes that are REQUIRED for that type of response.
The "Encoding and Transport" document [IPP-PRO] defines special rules The "Encoding and Transport" document [RFC2910] defines special rules
for the encoding of these parameters. All other operation elements are for the encoding of these parameters. All other operation elements
represented using the more generic encoding rules for attributes and are represented using the more generic encoding rules for attributes
groups of attributes. and groups of attributes.
3.1.2 Operation IDs and Request IDs 3.1.2 Operation IDs and Request IDs
Each IPP operation request includes an identifying "operation-id" value. Each IPP operation request includes an identifying "operation-id"
Valid values are defined in the "operations-supported" Printer attribute value. Valid values are defined in the "operations-supported"
section (see section 4.4.15). The client specifies which operation is Printer attribute section (see section 4.4.15). The client specifies
being requested by supplying the correct "operation-id" value. which operation is being requested by supplying the correct
"operation-id" value.
In addition, every invocation of an operation is identified by a In addition, every invocation of an operation is identified by a
"request-id" value. For each request, the client chooses the "request- "request-id" value. For each request, the client chooses the
id" which MUST be an integer (possibly unique depending on client "request-id" which MUST be an integer (possibly unique depending on
requirements) in the range from 1 to 2**31 - 1 (inclusive). This client requirements) in the range from 1 to 2**31 - 1 (inclusive).
"request-id" allows clients to manage multiple outstanding requests. The This "request-id" allows clients to manage multiple outstanding
receiving IPP object copies all 32-bits of the client-supplied "request- requests. The receiving IPP object copies all 32-bits of the client-
id" attribute into the response so that the client can match the supplied "request-id" attribute into the response so that the client
response with the correct outstanding request, even if the "request-id" can match the response with the correct outstanding request, even if
is out of range. If the request is terminated before the complete the "request-id" is out of range. If the request is terminated
"request-id" is received, the IPP object rejects the request and returns before the complete "request-id" is received, the IPP object rejects
a response with a "request-id" of 0. the request and returns a response with a "request-id" of 0.
Note: In some cases, the transport protocol underneath IPP might be a Note: In some cases, the transport protocol underneath IPP might be a
connection oriented protocol that would make it impossible for a client connection oriented protocol that would make it impossible for a
to receive responses in any order other than the order in which the client to receive responses in any order other than the order in
corresponding requests were sent. In such cases, the "request-id" which the corresponding requests were sent. In such cases, the
attribute would not be essential for correct protocol operation. "request-id" attribute would not be essential for correct protocol
However, in other mappings, the operation responses can come back in any operation. However, in other mappings, the operation responses can
order. In these cases, the "request-id" would be essential. come back in any order. In these cases, the "request-id" would be
essential.
3.1.3 Attributes 3.1.3 Attributes
Operation requests and responses are both composed of groups of Operation requests and responses are both composed of groups of
attributes and/or document data. The attributes groups are: attributes and/or document data. The attributes groups are:
Expires September 1, 2000
- Operation Attributes: These attributes are passed in the operation
and affect the IPP object's behavior while processing the operation
request and may affect other attributes or groups of attributes.
Some operation attributes describe the document data associated
with the print job and are associated with new Job objects, however
most operation attributes do not persist beyond the life of the
operation. The description of each operation attribute includes
conformance statements indicating which operation attributes are
REQUIRED and which are OPTIONAL for an IPP object to support and
which attributes a client MUST supply in a request and an IPP
object MUST supply in a response.
- Job Template Attributes: These attributes affect the processing of
a job. A client OPTIONALLY supplies Job Template Attributes in a
create request, and the receiving object MUST be prepared to
receive all supported attributes. The Job object can later be
queried to find out what Job Template attributes were originally
requested in the create request, and such attributes are returned
in the response as Job Object Attributes. The Printer object can
be queried about its Job Template attributes to find out what type
of job processing capabilities are supported and/or what the
default job processing behaviors are, though such attributes are
returned in the response as Printer Object Attributes. The "ipp-
attribute-fidelity" operation attribute affects processing of all
client-supplied Job Template attributes (see sections 3.2.1.2 and
15 for a full description of "ipp-attribute-fidelity" and its
relationship to other attributes).
- Job Object Attributes: These attributes are returned in response to
a query operation directed at a Job object.
- Printer Object Attributes: These attributes are returned in
response to a query operation directed at a Printer object.
- Unsupported Attributes: In a create request, the client supplies a
set of Operation and Job Template attributes. If any of these
attributes or their values is unsupported by the Printer object,
the Printer object returns the set of unsupported attributes in the
response. Sections 3.1.7, 3.2.1.2, and 15 give a full description
of how Job Template attributes supplied by the client in a create
request are processed by the Printer object and how unsupported
attributes are returned to the client. Because of extensibility,
any IPP object might receive a request that contains new or unknown
attributes or values for which it has no support. In such cases,
the IPP object processes what it can and returns the unsupported
attributes in the response. The Unsupported Attribute group is
defined for all operation responses for returning unsupported
attributes that the client supplied in the request.
Later in this section, each operation is formally defined by identifying - Operation Attributes: These attributes are passed in the
the allowed and expected groups of attributes for each request and operation and affect the IPP object's behavior while processing
response. The model identifies a specific order for each group in each the operation request and may affect other attributes or groups
request or response, but the attributes within each group may be in any of attributes. Some operation attributes describe the document
order, unless specified otherwise. data associated with the print job and are associated with new
Job objects, however most operation attributes do not persist
beyond the life of the operation. The description of each
operation attribute includes conformance statements indicating
which operation attributes are REQUIRED and which are OPTIONAL
for an IPP object to support and which attributes a client MUST
supply in a request and an IPP object MUST supply in a response.
- Job Template Attributes: These attributes affect the processing
of a job. A client OPTIONALLY supplies Job Template Attributes
in a create request, and the receiving object MUST be prepared
to receive all supported attributes. The Job object can later
be queried to find out what Job Template attributes were
originally requested in the create request, and such attributes
are returned in the response as Job Object Attributes. The
Printer object can be queried about its Job Template attributes
to find out what type of job processing capabilities are
supported and/or what the default job processing behaviors are,
though such attributes are returned in the response as Printer
Object Attributes. The "ipp-attribute-fidelity" operation
attribute affects processing of all client-supplied Job Template
attributes (see sections 3.2.1.2 and 15 for a full description
of "ipp-attribute-fidelity" and its relationship to other
attributes).
- Job Object Attributes: These attributes are returned in response
to a query operation directed at a Job object.
- Printer Object Attributes: These attributes are returned in
response to a query operation directed at a Printer object.
- Unsupported Attributes: In a create request, the client supplies
a set of Operation and Job Template attributes. If any of these
attributes or their values is unsupported by the Printer object,
the Printer object returns the set of unsupported attributes in
the response. Sections 3.1.7, 3.2.1.2, and 15 give a full
description of how Job Template attributes supplied by the
client in a create request are processed by the Printer object
and how unsupported attributes are returned to the client.
Because of extensibility, any IPP object might receive a request
that contains new or unknown attributes or values for which it
has no support. In such cases, the IPP object processes what it
can and returns the unsupported attributes in the response. The
Unsupported Attribute group is defined for all operation
responses for returning unsupported attributes that the client
supplied in the request.
The attributes within a group MUST be unique; if an attribute with the Later in this section, each operation is formally defined by
same name occurs more than once, the group is mal-formed. Clients MUST identifying the allowed and expected groups of attributes for each
request and response. The model identifies a specific order for each
group in each request or response, but the attributes within each
group may be in any order, unless specified otherwise.
Expires September 1, 2000 The attributes within a group MUST be unique; if an attribute with
NOT submit such malformed requests and Printers MUST NOT return such the same name occurs more than once, the group is mal-formed.
malformed responses. If such a malformed request is submitted to a Clients MUST NOT submit such malformed requests and Printers MUST NOT
Printer, the Printer MUST either (1) reject the request with the return such malformed responses. If such a malformed request is
'client-error-bad-request' status code (see section 13.1.4.1) or (2) submitted to a Printer, the Printer MUST either (1) reject the
process the request normally after selecting only one of the attribute request with the 'client-error-bad-request' status code (see section
instances, depending on implementation. Which attribute is selected 13.1.4.1) or (2) process the request normally after selecting only
when there are duplicate attributes depends on implementation. The IPP one of the attribute instances, depending on implementation. Which
Printer MUST NOT use the values from more than one such duplicate attribute is selected when there are duplicate attributes depends on
attribute instance. implementation. The IPP Printer MUST NOT use the values from more
than one such duplicate attribute instance.
Each attribute definition includes the attribute's name followed by the Each attribute definition includes the attribute's name followed by
name of its attribute syntax(es) in parenthesizes. In addition, each the name of its attribute syntax(es) in parenthesizes. In addition,
'integer' attribute is followed by the allowed range in parentheses, each 'integer' attribute is followed by the allowed range in
(m:n), for values of that attribute. Each 'text' or 'name' attribute is parentheses, (m:n), for values of that attribute. Each 'text' or
followed by the maximum size in octets in parentheses, (size), for 'name' attribute is followed by the maximum size in octets in
values of that attribute. For more details on attribute syntax notation, parentheses, (size), for values of that attribute. For more details
see the descriptions of these attributes syntaxes in section 4.1. on attribute syntax notation, see the descriptions of these
attributes syntaxes in section 4.1.
Note: Document data included in the operation is not strictly an Note: Document data included in the operation is not strictly an
attribute, but it is treated as a special attribute group for ordering attribute, but it is treated as a special attribute group for
purposes. The only operations that support supplying the document data ordering purposes. The only operations that support supplying the
within an operation request are Print-Job and Send-Document. There are document data within an operation request are Print-Job and Send-
no operation responses that include document data. Document. There are no operation responses that include document
data.
Some operations are REQUIRED for IPP objects to support; the others are Some operations are REQUIRED for IPP objects to support; the others
OPTIONAL (see section 5.2.2). Therefore, before using an OPTIONAL are OPTIONAL (see section 5.2.2). Therefore, before using an
operation, a client SHOULD first use the REQUIRED Get-Printer-Attributes OPTIONAL operation, a client SHOULD first use the REQUIRED Get-
operation to query the Printer's "operations-supported" attribute in Printer-Attributes operation to query the Printer's "operations-
order to determine which OPTIONAL Printer and Job operations are supported" attribute in order to determine which OPTIONAL Printer and
actually supported. The client SHOULD NOT use an OPTIONAL operation Job operations are actually supported. The client SHOULD NOT use an
that is not supported. When an IPP object receives a request to perform OPTIONAL operation that is not supported. When an IPP object
an operation it does not support, it returns the 'server-error- receives a request to perform an operation it does not support, it
operation-not-supported' status code (see section 13.1.5.2). An IPP returns the 'server-error-operation-not-supported' status code (see
object is non-conformant if it does not support a REQUIRED operation. section 13.1.5.2). An IPP object is non-conformant if it does not
support a REQUIRED operation.
3.1.4 Character Set and Natural Language Operation Attributes 3.1.4 Character Set and Natural Language Operation Attributes
Some Job and Printer attributes have values that are text strings and Some Job and Printer attributes have values that are text strings and
names intended for human understanding rather than machine understanding names intended for human understanding rather than machine
(see the 'text' and 'name' attribute syntax descriptions in section understanding (see the 'text' and 'name' attribute syntax
4.1). The following sections describe two special Operation Attributes descriptions in section 4.1). The following sections describe two
called "attributes-charset" and "attributes-natural-language". These special Operation Attributes called "attributes-charset" and
attributes are always part of the Operation Attributes group. For most "attributes-natural-language". These attributes are always part of
attribute groups, the order of the attributes within the group is not the Operation Attributes group. For most attribute groups, the order
important. However, for these two attributes within the Operation of the attributes within the group is not important. However, for
Attributes group, the order is critical. The "attributes-charset" these two attributes within the Operation Attributes group, the order
attribute MUST be the first attribute in the group and the "attributes- is critical. The "attributes-charset" attribute MUST be the first
natural-language" attribute MUST be the second attribute in the group. attribute in the group and the "attributes-natural-language"
In other words, these attributes MUST be supplied in every IPP request attribute MUST be the second attribute in the group. In other words,
and response, they MUST come first in the group, and MUST come in the these attributes MUST be supplied in every IPP request and response,
specified order. For job creation operations, the IPP Printer they MUST come first in the group, and MUST come in the specified
implementation saves these two attributes with the new Job object as Job order. For job creation operations, the IPP Printer implementation
Description attributes. For the sake of brevity in this document, these saves these two attributes with the new Job object as Job Description
attributes. For the sake of brevity in this document, these
Expires September 1, 2000 operation attribute descriptions are not repeated with every
operation attribute descriptions are not repeated with every operation operation request and response, but have a reference back to this
request and response, but have a reference back to this section instead. section instead.
3.1.4.1 Request Operation Attributes 3.1.4.1 Request Operation Attributes
The client MUST supply and the Printer object MUST support the following The client MUST supply and the Printer object MUST support the
REQUIRED operation attributes in every IPP/1.1 operation request: following REQUIRED operation attributes in every IPP/1.1 operation
request:
"attributes-charset" (charset):
This operation attribute identifies the charset (coded character
set and encoding method) used by any 'text' and 'name' attributes
that the client is supplying in this request. It also identifies
the charset that the Printer object MUST use (if supported) for all
'text' and 'name' attributes and status messages that the Printer
object returns in the response to this request. See Sections 4.1.1
and 4.1.2 for the definition of the 'text' and 'name' attribute
syntaxes.
All clients and IPP objects MUST support the 'utf-8' charset
[RFC2279] and MAY support additional charsets provided that they
are registered with IANA [IANA-CS]. If the Printer object does not
support the client supplied charset value, the Printer object MUST
reject the request, set the "attributes-charset" to 'utf-8' in the
response, and return the 'client-error-charset-not-supported'
status code and any 'text' or 'name' attributes using the 'utf-8'
charset. The Printer NEED NOT return any attributes in the
Unsupported Attributes Group (See sections 3.1.7 and 3.2.1.2). The
Printer object MUST indicate the charset(s) supported as the values
of the "charset-supported" Printer attribute (see Section 4.4.18),
so that the client can query to determine which charset(s) are
supported.
Note to client implementers: Since IPP objects are only required to
support the 'utf-8' charset, in order to maximize interoperability
with multiple IPP object implementations, a client may want to
supply 'utf-8' in the "attributes-charset" operation attribute,
even though the client is only passing and able to present a
simpler charset, such as US-ASCII or ISO-8859-1. Then the client
will have to filter out (or charset convert) those characters that
are returned in the response that it cannot present to its user.
On the other hand, if both the client and the IPP objects also
support a charset in common besides utf-8, the client may want to
use that charset in order to avoid charset conversion or data loss.
See the 'charset' attribute syntax description in Section 4.1.7 for "attributes-charset" (charset):
the syntax and semantic interpretation of the values of this This operation attribute identifies the charset (coded
attribute and for example values. character set and encoding method) used by any 'text' and
'name' attributes that the client is supplying in this request.
It also identifies the charset that the Printer object MUST use
(if supported) for all 'text' and 'name' attributes and status
messages that the Printer object returns in the response to
this request. See Sections 4.1.1 and 4.1.2 for the definition
of the 'text' and 'name' attribute syntaxes.
"attributes-natural-language" (naturalLanguage): All clients and IPP objects MUST support the 'utf-8' charset
This operation attribute identifies the natural language used by [RFC2279] and MAY support additional charsets provided that
any 'text' and 'name' attributes that the client is supplying in they are registered with IANA [IANA-CS]. If the Printer object
this request. This attribute also identifies the natural language does not support the client supplied charset value, the Printer
that the Printer object SHOULD use for all 'text' and 'name' object MUST reject the request, set the "attributes-charset" to
'utf-8' in the response, and return the 'client-error-charset-
not-supported' status code and any 'text' or 'name' attributes
using the 'utf-8' charset. The Printer NEED NOT return any
attributes in the Unsupported Attributes Group (See sections
3.1.7 and 3.2.1.2). The Printer object MUST indicate the
charset(s) supported as the values of the "charset-supported"
Printer attribute (see Section 4.4.18), so that the client can
query to determine which charset(s) are supported.
Expires September 1, 2000 Note to client implementers: Since IPP objects are only
attributes and status messages that the Printer object returns in required to support the 'utf-8' charset, in order to maximize
the response to this request. interoperability with multiple IPP object implementations, a
client may want to supply 'utf-8' in the "attributes-charset"
operation attribute, even though the client is only passing and
able to present a simpler charset, such as US-ASCII [ASCII] or
ISO-8859-1 [ISO8859-1]. Then the client will have to filter
out (or charset convert) those characters that are returned in
the response that it cannot present to its user. On the other
hand, if both the client and the IPP objects also support a
charset in common besides utf-8, the client may want to use
that charset in order to avoid charset conversion or data loss.
There are no REQUIRED natural languages required for the Printer See the 'charset' attribute syntax description in Section 4.1.7
object to support. However, the Printer object's "generated- for the syntax and semantic interpretation of the values of
natural-language-supported" attribute identifies the natural this attribute and for example values.
languages supported by the Printer object and any contained Job
objects for all text strings generated by the IPP object. A client
MAY query this attribute to determine which natural language(s) are
supported for generated messages.
For any of the attributes for which the Printer object generates "attributes-natural-language" (naturalLanguage):
text, i.e., for the "job-state-message", "printer-state-message", This operation attribute identifies the natural language used
and status messages (see Section 3.1.6), the Printer object MUST be by any 'text' and 'name' attributes that the client is
able to generate these text strings in any of its supported natural supplying in this request. This attribute also identifies the
languages. If the client requests a natural language that is not natural language that the Printer object SHOULD use for all
supported, the Printer object MUST return these generated messages 'text' and 'name' attributes and status messages that the
in the Printer's configured natural language as specified by the Printer object returns in the response to this request. See
Printer's "natural-language-configured" attribute" (see Section the 'naturalLanguage' attribute syntax description in section
4.4.19). 4.1.8 for the syntax and semantic interpretation of the values
of this attribute and for example values.
For other 'text' and 'name' attributes supplied by the client, There are no REQUIRED natural languages required for the
authentication system, operator, system administrator, or Printer object to support. However, the Printer object's
manufacturer (i.e., for "job-originating-user-name", "printer-name" "generated-natural-language-supported" attribute identifies the
(name), "printer-location" (text), "printer-info" (text), and natural languages supported by the Printer object and any
"printer-make-and-model" (text)), the Printer object is only contained Job objects for all text strings generated by the IPP
required to support the configured natural language of the Printer object. A client MAY query this attribute to determine which
identified by the Printer object's "natural-language-configured" natural language(s) are supported for generated messages.
attribute, though support of additional natural languages for these
attributes is permitted.
For any 'text' or 'name' attribute in the request that is in a For any of the attributes for which the Printer object
different natural language than the value supplied in the generates text, i.e., for the "job-state-message", "printer-
"attributes-natural-language" operation attribute, the client MUST state-message", and status messages (see Section 3.1.6), the
use the Natural Language Override mechanism (see sections 4.1.1.2 Printer object MUST be able to generate these text strings in
and 4.1.2.2) for each such attribute value supplied. The client any of its supported natural languages. If the client requests
MAY use the Natural Language Override mechanism redundantly, i.e., a natural language that is not supported, the Printer object
use it even when the value is in the same natural language as the MUST return these generated messages in the Printer's
value supplied in the "attributes-natural-language" operation configured natural language as specified by the Printer's
attribute of the request. "natural-language-configured" attribute" (see Section 4.4.19).
The IPP object MUST accept any natural language and any Natural For other 'text' and 'name' attributes supplied by the client,
Language Override, whether the IPP object supports that natural authentication system, operator, system administrator, or
language or not (and independent of the value of the "ipp- manufacturer (i.e., for "job-originating-user-name", "printer-
attribute-fidelity" Operation attribute). That is the IPP object name" (name), "printer-location" (text), "printer-info" (text),
accepts all client supplied values no matter what the values are in and "printer-make-and-model" (text)), the Printer object is
the Printer object's "generated-natural-language-supported" only required to support the configured natural language of the
attribute. That attribute, "generated-natural-language-supported", Printer identified by the Printer object's "natural-language-
only applies to generated messages, not client supplied messages. configured" attribute, though support of additional natural
The IPP object MUST remember that natural language for all client- languages for these attributes is permitted.
supplied attributes, and when returning those attributes in
response to a query, the IPP object MUST indicate that natural
language.
Expires September 1, 2000 For any 'text' or 'name' attribute in the request that is in a
Each value whose attribute syntax type is 'text' or 'name' (see different natural language than the value supplied in the
sections 4.1.1 and 4.1.2) has an Associated Natural-Language. This "attributes-natural-language" operation attribute, the client
document does not specify how this association is stored in a MUST use the Natural Language Override mechanism (see sections
Printer or Job object. When such a value is encoded in a request 4.1.1.2 and 4.1.2.2) for each such attribute value supplied.
or response, the natural language is either implicit or explicit: The client MAY use the Natural Language Override mechanism
redundantly, i.e., use it even when the value is in the same
natural language as the value supplied in the "attributes-
natural-language" operation attribute of the request.
@ In the implicit case, the value contains only the text/name The IPP object MUST accept any natural language and any Natural
value, and the language is specified by the "attributes- Language Override, whether the IPP object supports that natural
natural-language" operation attribute in the request or language or not (and independent of the value of the "ipp-
response (see sections 4.1.1.1 textWithoutLanguage and 4.1.2.1 attribute-fidelity" Operation attribute). That is the IPP
nameWithoutLanguage). object accepts all client supplied values no matter what the
values are in the Printer object's "generated-natural-
language-supported" attribute. That attribute, "generated-
natural-language-supported", only applies to generated
messages, not client supplied messages. The IPP object MUST
remember that natural language for all client-supplied
attributes, and when returning those attributes in response to
a query, the IPP object MUST indicate that natural language.
@ In the explicit case (also known as the Natural-Language Each value whose attribute syntax type is 'text' or 'name' (see
Override case), the value contains both the language and the sections 4.1.1 and 4.1.2) has an Associated Natural-Language.
text/name value (see sections 4.1.1.2 textWithLanguage and This document does not specify how this association is stored
4.1.2.2 nameWithLanguage). in a Printer or Job object. When such a value is encoded in a
request or response, the natural language is either implicit or
explicit:
For example, the "job-name" attribute MAY be supplied by the client - In the implicit case, the value contains only the text/name
in a create request. The text value for this attribute will be in value, and the language is specified by the "attributes-
the natural language identified by the "attribute-natural-language" natural-language" operation attribute in the request or
attribute, or if different, as identified by the Natural Language response (see sections 4.1.1.1 textWithoutLanguage and
Override mechanism. If supplied, the IPP object will use the value 4.1.2.1 nameWithoutLanguage).
of the "job-name" attribute to populate the Job object's "job-name"
attribute. Whenever any client queries the Job object's "job-name"
attribute, the IPP object returns the attribute as stored and uses
the Natural Language Override mechanism to specify the natural
language, if it is different from that reported in the "attributes-
natural-language" operation attribute of the response. The IPP
object MAY use the Natural Language Override mechanism redundantly,
i.e., use it even when the value is in the same natural language
as the value supplied in the "attributes-natural-language"
operation attribute of the response.
An IPP object MUST NOT reject a request based on a supplied natural - In the explicit case (also known as the Natural-Language
language in an "attributes-natural-language" Operation attribute or Override case), the value contains both the language and the
in any attribute that uses the Natural Language Override. text/name value (see sections 4.1.1.2 textWithLanguage and
4.1.2.2 nameWithLanguage).
See the 'naturalLanguage' attribute syntax description in section For example, the "job-name" attribute MAY be supplied by the
4.1.8 for the syntax and semantic interpretation of the values of client in a create request. The text value for this attribute
this attribute and for example values. will be in the natural language identified by the "attribute-
natural-language" attribute, or if different, as identified by
the Natural Language Override mechanism. If supplied, the IPP
object will use the value of the "job-name" attribute to
populate the Job object's "job-name" attribute. Whenever any
client queries the Job object's "job-name" attribute, the IPP
object returns the attribute as stored and uses the Natural
Language Override mechanism to specify the natural language, if
it is different from that reported in the "attributes-natural-
language" operation attribute of the response. The IPP object
MAY use the Natural Language Override mechanism redundantly,
i.e., use it even when the value is in the same natural
language as the value supplied in the "attributes-natural-
language" operation attribute of the response.
Clients SHOULD NOT supply 'text' or 'name' attributes that use an An IPP object MUST NOT reject a request based on a supplied
illegal combination of natural language and charset. For example, natural language in an "attributes-natural-language" Operation
suppose a Printer object supports charsets 'utf-8', 'iso-8859-1', and attribute or in any attribute that uses the Natural Language
'iso-8859-7'. Suppose also, that it supports natural languages 'en' Override.
(English), 'fr' (French), and 'el' (Greek). Although the Printer object
supports the charset 'iso-8859-1' and natural language 'el', it probably
does not support the combination of Greek text strings using the 'iso-
8859-1' charset. The Printer object handles this apparent
incompatibility differently depending on the context in which it occurs:
- In a create request: If the client supplies a text or name Clients SHOULD NOT supply 'text' or 'name' attributes that use an
attribute (for example, the "job-name" operation attribute) that illegal combination of natural language and charset. For example,
uses an apparently incompatible combination, it is a client choice suppose a Printer object supports charsets 'utf-8', 'iso-8859-1', and
'iso-8859-7'. Suppose also, that it supports natural languages 'en'
(English), 'fr' (French), and 'el' (Greek). Although the Printer
object supports the charset 'iso-8859-1' and natural language 'el',
it probably does not support the combination of Greek text strings
using the 'iso-8859-1' charset. The Printer object handles this
apparent incompatibility differently depending on the context in
which it occurs:
Expires September 1, 2000 - In a create request: If the client supplies a text or name
that does not affect the Printer object or its correct operation. attribute (for example, the "job-name" operation attribute) that
Therefore, the Printer object simply accepts the client supplied uses an apparently incompatible combination, it is a client
value, stores it with the Job object, and responds back with the choice that does not affect the Printer object or its correct
same combination whenever the client (or any client) queries for operation. Therefore, the Printer object simply accepts the
that attribute. client supplied value, stores it with the Job object, and
- In a query-type operation, like Get-Printer-Attributes: If the responds back with the same combination whenever the client (or
client requests an apparently incompatible combination, the Printer any client) queries for that attribute.
object responds (as described in section 3.1.4.2) using the - In a query-type operation, like Get-Printer-Attributes: If the
Printer's configured natural language rather than the natural client requests an apparently incompatible combination, the
language requested by the client. Printer object responds (as described in section 3.1.4.2) using
the Printer's configured natural language rather than the
natural language requested by the client.
In either case, the Printer object does not reject the request because In either case, the Printer object does not reject the request
of the apparent incompatibility. The potential incompatible combination because of the apparent incompatibility. The potential incompatible
of charset and natural language can occur either at the global operation combination of charset and natural language can occur either at the
level or at the Natural Language Override attribute-by-attribute level. global operation level or at the Natural Language Override
In addition, since the response always includes explicit charset and attribute-by-attribute level. In addition, since the response always
natural language information, there is never any question or ambiguity includes explicit charset and natural language information, there is
in how the client interprets the response. never any question or ambiguity in how the client interprets the
response.
3.1.4.2 Response Operation Attributes 3.1.4.2 Response Operation Attributes
The Printer object MUST supply and the client MUST support the following The Printer object MUST supply and the client MUST support the
REQUIRED operation attributes in every IPP/1.1 operation response: following REQUIRED operation attributes in every IPP/1.1 operation
response:
"attributes-charset" (charset):
This operation attribute identifies the charset used by any 'text'
and 'name' attributes that the Printer object is returning in this
response. The value in this response MUST be the same value as the
"attributes-charset" operation attribute supplied by the client in
the request. If this is not possible (i.e., the charset requested
is not supported), the request would have been rejected. See
"attributes-charset" described in Section 3.1.4.1 above.
If the Printer object supports more than just the 'utf-8' charset, "attributes-charset" (charset):
the Printer object MUST be able to code convert between each of the This operation attribute identifies the charset used by any
charsets supported on a highest fidelity possible basis in order to 'text' and 'name' attributes that the Printer object is
return the 'text' and 'name' attributes in the charset requested by returning in this response. The value in this response MUST be
the client. However, some information loss MAY occur during the the same value as the "attributes-charset" operation attribute
charset conversion depending on the charsets involved. For supplied by the client in the request. If this is not possible
example, the Printer object may convert from a UTF-8 'a' to a US- (i.e., the charset requested is not supported), the request
ASCII 'a' (with no loss of information), from an ISO Latin 1 would have been rejected. See "attributes-charset" described
CAPITAL LETTER A WITH ACUTE ACCENT to US-ASCII 'A' (losing the in Section 3.1.4.1 above.
accent), or from a UTF-8 Japanese Kanji character to some ISO Latin
1 error character indication such as '?', decimal code equivalent,
or to the absence of a character, depending on implementation.
Whether an implementation that supports more than one charset If the Printer object supports more than just the 'utf-8'
stores the data in the charset supplied by the client or code charset, the Printer object MUST be able to code convert
converts to one of the other supported charsets, depends on between each of the charsets supported on a highest fidelity
implementation. The strategy should try to minimize loss of possible basis in order to return the 'text' and 'name'
information during code conversion. On each response, such an attributes in the charset requested by the client. However,
implementation converts from its internal charset to that some information loss MAY occur during the charset conversion
requested. depending on the charsets involved. For example, the Printer
object may convert from a UTF-8 'a' to a US-ASCII 'a' (with no
loss of information), from an ISO Latin 1 CAPITAL LETTER A WITH
ACUTE ACCENT to US-ASCII 'A' (losing the accent), or from a
UTF-8 Japanese Kanji character to some ISO Latin 1 error
character indication such as '?', decimal code equivalent, or
to the absence of a character, depending on implementation.
Expires September 1, 2000 Whether an implementation that supports more than one charset
stores the data in the charset supplied by the client or code
converts to one of the other supported charsets, depends on
implementation. The strategy should try to minimize loss of
information during code conversion. On each response, such an
implementation converts from its internal charset to that
requested.
"attributes-natural-language" (naturalLanguage): "attributes-natural-language" (naturalLanguage):
This operation attribute identifies the natural language used by This operation attribute identifies the natural language used
any 'text' and 'name' attributes that the IPP object is returning by any 'text' and 'name' attributes that the IPP object is
in this response. Unlike the "attributes-charset" operation returning in this response. Unlike the "attributes-charset"
attribute, the IPP object NEED NOT return the same value as that operation attribute, the IPP object NEED NOT return the same
supplied by the client in the request. The IPP object MAY return value as that supplied by the client in the request. The IPP
the natural language of the Job object or the Printer's configured object MAY return the natural language of the Job object or the
natural language as identified by the Printer object's "natural- Printer's configured natural language as identified by the
language-configured" attribute, rather than the natural language Printer object's "natural-language-configured" attribute,
supplied by the client. For any 'text' or 'name' attribute or rather than the natural language supplied by the client. For
status message in the response that is in a different natural any 'text' or 'name' attribute or status message in the
language than the value returned in the "attributes-natural- response that is in a different natural language than the value
language" operation attribute, the IPP object MUST use the Natural returned in the "attributes-natural-language" operation
Language Override mechanism (see sections 4.1.1.2 and 4.1.2.2) on attribute, the IPP object MUST use the Natural Language
each attribute value returned. The IPP object MAY use the Natural Override mechanism (see sections 4.1.1.2 and 4.1.2.2) on each
Language Override mechanism redundantly, i.e., use it even when the attribute value returned. The IPP object MAY use the Natural
value is in the same natural language as the value supplied in the Language Override mechanism redundantly, i.e., use it even when
"attributes-natural-language" operation attribute of the response. the value is in the same natural language as the value supplied
in the "attributes-natural-language" operation attribute of the
response.
3.1.5 Operation Targets 3.1.5 Operation Targets
All IPP operations are directed at IPP objects. For Printer operations, All IPP operations are directed at IPP objects. For Printer
the operation is always directed at a Printer object using one of its operations, the operation is always directed at a Printer object
URIs (i.e., one of the values in the Printer object's "printer-uri- using one of its URIs (i.e., one of the values in the Printer
supported" attribute). Even if the Printer object supports more than object's "printer-uri-supported" attribute). Even if the Printer
one URI, the client supplies only one URI as the target of the object supports more than one URI, the client supplies only one URI
operation. The client identifies the target object by supplying the as the target of the operation. The client identifies the target
correct URI in the "printer-uri (uri)" operation attribute. object by supplying the correct URI in the "printer-uri (uri)"
operation attribute.
For Job operations, the operation is directed at either: For Job operations, the operation is directed at either:
- The Job object itself using the Job object's URI. In this case, - The Job object itself using the Job object's URI. In this case,
the client identifies the target object by supplying the correct the client identifies the target object by supplying the correct
URI in the "job-uri (uri)" operation attribute. URI in the "job-uri (uri)" operation attribute.
- The Printer object that created the Job object using both the - The Printer object that created the Job object using both the
Printer objects URI and the Job object's Job ID. Since the Printer Printer objects URI and the Job object's Job ID. Since the
object that created the Job object generated the Job ID, it MUST be Printer object that created the Job object generated the Job ID,
able to correctly associate the client supplied Job ID with the it MUST be able to correctly associate the client supplied Job
correct Job object. The client supplies the Printer object's URI ID with the correct Job object. The client supplies the Printer
in the "printer-uri (uri)" operation attribute and the Job object's object's URI in the "printer-uri (uri)" operation attribute and
Job ID in the "job-id (integer(1:MAX))" operation attribute. the Job object's Job ID in the "job-id (integer(1:MAX))"
operation attribute.
If the operation is directed at the Job object directly using the Job If the operation is directed at the Job object directly using the Job
object's URI, the client MUST NOT include the redundant "job-id" object's URI, the client MUST NOT include the redundant "job-id"
operation attribute. operation attribute.
The operation target attributes are REQUIRED operation attributes that The operation target attributes are REQUIRED operation attributes
MUST be included in every operation request. Like the charset and that MUST be included in every operation request. Like the charset
natural language attributes (see section 3.1.4), the operation target and natural language attributes (see section 3.1.4), the operation
attributes are specially ordered operation attributes. In all cases, target attributes are specially ordered operation attributes. In all
the operation target attributes immediately follow the "attributes- cases, the operation target attributes immediately follow the
charset" and "attributes-natural-language" attributes within the "attributes-charset" and "attributes-natural-language" attributes
operation attribute group, however the specific ordering rules are: within the operation attribute group, however the specific ordering
rules are:
Expires September 1, 2000 - In the case where there is only one operation target attribute
- In the case where there is only one operation target attribute (i.e., either only the "printer-uri" attribute or only the
(i.e., either only the "printer-uri" attribute or only the "job- "job-uri" attribute), that attribute MUST be the third attribute
uri" attribute), that attribute MUST be the third attribute in the in the operation attributes group.
operation attributes group. - In the case where Job operations use two operation target
- In the case where Job operations use two operation target attributes (i.e., the "printer-uri" and "job-id" attributes),
attributes (i.e., the "printer-uri" and "job-id" attributes), the the "printer-uri" attribute MUST be the third attribute and the
"printer-uri" attribute MUST be the third attribute and the "job- "job-id" attribute MUST be the fourth attribute.
id" attribute MUST be the fourth attribute.
In all cases, the target URIs contained within the body of IPP operation In all cases, the target URIs contained within the body of IPP
requests and responses must be in absolute format rather than relative operation requests and responses must be in absolute format rather
format (a relative URL identifies a resource with the scope of the HTTP than relative format (a relative URL identifies a resource with the
server, but does not include scheme, host or port). scope of the HTTP server, but does not include scheme, host or port).
The following rules apply to the use of port numbers in URIs that The following rules apply to the use of port numbers in URIs that
identify IPP objects: identify IPP objects:
1. If the URI scheme allows the port number to be explicitly included 1. If the URI scheme allows the port number to be explicitly
in the URI string, and a port number is specified within the URI, included in the URI string, and a port number is specified
then that port number MUST be used by the client to contact the IPP within the URI, then that port number MUST be used by the
object. client to contact the IPP object.
2. If the URI scheme allows the port number to be explicitly included 2. If the URI scheme allows the port number to be explicitly
in the URI string, and a port number is not specified within the included in the URI string, and a port number is not specified
URI, then default port number implied by that URI scheme MUST be within the URI, then default port number implied by that URI
used by the client to contact the IPP object. scheme MUST be used by the client to contact the IPP object.
3. If the URI scheme does not allow an explicit port number to be 3. If the URI scheme does not allow an explicit port number to be
specified within the URI, then the default port number implied by specified within the URI, then the default port number implied
that URI MUST be used by the client to contact the IPP object. by that URI MUST be used by the client to contact the IPP
object.
Note: The IPP "Encoding and Transport document [IPP-PRO] shows a mapping Note: The IPP "Encoding and Transport document [RFC2910] shows a
of IPP onto HTTP/1.1 [RFC2616] and defines a new default port number for mapping of IPP onto HTTP/1.1 [RFC2616] and defines a new default port
using IPP over HTTP/1.1. number for using IPP over HTTP/1.1.
3.1.6 Operation Response Status Codes and Status Messages 3.1.6 Operation Response Status Codes and Status Messages
Every operation response includes a REQUIRED "status-code" parameter and Every operation response includes a REQUIRED "status-code" parameter
an OPTIONAL "status-message" operation attribute, and an OPTIONAL and an OPTIONAL "status-message" operation attribute, and an OPTIONAL
"detailed-status-message" operation attribute. The Print-URI and Send- "detailed-status-message" operation attribute. The Print-URI and
URI response MAY include an OPTIONAL "document-access-error" operation Send-URI response MAY include an OPTIONAL "document-access-error"
attribute. operation attribute.
3.1.6.1 "status-code" (type2 enum) 3.1.6.1 "status-code" (type2 enum)
The REQUIRED "status-code" parameter provides information on the The REQUIRED "status-code" parameter provides information on the
processing of a request. processing of a request.
The status code is intended for use by automata. A client The status code is intended for use by automata. A client
implementation of IPP SHOULD convert status code values into any implementation of IPP SHOULD convert status code values into any
localized message that has semantic meaning to the end user. localized message that has semantic meaning to the end user.
Expires September 1, 2000 The "status-code" value is a numeric value that has semantic meaning.
The "status-code" value is a numeric value that has semantic meaning. The "status-code" syntax is similar to a "type2 enum" (see section
The "status-code" syntax is similar to a "type2 enum" (see section 4.1 4.1 on "Attribute Syntaxes") except that values can range only from
on "Attribute Syntaxes") except that values can range only from 0x0000 0x0000 to 0x7FFF. Section 13 describes the status codes, assigns the
to 0x7FFF. Section 13 describes the status codes, assigns the numeric numeric values, and suggests a corresponding status message for each
values, and suggests a corresponding status message for each status code status code for use by the client when the user's natural language is
for use by the client when the user's natural language is English. English.
If the Printer performs an operation with no errors and it encounters no If the Printer performs an operation with no errors and it encounters
problems, it MUST return the status code 'successful-ok' in the no problems, it MUST return the status code 'successful-ok' in the
response. See section 13. response. See section 13.
If the client supplies unsupported values for the following parameters If the client supplies unsupported values for the following
or Operation attributes, the Printer object MUST reject the operation, parameters or Operation attributes, the Printer object MUST reject
NEED NOT return the unsupported attribute value in the Unsupported the operation, NEED NOT return the unsupported attribute value in the
Attributes group, and MUST return the indicated status code: Unsupported Attributes group, and MUST return the indicated status
code:
Parameter/Attribute Status code Parameter/Attribute Status code
version-number server-error-version-not-supported version-number server-error-version-not-supported
operation-id server-error-operation-not-supported operation-id server-error-operation-not-supported
attributes-charset client-error-charset-not-supported attributes-charset client-error-charset-not-supported
compression client-error-compression-not-supported compression client-error-compression-not-supported
document-format client-error-document-format-not-supported document-format client-error-document-format-not-supported
document-uri client-error-uri-scheme-not-supported, document-uri client-error-uri-scheme-not-supported,
client-error-document-access-error client-error-document-access-error
If the client supplies unsupported values for other attributes, or If the client supplies unsupported values for other attributes, or
unsupported attributes, the Printer returns the status code defined in unsupported attributes, the Printer returns the status code defined
section 3.1.7 on Unsupported Attributes. in section 3.1.7 on Unsupported Attributes.
3.1.6.2 "status-message" (text(255)) 3.1.6.2 "status-message" (text(255))
The OPTIONAL "status-message" operation attribute provides a short The OPTIONAL "status-message" operation attribute provides a short
textual description of the status of the operation. The "status- textual description of the status of the operation. The "status-
message" attribute's syntax is "text(255)", so the maximum length is 255 message" attribute's syntax is "text(255)", so the maximum length is
octets (see section 4.1.1). The status message is intended for the 255 octets (see section 4.1.1). The status message is intended for
human end user. If a response does include a "status-message" the human end user. If a response does include a "status-message"
attribute, an IPP client NEED NOT examine or display the messages, attribute, an IPP client NEED NOT examine or display the messages,
however it SHOULD do so in some implementation specific manner. The however it SHOULD do so in some implementation specific manner. The
"status-message" is especially useful for a later version of a Printer "status-message" is especially useful for a later version of a
object to return as supplemental information for the human user to Printer object to return as supplemental information for the human
accompany a status code that an earlier version of a client might not user to accompany a status code that an earlier version of a client
understand. might not understand.
If the Printer object supports the "status-message" operation attribute, If the Printer object supports the "status-message" operation
the Printer object MUST be able to generate this message in any of the attribute, the Printer object MUST be able to generate this message
natural languages identified by the Printer object's "generated-natural- in any of the natural languages identified by the Printer object's
language-supported" attribute (see the "attributes-natural-language" "generated-natural-language-supported" attribute (see the
operation attribute specified in section 3.1.4.1. Section 13 suggests "attributes-natural-language" operation attribute specified in
the text for the status message returned by the Printer for use with the section 3.1.4.1. Section 13 suggests the text for the status message
English natural language. returned by the Printer for use with the English natural language.
Expires September 1, 2000 As described in section 3.1.4.1 for any returned 'text' attribute, if
As described in section 3.1.4.1 for any returned 'text' attribute, if there is a choice for generating this message, the Printer object
there is a choice for generating this message, the Printer object uses uses the natural language indicated by the value of the "attributes-
the natural language indicated by the value of the "attributes-natural- natural-language" in the client request if supported, otherwise the
language" in the client request if supported, otherwise the Printer Printer object uses the value in the Printer object's own "natural-
object uses the value in the Printer object's own "natural-language- language-configured" attribute.
configured" attribute.
If the Printer object supports the "status-message" operation attribute, If the Printer object supports the "status-message" operation
it SHOULD use the REQUIRED 'utf-8' charset to return a status message attribute, it SHOULD use the REQUIRED 'utf-8' charset to return a
for the following error status codes (see section 13): 'client-error- status message for the following error status codes (see section 13):
bad-request', 'client-error-charset-not-supported', 'server-error- 'client-error-bad-request', 'client-error-charset-not-supported',
internal-error', 'server-error-operation-not-supported', and 'server- 'server-error-internal-error', 'server-error-operation-not-
error-version-not-supported'. In this case, it MUST set the value of supported', and 'server-error-version-not-supported'. In this case,
the "attributes-charset" operation attribute to 'utf-8' in the error it MUST set the value of the "attributes-charset" operation attribute
response. to 'utf-8' in the error response.
3.1.6.3 "detailed-status-message" (text(MAX)) 3.1.6.3 "detailed-status-message" (text(MAX))
The OPTIONAL "detailed-status-message" operation attribute provides The OPTIONAL "detailed-status-message" operation attribute provides
additional more detailed technical and implementation-specific additional more detailed technical and implementation-specific
information about the operation. The "detailed-status-message" information about the operation. The "detailed-status-message"
attribute's syntax is "text(MAX)", so the maximum length is 1023 octets attribute's syntax is "text(MAX)", so the maximum length is 1023
(see section 4.1.1). If the Printer objects supports the "detailed- octets (see section 4.1.1). If the Printer objects supports the
status-message" operation attribute, neither the Printer nor the client "detailed-status-message" operation attribute, the Printer NEED NOT
localizes the message, since it is intended for use by the system localize the message, since it is intended for use by the system
administrator or other experienced technical persons. Clients MUST NOT administrator or other experienced technical persons. Localization
attempt to parse the value of this attribute. See the "document-access- might obscure the technical meaning of such messages. Clients MUST
error" operation attribute (section 3.1.6.4) for additional errors that NOT attempt to parse the value of this attribute. See the
a program can process. "document-access-error" operation attribute (section 3.1.6.4) for
additional errors that a program can process.
3.1.6.4 "document-access-error" (text(MAX)) 3.1.6.4 "document-access-error" (text(MAX))
This OPTIONAL operation attribute provides additional information about This OPTIONAL operation attribute provides additional information
any document access errors encountered by the Printer before it returned about any document access errors encountered by the Printer before it
a response to the Print-URI (section 3.2.2) or Send-URI (section 3.3.1) returned a response to the Print-URI (section 3.2.2) or Send-URI
operation. For errors in the protocol identified by the URI scheme in (section 3.3.1) operation. For errors in the protocol identified by
the "document-uri" operation attribute, such as 'http:' or 'ftp:', the the URI scheme in the "document-uri" operation attribute, such as
error code is returned in parentheses, followed by the URI. For 'http:' or 'ftp:', the error code is returned in parentheses,
example: followed by the URI. For example:
(404) http://ftp.pwg.org/pub/pwg/ipp/new_MOD/ipp-model-v11- (404) http://ftp.pwg.org/pub/pwg/ipp/new_MOD/ipp-model-v11.pdf
990510.pdf
Most Internet protocols use decimal error codes (unlike IPP), so the Most Internet protocols use decimal error codes (unlike IPP), so the
ASCII error code representation is in decimal. ASCII error code representation is in decimal.
3.1.7 Unsupported Attributes 3.1.7 Unsupported Attributes
The Unsupported Attributes group contains attributes that are not The Unsupported Attributes group contains attributes that are not
supported by the operation. This group is primarily for the job creation supported by the operation. This group is primarily for the job
operations, but all operations can return this group. creation operations, but all operations can return this group.
Expires September 1, 2000 A Printer object MUST include an Unsupported Attributes group in a
A Printer object MUST include an Unsupported Attributes group in a response if the status code is one of the following: 'successful-
response if the status code is one of the following: 'successful-ok- ok-ignored-or-substituted-attributes', 'successful-ok-conflicting-
ignored-or-substituted-attributes', 'successful-ok-conflicting- attributes', 'client-error-attributes-or-values-not-supported' or
attributes', 'client-error-attributes-or-values-not-supported' or 'client-error-conflicting-attributes'.
'client-error-conflicting-attributes'.
If the status code is one of the four specified in the preceding If the status code is one of the four specified in the preceding
paragraph, the Unsupported Attributes group MUST contain all of those paragraph, the Unsupported Attributes group MUST contain all of those
attributes and only those attributes that are: attributes and only those attributes that are:
a. an Operation or Job Template attribute supplied in the request, and a. an Operation or Job Template attribute supplied in the request,
and
b. unsupported by the printer. See below for details on the three b. unsupported by the printer. See below for details on the three
categories "unsupported" attributes. categories "unsupported" attributes.
If the status code is one of those in the table in section 3.1.6.1, the If the status code is one of those in the table in section 3.1.6.1,
Unsupported Attributes group NEED NOT contain the unsupported parameter the Unsupported Attributes group NEED NOT contain the unsupported
or attribute indicated in that table. parameter or attribute indicated in that table.
If the Printer object is not returning any Unsupported Attributes in the If the Printer object is not returning any Unsupported Attributes in
response, the Printer object SHOULD omit Group 2 rather than sending an the response, the Printer object SHOULD omit Group 2 rather than
empty group. However, a client MUST be able to accept an empty group. sending an empty group. However, a client MUST be able to accept an
empty group.
Unsupported attributes fall into three categories: Unsupported attributes fall into three categories:
1. The Printer object does not support the supplied attribute (no 1. The Printer object does not support the supplied attribute (no
matter what the attribute syntax or value). matter what the attribute syntax or value).
2. The Printer object does support the attribute, but does not support 2. The Printer object does support the attribute, but does not
some or all of the particular attribute syntaxes or values supplied support some or all of the particular attribute syntaxes or
by the client (i.e., the Printer object does not have those values supplied by the client (i.e., the Printer object does
attribute syntaxes or values in its corresponding "xxx-supported" not have those attribute syntaxes or values in its
attribute). corresponding "xxx-supported" attribute).
3. The Printer object does support the attributes and values supplied, 3. The Printer object does support the attributes and values
but the particular values are in conflict with one another, because supplied, but the particular values are in conflict with one
they violate a constraint, such as not being able to staple another, because they violate a constraint, such as not being
transparencies. able to staple transparencies.
In the case of an unsupported attribute name, the Printer object returns In the case of an unsupported attribute name, the Printer object
the client-supplied attribute with a substituted value of 'unsupported'. returns the client-supplied attribute with a substituted value of
This value's syntax type is "out-of-band" and its encoding is defined by 'unsupported'. This value's syntax type is "out-of-band" and its
special rules for "out-of-band" values in the "Encoding and Transport" encoding is defined by special rules for "out-of-band" values in the
document [IPP-PRO]. Its value indicates no support for the attribute "Encoding and Transport" document [RFC2910]. Its value indicates no
itself (see the beginning of section 4.1). support for the attribute itself (see the beginning of section 4.1).
In the case of a supported attribute with one or more unsupported In the case of a supported attribute with one or more unsupported
attribute syntaxes or values, the Printer object simply returns the attribute syntaxes or values, the Printer object simply returns the
client-supplied attribute with the unsupported attribute syntaxes or client-supplied attribute with the unsupported attribute syntaxes or
values as supplied by the client. This indicates support for the values as supplied by the client. This indicates support for the
attribute, but no support for that particular attribute syntax or value. attribute, but no support for that particular attribute syntax or
If the client supplies a multi-valued attribute with more than one value value. If the client supplies a multi-valued attribute with more
and the Printer object supports the attribute but only supports a subset than one value and the Printer object supports the attribute but only
of the client-supplied attribute syntaxes or values, the Printer object supports a subset of the client-supplied attribute syntaxes or
values, the Printer object
Expires September 1, 2000 MUST return only those attribute syntaxes or values that are
MUST return only those attribute syntaxes or values that are unsupported.
unsupported.
In the case of two (or more) supported attribute values that are in In the case of two (or more) supported attribute values that are in
conflict with one another (although each is supported independently, the conflict with one another (although each is supported independently,
values conflict when requested together within the same job), the the values conflict when requested together within the same job), the
Printer object MUST return all the values that it ignores or substitutes Printer object MUST return all the values that it ignores or
to resolve the conflict, but not any of the values that it is still substitutes to resolve the conflict, but not any of the values that
using. The choice for exactly how to resolve the conflict is it is still using. The choice for exactly how to resolve the
implementation dependent. See sections 3.2.1.2 and 15. See The conflict is implementation dependent. See sections 3.2.1.2 and 15.
Implementer's Guide [IPP-IIG] for an example. See The Implementer's Guide [IPP-IIG] for an example.
3.1.8 Versions 3.1.8 Versions
Each operation request and response carries with it a "version-number" Each operation request and response carries with it a "version-
parameter. Each value of the "version-number" is in the form "X.Y" number" parameter. Each value of the "version-number" is in the form
where X is the major version number and Y is the minor version number. "X.Y" where X is the major version number and Y is the minor version
By including a version number in the client request, it allows the number. By including a version number in the client request, it
client to identify which version of IPP it is interested in using, allows the client to identify which version of IPP it is interested
i.e., the version whose conformance requirements the client may be in using, i.e., the version whose conformance requirements the client
depending upon the Printer to meet. may be depending upon the Printer to meet.
If the IPP object does not support that major version number supplied by
the client, i.e., the major version field of the "version-number"
parameter does not match any of the values of the Printer's "ipp-
versions-supported" (see section 4.4.14), the object MUST respond with a
status code of 'server-error-version-not-supported' along with the
closest version number that is supported (see section 13.1.5.4). If the
major version number is supported, but the minor version number is not,
the IPP object SHOULD accept and attempt to perform the request (or
reject the request if the operation is not supported), else it rejects
the request and returns the 'server-error-version-not-supported' status
code. In all cases, the IPP object MUST return the "version-number"
that it supports that is closest to the version number supplied by the
client in the request.
There is no version negotiation per se. However, if after receiving a
'server-error-version-not-supported' status code from an IPP object, a
client SHOULD try again with a different version number. A client MAY
also determine the versions supported either from a directory that
conforms to Appendix E (see section 16) or by querying the Printer
object's "ipp-versions-supported" attribute (see section 4.4.14) to
determine which versions are supported.
An IPP object implementation MUST support version '1.1', i.e., meet the If the IPP object does not support that major version number supplied
conformance requirements for IPP/1.1 as specified in this document and by the client, i.e., the major version field of the "version-number"
[IPP-PRO]. It is recommended that IPP object implementations accept any parameter does not match any of the values of the Printer's "ipp-
request with the major version '1' (or reject the request if the versions-supported" (see section 4.4.14), the object MUST respond
operation is not supported). with a status code of 'server-error-version-not-supported' along with
the closest version number that is supported (see section 13.1.5.4).
If the major version number is supported, but the minor version
number is not, the IPP object SHOULD accept and attempt to perform
the request (or reject the request if the operation is not
supported), else it rejects the request and returns the 'server-
error-version-not-supported' status code. In all cases, the IPP
object MUST return the "version-number" that it supports that is
closest to the version number supplied by the client in the request.
There is only one notion of "version number" that covers both IPP Model There is no version negotiation per se. However, if after receiving
and IPP Protocol changes. Thus the version number MUST change when a 'server-error-version-not-supported' status code from an IPP
introducing a new version of the Model and Semantics document (this object, a client SHOULD try again with a different version number. A
client MAY also determine the versions supported either from a
directory that conforms to Appendix E (see section 16) or by querying
the Printer object's "ipp-versions-supported" attribute (see section
4.4.14) to determine which versions are supported.
Expires September 1, 2000 An IPP object implementation MUST support version '1.1', i.e., meet
document) or a new version of the "Encoding and Transport" document the conformance requirements for IPP/1.1 as specified in this
[IPP-PRO]. document and [RFC2910]. It is recommended that IPP object
implementations accept any request with the major version '1' (or
reject the request if the operation is not supported).
Changes to the major version number of the Model and Semantics document There is only one notion of "version number" that covers both IPP
indicate structural or syntactic changes that make it impossible for Model and IPP Protocol changes. Thus the version number MUST change
older version of IPP clients and Printer objects to correctly parse and when introducing a new version of the Model and Semantics document
correctly process the new or changed attributes, operations and (this document) or a new version of the "Encoding and Transport"
responses. If the major version number changes, the minor version document [RFC2910].
numbers is set to zero. As an example, adding the REQUIRED "ipp-
attribute-fidelity" attribute to version '1.1' (if it had not been part
of version '1.0'), would have required a change to the major version
number, since an IPP/1.0 Printer would not have processed a request with
the correct semantics that contained the "ipp-attribute-fidelity"
attribute that it did not know about. Items that might affect the
changing of the major version number include any changes to the Model
and Semantics document (this document) or the "Encoding and Transport"
document [IPP-PRO] itself, such as:
- reordering of ordered attributes or attribute sets Changes to the major version number of the Model and Semantics
- changes to the syntax of existing attributes document indicate structural or syntactic changes that make it
- adding REQUIRED (for an IPP object to support) operation attribute impossible for older version of IPP clients and Printer objects to
groups correctly parse and correctly process the new or changed attributes,
- adding values to existing REQUIRED operation attributes operations and responses. If the major version number changes, the
- adding REQUIRED operations minor version numbers is set to zero. As an example, adding the
REQUIRED "ipp-attribute-fidelity" attribute to version '1.1' (if it
had not been part of version '1.0'), would have required a change to
the major version number, since an IPP/1.0 Printer would not have
processed a request with the correct semantics that contained the
"ipp-attribute-fidelity" attribute that it did not know about. Items
that might affect the changing of the major version number include
any changes to the Model and Semantics document (this document) or
the "Encoding and Transport" document [RFC2910] itself, such as:
Changes to the minor version number indicate the addition of new - reordering of ordered attributes or attribute sets
features, attributes and attribute values that may not be understood by - changes to the syntax of existing attributes
all IPP objects, but which can be ignored if not understood. Items that - adding REQUIRED (for an IPP object to support) operation
might affect the changing of the minor version number include any attribute groups
changes to the model objects and attributes but not the encoding and - adding values to existing REQUIRED operation attributes
transport rules [IPP-PRO] (except adding attribute syntaxes). Examples - adding REQUIRED operations
of such changes are:
- grouping all extensions not included in a previous version into a Changes to the minor version number indicate the addition of new
new version features, attributes and attribute values that may not be understood
- adding new attribute values by all IPP objects, but which can be ignored if not understood.
- adding new object attributes Items that might affect the changing of the minor version number
- adding OPTIONAL (for an IPP object to support) operation attributes include any changes to the model objects and attributes but not the
(i.e., those attributes that an IPP object can ignore without encoding and transport rules [RFC2910] (except adding attribute
confusing clients) syntaxes). Examples of such changes are:
- adding OPTIONAL (for an IPP object to support) operation attribute
groups (i.e., those attributes that an IPP object can ignore
without confusing clients)
- adding new attribute syntaxes
- adding OPTIONAL operations
- changing Job Description attributes or Printer Description
attributes from OPTIONAL to REQUIRED or vice versa.
- adding OPTIONAL attribute syntaxes to an existing attribute.
The encoding of the "version-number" MUST NOT change over any version - grouping all extensions not included in a previous version into
number (either major or minor). This rule guarantees that all future a new version
versions will be backwards compatible with all previous versions (at - adding new attribute values
least for checking the "version-number"). In addition, any protocol - adding new object attributes
elements (attributes, error codes, tags, etc.) that are not carried - adding OPTIONAL (for an IPP object to support) operation
attributes (i.e., those attributes that an IPP object can ignore
without confusing clients)
- adding OPTIONAL (for an IPP object to support) operation
attribute groups (i.e., those attributes that an IPP object can
ignore without confusing clients)
- adding new attribute syntaxes
- adding OPTIONAL operations
- changing Job Description attributes or Printer Description
attributes from OPTIONAL to REQUIRED or vice versa.
- adding OPTIONAL attribute syntaxes to an existing attribute.
Expires September 1, 2000 The encoding of the "version-number" MUST NOT change over any version
forward from one version to the next are deprecated so that they can number (either major or minor). This rule guarantees that all future
never be reused with new semantics. versions will be backwards compatible with all previous versions (at
least for checking the "version-number"). In addition, any protocol
elements (attributes, error codes, tags, etc.) that are not carried
forward from one version to the next are deprecated so that they can
never be reused with new semantics.
Implementations that support a certain version NEED NOT support ALL Implementations that support a certain version NEED NOT support ALL
previous versions. As each new version is defined (through the release previous versions. As each new version is defined (through the
of a new IPP specification document), that version will specify which release of a new IPP specification document), that version will
previous versions MUST and which versions SHOULD be supported in specify which previous versions MUST and which versions SHOULD be
compliant implementations. supported in compliant implementations.
3.1.9 Job Creation Operations 3.1.9 Job Creation Operations
In order to "submit a print job" and create a new Job object, a client In order to "submit a print job" and create a new Job object, a
issues a create request. A create request is any one of following three client issues a create request. A create request is any one of
operation requests: following three operation requests:
- The Print-Job Request: A client that wants to submit a print job
with only a single document uses the Print-Job operation. The
operation allows for the client to "push" the document data to the
Printer object by including the document data in the request
itself.
- The Print-URI Request: A client that wants to submit a print job
with only a single document (where the Printer object "pulls" the
document data instead of the client "pushing" the data to the
Printer object) uses the Print-URI operation. In this case, the
client includes in the request only a URI reference to the document
data (not the document data itself).
- The Create-Job Request: A client that wants to submit a print job - The Print-Job Request: A client that wants to submit a print job
with multiple documents uses the Create-Job operation. This with only a single document uses the Print-Job operation. The
operation is followed by an arbitrary number of Send-Document operation allows for the client to "push" the document data to
and/or Send-URI operations (each creating another document for the the Printer object by including the document data in the request
newly create Job object). The Send-Document operation includes the itself.
document data in the request (the client "pushes" the document data
to the printer), and the Send-URI operation includes only a URI
reference to the document data in the request (the Printer "pulls"
the document data from the referenced location). The last Send-
Document or Send-URI request for a given Job object includes a
"last-document" operation attribute set to 'true' indicating that
this is the last request.
Throughout this model document, the term "create request" is used to - The Print-URI Request: A client that wants to submit a print job
refer to any of these three operation requests. with only a single document (where the Printer object "pulls"
the document data instead of the client "pushing" the data to
the Printer object) uses the Print-URI operation. In this
case, the client includes in the request only a URI reference to
the document data (not the document data itself).
A Create-Job operation followed by only one Send-Document operation is - The Create-Job Request: A client that wants to submit a print
semantically equivalent to a Print-Job operation, however, for job with multiple documents uses the Create-Job operation. This
performance reasons, the client SHOULD use the Print-Job operation for operation is followed by an arbitrary number (one or more) of
all single document jobs. Also, Print-Job is a REQUIRED operation (all Send-Document and/or Send-URI operations (each creating another
implementations MUST support it) whereas Create-Job is an OPTIONAL document for the newly create Job object). The Send-Document
operation, hence some implementations might not support it. operation includes the document data in the request (the client
"pushes" the document data to the printer), and the Send-URI
operation includes only a URI reference to the document data in
the request (the Printer "pulls" the document data from the
referenced location). The last Send-Document or Send-URI
request for a given Job object includes a "last-document"
operation attribute set to 'true' indicating that this is the
last request.
Job submission time is the point in time when a client issues a create Throughout this model document, the term "create request" is used to
request. The initial state of every Job object is the 'pending', refer to any of these three operation requests.
Expires September 1, 2000 A Create-Job operation followed by only one Send-Document operation
'pending-held', or 'processing' state (see section 4.3.7). When the is semantically equivalent to a Print-Job operation, however, for
Printer object begins processing the print job, the Job object's state performance reasons, the client SHOULD use the Print-Job operation
moves to 'processing'. This is known as job processing time. There are for all single document jobs. Also, Print-Job is a REQUIRED
validation checks that must be done at job submission time and others operation (all implementations MUST support it) whereas Create-Job is
that must be performed at job processing time. an OPTIONAL operation, hence some implementations might not support
it.
At job submission time and at the time a Validate-Job operation is Job submission time is the point in time when a client issues a
received, the Printer MUST do the following: create request. The initial state of every Job object is the
'pending', 'pending-held', or 'processing' state (see section 4.3.7).
When the Printer object begins processing the print job, the Job
object's state moves to 'processing'. This is known as job
processing time. There are validation checks that must be done at
job submission time and others that must be performed at job
processing time.
1. Process the client supplied attributes and either accept or reject At job submission time and at the time a Validate-Job operation is
the request received, the Printer MUST do the following:
2. Validate the syntax of and support for the scheme of any client
supplied URI
At job submission time the Printer object MUST validate whether or not 1. Process the client supplied attributes and either accept or
the supplied attributes, attribute syntaxes, and values are supported by reject the request
matching them with the Printer object's corresponding "xxx-supported" 2. Validate the syntax of and support for the scheme of any client
attributes. See section 3.1.7 for details. [IPP-IIG] presents supplied URI
suggested steps for an IPP object to either accept or reject any request
and additional steps for processing create requests.
At job submission time the Printer object NEED NOT perform the At job submission time the Printer object MUST validate whether or
validation checks reserved for job processing time such as: not the supplied attributes, attribute syntaxes, and values are
supported by matching them with the Printer object's corresponding
"xxx-supported" attributes. See section 3.1.7 for details. [IPP-
IIG] presents suggested steps for an IPP object to either accept or
reject any request and additional steps for processing create
requests.
1. Validating the document data At job submission time the Printer object NEED NOT perform the
2. Validating the actual contents of any client supplied URI (resolve validation checks reserved for job processing time such as:
the reference and follow the link to the document data)
At job submission time, these additional job processing time validation 1. Validating the document data
checks are essentially useless, since they require actually parsing and 2. Validating the actual contents of any client supplied URI
interpreting the document data, are not guaranteed to be 100% accurate, (resolve the reference and follow the link to the document
and MUST be done, yet again, at job processing time. Also, in the case data)
of a URI, checking for availability at job submission time does not
guarantee availability at job processing time. In addition, at job
processing time, the Printer object might discover any of the following
conditions that were not detectable at job submission time:
- runtime errors in the document data, At job submission time, these additional job processing time
- nested document data that is in an unsupported format, validation checks are essentially useless, since they require
- the URI reference is no longer valid (i.e., the server hosting the actually parsing and interpreting the document data, are not
document might be down), or guaranteed to be 100% accurate, and MUST be done, yet again, at job
- any other job processing error processing time. Also, in the case of a URI, checking for
availability at job submission time does not guarantee availability
at job processing time. In addition, at job processing time, the
Printer object might discover any of the following conditions that
were not detectable at job submission time:
At job submission time, a Printer object, especially a non-spooling - runtime errors in the document data,
Printer, MAY accept jobs that it does not have enough space for. In - nested document data that is in an unsupported format,
such a situation, a Printer object MAY stop reading data from a client - the URI reference is no longer valid (i.e., the server hosting
for an indefinite period of time. A client MUST be prepared for a write the document might be down), or
operation to block for an indefinite period of time (see section 5.1 on - any other job processing error
client conformance).
When a Printer object has too little space for starting a new job, it At job submission time, a Printer object, especially a non-spooling
MAY reject a new create request. In this case, a Printer object MUST Printer, MAY accept jobs that it does not have enough space for. In
return a response (in reply to the rejected request) with a status-code such a situation, a Printer object MAY stop reading data from a
of 'server-error-busy' (see section 14.1.5.8) and it MAY close the client for an indefinite period of time. A client MUST be prepared
for a write operation to block for an indefinite period of time (see
section 5.1 on client conformance).
Expires September 1, 2000 When a Printer object has too little space for starting a new job, it
connection before receiving all bytes of the operation. A Printer MAY reject a new create request. In this case, a Printer object MUST
SHOULD indicate that it is temporarily unable to accept jobs by setting return a response (in reply to the rejected request) with a status-
the 'spool-space-full' value in its "printer-state-reasons" attribute code of 'server-error-busy' (see section 14.1.5.8) and it MAY close
and removing the value when it can accept another job (see section the connection before receiving all bytes of the operation. A
4.4.12). Printer SHOULD indicate that it is temporarily unable to accept jobs
by setting the 'spool-space-full' value in its "printer-state-
reasons" attribute and removing the value when it can accept another
job (see section 4.4.12).
When receiving a 'server-error-busy' status-code in an operation When receiving a 'server-error-busy' status-code in an operation
response, a client MUST be prepared for the Printer object to close the response, a client MUST be prepared for the Printer object to close
connection before the client has sent all of the data (especially for the connection before the client has sent all of the data (especially
the Print-Job operation). A client MUST be prepared to keep submitting a for the Print-Job operation). A client MUST be prepared to keep
create request until the IPP Printer object accepts the create request. submitting a create request until the IPP Printer object accepts the
create request.
At job processing time, since the Printer object has already responded At job processing time, since the Printer object has already
with a successful status code in the response to the create request, if responded with a successful status code in the response to the create
the Printer object detects an error, the Printer object is unable to request, if the Printer object detects an error, the Printer object
inform the end user of the error with an operation status code. In is unable to inform the end user of the error with an operation
this case, the Printer, depending on the error, can set the job object's status code. In this case, the Printer, depending on the error, can
"job-state", "job-state-reasons", or "job-state-message" attributes to set the job object's "job-state", "job-state-reasons", or "job-
the appropriate value(s) so that later queries can report the correct state-message" attributes to the appropriate value(s) so that later
job status. queries can report the correct job status.
Note: Asynchronous notification of events is outside the scope of this Note: Asynchronous notification of events is outside the scope of
IPP/1.1 document. this IPP/1.1 document.
3.2 Printer Operations 3.2 Printer Operations
All Printer operations are directed at Printer objects. A client MUST All Printer operations are directed at Printer objects. A client
always supply the "printer-uri" operation attribute in order to identify MUST always supply the "printer-uri" operation attribute in order to
the correct target of the operation. identify the correct target of the operation.
3.2.1 Print-Job Operation 3.2.1 Print-Job Operation
This REQUIRED operation allows a client to submit a print job with only This REQUIRED operation allows a client to submit a print job with
one document and supply the document data (rather than just a reference only one document and supply the document data (rather than just a
to the data). See Section 15 for the suggested steps for processing reference to the data). See Section 15 for the suggested steps for
create operations and their Operation and Job Template attributes. processing create operations and their Operation and Job Template
attributes.
3.2.1.1 Print-Job Request 3.2.1.1 Print-Job Request
The following groups of attributes are supplied as part of the Print-Job The following groups of attributes are supplied as part of the
Request: Print-Job Request:
Group 1: Operation Attributes
Natural Language and Character Set: Group 1: Operation Attributes
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.1. The Printer object
MUST copy these values to the corresponding Job Description
attributes described in sections 4.3.19 and 4.3.20.
Expires September 1, 2000 Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.1. The Printer object
MUST copy these values to the corresponding Job Description
attributes described in sections 4.3.19 and 4.3.20.
Target: Target:
The "printer-uri" (uri) operation attribute which is the target for The "printer-uri" (uri) operation attribute which is the target
this operation as described in section 3.1.5. for this operation as described in section 3.1.5.
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 section 8.3. supplied by the client as described in section 8.3.
"job-name" (name(MAX)): "job-name" (name(MAX)):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
MUST support this attribute. It contains the client supplied Job object MUST support this attribute. It contains the client
name. If this attribute is supplied by the client, its value is supplied Job name. If this attribute is supplied by the
used for the "job-name" attribute of the newly created Job object. client, its value is used for the "job-name" attribute of the
The client MAY automatically include any information that will help newly created Job object. The client MAY automatically include
the end-user distinguish amongst his/her jobs, such as the name of any information that will help the end-user distinguish amongst
the application program along with information from the document, his/her jobs, such as the name of the application program along
such as the document name, document subject, or source file name. with information from the document, such as the document name,
If this attribute is not supplied by the client, the Printer document subject, or source file name. If this attribute is
generates a name to use in the "job-name" attribute of the newly not supplied by the client, the Printer generates a name to use
created Job object (see Section 4.3.5). in the "job-name" attribute of the newly created Job object
(see Section 4.3.5).
"ipp-attribute-fidelity" (boolean): "ipp-attribute-fidelity" (boolean):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
MUST support this attribute. The value 'true' indicates that total object MUST support this attribute. The value 'true' indicates
fidelity to client supplied Job Template attributes and values is that total fidelity to client supplied Job Template attributes
required, else the Printer object MUST reject the Print-Job and values is required, else the Printer object MUST reject the
request. The value 'false' indicates that a reasonable attempt to Print-Job request. The value 'false' indicates that a
print the Job object is acceptable and the Printer object MUST reasonable attempt to print the Job object is acceptable and
accept the Print-Job request. If not supplied, the Printer object the Printer object MUST accept the Print-Job request. If not
assumes the value is 'false'. All Printer objects MUST support supplied, the Printer object assumes the value is 'false'. All
both types of job processing. See section 15 for a full Printer objects MUST support both types of job processing. See
description of "ipp-attribute-fidelity" and its relationship to section 15 for a full description of "ipp-attribute-fidelity"
other attributes, especially the Printer object's "pdl-override- and its relationship to other attributes, especially the
supported" attribute. Printer object's "pdl-override-supported" attribute.
"document-name" (name(MAX)): "document-name" (name(MAX)):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
MUST support this attribute. It contains the client supplied object MUST support this attribute. It contains the client
document name. The document name MAY be different than the Job supplied document name. The document name MAY be different
name. Typically, the client software automatically supplies the than the Job name. Typically, the client software
document name on behalf of the end user by using a file name or an automatically supplies the document name on behalf of the end
application generated name. If this attribute is supplied, its user by using a file name or an application generated name. If
value can be used in a manner defined by each implementation. this attribute is supplied, its value can be used in a manner
Examples include: printed along with the Job (job start sheet, page defined by each implementation. Examples include: printed
adornments, etc.), used by accounting or resource tracking along with the Job (job start sheet, page adornments, etc.),
management tools, or even stored along with the document as a used by accounting or resource tracking management tools, or
document level attribute. IPP/1.1 does not support the concept of even stored along with the document as a document level
document level attributes. attribute. IPP/1.1 does not support the concept of document
level attributes.
"compression" (type3 keyword) "compression" (type3 keyword):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
MUST support this attribute and the "compression-supported" object MUST support this attribute and the "compression-
attribute (see section 4.4.32). The client supplied "compression" supported" attribute (see section 4.4.32). The client supplied
"compression" operation attribute identifies the compression
algorithm used on the document data. The following cases exist:
Expires September 1, 2000 a) If the client omits this attribute, the Printer object MUST
operation attribute identifies the compression algorithm used on
the document data. The following cases exist:
a)If the client omits this attribute, the Printer object MUST
assume that the data is not compressed (i.e. the Printer assume that the data is not compressed (i.e. the Printer
follows the rules below as if the client supplied the follows the rules below as if the client supplied the
"compression" attribute with a value of 'none'). "compression" attribute with a value of 'none').
b)If the client supplies this attribute, but the value is not b) If the client supplies this attribute, but the value is not
supported by the Printer object, i.e., the value is not one supported by the Printer object, i.e., the value is not one
of the values of the Printer object's "compression- of the values of the Printer object's "compression-
supported" attribute, the Printer object MUST reject the supported" attribute, the Printer object MUST reject the
request, and return the 'client-error-compression-not- request, and return the 'client-error-compression-not-
supported' status code. See section 3.1.7 for returning supported' status code. See section 3.1.7 for returning
unsupported attributes and values. unsupported attributes and values.
c)If the client supplies the attribute and the Printer object
c) If the client supplies the attribute and the Printer object
supports the attribute value, the Printer object uses the supports the attribute value, the Printer object uses the
corresponding decompression algorithm on the document data. corresponding decompression algorithm on the document data.
d)If the decompression algorithm fails before the Printer d) If the decompression algorithm fails before the Printer
returns an operation response, the Printer object MUST returns an operation response, the Printer object MUST
reject the request and return the 'client-error- reject the request and return the 'client-error-
compression-error' status code. compression-error' status code.
e)If the decompression algorithm fails after the Printer e) If the decompression algorithm fails after the Printer
returns an operation response, the Printer object MUST returns an operation response, the Printer object MUST abort
abort the job and add the 'compression-error' value to the the job and add the 'compression-error' value to the job's
job's "job-state-reasons" attribute. "job-state-reasons" attribute.
f)If the decompression algorithm succeeds, the document data f) If the decompression algorithm succeeds, the document data
MUST then have the format specified by the job's "document- MUST then have the format specified by the job's "document-
format" attribute, if supplied (see "document-format" format" attribute, if supplied (see "document-format"
operation attribute definition below). operation attribute definition below).
"document-format" (mimeMediaType) : "document-format" (mimeMediaType):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
MUST support this attribute. The value of this attribute object MUST support this attribute. The value of this
identifies the format of the supplied document data. The following attribute identifies the format of the supplied document data.
cases exist: The following cases exist:
a)If the client does not supply this attribute, the Printer
a) If the client does not supply this attribute, the Printer
object assumes that the document data is in the format object assumes that the document data is in the format
defined by the Printer object's "document-format-default" defined by the Printer object's "document-format-default"
attribute. (i.e. the Printer follows the rules below as if attribute. (i.e. the Printer follows the rules below as if
the client supplied the "document-format" attribute with a the client supplied the "document-format" attribute with a
value equal to the printer's default value). value equal to the printer's default value).
b)If the client supplies this attribute, but the value is not b) If the client supplies this attribute, but the value is not
supported by the Printer object, i.e., the value is not one supported by the Printer object, i.e., the value is not one
of the values of the Printer object's "document-format- of the values of the Printer object's "document-format-
supported" attribute, the Printer object MUST reject the supported" attribute, the Printer object MUST reject the
request and return the 'client-error-document-format-not- request and return the 'client-error-document-format-not-
supported' status code. supported' status code.
c)If the client supplies this attribute and its value is c) If the client supplies this attribute and its value is
'application/octet-stream' (i.e. to be auto-sensed, see 'application/octet-stream' (i.e. to be auto-sensed, see
Section 4.1.9.1), and the format is not one of the Section 4.1.9.1), and the format is not one of the
document-formats that the Printer can auto-sense, and this document-formats that the Printer can auto-sense, and this
check occurs before the Printer returns an operation check occurs before the Printer returns an operation
response, then the Printer MUST reject the request and response, then the Printer MUST reject the request and
return the 'client-error-document-format-not-supported' return the 'client-error-document-format-not-supported'
status code. status code.
d) If the client supplies this attribute, and the value is
supported by the Printer object, the Printer is capable of
interpreting the document data.
Expires September 1, 2000 e) If interpreting of the document data fails before the
d)If the client supplies this attribute, and the value is
supported by the Printer object, the document data, the
Printer is capable of interpreting the document data.
e)If interpreting of the document data fails before the
Printer returns an operation response, the Printer object Printer returns an operation response, the Printer object
MUST reject the request and return the 'client-error- MUST reject the request and return the 'client-error-
document-format-error' status code. document-format-error' status code.
f)If interpreting of the document data fails after the f) If interpreting of the document data fails after the Printer
Printer returns an operation response, the Printer object returns an operation response, the Printer object MUST abort
MUST abort the job and add the 'document-format-error' the job and add the 'document-format-error' value to the
value to the job's "job-state-reasons" attribute. job's "job-state-reasons" attribute.
"document-natural-language" (naturalLanguage): "document-natural-language" (naturalLanguage):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
OPTIONALLY supports this attribute. This attribute specifies the object OPTIONALLY supports this attribute. This attribute
natural language of the document for those document-formats that specifies the natural language of the document for those
require a specification of the natural language in order to image document-formats that require a specification of the natural
the document unambiguously. There are no particular values required language in order to image the document unambiguously. There
for the Printer object to support. are no particular values required for the Printer object to
support.
"job-k-octets" (integer(0:MAX)) "job-k-octets" (integer(0:MAX)):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
OPTIONALLY supports this attribute and the "job-k-octets-supported" object OPTIONALLY supports this attribute and the "job-k-
attribute (see section 4.4.33). The client supplied "job-k-octets" octets-supported" attribute (see section 4.4.33). The client
operation attribute identifies the total size of the document(s) in supplied "job-k-octets" operation attribute identifies the
K octets being submitted (see section 4.3.17.1 for the complete total size of the document(s) in K octets being submitted (see
semantics). If the client supplies the attribute and the Printer section 4.3.17.1 for the complete semantics). If the client
object supports the attribute, the value of the attribute is used supplies the attribute and the Printer object supports the
to populate the Job object's "job-k-octets" Job Description attribute, the value of the attribute is used to populate the
attribute. Job object's "job-k-octets" Job Description attribute.
For this attribute and the following two attributes ("job- For this attribute and the following two attributes ("job-
impressions", and "job-media-sheets"), if the client supplies the impressions", and "job-media-sheets"), if the client supplies
attribute, but the Printer object does not support the attribute, the attribute, but the Printer object does not support the
the Printer object ignores the client-supplied value. If the attribute, the Printer object ignores the client-supplied
client supplies the attribute and the Printer supports the value. If the client supplies the attribute and the Printer
attribute, and the value is within the range of the corresponding supports the attribute, and the value is within the range of
Printer object's "xxx-supported" attribute, the Printer object MUST the corresponding Printer object's "xxx-supported" attribute,
use the value to populate the Job object's "xxx" attribute. If the the Printer object MUST use the value to populate the Job
client supplies the attribute and the Printer supports the object's "xxx" attribute. If the client supplies the attribute
attribute, but the value is outside the range of the corresponding and the Printer supports the attribute, but the value is
Printer object's "xxx-supported" attribute, the Printer object MUST outside the range of the corresponding Printer object's "xxx-
copy the attribute and its value to the Unsupported Attributes supported" attribute, the Printer object MUST copy the
response group, reject the request, and return the 'client-error- attribute and its value to the Unsupported Attributes response
attributes-or-values-not-supported' status code. If the client group, reject the request, and return the 'client-error-
does not supply the attribute, the Printer object MAY choose to attributes-or-values-not-supported' status code. If the client
populate the corresponding Job object attribute depending on does not supply the attribute, the Printer object MAY choose to
whether the Printer object supports the attribute and is able to populate the corresponding Job object attribute depending on
calculate or discern the correct value. whether the Printer object supports the attribute and is able
to calculate or discern the correct value.
"job-impressions" (integer(0:MAX)) "job-impressions" (integer(0:MAX)):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
OPTIONALLY supports this attribute and the "job-impressions- object OPTIONALLY supports this attribute and the "job-
supported" attribute (see section 4.4.34). The client supplied impressions-supported" attribute (see section 4.4.34). The
client supplied "job-impressions" operation attribute
identifies the total size in number of impressions of the
document(s) being submitted (see section 4.3.17.2 for the
complete semantics).
Expires September 1, 2000 See last paragraph under "job-k-octets".
"job-impressions" operation attribute identifies the total size in
number of impressions of the document(s) being submitted (see
section 4.3.17.2 for the complete semantics).
See last paragraph under "job-k-octets". "job-media-sheets" (integer(0:MAX)):
The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute and the "job-media-
sheets-supported" attribute (see section 4.4.35). The client
supplied "job-media-sheets" operation attribute identifies the
total number of media sheets to be produced for this job (see
section 4.3.17.3 for the complete semantics).
"job-media-sheets" (integer(0:MAX)) See last paragraph under "job-k-octets".
The client OPTIONALLY supplies this attribute. The Printer object
OPTIONALLY supports this attribute and the "job-media-sheets-
supported" attribute (see section 4.4.35). The client supplied
"job-media-sheets" operation attribute identifies the total number
of media sheets to be produced for this job (see section 4.3.17.3
for the complete semantics).
See last paragraph under "job-k-octets". Group 2: Job Template Attributes
Group 2: Job Template Attributes The client OPTIONALLY supplies a set of Job Template attributes as
defined in section 4.2. If the client is not supplying any Job
Template attributes in the request, the client SHOULD omit Group 2
rather than sending an empty group. However, a Printer object
MUST be able to accept an empty group.
The client OPTIONALLY supplies a set of Job Template attributes as Group 3: Document Content
defined in section 4.2. If the client is not supplying any Job
Template attributes in the request, the client SHOULD omit Group 2
rather than sending an empty group. However, a Printer object MUST
be able to accept an empty group.
Group 3: Document Content The client MUST supply the document data to be processed.
The client MUST supply the document data to be processed. In addition to the MANDATORY parameters required for every
operation request, the simplest Print-Job Request consists of just
the "attributes-charset" and "attributes-natural-language"
operation attributes; the "printer-uri" target operation
attribute; the Document Content and nothing else. In this simple
case, the Printer object:
In addition to the MANDATORY parameters required for every operation - creates a new Job object (the Job object contains a single
request, the simplest Print-Job Request consists of just the document),
"attributes-charset" and "attributes-natural-language" operation - stores a generated Job name in the "job-name" attribute in the
attributes; the "printer-uri" target operation attribute; the Document natural language and charset requested (see Section 3.1.4.1) (if
Content and nothing else. In this simple case, the Printer object: those are supported, otherwise using the Printer object's
default natural language and charset), and
- creates a new Job object (the Job object contains a single - at job processing time, uses its corresponding default value
document), attributes for the supported Job Template attributes that were
- stores a generated Job name in the "job-name" attribute in the not supplied by the client as IPP attribute or embedded
natural language and charset requested (see Section 3.1.4.1) (if instructions in the document data.
those are supported, otherwise using the Printer object's default
natural language and charset), and
- at job processing time, uses its corresponding default value
attributes for the supported Job Template attributes that were not
supplied by the client as IPP attribute or embedded instructions in
the document data.
3.2.1.2 Print-Job Response 3.2.1.2 Print-Job Response
The Printer object MUST return to the client the following sets of The Printer object MUST return to the client the following sets of
attributes as part of the Print-Job Response: attributes as part of the Print-Job Response:
Group 1: Operation Attributes
Expires September 1, 2000 Group 1: Operation Attributes
Status Message:
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 sections 13 and 3.1.6. If the client supplies
unsupported or conflicting Job Template attributes or values, the
Printer object MUST reject or accept the Print-Job request
depending on the whether the client supplied a 'true' or 'false'
value for the "ipp-attribute-fidelity" operation attribute. See
the Implementer's Guide [IPP-IIG] for a complete description of the
suggested steps for processing a create request.
Natural Language and Character Set: Status Message:
The "attributes-charset" and "attributes-natural-language" In addition to the REQUIRED status code returned in every
attributes as described in section 3.1.4.2. response, the response OPTIONALLY includes a "status-message"
(text(255)) and/or a "detailed-status-message" (text(MAX))
operation attribute as described in sections 13 and 3.1.6. If
the client supplies unsupported or conflicting Job Template
attributes or values, the Printer object MUST reject or accept
the Print-Job request depending on the whether the client
supplied a 'true' or 'false' value for the "ipp-attribute-
fidelity" operation attribute. See the Implementer's Guide
[IPP-IIG] for a complete description of the suggested steps for
processing a create request.
Group 2: Unsupported Attributes Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.2.
See section 3.1.7 for details on returning Unsupported Attributes. Group 2: Unsupported Attributes
The value of the "ipp-attribute-fidelity" supplied by the client See section 3.1.7 for details on returning Unsupported Attributes.
does not affect what attributes the Printer object returns in this
group. The value of "ipp-attribute-fidelity" only affects whether
the Print-Job operation is accepted or rejected. If the job is
accepted, the client may query the job using the Get-Job-Attributes
operation requesting the unsupported attributes that were returned
in the create response to see which attributes were ignored (not
stored on the Job object) and which attributes were stored with
other (substituted) values.
Group 3: Job Object Attributes The value of the "ipp-attribute-fidelity" supplied by the client
does not affect what attributes the Printer object returns in this
group. The value of "ipp-attribute-fidelity" only affects whether
the Print-Job operation is accepted or rejected. If the job is
accepted, the client may query the job using the Get-Job-
Attributes operation requesting the unsupported attributes that
were returned in the create response to see which attributes were
ignored (not stored on the Job object) and which attributes were
stored with other (substituted) values.
"job-uri" (uri): Group 3: Job Object Attributes
The Printer object MUST return the Job object's URI by returning
the contents of the REQUIRED "job-uri" Job object attribute. The
client uses the Job object's URI when directing operations at the
Job object. The Printer object always uses its configured security
policy when creating the new URI. However, if the Printer object
supports more than one URI, the Printer object also uses
information about which URI was used in the Print-Job Request to
generated the new URI so that the new URI references the correct
access channel. In other words, if the Print-Job Request comes in
over a secure channel, the Printer object MUST generate a Job URI
that uses the secure channel as well.
"job-id" (integer(1:MAX)): "job-uri" (uri):
The Printer object MUST return the Job object's Job ID by returning The Printer object MUST return the Job object's URI by
the REQUIRED "job-id" Job object attribute. The client uses this returning the contents of the REQUIRED "job-uri" Job object
"job-id" attribute in conjunction with the "printer-uri" attribute attribute. The client uses the Job object's URI when directing
used in the Print-Job Request when directing Job operations at the operations at the Job object. The Printer object always uses
Printer object. its configured security policy when creating the new URI.
However, if the Printer object supports more than one URI, the
Printer object also uses information about which URI was used
in the Print-Job Request to generated the new URI so that the
new URI references the correct access channel. In other words,
if the Print-Job Request comes in over a secure channel, the
Printer object MUST generate a Job URI that uses the secure
channel as well.
Expires September 1, 2000 "job-id" (integer(1:MAX)):
The Printer object MUST return the Job object's Job ID by
returning the REQUIRED "job-id" Job object attribute. The
client uses this "job-id" attribute in conjunction with the
"printer-uri" attribute used in the Print-Job Request when
directing Job operations at the Printer object.
"job-state": "job-state" (type1 enum):
The Printer object MUST return the Job object's REQUIRED "job- The Printer object MUST return the Job object's REQUIRED "job-
state" attribute. The value of this attribute (along with the value state" attribute. The value of this attribute (along with the
of the next attribute: "job-state-reasons") is taken from a value of the next attribute: "job-state-reasons") is taken
"snapshot" of the new Job object at some meaningful point in time from a "snapshot" of the new Job object at some meaningful
(implementation defined) between when the Printer object receives point in time (implementation defined) between when the Printer
the Print-Job Request and when the Printer object returns the object receives the Print-Job Request and when the Printer
response. object returns the response.
"job-state-reasons": "job-state-reasons" (1setOf type2 keyword):
The Printer object MUST return the Job object's REQUIRED "job- The Printer object MUST return the Job object's REQUIRED "job-
state-reasons" attribute. state-reasons" attribute.
"job-state-message": "job-state-message" (text(MAX)):
The Printer object OPTIONALLY returns the Job object's OPTIONAL The Printer object OPTIONALLY returns the Job object's OPTIONAL
"job-state-message" attribute. If the Printer object supports this "job-state-message" attribute. If the Printer object supports
attribute then it MUST be returned in the response. If this this attribute then it MUST be returned in the response. If
attribute is not returned in the response, the client can assume this attribute is not returned in the response, the client can
that the "job-state-message" attribute is not supported and will assume that the "job-state-message" attribute is not supported
not be returned in a subsequent Job object query. and will not be returned in a subsequent Job object query.
"number-of-intervening-jobs": "number-of-intervening-jobs" (integer(0:MAX)):
The Printer object OPTIONALLY returns the Job object's OPTIONAL The Printer object OPTIONALLY returns the Job object's OPTIONAL
"number-of-intervening-jobs" attribute. If the Printer object "number-of-intervening-jobs" attribute. If the Printer object
supports this attribute then it MUST be returned in the response. supports this attribute then it MUST be returned in the
If this attribute is not returned in the response, the client can response. If this attribute is not returned in the response,
assume that the "number-of-intervening-jobs" attribute is not the client can assume that the "number-of-intervening-jobs"
supported and will not be returned in a subsequent Job object attribute is not supported and will not be returned in a
query. subsequent Job object query.
Note: Since any printer state information which affects a job's Note: Since any printer state information which affects a job's
state is reflected in the "job-state" and "job-state-reasons" state is reflected in the "job-state" and "job-state-reasons"
attributes, it is sufficient to return only these attributes and no attributes, it is sufficient to return only these attributes
specific printer status attributes. and no specific printer status attributes.
Note: In addition to the MANDATORY parameters required for every Note: In addition to the MANDATORY parameters required for every
operation response, the simplest response consists of the just the operation response, the simplest response consists of the just the
"attributes-charset" and "attributes-natural-language" operation "attributes-charset" and "attributes-natural-language" operation
attributes and the "job-uri", "job-id", and "job-state" Job Object attributes and the "job-uri", "job-id", and "job-state" Job Object
Attributes. In this simplest case, the status code is 'successful-ok' Attributes. In this simplest case, the status code is 'successful-
and there is no "status-message" or "detailed-status-message" operation ok' and there is no "status-message" or "detailed-status-message"
attribute. operation attribute.
3.2.2 Print-URI Operation 3.2.2 Print-URI Operation
This OPTIONAL operation is identical to the Print-Job operation (section This OPTIONAL operation is identical to the Print-Job operation
3.2.1) except that a client supplies a URI reference to the document (section 3.2.1) except that a client supplies a URI reference to the
data using the "document-uri" (uri) operation attribute (in Group 1) document data using the "document-uri" (uri) operation attribute (in
rather than including the document data itself. Before returning the Group 1) rather than including the document data itself. Before
response, the Printer MUST validate that the Printer supports the returning the response, the Printer MUST validate that the Printer
retrieval method (e.g., http, ftp, etc.) implied by the URI, and MUST supports the retrieval method (e.g., http, ftp, etc.) implied by the
check for valid URI syntax. If the client-supplied URI scheme is not URI, and MUST check for valid URI syntax. If the client-supplied URI
supported, i.e. the value is not in the Printer object's "referenced- scheme is not supported, i.e. the value is not in the Printer
object's "referenced-uri-scheme-supported" attribute, the Printer
Expires September 1, 2000 object MUST reject the request and return the 'client-error-uri-
uri-scheme-supported" attribute, the Printer object MUST reject the scheme-not-supported' status code.
request and return the 'client-error-uri-scheme-not-supported' status
code.
The IPP Printer MAY validate the accessibility of the document as part The IPP Printer MAY validate the accessibility of the document as
of the operation or subsequently. If the Printer determines an part of the operation or subsequently. If the Printer determines an
accessibility problem before returning an operation response, it rejects accessibility problem before returning an operation response, it
the request and returns the 'client-error-document-access-error' status rejects the request and returns the 'client-error-document-access-
code. The Printer MAY also return a specific document access error code error' status code. The Printer MAY also return a specific document
using the "document-access-error" operation attribute (see section access error code using the "document-access-error" operation
3.1.6.4). attribute (see section 3.1.6.4).
If the Printer determines this document accessibility problem after If the Printer determines this document accessibility problem after
accepting the request and returning an operation response with one of accepting the request and returning an operation response with one of
the successful status codes, the Printer adds the 'document-access- the successful status codes, the Printer adds the 'document-access-
error' value to the job's "job-state-reasons" attribute and MAY populate error' value to the job's "job-state-reasons" attribute and MAY
the job's "job-document-access-errors" Job Description attribute (see populate the job's "job-document-access-errors" Job Description
section 4.3.11). See The Implementer's Guide [IPP-IIG] for suggested attribute (see section 4.3.11). See The Implementer's Guide [IPP-
additional checks. IIG] for suggested additional checks.
If the Printer object supports this operation, it MUST support the If the Printer object supports this operation, it MUST support the
"reference-uri-schemes-supported" Printer attribute (see section "reference-uri-schemes-supported" Printer attribute (see section
4.4.27). 4.4.27).
It is up to the IPP object to interpret the URI and subsequently "pull" It is up to the IPP object to interpret the URI and subsequently
the document from the source referenced by the URI string. "pull" the document from the source referenced by the URI string.
3.2.3 Validate-Job Operation 3.2.3 Validate-Job Operation
This REQUIRED operation is similar to the Print-Job operation (section This REQUIRED operation is similar to the Print-Job operation
3.2.1) except that a client supplies no document data and the Printer (section 3.2.1) except that a client supplies no document data and
allocates no resources (i.e., it does not create a new Job object). the Printer allocates no resources (i.e., it does not create a new
This operation is used only to verify capabilities of a printer object Job object). This operation is used only to verify capabilities of a
against whatever attributes are supplied by the client in the Validate- printer object against whatever attributes are supplied by the client
Job request. By using the Validate-Job operation a client can validate in the Validate-Job request. By using the Validate-Job operation a
that an identical Print-Job operation (with the document data) would be client can validate that an identical Print-Job operation (with the
accepted. The Validate-Job operation also performs the same security document data) would be accepted. The Validate-Job operation also
negotiation as the Print-Job operation (see section 8), so that a client performs the same security negotiation as the Print-Job operation
can check that the client and Printer object security requirements can (see section 8), so that a client can check that the client and
be met before performing a Print-Job operation. Printer object security requirements can be met before performing a
Print-Job operation.
The Validate-Job operation does not accept a "document-uri" attribute in The Validate-Job operation does not accept a "document-uri" attribute
order to allow a client to check that the same Print-URI operation will in order to allow a client to check that the same Print-URI operation
be accepted, since the client doesn't send the data with the Print-URI will be accepted, since the client doesn't send the data with the
operation. The client SHOULD just issue the Print-URI request. Print-URI operation. The client SHOULD just issue the Print-URI
request.
The Printer object returns the same status codes, Operation Attributes The Printer object returns the same status codes, Operation
(Group 1) and Unsupported Attributes (Group 2) as the Print-Job Attributes (Group 1) and Unsupported Attributes (Group 2) as the
operation. However, no Job Object Attributes (Group 3) are returned, Print-Job operation. However, no Job Object Attributes (Group 3) are
since no Job object is created. returned, since no Job object is created.
Expires September 1, 2000
3.2.4 Create-Job Operation 3.2.4 Create-Job Operation
This OPTIONAL operation is similar to the Print-Job operation (section This OPTIONAL operation is similar to the Print-Job operation
3.2.1) except that in the Create-Job request, a client does not supply (section 3.2.1) except that in the Create-Job request, a client does
document data or any reference to document data. Also, the client does not supply document data or any reference to document data. Also,
not supply any of the "document-name", "document-format", "compression", the client does not supply any of the "document-name", "document-
or "document-natural-language" operation attributes. This operation is format", "compression", or "document-natural-language" operation
followed by one or more Send-Document or Send-URI operations. In each attributes. This operation is followed by one or more Send-Document
of those operation requests, the client OPTIONALLY supplies the or Send-URI operations. In each of those operation requests, the
"document-name", "document-format", and "document-natural-language" client OPTIONALLY supplies the "document-name", "document-format",
attributes for each document in the multi-document Job object. and "document-natural-language" attributes for each document in the
multi-document Job object.
If a Printer object supports the Create-Job operation, it MUST also If a Printer object supports the Create-Job operation, it MUST also
support the Send-Document operation and also MAY support the Send-URI support the Send-Document operation and also MAY support the Send-URI
operation. operation.
If the Printer object supports this operation, it MUST support the If the Printer object supports this operation, it MUST support the
"multiple-operation-time-out" Printer attribute (see section 4.4.31). "multiple-operation-time-out" Printer attribute (see section 4.4.31).
If the Printer object supports this operation, then it MUST support the If the Printer object supports this operation, then it MUST support
"multiple-document-jobs-supported" Printer Description attribute (see the "multiple-document-jobs-supported" Printer Description attribute
section 4.4.16) and indicate whether or not it supports multiple- (see section 4.4.16) and indicate whether or not it supports
document jobs. multiple-document jobs.
If the Printer object supports this operation and supports multiple If the Printer object supports this operation and supports multiple
documents in a job, then it MUST support the "multiple-document- documents in a job, then it MUST support the "multiple-document-
handling" Job Template job attribute with at least one value (see handling" Job Template job attribute with at least one value (see
section 4.2.4) and the associated "multiple-document-handling-default" section 4.2.4) and the associated "multiple-document-handling-
and "multiple-document-handling-supported" Job Template Printer default" and "multiple-document-handling-supported" Job Template
attributes (see section 4.2). Printer attributes (see section 4.2).
After the Create-Job operation has completed, the value of the "job- After the Create-Job operation has completed, the value of the "job-
state" attribute is similar to the "job-state" after a Print-Job, even state" attribute is similar to the "job-state" after a Print-Job,
though no document-data has arrived. A Printer MAY set the 'job-data- even though no document-data has arrived. A Printer MAY set the
insufficient' value of the job's "job-state-reason" attribute to 'job-data-insufficient' value of the job's "job-state-reason"
indicate that processing cannot begin until sufficient data has arrived attribute to indicate that processing cannot begin until sufficient
and set the "job-state" to either 'pending' or 'pending-held'. A non- data has arrived and set the "job-state" to either 'pending' or
spooling printer that doesn't implement the 'pending' job state may even 'pending-held'. A non-spooling printer that doesn't implement the
set the "job-state" to 'processing', even though there is not yet any 'pending' job state may even set the "job-state" to 'processing',
data to process. See sections 4.3.7 and 4.3.8. even though there is not yet any data to process. See sections 4.3.7
and 4.3.8.
3.2.5 Get-Printer-Attributes Operation 3.2.5 Get-Printer-Attributes Operation
This REQUIRED operation allows a client to request the values of the This REQUIRED operation allows a client to request the values of the
attributes of a Printer object. In the request, the client supplies attributes of a Printer object. In the request, the client supplies
the set of Printer attribute names and/or attribute group names in which the set of Printer attribute names and/or attribute group names in
the requester is interested. In the response, the Printer object which the requester is interested. In the response, the Printer
returns a corresponding attribute set with the appropriate attribute object returns a corresponding attribute set with the appropriate
values filled in. attribute values filled in.
For Printer objects, the possible names of attribute groups are: For Printer objects, the possible names of attribute groups are:
Expires September 1, 2000 - 'job-template': the subset of the Job Template attributes that
- 'job-template': the subset of the Job Template attributes that apply to a Printer object (the last two columns of the table in
apply to a Printer object (the last two columns of the table in Section 4.2) that the implementation supports for Printer
Section 4.2) that the implementation supports for Printer objects. objects.
- 'printer-description': the subset of the attributes specified in - 'printer-description': the subset of the attributes specified in
Section 4.4 that the implementation supports for Printer objects. Section 4.4 that the implementation supports for Printer
- 'all': the special group 'all' that includes all attributes that objects.
the implementation supports for Printer objects.
Since a client MAY request specific attributes or named groups, there is - 'all': the special group 'all' that includes all attributes that
a potential that there is some overlap. For example, if a client the implementation supports for Printer objects.
requests, 'printer-name' and 'all', the client is actually requesting
the "printer-name" attribute twice: once by naming it explicitly, and
once by inclusion in the 'all' group. In such cases, the Printer object
NEED NOT return each attribute only once in the response even if it is
requested multiple times. The client SHOULD NOT request the same
attribute in multiple ways.
It is NOT REQUIRED that a Printer object support all attributes Since a client MAY request specific attributes or named groups, there
belonging to a group (since some attributes are OPTIONAL). However, it is a potential that there is some overlap. For example, if a client
is REQUIRED that each Printer object support all group names. requests, 'printer-name' and 'all', the client is actually requesting
the "printer-name" attribute twice: once by naming it explicitly, and
once by inclusion in the 'all' group. In such cases, the Printer
object NEED NOT return each attribute only once in the response even
if it is requested multiple times. The client SHOULD NOT request the
same attribute in multiple ways.
3.2.5.1 Get-Printer-Attributes Request It is NOT REQUIRED that a Printer object support all attributes
belonging to a group (since some attributes are OPTIONAL). However,
it is REQUIRED that each Printer object support all group names.
The following sets of attributes are part of the Get-Printer-Attributes 3.2.5.1 Get-Printer-Attributes Request
Request:
Group 1: Operation Attributes The following sets of attributes are part of the Get-Printer-
Attributes Request:
Natural Language and Character Set: Group 1: Operation Attributes
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.1.
Target: Natural Language and Character Set:
The "printer-uri" (uri) operation attribute which is the target for The "attributes-charset" and "attributes-natural-language"
this operation as described in section 3.1.5. attributes as described in section 3.1.4.1.
Requesting User Name: Target:
The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied The "printer-uri" (uri) operation attribute which is the target
by the client as described in section 8.3. for this operation as described in section 3.1.5.
"requested-attributes" (1setOf keyword) : Requesting User Name:
The client OPTIONALLY supplies a set of attribute names and/or The "requesting-user-name" (name(MAX)) attribute SHOULD be
attribute group names in whose values the requester is interested. supplied by the client as described in section 8.3.
The Printer object MUST support this attribute. If the client
omits this attribute, the Printer MUST respond as if this attribute
had been supplied with a value of 'all'.
"document-format" (mimeMediaType) : "requested-attributes" (1setOf keyword):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies a set of attribute names and/or
MUST support this attribute. This attribute is useful for a attribute group names in whose values the requester is
Printer object to determine the set of supported attribute values interested. The Printer object MUST support this attribute.
that relate to the requested document format. The Printer object If the client omits this attribute, the Printer MUST respond as
MUST return the attributes and values that it uses to validate a if this attribute had been supplied with a value of 'all'.
Expires September 1, 2000 "document-format" (mimeMediaType):
job on a create or Validate-Job operation in which this document The client OPTIONALLY supplies this attribute. The Printer
format is supplied. The Printer object SHOULD return only (1) those object MUST support this attribute. This attribute is useful
attributes that are supported for the specified format and (2) the for a Printer object to determine the set of supported
attribute values that are supported for the specified document attribute values that relate to the requested document format.
format. By specifying the document format, the client can get the The Printer object MUST return the attributes and values that
Printer object to eliminate the attributes and values that are not it uses to validate a job on a create or Validate-Job operation
supported for a specific document format. For example, a Printer in which this document format is supplied. The Printer object
object might have multiple interpreters to support both SHOULD return only (1) those attributes that are supported for
'application/postscript' (for PostScript) and 'text/plain' (for the specified format and (2) the attribute values that are
text) documents. However, for only one of those interpreters might supported for the specified document format. By specifying the
the Printer object be able to support "number-up" with values of document format, the client can get the Printer object to
'1', '2', and '4'. For the other interpreter it might be able to eliminate the attributes and values that are not supported for
only support "number-up" with a value of '1'. Thus a client can use a specific document format. For example, a Printer object
the Get-Printer-Attributes operation to obtain the attributes and might have multiple interpreters to support both
values that will be used to accept/reject a create job operation. 'application/postscript' (for PostScript) and 'text/plain' (for
text) documents. However, for only one of those interpreters
might the Printer object be able to support "number-up" with
values of '1', '2', and '4'. For the other interpreter it
might be able to only support "number-up" with a value of '1'.
Thus a client can use the Get-Printer-Attributes operation to
obtain the attributes and values that will be used to
accept/reject a create job operation.
If the Printer object does not distinguish between different sets If the Printer object does not distinguish between different
of supported values for each different document format when sets of supported values for each different document format
validating jobs in the create and Validate-Job operations, it MUST when validating jobs in the create and Validate-Job operations,
NOT distinguish between different document formats in the Get- it MUST NOT distinguish between different document formats in
Printer-Attributes operation. If the Printer object does the Get-Printer-Attributes operation. If the Printer object
distinguish between different sets of supported values for each does distinguish between different sets of supported values for
different document format specified by the client, this each different document format specified by the client, this
specialization applies only to the following Printer object specialization applies only to the following Printer object
attributes: attributes:
- Printer attributes that are Job Template attributes ("xxx- - Printer attributes that are Job Template attributes ("xxx-
default" "xxx-supported", and "xxx-ready" in the Table in default" "xxx-supported", and "xxx-ready" in the Table in
Section 4.2), Section 4.2),
- "pdl-override-supported", - "pdl-override-supported",
- "compression-supported", - "compression-supported",
- "job-k-octets-supported", - "job-k-octets-supported",
- "job-impressions-supported, - "job-impressions-supported",
- "job-media-sheets-supported" - "job-media-sheets-supported",
- "printer-driver-installer", - "printer-driver-installer",
- "color-supported", and - "color-supported", and
- "reference-uri-schemes-supported" - "reference-uri-schemes-supported"
The values of all other Printer object attributes (including The values of all other Printer object attributes (including
"document-format-supported") remain invariant with respect to the "document-format-supported") remain invariant with respect to the
client supplied document format (except for new Printer description client supplied document format (except for new Printer
attribute as registered according to section 6.2). description attribute as registered according to section 6.2).
If the client omits this "document-format" operation attribute, the If the client omits this "document-format" operation attribute,
Printer object MUST respond as if the attribute had been supplied the Printer object MUST respond as if the attribute had been
with the value of the Printer object's "document-format-default" supplied with the value of the Printer object's "document-format-
attribute. It is recommended that the client always supply a value default" attribute. It is RECOMMENDED that the client always
for "document-format", since the Printer object's "document-format- supply a value for "document-format", since the Printer object's
default" may be 'application/octet-stream', in which case the "document-format-default" may be 'application/octet-stream', in
returned attributes and values are for the union of the document which case the returned attributes and values are for the union of
formats that the Printer can automatically sense. For more the document formats that the Printer can automatically sense.
details, see the description of the 'mimeMediaType' attribute For more details, see the description of the 'mimeMediaType'
syntax in section 4.1.9. attribute syntax in section 4.1.9.
Expires September 1, 2000 If the client supplies a value for the "document-format" Operation
If the client supplies a value for the "document-format" Operation attribute that is not supported by the Printer, i.e., is not among
attribute that is not supported by the Printer, i.e., is not among the values of the Printer object's "document-format-supported"
the values of the Printer object's "document-format-supported" attribute, the Printer object MUST reject the operation and return
attribute, the Printer object MUST reject the operation and return the 'client-error-document-format-not-supported' status code.
the 'client-error-document-format-not-supported' status code.
3.2.5.2 Get-Printer-Attributes Response 3.2.5.2 Get-Printer-Attributes Response
The Printer object returns the following sets of attributes as part of The Printer object returns the following sets of attributes as part
the Get-Printer-Attributes Response: of the Get-Printer-Attributes Response:
Group 1: Operation Attributes
Status Message: Group 1: Operation Attributes
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 sections 13 and 3.1.6.
Natural Language and Character Set: Status Message:
The "attributes-charset" and "attributes-natural-language" In addition to the REQUIRED status code returned in every
attributes as described in section 3.1.4.2. response, the response OPTIONALLY includes a "status-message"
(text(255)) and/or a "detailed-status-message" (text(MAX))
operation attribute as described in sections 13 and 3.1.6.
Group 2: Unsupported Attributes Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.2.
See section 3.1.7 for details on returning Unsupported Attributes. Group 2: Unsupported Attributes
The response NEED NOT contain the "requested-attributes" operation See section 3.1.7 for details on returning Unsupported Attributes.
attribute with any supplied values (attribute keywords) that were
requested by the client but are not supported by the IPP object. If
the Printer object does include unsupported attributes referenced
in "requested-attributes" and such attributes include group names,
such as 'all', the unsupported attributes MUST NOT include
attributes described in the standard but not supported by the
implementation.
Group 3: Printer Object Attributes The response NEED NOT contain the "requested-attributes" operation
attribute with any supplied values (attribute keywords) that were
requested by the client but are not supported by the IPP object.
If the Printer object does return unsupported attributes
referenced in the "requested-attributes" operation attribute and
that attribute included group names, such as 'all', the
unsupported attributes MUST NOT include attributes described in
the standard but not supported by the implementation.
This is the set of requested attributes and their current values. Group 3: Printer Object Attributes
The Printer object ignores (does not respond with) any requested
attribute which is not supported. The Printer object MAY respond
with a subset of the supported attributes and values, depending on
the security policy in force. However, the Printer object MUST
respond with the 'unknown' value for any supported attribute
(including all REQUIRED attributes) for which the Printer object
does not know the value. Also the Printer object MUST respond with
the 'no-value' for any supported attribute (including all REQUIRED
attributes) for which the system administrator has not configured a
value. See the description of the "out-of-band" values in the
beginning of Section 4.1.
Expires September 1, 2000 This is the set of requested attributes and their current values.
The Printer object ignores (does not respond with) any requested
attribute which is not supported. The Printer object MAY respond
with a subset of the supported attributes and values, depending on
the security policy in force. However, the Printer object MUST
respond with the 'unknown' value for any supported attribute
(including all REQUIRED attributes) for which the Printer object
does not know the value. Also the Printer object MUST respond
with the 'no-value' for any supported attribute (including all
REQUIRED attributes) for which the system administrator has not
configured a value. See the description of the "out-of-band"
values in the beginning of Section 4.1.
3.2.6 Get-Jobs Operation 3.2.6 Get-Jobs Operation
This REQUIRED operation allows a client to retrieve the list of Job This REQUIRED operation allows a client to retrieve the list of Job
objects belonging to the target Printer object. The client may also objects belonging to the target Printer object. The client may also
supply a list of Job attribute names and/or attribute group names. A supply a list of Job attribute names and/or attribute group names. A
group of Job object attributes will be returned for each Job object that group of Job object attributes will be returned for each Job object
is returned. that is returned.
This operation is similar to the Get-Job-Attributes operation, except This operation is similar to the Get-Job-Attributes operation, except
that this Get-Jobs operation returns attributes from possibly more than that this Get-Jobs operation returns attributes from possibly more
one object (see the description of Job attribute group names in section than one object.
3.3.4).
3.2.6.1 Get-Jobs Request 3.2.6.1 Get-Jobs Request
The client submits the Get-Jobs request to a Printer object. The client submits the Get-Jobs request to a Printer object.
The following groups of attributes are part of the Get-Jobs Request:
Group 1: Operation Attributes The following groups of attributes are part of the Get-Jobs Request:
Natural Language and Character Set: Group 1: Operation Attributes
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.1.
Target: Natural Language and Character Set:
The "printer-uri" (uri) operation attribute which is the target for The "attributes-charset" and "attributes-natural-language"
this operation as described in section 3.1.5. attributes as described in section 3.1.4.1.
Requesting User Name: Target:
The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied The "printer-uri" (uri) operation attribute which is the target
by the client as described in section 8.3. for this operation as described in section 3.1.5.
"limit" (integer(1:MAX)): Requesting User Name:
The client OPTIONALLY supplies this attribute. The Printer object The "requesting-user-name" (name(MAX)) attribute SHOULD be
MUST support this attribute. It is an integer value that determines supplied by the client as described in section 8.3.
the maximum number of jobs that a client will receive from the
Printer even if "which-jobs" or "my-jobs" constrain which jobs are
returned. The limit is a "stateless limit" in that if the value
supplied by the client is 'N', then only the first 'N' jobs are
returned in the Get-Jobs Response. There is no mechanism to allow
for the next 'M' jobs after the first 'N' jobs. If the client does
not supply this attribute, the Printer object responds with all
applicable jobs.
"requested-attributes" (1setOf keyword): "limit" (integer(1:MAX)):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
MUST support this attribute. It is a set of Job attribute names object MUST support this attribute. It is an integer value that
and/or attribute groups names in whose values the requester is determines the maximum number of jobs that a client will
interested. This set of attributes is returned for each Job object receive from the Printer even if "which-jobs" or "my-jobs"
that is returned. The allowed attribute group names are the same constrain which jobs are returned. The limit is a "stateless
as those defined in the Get-Job-Attributes operation in section limit" in that if the value supplied by the client is 'N', then
3.3.4. If the client does not supply this attribute, the Printer only the first 'N' jobs are returned in the Get-Jobs Response.
There is no mechanism to allow for the next 'M' jobs after the
first 'N' jobs. If the client does not supply this attribute,
the Printer object responds with all applicable jobs.
Expires September 1, 2000 "requested-attributes" (1setOf type2 keyword):
MUST respond as if the client had supplied this attribute with two The client OPTIONALLY supplies this attribute. The Printer
values: 'job-uri' and 'job-id'. object MUST support this attribute. It is a set of Job
attribute names and/or attribute groups names in whose values
the requester is interested. This set of attributes is
returned for each Job object that is returned. The allowed
attribute group names are the same as those defined in the
Get-Job-Attributes operation in section 3.3.4. If the client
does not supply this attribute, the Printer MUST respond as if
the client had supplied this attribute with two values: 'job-
uri' and 'job-id'.
"which-jobs" (type2 keyword): "which-jobs" (type2 keyword):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
MUST support this attribute. It indicates which Job objects MUST object MUST support this attribute. It indicates which Job
be returned by the Printer object. The values for this attribute objects MUST be returned by the Printer object. The values for
are: this attribute are:
'completed': This includes any Job object whose state is 'completed': This includes any Job object whose state is
'completed', 'canceled', or 'aborted'. 'completed', 'canceled', or 'aborted'.
'not-completed': This includes any Job object whose state is 'not-completed': This includes any Job object whose state is
'pending', 'processing', 'processing-stopped', or 'pending- 'pending', 'processing', 'processing-stopped', or 'pending-
held'. held'.
A Printer object MUST support both values. However, if the A Printer object MUST support both values. However, if the
implementation does not keep jobs in the 'completed', 'canceled', implementation does not keep jobs in the 'completed',
and 'aborted' states, then it returns no jobs when the 'completed' 'canceled', and 'aborted' states, then it returns no jobs when
value is supplied. the 'completed' value is supplied.
If a client supplies some other value, the Printer object MUST copy If a client supplies some other value, the Printer object MUST
the attribute and the unsupported value to the Unsupported copy the attribute and the unsupported value to the Unsupported
Attributes response group, reject the request, and return the Attributes response group, reject the request, and return the
'client-error-attributes-or-values-not-supported' status code. 'client-error-attributes-or-values-not-supported' status code.
If the client does not supply this attribute, the Printer object If the client does not supply this attribute, the Printer
MUST respond as if the client had supplied the attribute with a object MUST respond as if the client had supplied the attribute
value of 'not-completed'. with a value of 'not-completed'.
"my-jobs" (boolean): "my-jobs" (boolean):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
MUST support this attribute. It indicates whether jobs from all object MUST support this attribute. It indicates whether jobs
users or just the jobs submitted by the requesting user of this from all users or just the jobs submitted by the requesting
request MUST be returned by the Printer object. If the client does user of this request MUST be considered as candidate jobs to be
not supply this attribute, the Printer object MUST respond as if returned by the Printer object. If the client does not supply
the client had supplied the attribute with a value of 'false', this attribute, the Printer object MUST respond as if the
i.e., jobs from all users. The means for authenticating the client had supplied the attribute with a value of 'false',
requesting user and matching the jobs is described in section 8. i.e., jobs from all users. The means for authenticating the
requesting user and matching the jobs is described in section
8.
3.2.6.2 Get-Jobs Response 3.2.6.2 Get-Jobs Response
The Printer object returns all of the Job objects up to the number The Printer object returns all of the Job objects up to the number
specified by the "limit" attribute that match the criteria as defined by specified by the "limit" attribute that match the criteria as defined
the attribute values supplied by the client in the request. It is by the attribute values supplied by the client in the request. It is
possible that no Job objects are returned since there may literally be possible that no Job objects are returned since there may literally
no Job objects at the Printer, or there may be no Job objects that match be no Job objects at the Printer, or there may be no Job objects that
the criteria supplied by the client. If the client requests any Job match the criteria supplied by the client. If the client requests
attributes at all, there is a set of Job Object Attributes returned for any Job attributes at all, there is a set of Job Object Attributes
each Job object. returned for each Job object.
It is not an error for the Printer to return 0 jobs. If the response
returns 0 jobs because there are no jobs matching the criteria, and the
request would have returned 1 or more jobs with a status code of
Expires September 1, 2000
'successful-ok' if there had been jobs matching the criteria, then the
status code for 0 jobs MUST be 'successful-ok'.
Group 1: Operation Attributes It is not an error for the Printer to return 0 jobs. If the response
returns 0 jobs because there are no jobs matching the criteria, and
the request would have returned 1 or more jobs with a status code of
'successful-ok' if there had been jobs matching the criteria, then
the status code for 0 jobs MUST be 'successful-ok'.
Status Message: Group 1: Operation Attributes
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 sections 13 and 3.1.6.
Natural Language and Character Set: Status Message:
The "attributes-charset" and "attributes-natural-language" In addition to the REQUIRED status code returned in every
attributes as described in section 3.1.4.2. response, the response OPTIONALLY includes a "status-message"
(text(255)) and/or a "detailed-status-message" (text(MAX))
operation attribute as described in sections 13 and 3.1.6.
Group 2: Unsupported Attributes Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.2.
See section 3.1.7 for details on returning Unsupported Attributes. Group 2: Unsupported Attributes
The response NEED NOT contain the "requested-attributes" operation See section 3.1.7 for details on returning Unsupported Attributes.
attribute with any supplied values (attribute keywords) that were
requested by the client but are not supported by the IPP object. If
the Printer object does include unsupported attributes referenced
in "requested-attributes" and such attributes include group names,
such as 'all', the unsupported attributes MUST NOT include
attributes described in the standard but not supported by the
implementation.
Groups 3 to N: Job Object Attributes The response NEED NOT contain the "requested-attributes" operation
attribute with any supplied values (attribute keywords) that were
requested by the client but are not supported by the IPP object.
If the Printer object does return unsupported attributes
referenced in the "requested-attributes" operation attribute and
that attribute included group names, such as 'all', the
unsupported attributes MUST NOT include attributes described in
the standard but not supported by the implementation.
The Printer object responds with one set of Job Object Attributes Groups 3 to N: Job Object Attributes
for each returned Job object. The Printer object ignores (does not
respond with) any requested attribute or value which is not
supported or which is restricted by the security policy in force,
including whether the requesting user is the user that submitted
the job (job originating user) or not (see section 8). However,
the Printer object MUST respond with the 'unknown' value for any
supported attribute (including all REQUIRED attributes) for which
the Printer object does not know the value, unless it would violate
the security policy. See the description of the "out-of-band"
values in the beginning of Section 4.1.
Jobs are returned in the following order: The Printer object responds with one set of Job Object Attributes
for each returned Job object. The Printer object ignores (does
not respond with) any requested attribute or value which is not
supported or which is restricted by the security policy in force,
including whether the requesting user is the user that submitted
the job (job originating user) or not (see section 8). However,
the Printer object MUST respond with the 'unknown' value for any
supported attribute (including all REQUIRED attributes) for which
the Printer object does not know the value, unless it would
violate the security policy. See the description of the "out-of-
band" values in the beginning of Section 4.1.
- If the client requests all 'completed' Jobs (Jobs in the Jobs are returned in the following order:
'completed', 'aborted', or 'canceled' states), then the Jobs
are returned newest to oldest (with respect to actual
completion time)
- If the client requests all 'not-completed' Jobs (Jobs in the
'pending', 'processing', 'pending-held', and 'processing-
stopped' states), then Jobs are returned in relative
chronological order of expected time to complete (based on
whatever scheduling algorithm is configured for the Printer
object).
Expires September 1, 2000 - If the client requests all 'completed' Jobs (Jobs in the
'completed', 'aborted', or 'canceled' states), then the Jobs are
returned newest to oldest (with respect to actual completion
time)
- If the client requests all 'not-completed' Jobs (Jobs in the
'pending', 'processing', 'pending-held', and 'processing-
stopped' states), then Jobs are returned in relative
chronological order of expected time to complete (based on
whatever scheduling algorithm is configured for the Printer
object).
3.2.7 Pause-Printer Operation 3.2.7 Pause-Printer Operation
This OPTIONAL operation allows a client to stop the Printer object from This OPTIONAL operation allows a client to stop the Printer object
scheduling jobs on all its devices. Depending on implementation, the from scheduling jobs on all its devices. Depending on
Pause-Printer operation MAY also stop the Printer from processing the implementation, the Pause-Printer operation MAY also stop the Printer
current job or jobs. Any job that is currently being printed is either from processing the current job or jobs. Any job that is currently
stopped as soon as the implementation permits or is completed, depending being printed is either stopped as soon as the implementation permits
on implementation. The Printer object MUST still accept create or is completed, depending on implementation. The Printer object
operations to create new jobs, but MUST prevent any jobs from entering MUST still accept create operations to create new jobs, but MUST
the 'processing' state. prevent any jobs from entering the 'processing' state.
If the Pause-Printer operation is supported, then the Resume-Printer If the Pause-Printer operation is supported, then the Resume-Printer
operation MUST be supported, and vice-versa. operation MUST be supported, and vice-versa.
The IPP Printer stops the current job(s) on its device(s) that were in The IPP Printer stops the current job(s) on its device(s) that were
the 'processing' or 'processing-stopped' states as soon as the in the 'processing' or 'processing-stopped' states as soon as the
implementation permits. If the implementation will take appreciable implementation permits. If the implementation will take appreciable
time to stop, the IPP Printer adds the 'moving-to-paused' value to the time to stop, the IPP Printer adds the 'moving-to-paused' value to
Printer object's "printer-state-reasons" attribute (see section 4.4.12). the Printer object's "printer-state-reasons" attribute (see section
When the device(s) have all stopped, the IPP Printer transitions the 4.4.12). When the device(s) have all stopped, the IPP Printer
Printer object to the 'stopped' state, removes the 'moving-to-paused' transitions the Printer object to the 'stopped' state, removes the
value, if present, and adds the 'paused' value to the Printer object's 'moving-to-paused' value, if present, and adds the 'paused' value to
"printer-state-reasons" attribute. the Printer object's "printer-state-reasons" attribute.
When the current job(s) complete that were in the 'processing' state, When the current job(s) complete that were in the 'processing' state,
the IPP Printer transitions them to the 'completed' state. When the the IPP Printer transitions them to the 'completed' state. When the
current job(s) stop in mid processing that were in the 'processing' current job(s) stop in mid processing that were in the 'processing'
state, the IPP Printer transitions them to the 'processing-stopped' state, the IPP Printer transitions them to the 'processing-stopped'
state and adds the 'printer-stopped' value to the job's "job-state- state and adds the 'printer-stopped' value to the job's "job-state-
reasons" attribute. reasons" attribute.
For any jobs that are 'pending' or 'pending-held', the 'printer-stopped' For any jobs that are 'pending' or 'pending-held', the 'printer-
value of the jobs' "job-state-reasons" attribute also applies. However, stopped' value of the jobs' "job-state-reasons" attribute also
the IPP Printer NEED NOT update those jobs' "job-state-reasons" applies. However, the IPP Printer NEED NOT update those jobs' "job-
attributes and only need return the 'printer-stopped' value when those state-reasons" attributes and only need return the 'printer-stopped'
jobs are queried (so-called "lazy evaluation"). value when those jobs are queried (so-called "lazy evaluation").
Whether the Pause-Printer operation affects jobs that were submitted to Whether the Pause-Printer operation affects jobs that were submitted
the device from other sources than the IPP Printer object in the same to the device from other sources than the IPP Printer object in the
way that the Pause-Printer operation affects jobs that were submitted to same way that the Pause-Printer operation affects jobs that were
the IPP Printer object using IPP, depends on implementation, i.e., on submitted to the IPP Printer object using IPP, depends on
whether the IPP protocol is being used as a universal management implementation, i.e., on whether the IPP protocol is being used as a
protocol or just to manage IPP jobs, respectively. universal management protocol or just to manage IPP jobs,
respectively.
The IPP Printer MUST accept the request in any state and transition the The IPP Printer MUST accept the request in any state and transition
Printer to the indicated new "printer-state" before returning as the Printer to the indicated new "printer-state" before returning as
follows: follows:
Expires September 1, 2000
Current New "printer IPP Printer's response status Current New "printer IPP Printer's response status
"printer- "printer- -state- code and action: "printer- "printer- -state- code and action:
state" state" reasons" state" state" reasons"
'idle' 'stopped' 'paused' 'successful-ok' 'idle' 'stopped' 'paused' 'successful-ok'
'processing' 'processing' 'moving- OPTION 1: 'successful-ok'; 'processing' 'processing' 'moving- OPTION 1: 'successful-ok';
to- Later, when all output has to- Later, when all output has
paused' stopped, the "printer-state" paused' stopped, the "printer-state"
becomes 'stopped', and the becomes 'stopped', and the
'paused' value replaces the 'paused' value replaces the
'moving-to-paused' value in the 'moving-to-paused' value in the
"printer-state-reasons" "printer-state-reasons"
attribute attribute
'processing' 'stopped' 'paused' OPTION 2: 'successful-ok'; 'processing' 'stopped' 'paused' OPTION 2: 'successful-ok';
all device output stopped all device output stopped
immediately immediately
'stopped' 'stopped' 'paused' 'successful-ok' 'stopped' 'stopped' 'paused' 'successful-ok'
Access Rights: The authenticated user (see section 8.3) performing this Access Rights: The authenticated user (see section 8.3) performing
operation must be an operator or administrator of the Printer object this operation must be an operator or administrator of the Printer
(see Sections 1 and 8.5). Otherwise, the IPP Printer MUST reject the object (see Sections 1 and 8.5). Otherwise, the IPP Printer MUST
operation and return: 'client-error-forbidden', 'client-error-not- reject the operation and return: 'client-error-forbidden', 'client-
authenticated', or 'client-error-not-authorized' as appropriate. error-not-authenticated', or 'client-error-not-authorized' as
appropriate.
3.2.7.1 Pause-Printer Request 3.2.7.1 Pause-Printer Request
The following groups of attributes are part of the Pause-Printer The following groups of attributes are part of the Pause-Printer
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 section 3.1.4.1. attributes as described in section 3.1.4.1.
Target: Target:
The "printer-uri" (uri) operation attribute which is the target for The "printer-uri" (uri) operation attribute which is the target
this operation as described in section 3.1.5. for this operation as described in section 3.1.5.
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 section 8.3. supplied by the client as described in section 8.3.
3.2.7.2 Pause-Printer Response 3.2.7.2 Pause-Printer Response
The following groups of attributes are part of the Pause-Printer The following groups of attributes are part of the Pause-Printer
Response: Response:
Group 1: Operation Attributes
Status Message: Group 1: Operation Attributes
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 sections 13 and 3.1.6.
Expires September 1, 2000 Status Message:
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 sections 13 and 3.1.6.
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 3.1.4.2. attributes as described in section 3.1.4.2.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See section 3.1.7 for details on returning Unsupported Attributes. See section 3.1.7 for details on returning Unsupported Attributes.
3.2.8 Resume-Printer Operation 3.2.8 Resume-Printer Operation
This operation allows a client to resume the Printer object scheduling This operation allows a client to resume the Printer object
jobs on all its devices. The Printer object MUST remove the 'paused' scheduling jobs on all its devices. The Printer object MUST remove
and 'moving-to-paused' values from the Printer object's "printer-state- the 'paused' and 'moving-to-paused' values from the Printer object's
reasons" attribute, if present. If there are no other reasons to keep a "printer-state-reasons" attribute, if present. If there are no other
device paused (such as media-jam), the IPP Printer is free to transition reasons to keep a device paused (such as media-jam), the IPP Printer
itself to the 'processing' or 'idle' states, depending on whether there is free to transition itself to the 'processing' or 'idle' states,
are jobs to be processed or not, respectively, and the device(s) resume depending on whether there are jobs to be processed or not,
processing jobs. respectively, and the device(s) resume processing jobs.
If the Pause-Printer operation is supported, then the Resume-Printer If the Pause-Printer operation is supported, then the Resume-Printer
operation MUST be supported, and vice-versa. operation MUST be supported, and vice-versa.
The IPP Printer removes the 'printer-stopped' value from any job's "job- The IPP Printer removes the 'printer-stopped' value from any job's
state-reasons" attributes contained in that Printer. "job-state-reasons" attributes contained in that Printer.
The IPP Printer MUST accept the request in any state, transition the The IPP Printer MUST accept the request in any state, transition the
Printer object to the indicated new state as follows: Printer object to the indicated new state as follows:
Current New "printer- IPP Printer's response status code and Current New "printer- IPP Printer's response status code and
"printer- state" action: "printer- state" action:
state" state"
'idle' 'idle' 'successful-ok' 'idle' 'idle' 'successful-ok'
'processing 'processing' 'successful-ok' 'processing' 'processing' 'successful-ok'
'
'stopped' 'processing' 'successful-ok';
when there are jobs to be processed
'stopped' 'idle' 'successful-ok';
when there are no jobs to be processed.
Access Rights: The authenticated user (see section 8.3) performing this 'stopped' 'processing' 'successful-ok';
operation must be an operator or administrator of the Printer object when there are jobs to be processed
(see Sections 1 and 8.5). Otherwise, the IPP Printer MUST reject the 'stopped' 'idle' 'successful-ok';
operation and return: 'client-error-forbidden', 'client-error-not- when there are no jobs to be processed.
authenticated', or 'client-error-not-authorized' as appropriate.
The Resume-Printer Request and Resume-Printer Response have the same Access Rights: The authenticated user (see section 8.3) performing
attribute groups and attributes as the Pause-Printer operation (see this operation must be an operator or administrator of the Printer
sections 3.2.7.1 and 3.2.7.2). object (see Sections 1 and 8.5). Otherwise, the IPP Printer MUST
reject the operation and return: 'client-error-forbidden', 'client-
error-not-authenticated', or 'client-error-not-authorized' as
appropriate.
The Resume-Printer Request and Resume-Printer Response have the same
attribute groups and attributes as the Pause-Printer operation (see
sections 3.2.7.1 and 3.2.7.2).
Expires September 1, 2000
3.2.9 Purge-Jobs Operation 3.2.9 Purge-Jobs Operation
This OPTIONAL operation allows a client to remove all jobs from an IPP This OPTIONAL operation allows a client to remove all jobs from an
Printer object, regardless of their job states, including jobs in the IPP Printer object, regardless of their job states, including jobs in
Printer object's Job History (see Section 4.3.7.2). After a Purge-Jobs the Printer object's Job History (see Section 4.3.7.2). After a
operation has been performed, a Printer object MUST return no jobs in Purge-Jobs operation has been performed, a Printer object MUST return
subsequent Get-Job-Attributes and Get-Jobs responses (until new jobs are no jobs in subsequent Get-Job-Attributes and Get-Jobs responses
submitted). (until new jobs are submitted).
Whether the Purge-Jobs (and Get-Jobs) operation affects jobs that were Whether the Purge-Jobs (and Get-Jobs) operation affects jobs that
submitted to the device from other sources than the IPP Printer object were submitted to the device from other sources than the IPP Printer
in the same way that the Purge-Jobs operation affects jobs that were object in the same way that the Purge-Jobs operation affects jobs
submitted to the IPP Printer object using IPP, depends on that were submitted to the IPP Printer object using IPP, depends on
implementation, i.e., on whether the IPP protocol is being used as a implementation, i.e., on whether the IPP protocol is being used as a
universal management protocol or just to manage IPP jobs, respectively. universal management protocol or just to manage IPP jobs,
respectively.
Note: if an operator wants to cancel all jobs without clearing out the Note: if an operator wants to cancel all jobs without clearing out
Job History, the operator uses the Cancel-Job operation on each job the Job History, the operator uses the Cancel-Job operation on each
instead of using the Purge-Jobs operation. job instead of using the Purge-Jobs operation.
The Printer object MUST accept this operation in any state and The Printer object MUST accept this operation in any state and
transition the Printer object to the 'idle' state. transition the Printer object to the 'idle' state.
Access Rights: The authenticated user (see section 8.3) performing this Access Rights: The authenticated user (see section 8.3) performing
operation must be an operator or administrator of the Printer object this operation must be an operator or administrator of the Printer
(see Sections 1 and 8.5). Otherwise, the IPP object MUST reject the object (see Sections 1 and 8.5). Otherwise, the IPP object MUST
operation and return: client-error-forbidden, client-error-not- reject the operation and return: client-error-forbidden, client-
authenticated, and client-error-not-authorized as appropriate. error-not-authenticated, and client-error-not-authorized as
appropriate.
The Purge-Jobs Request and Purge-Jobs Response have the same attribute The Purge-Jobs Request and Purge-Jobs Response have the same
groups and attributes as the Pause-Printer operation (see sections attribute groups and attributes as the Pause-Printer operation (see
3.2.7.1 and 3.2.7.2). sections 3.2.7.1 and 3.2.7.2).
3.3 Job Operations 3.3 Job Operations
All Job operations are directed at Job objects. A client MUST always All Job operations are directed at Job objects. A client MUST always
supply some means of identifying the Job object in order to identify the supply some means of identifying the Job object in order to identify
correct target of the operation. That job identification MAY either be the correct target of the operation. That job identification MAY
a single Job URI or a combination of a Printer URI with a Job ID. The either be a single Job URI or a combination of a Printer URI with a
IPP object implementation MUST support both forms of identification for Job ID. The IPP object implementation MUST support both forms of
every job. identification for every job.
3.3.1 Send-Document Operation 3.3.1 Send-Document Operation
This OPTIONAL operation allows a client to create a multi-document Job This OPTIONAL operation allows a client to create a multi-document
object that is initially "empty" (contains no documents). In the Job object that is initially "empty" (contains no documents). In the
Create-Job response, the Printer object returns the Job object's URI Create-Job response, the Printer object returns the Job object's URI
(the "job-uri" attribute) and the Job object's 32-bit identifier (the (the "job-uri" attribute) and the Job object's 32-bit identifier (the
"job-id" attribute). For each new document that the client desires to "job-id" attribute). For each new document that the client desires
add, the client uses a Send-Document operation. Each Send-Document to add, the client uses a Send-Document operation. Each Send-
Request contains the entire stream of document data for one document. Document Request contains the entire stream of document data for one
document.
Expires September 1, 2000 If the Printer supports this operation but does not support multiple
If the Printer supports this operation but does not support multiple documents per job, the Printer MUST reject subsequent Send-Document
documents per job, the Printer MUST reject subsequent Send-Document operations supplied with data and return the 'server-error-multiple-
operations supplied with data and return the 'server-error-multiple- document-jobs-not-supported'. However, the Printer MUST accept the
document-jobs-not-supported'. However, the Printer MUST accept the first document with a 'true' or 'false' value for the "last-document"
first document with a 'true' or 'false' value for the "last-document" operation attribute (see below), so that clients MAY always submit
operation attribute (see below), so that clients MAY always submit one one document jobs with a 'false' value for "last-document" in the
document jobs with a 'false' value for "last-document" in the first first Send-Document and a 'true' for "last-document" in the second
Send-Document and a 'true' for "last-document" in the second Send- Send-Document (with no data).
Document (with no data).
Since the Create-Job and the send operations (Send-Document or Send-URI Since the Create-Job and the send operations (Send-Document or Send-
operations) that follow could occur over an arbitrarily long period of URI operations) that follow could occur over an arbitrarily long
time for a particular job, a client MUST send another send operation period of time for a particular job, a client MUST send another send
within an IPP Printer defined minimum time interval after the receipt of operation within an IPP Printer defined minimum time interval after
the previous request for the job. If a Printer object supports multiple the receipt of the previous request for the job. If a Printer object
document jobs, the Printer object MUST support the "multiple-operation- supports the Create-Job and Send-Document operations, the Printer
time-out" attribute (see section 4.4.31). This attribute indicates the object MUST support the "multiple-operation-time-out" attribute (see
minimum number of seconds the Printer object will wait for the next send section 4.4.31). This attribute indicates the minimum number of
operation before taking some recovery action. seconds the Printer object will wait for the next send operation
before taking some recovery action.
An IPP object MUST recover from an errant client that does not supply a An IPP object MUST recover from an errant client that does not supply
send operation, sometime after the minimum time interval specified by a send operation, sometime after the minimum time interval specified
the Printer object's "multiple-operation-time-out" attribute. Such by the Printer object's "multiple-operation-time-out" attribute.
recovery MAY include any of the following or other recovery actions: Such recovery MAY include any of the following or other recovery
actions:
1. Assume that the Job is an invalid job, start the process of 1. Assume that the Job is an invalid job, start the process of
changing the job state to 'aborted', add the 'aborted-by-system' changing the job state to 'aborted', add the 'aborted-by-
value to the job's "job-state-reasons" attribute (see section system' value to the job's "job-state-reasons" attribute (see
4.3.8), and clean up all resources associated with the Job. In section 4.3.8), and clean up all resources associated with the
this case, if another send operation is finally received, the Job. In this case, if another send operation is finally
Printer responds with an "client-error-not-possible" or "client- received, the Printer responds with an "client-error-not-
error-not-found" depending on whether or not the Job object is possible" or "client-error-not-found" depending on whether or
still around when the send operation finally arrives. not the Job object is still around when the send operation
2. Assume that the last send operation received was in fact the last finally arrives.
document (as if the "last-document" flag had been set to 'true'), 2. Assume that the last send operation received was in fact the
close the Job object, and proceed to process it (i.e., move the last document (as if the "last-document" flag had been set to
Job's state to 'pending'). 'true'), close the Job object, and proceed to process it (i.e.,
3. Assume that the last send operation received was in fact the last move the Job's state to 'pending').
document, close the Job, but move it to the 'pending-held' and add 3. Assume that the last send operation received was in fact the
the 'submission-interrupted' value to the job's "job-state-reasons" last document, close the Job, but move it to the 'pending-held'
attribute (see section 4.3.8). This action allows the user or an and add the 'submission-interrupted' value to the job's "job-
operator to determine whether to continue processing the Job by state-reasons" attribute (see section 4.3.8). This action
moving it back to the 'pending' state using the Release-Job allows the user or an operator to determine whether to continue
operation (see section 3.3.6) or to cancel the job using the processing the Job by moving it back to the 'pending' state
Cancel-Job operation (see section 3.3.3). using the Release-Job operation (see section 3.3.6) or to
cancel the job using the Cancel-Job operation (see section
3.3.3).
Each implementation is free to decide the "best" action to take Each implementation is free to decide the "best" action to take
depending on local policy, whether any documents have been added, depending on local policy, whether any documents have been added,
whether the implementation spools jobs or not, and/or any other piece whether the implementation spools jobs or not, and/or any other
of information available to it. If the choice is to abort the Job piece of information available to it. If the choice is to abort the
object, it is possible that the Job object may already have been Job object, it is possible that the Job object may already have been
processed to the point that some media sheet pages have been printed. processed to the point that some media sheet pages have been printed.
Expires September 1, 2000 Access Rights: The authenticated user (see section 8.3) performing
Access Rights: The authenticated user (see section 8.3) performing this this operation must either be the job owner (as determined in the
operation must either be the job owner (as determined in the Create-Job Create-Job operation) or an operator or administrator of the Printer
operation) or an operator or administrator of the Printer object (see object (see Sections 1 and 8.5). Otherwise, the IPP object MUST
Sections 1 and 8.5). Otherwise, the IPP object MUST reject the reject the operation and return: 'client-error-forbidden', 'client-
operation and return: 'client-error-forbidden', 'client-error-not- error-not-authenticated', or 'client-error-not-authorized' as
authenticated', or 'client-error-not-authorized' as appropriate. appropriate.
3.3.1.1 Send-Document Request 3.3.1.1 Send-Document Request
The following attribute sets are part of the Send-Document Request: The following attribute sets are part of the Send-Document Request:
Group 1: Operation Attributes
Natural Language and Character Set: Group 1: Operation Attributes
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.1.
Target: Natural Language and Character Set:
Either (1) the "printer-uri" (uri) plus "job-id" (integer(1:MAX))or The "attributes-charset" and "attributes-natural-language"
(2) the "job-uri" (uri) operation attribute(s) which define the attributes as described in section 3.1.4.1.
target for this operation as described in section 3.1.5.
Requesting User Name: Target:
The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied Either (1) the "printer-uri" (uri) plus "job-id"
by the client as described in section 8.3. (integer(1:MAX))or (2) the "job-uri" (uri) operation
attribute(s) which define the target for this operation as
described in section 3.1.5.
"document-name" (name(MAX)): Requesting User Name:
The client OPTIONALLY supplies this attribute. The Printer object The "requesting-user-name" (name(MAX)) attribute SHOULD be
MUST support this attribute. It contains the client supplied supplied by the client as described in section 8.3.
document name. The document name MAY be different than the Job
name. It might be helpful, but NEED NOT be unique across multiple
documents in the same Job. Typically, the client software
automatically supplies the document name on behalf of the end user
by using a file name or an application generated name. See the
description of the "document-name" operation attribute in the
Print-Job Request (section 3.2.1.1) for more information about this
attribute.
"compression" (type3 keyword) "document-name" (name(MAX)):
See the description of "compression" for the Print-Job operation in The client OPTIONALLY supplies this attribute. The Printer
Section 3.2.1.1. object MUST support this attribute. It contains the client
supplied document name. The document name MAY be different than
the Job name. It might be helpful, but NEED NOT be unique
across multiple documents in the same Job. Typically, the
client software automatically supplies the document name on
behalf of the end user by using a file name or an application
generated name. See the description of the "document-name"
operation attribute in the Print-Job Request (section 3.2.1.1)
for more information about this attribute.
"document-format" (mimeMediaType) : "compression" (type3 keyword):
See the description of "document-format" for the Print-Job See the description of "compression" for the Print-Job operation
operation in Section 3.2.1.1. in Section 3.2.1.1.
"document-natural-language" (naturalLanguage): "document-format" (mimeMediaType):
The client OPTIONALLY supplies this attribute. The Printer object See the description of "document-format" for the Print-Job
OPTIONALLY supports this attribute. This attribute specifies the operation in Section 3.2.1.1.
natural language of the document for those document-formats that
require a specification of the natural language in order to image
the document unambiguously. There are no particular values
required for the Printer object to support.
Expires September 1, 2000 "document-natural-language" (naturalLanguage):
The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute. This attribute
specifies the natural language of the document for those
document-formats that require a specification of the natural
language in order to image the document unambiguously. There
are no particular values required for the Printer object to
support.
"last-document" (boolean): "last-document" (boolean):
The client MUST supply this attribute. The Printer object MUST The client MUST supply this attribute. The Printer object MUST
support this attribute. It is a boolean flag that is set to 'true' support this attribute. It is a boolean flag that is set to
if this is the last document for the Job, 'false' otherwise. 'true' if this is the last document for the Job, 'false'
otherwise.
Group 2: Document Content Group 2: Document Content
The client MUST supply the document data if the "last-document" The client MUST supply the document data if the "last-document"
flag is set to 'false'. However, since a client might not know flag is set to 'false'. However, since a client might not know
that the previous document sent with a Send-Document (or Send-URI) that the previous document sent with a Send-Document (or Send-URI)
operation was the last document (i.e., the "last-document" operation was the last document (i.e., the "last-document"
attribute was set to 'false'), it is legal to send a Send-Document attribute was set to 'false'), it is legal to send a Send-Document
request with no document data where the "last-document" flag is set request with no document data where the "last-document" flag is
to 'true'. Such a request MUST NOT increment the value of the Job set to 'true'. Such a request MUST NOT increment the value of the
object's "number-of-documents" attribute, since no real document Job object's "number-of-documents" attribute, since no real
was added to the job. It is not an error for a client to submit a document was added to the job. It is not an error for a client to
job with no actual document data, i.e., only a single Create-Job submit a job with no actual document data, i.e., only a single
and Send-Document request with a "last-document" operation Create-Job and Send-Document request with a "last-document"
attribute set to 'true' with no document data. operation attribute set to 'true' with no document data.
3.3.1.2 Send-Document Response 3.3.1.2 Send-Document Response
The following sets of attributes are part of the Send-Document Response: The following sets of attributes are part of the Send-Document
Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
In addition to the REQUIRED status code returned in every response, In addition to the REQUIRED status code returned in every
the response OPTIONALLY includes a "status-message" (text(255)) response, the response OPTIONALLY includes a "status-message"
and/or a "detailed-status-message" (text(MAX)) operation attribute (text(255)) and/or a "detailed-status-message" (text(MAX))
as described in sections 13 and 3.1.6. operation attribute as described in sections 13 and 3.1.6.
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 3.1.4.2. attributes as described in section 3.1.4.2.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See section 3.1.7 for details on returning Unsupported Attributes. See section 3.1.7 for details on returning Unsupported Attributes.
Group 3: Job Object Attributes Group 3: Job Object Attributes
This is the same set of attributes as described in the Print-Job This is the same set of attributes as described in the Print-Job
response (see section 3.2.1.2). response (see section 3.2.1.2).
3.3.2 Send-URI Operation 3.3.2 Send-URI Operation
This OPTIONAL operation is identical to the Send-Document operation (see This OPTIONAL operation is identical to the Send-Document operation
section 3.3.1) except that a client MUST supply a URI reference (see section 3.3.1) except that a client MUST supply a URI reference
("document-uri" operation attribute) rather than the document data ("document-uri" operation attribute) rather than the document data
itself. If a Printer object supports this operation, clients can use itself. If a Printer object supports this operation, clients can use
both Send-URI or Send-Document operations to add new documents to an both Send-URI or Send-Document operations to add new documents to an
existing multi-document Job object. However, if a client needs to existing multi-document Job object. However, if a client needs to
indicate that the previous Send-URI or Send-Document was the last indicate that the previous Send-URI or Send-Document was the last
document, the client MUST use the Send-Document operation with no
Expires September 1, 2000 document data and the "last-document" flag set to 'true' (rather than
document, the client MUST use the Send-Document operation with no using a Send-URI operation with no "document-uri" operation
document data and the "last-document" flag set to 'true' (rather than attribute).
using a Send-URI operation with no "document-uri" operation attribute).
If a Printer object supports this operation, it MUST also support the If a Printer object supports this operation, it MUST also support the
Print-URI operation (see section 3.2.2). Print-URI operation (see section 3.2.2).
The Printer object MUST validate the syntax and URI scheme of the The Printer object MUST validate the syntax and URI scheme of the
supplied URI before returning a response, just as in the Print-URI supplied URI before returning a response, just as in the Print-URI
operation. The IPP Printer MAY validate the accessibility of the operation. The IPP Printer MAY validate the accessibility of the
document as part of the operation or subsequently (see section 3.2.2). document as part of the operation or subsequently (see section
3.2.2).
3.3.3 Cancel-Job Operation 3.3.3 Cancel-Job Operation
This REQUIRED operation allows a client to cancel a Print Job from the This REQUIRED operation allows a client to cancel a Print Job from
time the job is created up to the time it is completed, canceled, or the time the job is created up to the time it is completed, canceled,
aborted. Since a Job might already be printing by the time a Cancel-Job or aborted. Since a Job might already be printing by the time a
is received, some media sheet pages might be printed before the job is Cancel-Job is received, some media sheet pages might be printed
actually terminated. before the job is actually terminated.
The IPP object MUST accept or reject the request based on the job's The IPP object MUST accept or reject the request based on the job's
current state and transition the job to the indicated new state as current state and transition the job to the indicated new state as
follows: follows:
Current "job- New "job- IPP object's response status Current "job- New "job- IPP object's response status
state" state" code and action: state" state" code and action:
'pending' 'canceled' 'successful-ok' 'pending' 'canceled' 'successful-ok'
'pending-held' 'canceled' 'successful-ok' 'pending-held' 'canceled' 'successful-ok'
'processing' 'canceled' 'successful-ok' 'processing' 'canceled' 'successful-ok'
'processing' 'processing' 'successful-ok' See Rule 1 'processing' 'processing' 'successful-ok' See Rule 1
'processing' 'processing' 'client-error-not-possible' 'processing' 'processing' 'client-error-not-possible'
See Rule 2 See Rule 2
'processing- 'canceled' 'successful-ok' 'processing- 'canceled' 'successful-ok'
stopped' stopped'
'processing- 'processing- 'successful-ok' See Rule 1 'processing- 'processing- 'successful-ok' See Rule 1
stopped' stopped' stopped' stopped'
'processing- 'processing- 'client-error-not-possible' 'processing- 'processing- 'client-error-not-possible'
stopped' stopped' See Rule 2 stopped' stopped' See Rule 2
'completed' 'completed' 'client-error-not-possible' 'completed' 'completed' 'client-error-not-possible'
'canceled' 'canceled' 'client-error-not-possible' 'canceled' 'canceled' 'client-error-not-possible'
'aborted' 'aborted' 'client-error-not-possible' 'aborted' 'aborted' 'client-error-not-possible'
Rule 1: If the implementation requires some measurable time to cancel Rule 1: If the implementation requires some measurable time to
the job in the 'processing' or 'processing-stopped' job states, the IPP cancel the job in the 'processing' or 'processing-stopped' job
object MUST add the 'processing-to-stop-point' value to the job's "job- states, the IPP object MUST add the 'processing-to-stop-point' value
state-reasons" attribute and then transition the job to the 'canceled' to the job's "job-state-reasons" attribute and then transition the
state when the processing ceases (see section 4.3.8). job to the 'canceled' state when the processing ceases (see section
4.3.8).
Rule 2: If the Job object already has the 'processing-to-stop-point' Rule 2: If the Job object already has the 'processing-to-stop-point'
value in its "job-state-reasons" attribute, then the Printer object MUST value in its "job-state-reasons" attribute, then the Printer object
reject a Cancel-Job operation. MUST reject a Cancel-Job operation.
Expires September 1, 2000 Access Rights: The authenticated user (see section 8.3) performing
Access Rights: The authenticated user (see section 8.3) performing this this operation must either be the job owner or an operator or
operation must either be the job owner or an operator or administrator administrator of the Printer object (see Sections 1 and 8.5).
of the Printer object (see Sections 1 and 8.5). Otherwise, the IPP Otherwise, the IPP object MUST reject the operation and return:
object MUST reject the operation and return: 'client-error-forbidden', 'client-error-forbidden', 'client-error-not-authenticated', or
'client-error-not-authenticated', or 'client-error-not-authorized' as 'client-error-not-authorized' as appropriate.
appropriate.
3.3.3.1 Cancel-Job Request 3.3.3.1 Cancel-Job Request
The following groups of attributes are part of the Cancel-Job Request: The following groups of attributes are part of the Cancel-Job
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 3.1.4.1. attributes as described in section 3.1.4.1.
Target: Target:
Either (1) the "printer-uri" (uri) plus "job-id" Either (1) the "printer-uri" (uri) plus "job-id"
(integer(1:MAX))or (2) the "job-uri" (uri) operation attribute(s) (integer(1:MAX))or (2) the "job-uri" (uri) operation
which define the target for this operation as described in section attribute(s) which define the target for this operation as
3.1.5. described in section 3.1.5.
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 section 8.3. supplied by the client as described in section 8.3.
"message" (text(127)): "message" (text(127)):
The client OPTIONALLY supplies this attribute. The Printer object The client OPTIONALLY supplies this attribute. The Printer
OPTIONALLY supports this attribute. It is a message to the object OPTIONALLY supports this attribute. It is a message to
operator. This "message" attribute is not the same as the "job- the operator. This "message" attribute is not the same as the
message-from-operator" attribute. That attribute is used to report "job-message-from-operator" attribute. That attribute is used
a message from the operator to the end user that queries that to report a message from the operator to the end user that
attribute. This "message" operation attribute is used to send a queries that attribute. This "message" operation attribute is
message from the client to the operator along with the operation used to send a message from the client to the operator along
request. It is an implementation decision of how or where to with the operation request. It is an implementation decision
display this message to the operator (if at all). of how or where to display this message to the operator (if at
all).
3.3.3.2 Cancel-Job Response 3.3.3.2 Cancel-Job Response
The following sets of attributes are part of the Cancel-Job Response: The following sets of attributes are part of the Cancel-Job Response:
Group 1: Operation Attributes
Status Message: Group 1: Operation Attributes
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 sections 13 and 3.1.6.
Natural Language and Character Set: Status Message:
The "attributes-charset" and "attributes-natural-language" In addition to the REQUIRED status code returned in every
attributes as described in section 3.1.4.2. response, the response OPTIONALLY includes a "status-message"
(text(255)) and/or a "detailed-status-message" (text(MAX))
operation attribute as described in sections 13 and 3.1.6.
Expires September 1, 2000 Natural Language and Character Set:
The "attributes-charset" and "attributes-natural-language"
attributes as described in section 3.1.4.2.
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
See section 3.1.7 for details on returning Unsupported Attributes. See section 3.1.7 for details on returning Unsupported Attributes.
Once a successful response has been sent, the implementation guarantees Once a successful response has been sent, the implementation
that the Job will eventually end up in the 'canceled'