draft-ietf-ipp-model-10.txt   draft-ietf-ipp-model-11.txt 
INTERNET-DRAFT INTERNET-DRAFT
draft-ietf-ipp-model-10.txt draft-ietf-ipp-model-11.txt
R. deBry R. deBry
IBM Corporation IBM Corporation
T. Hastings T. Hastings
Xerox Corporation Xerox Corporation
R. Herriot R. Herriot
Sun Microsystems Sun Microsystems
S. Isaacson S. Isaacson
Novell, Inc. Novell, Inc.
P. Powell P. Powell
Astart Technologies Astart Technologies
June 30, 1998 November 16, 1998
Internet Printing Protocol/1.0: Model and Semantics Internet Printing Protocol/1.0: Model and Semantics
Copyright (C) The Internet Society (date). All Rights Reserved. Copyright (C) The Internet Society (date). All Rights Reserved.
Status of this Memo Status of this Memo
This document is an Internet-Draft. Internet-Drafts are working This document is an Internet-Draft. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas, documents of the Internet Engineering Task Force (IETF), its areas, and
and its working groups. Note that other groups may also distribute its working groups. Note that other groups may also distribute working
working documents as Internet-Drafts. documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference material
material or to cite them other than as "work in progress". or to cite them other than as "work in progress".
To learn the current status of any Internet-Draft, please check the To learn the current status of any Internet-Draft, please check the
"1id-abstracts.txt" listing contained in the Internet-Drafts Shadow "1id-abstracts.txt" listing contained in the Internet-Drafts Shadow
Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe), Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe),
munnari.oz.au (Pacific Rim), ftp.ietf.org (US East Coast), or munnari.oz.au (Pacific Rim), ftp.ietf.org (US East Coast), or
ftp.isi.edu (US West Coast). ftp.isi.edu (US West Coast).
Abstract Abstract
This document is one of a set of documents, which together describe This document is one of a set of documents, which together describe all
all aspects of a new Internet Printing Protocol (IPP). IPP is an aspects of a new Internet Printing Protocol (IPP). IPP is an
application level protocol that can be used for distributed printing application level protocol that can be used for distributed printing
using Internet tools and technologies. The protocol is heavily using Internet tools and technologies. This document describes a
influenced by the printing model introduced in the Document Printing simplified model consisting of abstract objects, their attributes, and
Application (DPA) [ISO10175] standard. Although DPA specifies both their operations that is independent of encoding and transport. The
end user and administrative features, IPP version 1.0 (IPP/1.0) model consists of a Printer and a Job object. A Job optionally supports
focuses only on end user functionality. multiple documents. IPP 1.0 semantics allow end-users and operators to
query printer capabilities, submit print jobs, inquire about the status
of print jobs and printers, and cancel print jobs. This document also
addresses security, internationalization, and directory issues.
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
The full set of IPP documents includes: The full set of IPP documents includes:
Design Goals for an Internet Printing Protocol [IPP-REQ] Design Goals for an Internet Printing Protocol [IPP-REQ]
(informational)
Rationale for the Structure and Model and Protocol for the Internet Rationale for the Structure and Model and Protocol for the Internet
Printing Protocol [IPP-RAT] (informational) Printing Protocol [IPP-RAT]
Internet Printing Protocol/1.0: Model and Semantics (this document) Internet Printing Protocol/1.0: Model and Semantics (this document)
Internet Printing Protocol/1.0: Encoding and Transport [IPP-PRO] Internet Printing Protocol/1.0: Encoding and Transport [IPP-PRO]
Mapping between LPD and IPP Protocols [IPP LPD] (informational) Internet Printing Protocol/1.0: Implementer's Guide [IPP-IIG]
Mapping between LPD and IPP Protocols [IPP LPD]
The design goals document, "Design Goals for an Internet Printing The "Design Goals for an Internet Printing Protocol" document takes a
Protocol", takes a broad look at distributed printing functionality, broad look at distributed printing functionality, and it enumerates
and it enumerates real-life scenarios that help to clarify the real-life scenarios that help to clarify the features that need to be
features that need to be included in a printing protocol for the included in a printing protocol for the Internet. It identifies
Internet. It identifies requirements for three types of users: end requirements for three types of users: end users, operators, and
users, operators, and administrators. The design goals document calls administrators. It calls out a subset of end user requirements that are
out a subset of end user requirements that are satisfied in IPP/1.0. satisfied in IPP/1.0. Operator and administrator requirements are out
Operator and administrator requirements are out of scope for version of scope for version 1.0.
1.0. The rationale document, "Rationale for the Structure and Model
and Protocol for the Internet Printing Protocol", describes IPP from a The "Rationale for the Structure and Model and Protocol for the Internet
high level view, defines a roadmap for the various documents that form Printing Protocol" document describes IPP from a high level view,
the suite of IPP specifications, and gives background and rationale defines a roadmap for the various documents that form the suite of IPP
for the IETF working group's major decisions. The model and semantics specifications, and gives background and rationale for the IETF working
document, "Internet Printing Protocol/1.0: Model and Semantics", group's major decisions.
describes a simplified model with abstract objects, their attributes,
and their operations. The model introduces a Printer and a Job. The The "Internet Printing Protocol/1.0: Encoding and Transport" document is
Job supports multiple documents per Job. The model document also a formal mapping of the abstract operations and attributes defined in
addresses how security, internationalization, and directory issues are the model document onto HTTP/1.1. It defines the encoding rules for a
addressed. The protocol specification, "Internet Printing new Internet media type called "application/ipp".
Protocol/1.0: Encoding and Transport", is a formal mapping of the
abstract operations and attributes defined in the model document onto The "Internet Printing Protocol/1.0: Implementer's Guide" document gives
HTTP/1.1. The protocol specification defines the encoding rules for a insight and advice to implementers of IPP clients and IPP objects. It
new Internet media type called "application/ipp". The LPD mapping is intended to help them understand IPP/1.0 and some of the
document, "Mapping between LPD and IPP Protocols", gives some advice 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) to implementers of gateways between IPP and LPD (Line Printer Daemon)
implementations. implementations.
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
Table of Contents Table of Contents
1. Introduction ....................................................9 1. Introduction 7
1.1 Simplified Printing Model ...................................10 1.1 Simplified Printing Model 8
2. IPP Objects ....................................................13
2.1 Printer Object ..............................................14
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 Attributes ...24
3.1.4.1 Request Operation Attributes ...........................24
3.1.4.2 Response Operation Attributes ..........................28
3.1.5 Operation Targets .........................................29
3.1.6 Operation Status Codes and Messages .......................30
3.1.7 Versions ..................................................31
3.1.8 Job Creation Operations ...................................33
3.2 Printer Operations ..........................................35
3.2.1 Print-Job Operation .......................................35
3.2.1.1 Print-Job Request ......................................35
3.2.1.2 Print-Job Response .....................................39
3.2.2 Print-URI Operation .......................................42
3.2.3 Validate-Job Operation ....................................42
3.2.4 Create-Job Operation ......................................43
3.2.5 Get-Printer-Attributes Operation ..........................43
3.2.5.1 Get-Printer-Attributes Request .........................44
3.2.5.2 Get-Printer-Attributes Response ........................46
3.2.6 Get-Jobs Operation ........................................47
3.2.6.1 Get-Jobs Request .......................................47
3.2.6.2 Get-Jobs Response ......................................49
3.3 Job Operations ..............................................50
3.3.1 Send-Document Operation ...................................50
3.3.1.1 Send-Document Request ..................................51
3.3.1.2 Send-Document Response .................................53
3.3.2 Send-URI Operation ........................................54
3.3.3 Cancel-Job Operation ......................................54
3.3.3.1 Cancel-Job Request .....................................54
3.3.3.2 Cancel-Job Response ....................................55
3.3.4 Get-Job-Attributes Operation ..............................56
3.3.4.1 Get-Job-Attributes Request .............................57
3.3.4.2 Get-Job-Attributes Response ............................57
4. Object Attributes ..............................................58
4.1 Attribute Syntaxes ..........................................58
4.1.1 'text' ....................................................59
Expires December 30, 1998 2. IPP Objects 11
2.1 Printer Object 11
2.2 Job Object 13
2.3 Object Relationships 14
2.4 Object Identity 15
4.1.1.1 'textWithoutLanguage' ..................................60 3. IPP Operations 17
4.1.1.2 'textWithLanguage' .....................................61 3.1 Common Semantics 18
4.1.2 'name' ....................................................62 3.1.1 Required Parameters 18
4.1.2.1 'nameWithoutLanguage' ..................................62 3.1.2 Operation IDs and Request IDs 19
4.1.2.2 'nameWithLanguage' .....................................62 3.1.3 Attributes 19
4.1.3 'keyword' .................................................63 3.1.4 Character Set and Natural Language Operation Attributes 21
4.1.4 'enum' ....................................................64 3.1.4.1 Request Operation Attributes 21
4.1.5 'uri' .....................................................64 3.1.4.2 Response Operation Attributes 24
4.1.6 'uriScheme' ...............................................65 3.1.5 Operation Targets 25
4.1.7 'charset' .................................................65 3.1.6 Operation Status Codes and Messages 27
4.1.8 'naturalLanguage' .........................................66 3.1.7 Versions 28
4.1.9 'mimeMediaType' ...........................................66 3.1.8 Job Creation Operations 29
4.1.10 'octetString' .............................................68 3.2 Printer Operations 31
4.1.11 'boolean' .................................................68 3.2.1 Print-Job Operation 31
4.1.12 'integer' .................................................68 3.2.1.1 Print-Job Request 31
4.1.13 'rangeOfInteger' ..........................................68 3.2.1.2 Print-Job Response 35
4.1.14 'dateTime' ................................................68 3.2.2 Print-URI Operation 37
4.1.15 'resolution' ..............................................69 3.2.3 Validate-Job Operation 38
4.1.16 '1setOf X' ...............................................69 3.2.4 Create-Job Operation 38
4.2 Job Template Attributes .....................................69 3.2.5 Get-Printer-Attributes Operation 39
4.2.1 job-priority (integer(1:100)) .............................73 3.2.5.1 Get-Printer-Attributes Request 39
4.2.2 job-hold-until (type3 keyword | name (MAX)) ...............74 3.2.5.2 Get-Printer-Attributes Response 41
4.2.3 job-sheets (type3 keyword | name(MAX)) ....................75 3.2.6 Get-Jobs Operation 42
4.2.4 multiple-document-handling (type2 keyword) ................75 3.2.6.1 Get-Jobs Request 42
4.2.5 copies (integer(1:MAX)) ...................................77 3.2.6.2 Get-Jobs Response 43
4.2.6 finishings (1setOf type2 enum) ............................77 3.3 Job Operations 45
4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX)) ...............78 3.3.1 Send-Document Operation 45
4.2.8 sides (type2 keyword) .....................................79 3.3.1.1 Send-Document Request 46
4.2.9 number-up (integer(1:MAX)) ................................80 3.3.1.2 Send-Document Response 47
4.2.10 orientation-requested (type2 enum) ........................80 3.3.2 Send-URI Operation 48
4.2.11 media (type3 keyword | name(MAX)) .........................81 3.3.3 Cancel-Job Operation 48
4.2.12 printer-resolution (resolution) ...........................82 3.3.3.1 Cancel-Job Request 49
4.2.13 print-quality (type2 enum) ................................82 3.3.3.2 Cancel-Job Response 49
4.3 Job Description Attributes ..................................83 3.3.4 Get-Job-Attributes Operation 50
4.3.1 job-uri (uri) .............................................85 3.3.4.1 Get-Job-Attributes Request 51
4.3.2 job-id (integer(1:MAX)) ...................................85 3.3.4.2 Get-Job-Attributes Response 51
4.3.3 job-printer-uri (uri) .....................................85
4.3.4 job-more-info (uri) .......................................86
4.3.5 job-name (name(MAX)) ......................................86
4.3.6 job-originating-user-name (name(MAX)) .....................86
4.3.7 job-state (type1 enum) ....................................87
4.3.8 job-state-reasons (1setOf type2 keyword) .................90
4.3.9 job-state-message (text(MAX)) .............................92
4.3.10 number-of-documents (integer(0:MAX)) ......................92
4.3.11 output-device-assigned (name(127)) ........................93
4.3.12 time-at-creation (integer(0:MAX)) .........................93
4.3.13 time-at-processing (integer(0:MAX)) .......................93
4.3.14 time-at-completed (integer(0:MAX)) ........................93
Expires December 30, 1998 4. Object Attributes 52
4.1 Attribute Syntaxes 52
4.1.1 'text' 53
4.1.1.1 'textWithoutLanguage' 54
4.1.1.2 'textWithLanguage' 54
4.3.15 number-of-intervening-jobs (integer(0:MAX)) ...............94 Isaacson, Powell Expires May 16, 1999
4.3.16 job-message-from-operator (text(127)) .....................94 4.1.2 'name' 55
4.3.17 job-k-octets (integer(0:MAX)) .............................94 4.1.2.1 'nameWithoutLanguage' 55
4.3.18 job-impressions (integer(0:MAX)) ..........................95 4.1.2.2 'nameWithLanguage' 56
4.3.19 job-media-sheets (integer(0:MAX)) .........................95 4.1.3 'keyword' 56
4.3.20 job-k-octets-processed (integer(0:MAX)) ...................96 4.1.4 'enum' 57
4.3.21 job-impressions-completed (integer(0:MAX)) ................96 4.1.5 'uri' 58
4.3.22 job-media-sheets-completed (integer(0:MAX)) ...............96 4.1.6 'uriScheme' 58
4.3.23 attributes-charset (charset) ..............................96 4.1.7 'charset' 58
4.3.24 attributes-natural-language (naturalLanguage) .............97 4.1.8 'naturalLanguage' 59
4.4 Printer Description Attributes ..............................97 4.1.9 'mimeMediaType' 60
4.4.1 printer-uri-supported (1setOf uri) ........................99 4.1.10 'octetString' 61
4.4.2 uri-security-supported (1setOf type2 keyword) .............99 4.1.11 'boolean' 61
4.4.3 printer-name (name(127)) .................................101 4.1.12 'integer' 61
4.4.4 printer-location (text(127)) .............................101 4.1.13 'rangeOfInteger' 61
4.4.5 printer-info (text(127)) .................................101 4.1.14 'dateTime' 61
4.4.6 printer-more-info (uri) ..................................101 4.1.15 'resolution' 62
4.4.7 printer-driver-installer (uri) ...........................102 4.1.16 '1setOf X' 62
4.4.8 printer-make-and-model (text(127)) .......................102 4.2 Job Template Attributes 62
4.4.9 printer-more-info-manufacturer (uri) .....................102 4.2.1 job-priority (integer(1:100)) 66
4.4.10 printer-state (type1 enum) ...............................102 4.2.2 job-hold-until (type3 keyword | name (MAX)) 67
4.4.11 printer-state-reasons (1setOf type2 keyword) .............103 4.2.3 job-sheets (type3 keyword | name(MAX)) 67
4.4.12 printer-state-message (text(MAX)) ........................106 4.2.4 multiple-document-handling (type2 keyword) 68
4.4.13 operations-supported (1setOf type2 enum) .................106 4.2.5 copies (integer(1:MAX)) 69
4.4.14 charset-configured (charset) .............................107 4.2.6 finishings (1setOf type2 enum) 69
4.4.15 charset-supported (1setOf charset) .......................107 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX)) 70
4.4.16 natural-language-configured (naturalLanguage) ............107 4.2.8 sides (type2 keyword) 71
4.4.17 generated-natural-language-supported 4.2.9 number-up (integer(1:MAX)) 72
(1setOf naturalLanguage) .................................108 4.2.10 orientation-requested (type2 enum) 72
4.4.18 document-format-default (mimeMediaType) ..................108 4.2.11 media (type3 keyword | name(MAX)) 73
4.4.19 document-format-supported (1setOf mimeMediaType) .........109 4.2.12 printer-resolution (resolution) 74
4.4.20 printer-is-accepting-jobs (boolean) ......................109 4.2.13 print-quality (type2 enum) 74
4.4.21 queued-job-count (integer(0:MAX)) ........................109 4.3 Job Description Attributes 74
4.4.22 printer-message-from-operator (text(127)) ................109 4.3.1 job-uri (uri) 76
4.4.23 color-supported (boolean) ................................109 4.3.2 job-id (integer(1:MAX)) 76
4.4.24 reference-uri-schemes-supported (1setOf uriScheme) .......110 4.3.3 job-printer-uri (uri) 76
4.4.25 pdl-override-supported (type2 keyword) ...................110 4.3.4 job-more-info (uri) 76
4.4.26 printer-up-time (integer(1:MAX)) .........................110 4.3.5 job-name (name(MAX)) 77
4.4.27 printer-current-time (dateTime) ..........................111 4.3.6 job-originating-user-name (name(MAX)) 77
4.4.28 multiple-operation-time-out (integer(1:MAX)) .............111 4.3.7 job-state (type1 enum) 77
4.4.29 compression-supported (1setOf type3 keyword) .............111 4.3.8 job-state-reasons (1setOf type2 keyword) 80
4.4.30 job-k-octets-supported (rangeOfInteger(0:MAX)) ...........112 4.3.9 job-state-message (text(MAX)) 82
4.4.31 job-impressions-supported (rangeOfInteger(0:MAX)) ........112 4.3.10 number-of-documents (integer(0:MAX)) 82
4.4.32 job-media-sheets-supported (rangeOfInteger(0:MAX)) .......112 4.3.11 output-device-assigned (name(127)) 82
5. Conformance ...................................................112 4.3.12 time-at-creation (integer(0:MAX)) 83
5.1 Client Conformance Requirements ............................113 4.3.13 time-at-processing (integer(0:MAX)) 83
5.2 IPP Object Conformance Requirements ........................113 4.3.14 time-at-completed (integer(0:MAX)) 83
5.2.1 Objects ..................................................113 4.3.15 number-of-intervening-jobs (integer(0:MAX)) 83
4.3.16 job-message-from-operator (text(127)) 83
4.3.17 job-k-octets (integer(0:MAX)) 83
4.3.18 job-impressions (integer(0:MAX)) 84
4.3.19 job-media-sheets (integer(0:MAX)) 84
4.3.20 job-k-octets-processed (integer(0:MAX)) 85
4.3.21 job-impressions-completed (integer(0:MAX)) 85
4.3.22 job-media-sheets-completed (integer(0:MAX)) 85
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
4.3.23 attributes-charset (charset) 86
4.3.24 attributes-natural-language (naturalLanguage) 86
4.4 Printer Description Attributes 86
4.4.1 printer-uri-supported (1setOf uri) 88
4.4.2 uri-security-supported (1setOf type2 keyword) 88
4.4.3 printer-name (name(127)) 89
4.4.4 printer-location (text(127)) 90
4.4.5 printer-info (text(127)) 90
4.4.6 printer-more-info (uri) 90
4.4.7 printer-driver-installer (uri) 90
4.4.8 printer-make-and-model (text(127)) 90
4.4.9 printer-more-info-manufacturer (uri) 90
4.4.10 printer-state (type1 enum) 91
4.4.11 printer-state-reasons (1setOf type2 keyword) 92
4.4.12 printer-state-message (text(MAX)) 94
4.4.13 operations-supported (1setOf type2 enum) 94
4.4.14 charset-configured (charset) 95
4.4.15 charset-supported (1setOf charset) 95
4.4.16 natural-language-configured (naturalLanguage) 95
4.4.17 generated-natural-language-supported(1setOf naturalLanguage)95
4.4.18 document-format-default (mimeMediaType) 96
4.4.19 document-format-supported (1setOf mimeMediaType) 96
4.4.20 printer-is-accepting-jobs (boolean) 96
4.4.21 queued-job-count (integer(0:MAX)) 97
4.4.22 printer-message-from-operator (text(127)) 97
4.4.23 color-supported (boolean) 97
4.4.24 reference-uri-schemes-supported (1setOf uriScheme) 97
4.4.25 pdl-override-supported (type2 keyword) 97
4.4.26 printer-up-time (integer(1:MAX)) 98
4.4.27 printer-current-time (dateTime) 98
4.4.28 multiple-operation-time-out (integer(1:MAX)) 98
4.4.29 compression-supported (1setOf type3 keyword) 99
4.4.30 job-k-octets-supported (rangeOfInteger(0:MAX)) 99
4.4.31 job-impressions-supported (rangeOfInteger(0:MAX)) 99
4.4.32 job-media-sheets-supported (rangeOfInteger(0:MAX)) 99
5.2.2 Operations ...............................................114 5. Conformance 99
5.2.3 IPP Object Attributes ....................................114 5.1 Client Conformance Requirements 100
5.2.4 Extensions ...............................................115 5.2 IPP Object Conformance Requirements 100
5.2.5 Attribute Syntaxes .......................................115 5.2.1 Objects 101
5.3 Charset and Natural Language Requirements ..................115 5.2.2 Operations 101
5.4 Security Conformance Requirements ..........................115 5.2.3 IPP Object Attributes 101
6. IANA Considerations (registered and private extensions) .......116 5.2.4 Extensions 102
6.1 Typed 'keyword' and 'enum' Extensions ......................116 5.2.5 Attribute Syntaxes 102
6.2 Attribute Extensibility ....................................118 5.3 Charset and Natural Language Requirements 102
6.3 Attribute Syntax Extensibility .............................119 5.4 Security Conformance Requirements 102
6.4 Operation Extensibility ....................................120
6.5 Status Code Extensibility ..................................120
6.6 Registration of MIME types/sub-types for document-formats ..121
6.7 Registration of charsets for use in 'charset' attribute
values .....................................................121
7. Internationalization Considerations ...........................121
8. Security Considerations .......................................124
8.1 Security Scenarios .........................................125
8.1.1 Client and Server in the Same Security Domain ............125
8.1.2 Client and Server in Different Security Domains ..........126
8.1.3 Print by Reference .......................................126
8.2 URIs for TLS and non-TLS Access ............................126
8.3 The "requesting-user-name" (name(MAX)) Operation Attribute .126
8.4 Restricted Queries .........................................128
8.5 IPP Security Application Profile for TLS ...................128
9. References ....................................................129
10.Copyright Notice ..............................................133
11.Author's Address ..............................................133
12.Formats for IPP Registration Proposals ........................136
12.1 Type2 keyword attribute values registration ................136
12.2 Type3 keyword attribute values registration ................136
12.3 Type2 enum attribute values registration ...................137
12.4 Type3 enum attribute values registration ...................137
12.5 Attribute registration .....................................137
12.6 Attribute Syntax registration ..............................138
12.7 Operation registration .....................................138
12.8 Status code registration ...................................139
13.APPENDIX A: Terminology .......................................139
13.1 Conformance Terminology ....................................139
13.1.1 NEED NOT .................................................139
13.2 Model Terminology ..........................................139
13.2.1 Keyword ..................................................139
13.2.2 Attributes ...............................................140
13.2.2.1 Attribute Name ........................................140
13.2.2.2 Attribute Group Name ..................................140
13.2.2.3 Attribute Value .......................................140
13.2.2.4 Attribute Syntax ......................................140
13.2.3 Supports .................................................141
Expires December 30, 1998 6. IANA Considerations (registered and private extensions) 103
6.1 Typed 'keyword' and 'enum' Extensions 103
6.2 Attribute Extensibility 105
6.3 Attribute Syntax Extensibility 106
6.4 Operation Extensibility 106
6.5 Attribute Groups 106
6.6 Status Code Extensibility 107
13.2.4 print-stream page ........................................143 Isaacson, Powell Expires May 16, 1999
13.2.5 impression ...............................................143 6.7 Registration of MIME types/sub-types for document-formats 107
14.APPENDIX B: Status Codes and Suggested Status Code Messages ..143 6.8 Registration of charsets for use in 'charset' attribute values107
14.1 Status Codes ...............................................144
14.1.1 Informational ............................................144
14.1.2 Successful Status Codes ..................................145
14.1.2.1 successful-ok (0x0000) ................................145
14.1.2.2 successful-ok-ignored-or-substituted-attributes
(0x0001) ..............................................145
14.1.2.3 successful-ok-conflicting-attributes (0x0002) .........145
14.1.3 Redirection Status Codes .................................145
14.1.4 Client Error Status Codes ................................145
14.1.4.1 client-error-bad-request (0x0400) .....................146
14.1.4.2 client-error-forbidden (0x0401) .......................146
14.1.4.3 client-error-not-authenticated (0x0402) ...............146
14.1.4.4 client-error-not-authorized (0x0403) ..................146
14.1.4.5 client-error-not-possible (0x0404) ....................146
14.1.4.6 client-error-timeout (0x0405) .........................147
14.1.4.7 client-error-not-found (0x0406) .......................147
14.1.4.8 client-error-gone (0x0407) ............................147
14.1.4.9 client-error-request-entity-too-large (0x0408) ........148
14.1.4.10 client-error-request-value-too-long (0x0409) ..........148
14.1.4.11 client-error-document-format-not-supported (0x040A) ...148
14.1.4.12 client-error-attributes-or-values-not-supported
(0x040B) ..............................................149
14.1.4.13 client-error-uri-scheme-not-supported (0x040C) ........149
14.1.4.14 client-error-charset-not-supported (0x040D) ...........149
14.1.4.15 client-error-conflicting-attributes (0x040E) ..........149
14.1.5 Server Error Status Codes ................................149
14.1.5.1 server-error-internal-error (0x0500) ..................150
14.1.5.2 server-error-operation-not-supported (0x0501) .........150
14.1.5.3 server-error-service-unavailable (0x0502) .............150
14.1.5.4 server-error-version-not-supported (0x0503) ...........150
14.1.5.5 server-error-device-error (0x0504) ....................151
14.1.5.6 server-error-temporary-error (0x0505) .................151
14.1.5.7 server-error-not-accepting-jobs (0x0506) ..............151
14.1.5.8 server-error-busy (0x0507) ............................151
14.2 Status Codes for IPP Operations ............................152
15.APPENDIX C: "media" keyword values ...........................153
16.APPENDIX D: Processing IPP Attributes .........................157
16.1 Fidelity ...................................................158
16.2 Page Description Language (PDL) Override ...................159
16.3 Suggested Operation Processing Steps for All Operations ....161
16.3.1 Validate version number ..................................162
16.3.2 Validate operation identifier ............................162
16.3.3 Validate the request identifier ..........................162
16.3.4 Validate attribute group and attribute presence and order 163
16.3.4.1 Validate the presence and order of attribute groups ...163
Expires December 30, 1998 7. Internationalization Considerations 108
16.3.4.2 Ignore unknown attribute groups in the expected 8. Security Considerations 110
position ..............................................163 8.1 Security Scenarios 112
16.3.4.3 Validate the presence of a single occurrence of 8.1.1 Client and Server in the Same Security Domain 112
required Operation attributes .........................164 8.1.2 Client and Server in Different Security Domains 112
16.3.5 Validate the values of the REQUIRED Operation attributes .169 8.1.3 Print by Reference 112
16.3.6 Validate the values of the OPTIONAL Operation attributes .172 8.2 URIs for SSL3 and non-SSL3 Access 112
16.4 Suggested Additional Processing Steps for Operations that 8.3 The "requesting-user-name" (name(MAX)) Operation Attribute 113
Create/Validate Jobs and Add Documents .....................175 8.4 Restricted Queries 114
16.4.1 Default "ipp-attribute-fidelity" if not supplied .........175 8.5 Queries on jobs submitted using non-IPP protocols 115
16.4.2 Check that the Printer object is accepting jobs ..........175 8.6 IPP Security Application Profile for SSL3 115
16.4.3 Validate the values of the Job Template attributes .......175
16.4.4 Check for conflicting Job Template attributes values .....180
16.4.5 Decide whether to REJECT the request .....................181
16.4.6 For the Validate-Job operation, RETURN one of the
success status codes .....................................181
16.4.7 Create the Job object with attributes to support .........181
16.4.8 Return one of the success status codes ...................183
16.4.9 Accept appended Document Content .........................184
16.4.10 Scheduling and Starting to Process the Job ...............184
16.4.11 Completing the Job .......................................184
16.4.12 Destroying the Job after completion ......................184
16.4.13 Interaction with "ipp-attribute-fidelity" ................184
16.5 Using Job Template Attributes During Document Processing. ..185
17.APPENDIX E: Generic Directory Schema ..........................186
Expires December 30, 1998 9. References 116
10.Copyright Notice 119
11.Author's Address 119
12.Formats for IPP Registration Proposals 122
12.1 Type2 keyword attribute values registration 122
12.2 Type3 keyword attribute values registration 122
12.3 Type2 enum attribute values registration 122
12.4 Type3 enum attribute values registration 123
12.5 Attribute registration 123
12.6 Attribute Syntax registration 124
12.7 Operation registration 124
12.8 Attribute Group registration 116
12.9 Status code registration 124
13.APPENDIX A: Terminology 125
13.1 Conformance Terminology 125
13.1.1 NEED NOT 125
13.2 Model Terminology 125
13.2.1 Keyword 125
13.2.2 Attributes 125
13.2.2.1 Attribute Name 126
13.2.2.2 Attribute Group Name 126
13.2.2.3 Attribute Value 126
13.2.2.4 Attribute Syntax 126
13.2.3 Supports 126
13.2.4 print-stream page 128
13.2.5 impression 128
14.APPENDIX B: Status Codes and Suggested Status Code Messages 128
14.1 Status Codes 129
14.1.1 Informational 130
14.1.2 Successful Status Codes 130
14.1.2.1 successful-ok (0x0000) 130
14.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001)130
14.1.2.3 successful-ok-conflicting-attributes (0x0002) 130
Isaacson, Powell Expires May 16, 1999
14.1.3 Redirection Status Codes 131
14.1.4 Client Error Status Codes 131
14.1.4.1 client-error-bad-request (0x0400) 131
14.1.4.2 client-error-forbidden (0x0401) 131
14.1.4.3 client-error-not-authenticated (0x0402) 131
14.1.4.4 client-error-not-authorized (0x0403) 131
14.1.4.5 client-error-not-possible (0x0404) 132
14.1.4.6 client-error-timeout (0x0405) 132
14.1.4.7 client-error-not-found (0x0406) 132
14.1.4.8 client-error-gone (0x0407) 132
14.1.4.9 client-error-request-entity-too-large (0x0408) 133
14.1.4.10client-error-request-value-too-long (0x0409) 133
14.1.4.11client-error-document-format-not-supported (0x040A) 133
14.1.4.12client-error-attributes-or-values-not-supported (0x040B)133
14.1.4.13client-error-uri-scheme-not-supported (0x040C) 134
14.1.4.14client-error-charset-not-supported (0x040D) 134
14.1.4.15client-error-conflicting-attributes (0x040E) 134
14.1.5 Server Error Status Codes 134
14.1.5.1 server-error-internal-error (0x0500) 134
14.1.5.2 server-error-operation-not-supported (0x0501) 135
14.1.5.3 server-error-service-unavailable (0x0502) 135
14.1.5.4 server-error-version-not-supported (0x0503) 135
14.1.5.5 server-error-device-error (0x0504) 135
14.1.5.6 server-error-temporary-error (0x0505) 136
14.1.5.7 server-error-not-accepting-jobs (0x0506) 136
14.1.5.8 server-error-busy (0x0507) 136
14.1.5.9 server-error-job-canceled (0x0508) 136
14.2 Status Codes for IPP Operations 137
15.APPENDIX C: "media" keyword values 137
16.APPENDIX D: Processing IPP Attributes 141
16.1 Fidelity 142
16.2 Page Description Language (PDL) Override 143
16.3 Using Job Template Attributes During Document Processing. 145
17.APPENDIX E: Generic Directory Schema 146
18.APPENDIX F: Change History for the Model and Semantics document 147
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.0 (IPP/1.0) focuses only on end user technologies. IPP version 1.0 (IPP/1.0) focuses only on end user
functionality. This document is just one of a suite of documents that functionality. This document is just one of a suite of documents that
fully define IPP. The full set of IPP documents includes: fully define IPP. The full set of IPP documents includes:
Design Goals for an Internet Printing Protocol [IPP-REQ] Design Goals for an Internet Printing Protocol [IPP-REQ]
(informational)
Rationale for the Structure and Model and Protocol for the Internet Rationale for the Structure and Model and Protocol for the Internet
Printing Protocol [IPP-RAT] (informational) Printing Protocol [IPP-RAT]
Internet Printing Protocol/1.0: Model and Semantics (this document) Internet Printing Protocol/1.0: Model and Semantics (this document)
Internet Printing Protocol/1.0: Encoding and Transport [IPP-PRO] Internet Printing Protocol/1.0: Encoding and Transport [IPP-PRO]
Mapping between LPD and IPP Protocols [IPP-LPD] (informational)
Anyone reading this document for the first time is strongly encouraged Isaacson, Powell Expires May 16, 1999
to read the IPP documents in the following order: Internet Printing Protocol/1.0: Implementer's Guide [IPP-IIG]
Mapping between LPD and IPP Protocols [IPP-LPD]
1. The design goals document, "Design Goals for an Internet
Printing Protocol". That 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. The design goals document calls out a subset of
end user requirements that are satisfied in IPP/1.0. Operator
and administrator requirements are out of scope for version 1.0.
2. The rationale document, "Rationale for the Structure and Model
and Protocol for the Internet Printing Protocol". That document
describes IPP from a high level view, defines a roadmap for the
various documents that form the suite of IPP specifications, and
gives background and rationale for the IETF working group's major
decisions.
3. This document, the "Internet Printing Protocol/1.0: Model and
Semantics" document. This document describes a simplified model
with abstract objects, their attributes, and their operations.
The model introduces a Printer and a Job. A Job optionally
supports multiple documents per Job. The model document also
describes how security, internationalization, and directory
issues are addressed.
4. The protocol specification, " Internet Printing Protocol/1.0:
Encoding and Transport". That document defines the encoding
rules for a new Internet media type called "application/ipp" and
shows a formal mapping of the abstract operations and attributes
defined in the model document onto HTTP/1.1.
Expires December 30, 1998
The LPD mapping document, "Mapping between LPD and IPP Protocols", is Anyone reading these documents for the first time is strongly encouraged
an informational document that recommends a mapping between the to read the IPP documents in the above order.
commands and operands of IPP. The LPD mapping document gives some
advice to implementers of gateways between IPP and LPD (Line Printer
Daemon) implementations.
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.0. IPP - Section 3 defines the operations included in IPP/1.0. IPP
operations are synchronous, therefore, for each operation, there operations are synchronous, therefore, for each operation, there is
is a both request and a response. a both request and a response.
- Section 4 defines the attributes (and their syntaxes) that are - Section 4 defines the attributes (and their syntaxes) that are used
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 - 12 cover the Internationalization and Security
considerations as well as References, Copyright Notice, and considerations as well as References, Copyright Notice, Author
Author contact information. contact information, and Formats for Registration Proposals.
- Sections 12 - 14 are appendices that cover Terminology, Status - Sections 13 - 15 are appendices that cover Terminology, Status
Codes and Messages, and "media" keyword values. This document Codes and Messages, and "media" keyword values.
uses terms such as "attributes", "keywords", and "support".
These terms have special meaning and are defined in the model Note: This document uses terms such as "attributes",
terminology section. Capitalized terms, such as MUST and "keywords", and "support". These terms have special meaning
OPTIONAL, have special meaning relating to conformance. These and are defined in the model terminology section 13.2.
terms are defined in the section on conformance terminology, most Capitalized terms, such as MUST, MUST NOT, REQUIRED, SHOULD,
of which is taken from RFC 2119 [RFC2119]. SHOULD NOT, MAY, NEED NOT, and OPTIONAL, have special meaning
- Section 15 is an appendix that defines the rules and suggested relating to conformance. These terms are defined in section
techniques for the processing of attributes in client requests by 13.1 on conformance terminology, most of which is taken from
IPP objects. This section helps to clarify the effects of RFC 2119 [RFC2119].
- Section 16 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 17 is an appendix that enumerates the subset of Printer
attributes that form a generic directory schema. These attributes that form a generic directory schema. These attributes
attributes are useful when registering a Printer so that a client are useful when registering a Printer so that a client can find the
can find the Printer not just by name, but by filtered searches Printer not just by name, but by filtered searches as well.
as well. - Section 18 is an appendix that provides a Change History
summarizing the clarification and changes that might affect an
implementation since the June 30, 1998 draft.
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 protocol
for the Internet, the Internet Printing Protocol (IPP) is based on a for the Internet, the Internet Printing Protocol (IPP) is based on a
simplified printing model that abstracts the many components of real simplified printing model that abstracts the many components of real
world printing solutions. The Internet is a distributed computing world printing solutions. The Internet is a distributed computing
Expires December 30, 1998
environment where requesters of print services (clients, applications, environment where requesters of print services (clients, applications,
printer drivers, etc.) cooperate and interact with print service printer drivers, etc.) cooperate and interact with print service
providers. This model and semantics document describes a simple, providers. This model and semantics document describes a simple,
abstract model for IPP even though the underlying configurations may abstract model for IPP even though the underlying configurations may be
be complex "n-tier" client/server systems. An important simplifying
step in the IPP model is to expose only the key objects and interfaces Isaacson, Powell Expires May 16, 1999
required for printing. The model described in this model document
does not include features, interfaces, and relationships that are complex "n-tier" client/server systems. An important simplifying step
beyond the scope of the first version of IPP (IPP/1.0). IPP/1.0 in the IPP model is to expose only the key objects and interfaces
incorporates many of the relevant ideas and lessons learned from other required for printing. The model described in this model document does
specification and development efforts [HTPP] [ISO10175] [LDPA] not include features, interfaces, and relationships that are beyond the
[P1387.4] [PSIS] [RFC1179] [SWP]. scope of the first version of IPP (IPP/1.0). IPP/1.0 incorporates many
of the relevant ideas and lessons learned from other specification and
development efforts [HTPP] [ISO10175] [LDPA] [P1387.4] [PSIS] [RFC1179]
[SWP]. IPP is heavily influenced by the printing model introduced in
the Document Printing Application (DPA) [ISO10175] standard. Although
DPA specifies both end user and administrative features, IPP version 1.0
(IPP/1.0) focuses only on end user functionality.
The IPP/1.0 model encapsulates the important components of distributed The IPP/1.0 model encapsulates the important components of distributed
printing into two object types: printing into two object types:
- Printer (Section 2.1) - Printer (Section 2.1)
- Job (Section 2.2) - Job (Section 2.2)
Each object type has an associated set of operations (see section 3) Each object type has an associated set of operations (see section 3) and
and attributes (see section 4). attributes (see section 4).
It is important, however, to understand that in real system It is important, however, to understand that in real system
implementations (which lie underneath the abstracted IPP/1.0 model), implementations (which lie underneath the abstracted IPP/1.0 model),
there are other components of a print service which are not explicitly there are other components of a print service which are not explicitly
defined in the IPP/1.0 model. The following figure illustrates where defined in the IPP/1.0 model. The following figure illustrates where
IPP/1.0 fits with respect to these other components. IPP/1.0 fits with respect to these other components.
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
+--------------+ +--------------+
| Application | | Application |
o +. . . . . . . | o +. . . . . . . |
\|/ | Spooler | \|/ | Spooler |
/ \ +. . . . . . . | +---------+ / \ +. . . . . . . | +---------+
End-User | Print Driver |---| File | End-User | Print Driver |---| File |
+-----------+ +-----+ +------+-------+ +----+----+ +-----------+ +-----+ +------+-------+ +----+----+
| Browser | | GUI | | | | Browser | | GUI | | |
+-----+-----+ +--+--+ | | +-----+-----+ +--+--+ | |
| | | | | | | |
skipping to change at page 12, line 44 skipping to change at page 10, line 44
+-----------------+ +-----------------+
An IPP Printer object encapsulates the functions normally associated An IPP Printer object encapsulates the functions normally associated
with physical output devices along with the spooling, scheduling and with physical output devices along with the spooling, scheduling and
multiple device management functions often associated with a print multiple device management functions often associated with a print
server. Printer objects are optionally registered as entries in a server. Printer objects are optionally registered as entries in a
directory where end users find and select them based on some sort of directory where end users find and select them based on some sort of
filtered and context based searching mechanism (see section 17). The filtered and context based searching mechanism (see section 17). The
directory is used to store relatively static information about the directory is used to store relatively static information about the
Printer, allowing end users to search for and find Printers that match Printer, allowing end users to search for and find Printers that match
their search criteria, for example: name, context, printer their search criteria, for example: name, context, printer capabilities,
capabilities, etc. The more dynamic information, such as state, etc. The more dynamic information, such as state, currently loaded and
currently loaded and ready media, number of jobs at the Printer, ready media, number of jobs at the Printer, errors, warnings, and so
errors, warnings, and so forth, is directly associated with the forth, is directly associated with the Printer object itself rather than
Printer object itself rather than with the entry in the directory with the entry in the directory which only represents the Printer
which only represents the Printer object. object.
IPP clients implement the IPP protocol on the client side and give end IPP clients implement the IPP protocol on the client side and give end
users (or programs running on behalf of end users) the ability to users (or programs running on behalf of end users) the ability to query
Printer objects and submit and manage print jobs. An IPP server is just
Expires December 30, 1998 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.
query Printer objects and submit and manage print jobs. An IPP server Isaacson, Powell Expires May 16, 1999
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 object
creates a new Job object. The end user then interacts with this new creates a new Job object. The end user then interacts with this new Job
Job object to query its status and monitor the progress of the job. object to query its status and monitor the progress of the job. End
End users may also cancel the print job by using the Job object's users may also cancel the print job by using the Job object's Cancel-Job
Cancel-Job operation. The notification service is out of scope for operation. The notification service is out of scope for IPP/1.0, but
IPP/1.0, but using such a notification service, the end user is able using such a notification service, the end user is able to register for
to register for and receive Printer specific and Job specific events. and receive Printer specific and Job specific events. An end user can
An end user can query the status of Printer objects and can follow the query the status of Printer objects and can follow the progress of Job
progress of Job objects by polling using the Get-Printer-Attributes, objects by polling using the Get-Printer-Attributes, Get-Jobs, and Get-
Get-Jobs, and Get-Job-Attributes operations. Job-Attributes operations.
2. IPP Objects 2. IPP Objects
The IPP/1.0 model introduces objects of type Printer and Job. Each The IPP/1.0 model introduces objects of type Printer and Job. Each type
type of object models relevant aspects of a real-world entity such as of object models relevant aspects of a real-world entity such as a real
a real printer or real print job. Each object type is defined as a printer or real print job. Each object type is defined as a set of
set of possible attributes that may be supported by instances of that possible attributes that may be supported by instances of that object
object type. For each object (instance), the actual set of supported type. For each object (instance), the actual set of supported
attributes and values describe a specific implementation. The attributes and values describe a specific implementation. The object's
object's attributes and values describe its state, capabilities, attributes and values describe its state, capabilities, realizable
realizable features, job processing functions, and default behaviors features, job processing functions, and default behaviors and
and characteristics. For example, the Printer object type is defined characteristics. For example, the Printer object type is defined as a
as a set of attributes that each Printer object potentially supports. set of attributes that each Printer object potentially supports. In the
In the same manner, the Job object type is defined as a set of same manner, the Job object type is defined as a set of attributes that
attributes that are potentially supported by each Job object. are potentially supported by each Job object.
Each attribute included in the set of attributes defining an object Each attribute included in the set of attributes defining an object type
type is labeled as: is labeled as:
- "REQUIRED": each object MUST support the attribute. - "REQUIRED": each object MUST support the attribute.
- "OPTIONAL": each object MAY support the attribute. - "OPTIONAL": each object MAY support the attribute.
There is no such similar labeling of attribute values. However, if an There is no such similar labeling of attribute values. However, if an
implementation supports an attribute, it MUST support at least one of implementation supports an attribute, it MUST support at least one of
the possible values for that attribute. the possible values for that attribute.
Expires December 30, 1998
2.1 Printer Object 2.1 Printer Object
The major component of the IPP/1.0 model is the Printer object. A The major component of the IPP/1.0 model is the Printer object. A
Printer object implements the server-side of the IPP/1.0 protocol. Printer object implements the server-side of the IPP/1.0 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 components
to remain opaque to the end user. Section 3 describes each of the to remain opaque to the end user. Section 3 describes each of the
Printer operations in detail. 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 Isaacson, Powell Expires May 16, 1999
job processing capabilities and defaults for the Printer object. - "job-template" attributes: These attributes describe supported job
(See section 4.2) processing capabilities and defaults for the Printer object. (See
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 represent any real or virtual device with semantics consistent with the
the Printer object, such as a fax device, an imager, or even a CD Printer object, such as a fax device, an imager, or even a CD writer.
writer.
Some examples of configurations supporting a Printer object include: Some examples of configurations supporting a Printer object include:
1) An output device with no spooling capabilities 1) An output device with no spooling capabilities
2) An output device with a built-in spooler 2) An output device with a built-in spooler
3) A print server supporting IPP with one or more associated output 3) A print server supporting IPP with one or more associated output
devices devices
3a) The associated output devices may or may not be capable of 3a) The associated output devices may or may not be capable of
spooling jobs spooling jobs
3b) The associated output devices may or may not support IPP 3b) The associated output devices may or may not support IPP
The following figures show some examples of how Printer objects can be The following figures show some examples of how Printer objects can be
realized on top of various distributed printing configurations. The realized on top of various distributed printing configurations. The
embedded case below represents configurations 1 and 2. The hosted and embedded case below represents configurations 1 and 2. The hosted and
fan-out figures below represent configurations 3a and 3b. fan-out figures below represent configurations 3a and 3b.
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
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
skipping to change at page 15, line 47 skipping to change at page 13, line 47
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 can contain one or A Job object is used to model a print job. A Job object contains
more documents. The information required to create a Job object is documents. The information required to create a Job object is sent in a
create request from the end user via an IPP Client to the Printer
Expires December 30, 1998 object. The Printer object validates the create request, and if the
Printer object accepts the request, the Printer object creates the new
Job object. Section 3 describes each of the Job operations in detail.
sent in a create request from the end user via an IPP Client to the Isaacson, Powell Expires May 16, 1999
Printer object. The Printer object validates the create request, and
if the Printer object accepts the request, the Printer object creates
the new Job object. Section 3 describes each of the Job operations in
detail.
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 - "job-template" attributes: These attributes can be supplied by the
the client or end user and include job processing instructions client or end user and include job processing instructions which
which are intended to override any Printer object defaults and/or are intended to override any Printer object defaults and/or
instructions embedded within the document data. (See section 4.2) instructions embedded within the document data. (See section 4.2)
- "job-description" attributes: These attributes describe the Job - "job-description" attributes: These attributes describe the Job
object's identification, state, size, etc. The client supplies object's identification, state, size, etc. The client supplies some
some of these attributes, and the Printer object generates of these attributes, and the Printer object generates others. (See
others. (See section 4.3) section 4.3)
A Job object contains at least one document, but may contain multiple An implementation MUST support at least one document per Job object. An
documents. A document is either: implementation MAY support multiple documents per Job object. A
document is either:
- a stream of document data in a format supported by the Printer - a stream of document data in a format supported by the Printer
object (typically a Page Description Language - PDL), or object (typically a Page Description Language - PDL), or
- a reference to such a stream of document data - a reference to such a stream of document data
In IPP/1.0, a document is not modeled as an IPP object, therefore it In IPP/1.0, a document is not modeled as an IPP object, therefore it has
has no object identifier or associated attributes. All job processing no object identifier or associated attributes. All job processing
instructions are modeled as Job object attributes. These attributes instructions are modeled as Job object attributes. These attributes are
are called Job Template attributes and they apply equally to all called Job Template attributes and they apply equally to all documents
documents within a Job object. 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 logical devices include a Web page publisher or a gateway into an online
online document archive or repository. A Printer object contains zero document archive or repository. A Printer object contains zero or more
or more Job objects. 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 second
Job object would be created which would be almost identical to the Job object would be created which would be almost identical to the first
Job object, however it would have new (different) Job object identifiers
Expires December 30, 1998 (see section 2.4).
first Job object, however it would have new (different) Job object A Job object is either empty (before any documents have been added) or
identifiers (see section 2.4). contains one or more documents. If the contained document is a stream
of document data, that stream can be contained in only one document.
However, there can be identical copies of the stream in other documents
in the same or different Job objects. If the contained document is just
a reference to a stream of document data, other documents (in the same
or different Job object(s)) may contain the same reference.
A Job object contains one or more documents. If the contained Isaacson, Powell Expires May 16, 1999
document is a stream of document data, that stream can be contained in
only one document. However, there can be identical copies of the
stream in other documents in the same or different Job objects. If
the contained document is just a reference to a stream of document
data, other documents (in the same or different Job object(s)) may
contain the same reference.
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) [RFC1630] 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. The notion of a URI is a useful concept,
however, until the notion of URI is more stable (i.e., defined more however, until the notion of URI is more stable (i.e., defined more
completely and deployed more widely), it is expected that the URIs completely and deployed more widely), it is expected that the URIs used
used for IPP objects will actually be URLs [RFC1738] [RFC1808]. Since for IPP objects will actually be URLs [RFC2396]. Since every URL is a
every URL is a specialized form of a URI, even though the more generic specialized form of a URI, even though the more generic term URI is used
term URI is used throughout the rest of this document, its usage is throughout the rest of this document, its usage is intended to cover the
intended to cover the more specific notion of URL as well. more specific notion of URL as well.
An administrator configures Printer objects to either support or not An administrator configures Printer objects to either support or not
support authentication and/or message privacy using TLS [TLS] (the support authentication and/or message privacy using SSL3 [SSL] (the
mechanism for security configuration is outside the scope of IPP/1.0). mechanism for security configuration is outside the scope of IPP/1.0).
In some situations, both types of connections (both authenticated and In some situations, both types of connections (both authenticated and
unauthenticated) can be established using a single communication unauthenticated) can be established using a single communication channel
channel that has some sort of negotiation mechanism. In other that has some sort of negotiation mechanism. In other situations,
situations, multiple communication channels are used, one for each multiple communication channels are used, one for each type of security
type of security configuration. Section 8 provides a full description configuration. Section 8 provides a full description of all security
of all security considerations and configurations. , considerations and configurations.
If a Printer object supports more than one communication channel, some If a Printer object supports more than one communication channel, some
or all of those channels might support and/or require different or all of those channels might support and/or require different security
security mechanisms. In such cases, an administrator could expose the mechanisms. In such cases, an administrator could expose the
simultaneous support for these multiple communication channels as simultaneous support for these multiple communication channels as
multiple URIs for a single Printer object where each URI represents multiple URIs for a single Printer object where each URI represents one
one of the communication channels to the Printer object. To support of the communication channels to the Printer object. To support this
this flexibility, the IPP Printer object type defines a multi-valued flexibility, the IPP Printer object type defines a multi-valued
identification attribute called the "printer-uri-supported" attribute. identification attribute called the "printer-uri-supported" attribute.
It MUST contain at least one URI. It MAY contain more than one URI. 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 That is, every Printer object will have at least one URI that identifies
identifies at least one communication channel to the Printer object, at least one communication channel to the Printer object, but it may
but it may have more than one URI where each URI identifies a have more than one URI where each URI identifies a different
different communication channel to the Printer object. The "printer- communication channel to the Printer object. The "printer-uri-
uri-supported" attribute has a companion attribute, the "uri-security- supported" attribute has a companion attribute, the "uri-security-
Expires December 30, 1998
supported" attribute, that has the same cardinality as "printer-uri- supported" attribute, that has the same cardinality as "printer-uri-
supported". The purpose of the "uri-security-supported" attribute is supported". The purpose of the "uri-security-supported" attribute is to
to indicate the security mechanisms (if any) used for each URI listed indicate the security mechanisms (if any) used for each URI listed in
in "printer-uri-supported". These two attributes are fully described "printer-uri-supported". These two attributes are fully described in
in sections 4.4.1 and 4.4.2. sections 4.4.1 and 4.4.2.
When a job is submitted to the Printer object via a create request, When a job is submitted to the Printer object via a create request, the
the client supplies only a single Printer object URI. The client client supplies only a single Printer object URI. The client supplied
supplied Printer object URI MUST be one of the values in the "printer- Printer object URI MUST be one of the values in the "printer-uri-
uri-supported" Printer attribute. supported" Printer attribute.
Note: IPP/1.0 does not specify how the client obtains the client Note: IPP/1.0 does not specify how the client obtains the client
supplied URI, but it is RECOMMENDED that a Printer object be supplied URI, but it is RECOMMENDED that a Printer object be registered
registered as an entry in a directory service. End-users and programs as an entry in a directory service. End-users and programs can then
can then interrogate the directory searching for Printers. Section 17 interrogate the directory searching for Printers. Section 17 defines a
defines a generic schema for Printer object entries in the directory generic schema for Printer object entries in the directory service and
service and describes how the entry acts as a bridge to the actual IPP describes how the entry acts as a bridge to the actual IPP Printer
Printer object. The entry in the directory that represents the IPP object. The entry in the directory that represents the IPP Printer
Printer object includes the possibly many URIs for that Printer object
as values in one its attributes. Isaacson, Powell Expires May 16, 1999
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 When a client submits a create request to the Printer object, the
Printer object validates the request and creates a new Job object. Printer object validates the request and creates a new Job object. The
The Printer object assigns the new Job object a URI which is stored in Printer object assigns the new Job object a URI which is stored in the
the "job-uri" Job attribute. This URI is then used by clients as the "job-uri" Job attribute. This URI is then used by clients as the target
target for subsequent Job operations. The Printer object generates a for subsequent Job operations. The Printer object generates a Job URI
Job URI based on its configured security policy and the URI used by based on its configured security policy and the URI used by the client
the client in the create request. in the create request.
For example, consider a Printer object that supports both a For example, consider a Printer object that supports both a
communication channel secured by the use of TLS (using a standard URI communication channel secured by the use of SSL3 (using HTTP over SSL3
indicating the use of HTTP over TLS) and another open communication with an "https" schemed URI) and another open communication channel that
channel that is not secured with TLS (using an simple "http" schemed is not secured with SSL3 (using a simple "http" schemed URI). If a
URI). If a client were to submit a job using the secure URI, the client were to submit a job using the secure URI, the Printer object
Printer object would assign the new Job object a secure URI as well. would assign the new Job object a secure URI as well. If a client were
If a client were to submit a job using the open-channel URI, the to submit a job using the open-channel URI, the Printer would assign the
Printer would assign the new Job object an open-channel URI. new Job object an open-channel URI.
In addition, the Printer object also populates the Job object's "job- In addition, the Printer object also populates the Job object's "job-
printer-uri" attribute. This is a reference back to the Printer printer-uri" attribute. This is a reference back to the Printer object
object that created the Job object. If a client only has access to a that created the Job object. If a client only has access to a Job
Job object's "job-uri" identifier, the client can query the Job's object's "job-uri" identifier, the client can query the Job's "job-
"job-printer-uri" attribute in order to determine which Printer object printer-uri" attribute in order to determine which Printer object
created the Job object. If the Printer object supports more than one created the Job object. If the Printer object supports more than one
URI, the Printer object picks the one URI supplied by the client when URI, the Printer object picks the one URI supplied by the client when
creating the job to build the value for and to populate the Job's creating the job to build the value for and to populate the Job's "job-
"job-printer-uri" attribute. printer-uri" attribute.
Expires December 30, 1998
Allowing Job objects to have URIs allows for flexibility and Allowing Job objects to have URIs allows for flexibility and
scalability. For example, in some implementations, the Printer object scalability. For example, in some implementations, the Printer object
might create Jobs that are processed in the same local environment as might create Jobs that are processed in the same local environment as
the Printer object itself. In this case, the Job URI might just be a the Printer object itself. In this case, the Job URI might just be a
composition of the Printer's URI and some unique component for the Job composition of the Printer's URI and some unique component for the Job
object, such as the unique 32-bit positive integer mentioned later in object, such as the unique 32-bit positive integer mentioned later in
this paragraph. In other implementations, the Printer object might be this paragraph. In other implementations, the Printer object might be a
a central clearing-house for validating all Job object creation central clearing-house for validating all Job object creation requests,
requests, but the Job object itself might be created in some but the Job object itself might be created in some environment that is
environment that is remote from the Printer object. In this case, the remote from the Printer object. In this case, the Job object's URI may
Job object's URI may have no physical-location relationship at all to have no physical-location relationship at all to the Printer object's
the Printer object's URI. Again, the fact that Job objects have URIs URI. Again, the fact that Job objects have URIs allows for flexibility
allows for flexibility and scalability, however, many existing and scalability, however, many existing printing systems have local
printing systems have local models or interface constraints that force models or interface constraints that force print jobs to be identified
print jobs to be identified using only a 32-bit positive integer using only a 32-bit positive integer rather than an independent URI.
rather than an independent URI. This numeric Job ID is only unique This numeric Job ID is only unique within the context of the Printer
within the context of the Printer object to which the create request object to which the create request was originally submitted. Therefore,
was originally submitted. Therefore, in order to allow both types of in order to allow both types of client access to IPP Job objects (either
client access to IPP Job objects (either by Job URI or by numeric Job by Job URI or by numeric Job ID), when the Printer object successfully
ID), when the Printer object successfully processes a create request processes a create request and creates a new Job object, the Printer
and creates a new Job object, the Printer object MUST generate both a object MUST generate both a Job URI and a Job ID. The Job ID (stored in
Job URI and a Job ID. The Job ID (stored in the "job-id" attribute) the "job-id" attribute) only has meaning in the context of the Printer
only has meaning in the context of the Printer object to which the object to which the create request was originally submitted. This
create request was originally submitted. This requirement to support requirement to support both Job URIs and Job IDs allows all types of
both Job URIs and Job IDs allows all types of clients to access
Printer objects and Job objects no matter the local constraints Isaacson, Powell Expires May 16, 1999
imposed on the client implementation.
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 names
("printer-name" and "job-name"). An object name NEED NOT be unique ("printer-name" and "job-name"). An object name NEED NOT be unique
across all instances of all objects. A Printer object's name is chosen across all instances of all objects. A Printer object's name is chosen
and set by an administrator through some mechanism outside the scope and set by an administrator through some mechanism outside the scope of
of IPP/1.0. A Job object's name is optionally chosen and supplied by IPP/1.0. A Job object's name is optionally chosen and supplied by the
the IPP client submitting the job. If the client does not supply a IPP client submitting the job. If the client does not supply a Job
Job object name, the Printer object generates a name for the new Job object name, the Printer object generates a name for the new Job object.
object. In all cases, the name only has local meaning. 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 - The Printer object's "uri-security-supported" attribute identifies
identifies the communication channel security protocols that may the communication channel security protocols that may or may not
or may not have been configured for the various Printer object have been configured for the various Printer object URIs (e.g.,
URIs (e.g., 'tls' or 'none'). 'ssl3' or 'none').
- Each Job object is identified with a Job URI. The Job's "job- - Each Job object is identified with a Job URI. The Job's "job-uri"
uri" attribute contains the URI. attribute contains the URI.
Expires December 30, 1998
- 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-bit,
positive integer. The Job's "job-id" attribute contains the Job positive integer. The Job's "job-id" attribute contains the Job
ID. The Job ID is only unique within the context of the Printer ID. The Job ID is only unique within the context of the Printer
object which created the Job object. object which created the Job object.
- Each Job object has a "job-printer-uri" attribute which contains - Each Job object has a "job-printer-uri" attribute which contains
the URI of the Printer object that was used to create the Job the URI of the Printer object that was used to create the Job
object. This attribute is used to determine the Printer object object. This attribute is used to determine the Printer object
that created a Job object when given only the URI for the Job that created a Job object when given only the URI for the Job
object. This linkage is necessary to determine the languages, object. This linkage is necessary to determine the languages,
charsets, and operations which are supported on that Job (the charsets, and operations which are supported on that Job (the basis
basis for such support comes from the creating Printer object). for such support comes from the creating Printer object).
- Each Printer object has a name (which is not necessarily unique). - Each Printer object has a name (which is not necessarily unique).
The administrator chooses and sets this name through some The administrator chooses and sets this name through some mechanism
mechanism outside the scope of IPP/1.0 itself. The Printer outside the scope of IPP/1.0 itself. The Printer object's
object's "printer-name" attribute contains the name. "printer-name" attribute contains the name.
- Each Job object has a name (which is not necessarily unique). - Each Job object has a name (which is not necessarily unique). The
The client optionally supplies this name in the create request. client optionally supplies this name in the create request. If the
If the client does not supply this name, the Printer object client does not supply this name, the Printer object generates a
generates a name for the Job object. The Job object's "job-name" name for the Job object. The Job object's "job-name" attribute
attribute contains the name. contains the name.
3. IPP Operations 3. IPP Operations
IPP objects support operations. An operation consists of a request IPP objects support operations. An operation consists of a request and
and a response. When a client communicates with an IPP object, the a response. When a client communicates with an IPP object, the client
client issues an operation request to the URI for that object. issues an operation request to the URI for that object. Operation
Operation requests and responses have parameters that identify the requests and responses have parameters that identify the operation.
operation. Operations also have attributes that affect the run-time Operations also have attributes that affect the run-time characteristics
characteristics of the operation (the intended target, localization of the operation (the intended target, localization information, etc.).
information, etc.). These operation-specific attributes are called These operation-specific attributes are called operation attributes (as
operation attributes (as compared to object attributes such as Printer compared to object attributes such as Printer object attributes or Job
object attributes or Job object attributes). Each request carries
along with it any operation attributes, object attributes, and/or Isaacson, Powell Expires May 16, 1999
document data required to perform the operation. Each request
requires a response from the object. Each response indicates success object attributes). Each request carries along with it any operation
or failure of the operation with a status code as a response attributes, object attributes, and/or document data required to perform
parameter. The response contains any operation attributes, object the operation. Each request requires a response from the object. Each
attributes, and/or status messages generated during the execution of response indicates success or failure of the operation with a status
the operation request. code as a response parameter. The response contains any operation
attributes, object 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.0 Printer operations are: The IPP/1.0 Printer operations are:
Print-Job (section 3.2.1) Print-Job (section 3.2.1)
Expires December 30, 1998
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)
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)
skipping to change at page 21, line 40 skipping to change at page 19, line 5
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:
Isaacson, Powell Expires May 16, 1999
- 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 [IPP-PRO] defines special rules for
for the encoding of these parameters. All other operation elements the encoding of these parameters. All other operation elements are
are represented using the more generic encoding rules for attributes represented using the more generic encoding rules for attributes and
and groups of attributes. groups of attributes.
Expires December 30, 1998
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" Each IPP operation request includes an identifying "operation-id" value.
value. Valid values are defined in the "operations-supported" Printer Valid values are defined in the "operations-supported" Printer attribute
attribute section (see section 4.4.13). The client specifies which section (see section 4.4.13). The client specifies which operation is
operation is being requested by supplying the correct "operation-id" being requested by supplying the correct "operation-id" value.
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 "request-
id" which is an integer (possibly unique depending on client id" which MUST be an integer (possibly unique depending on client
requirements) in the range from 1 to 2**31 - 1 (inclusive). This requirements) in the range from 1 to 2**31 - 1 (inclusive). This
"request-id" allows clients to manage multiple outstanding requests. "request-id" allows clients to manage multiple outstanding requests. The
The receiving IPP object copies the client supplied "request-id" receiving IPP object copies all 32-bits of the client-supplied "request-
attribute into the response so that the client can match the response id" attribute into the response so that the client can match the
with the correct outstanding request. response with the correct outstanding request, even if the "request-id"
is out of range. If the request is terminated before the complete
"request-id" is received, the IPP object rejects 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 connection oriented protocol that would make it impossible for a client
client to receive responses in any order other than the order in which to receive responses in any order other than the order in which the
the corresponding requests were sent. In such cases, the "request-id" corresponding requests were sent. In such cases, the "request-id"
attribute would not be essential for correct protocol operation. attribute would not be essential for correct protocol operation.
However, in other mappings, the operation responses can come back in However, in other mappings, the operation responses can come back in any
any order. In these cases, the "request-id" would be essential. 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:
- Operation Attributes: These attributes are passed in the - Operation Attributes: These attributes are passed in the operation
operation and affect the IPP object's behavior while processing and affect the IPP object's behavior while processing the operation
the operation request and may affect other attributes or groups request and may affect other attributes or groups of attributes.
of attributes. Some operation attributes describe the document Some operation attributes describe the document data associated
data associated with the print job and are associated with new with the print job and are associated with new Job objects, however
Job objects, however most operation attributes do not persist most operation attributes do not persist beyond the life of the
beyond the life of the operation. The description of each operation. The description of each operation attribute includes
operation attribute includes conformance statements indicating conformance statements indicating which operation attributes are
which operation attributes are REQUIRED and which are OPTIONAL REQUIRED and which are OPTIONAL for an IPP object to support and
for an IPP object to support and which attributes a client MUST which attributes a client MUST supply in a request and an IPP
supply in a request and an IPP object MUST supply in a response. object MUST supply in a response.
- Job Template Attributes: These attributes affect the processing
of a job. A client OPTIONALLY supplies Job Template Attributes Isaacson, Powell Expires May 16, 1999
in a create request, and the receiving object MUST be prepared to - 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 receive all supported attributes. The Job object can later be
queried to find out what Job Template attributes were originally queried to find out what Job Template attributes were originally
requested in the create request, and such attributes are returned requested in the create request, and such attributes are returned
Expires December 30, 1998
in the response as Job Object Attributes. The Printer object can in the response as Job Object Attributes. The Printer object can
be queried about its Job Template attributes to find out what be queried about its Job Template attributes to find out what type
type of job processing capabilities are supported and/or what the of job processing capabilities are supported and/or what the
default job processing behaviors are, though such attributes are default job processing behaviors are, though such attributes are
returned in the response as Printer Object Attributes. The "ipp- returned in the response as Printer Object Attributes. The "ipp-
attribute-fidelity" operation attribute affects processing of all attribute-fidelity" operation attribute affects processing of all
client-supplied Job Template attributes (see section 16 for a client-supplied Job Template attributes (see section 16 for a full
full description of "ipp-attribute-fidelity" and its relationship description of "ipp-attribute-fidelity" and its relationship to
to other attributes). other attributes).
- Job Object Attributes: These attributes are returned in response - Job Object Attributes: These attributes are returned in response to
to a query operation directed at a Job object. a query operation directed at a Job object.
- Printer Object Attributes: These attributes are returned in - Printer Object Attributes: These attributes are returned in
response to a query operation directed at a Printer object. response to a query operation directed at a Printer object.
- Unsupported Attributes: In a create request, the client supplies - Unsupported Attributes: In a create request, the client supplies a
a set of Operation and Job Template attributes. If any of these set of Operation and Job Template attributes. If any of these
attributes or their values is unsupported by the Printer object, attributes or their values is unsupported by the Printer object,
the Printer object returns the set of unsupported attributes in the Printer object returns the set of unsupported attributes in the
the response. Section 16 gives a full description of how Job response. Section 16 gives a full description of how Job Template
Template attributes supplied by the client in a create request attributes supplied by the client in a create request are processed
are processed by the Printer object and how unsupported by the Printer object and how unsupported attributes are returned
attributes are returned to the client. Because of extensibility, to the client. Because of extensibility, any IPP object might
any IPP object might receive a request that contains new or receive a request that contains new or unknown attributes or values
unknown attributes or values for which it has no support. In such for which it has no support. In such cases, the IPP object
cases, the IPP object processes what it can and returns the processes what it can and returns the unsupported attributes in the
unsupported attributes in the response. response.
Later in this section, each operation is formally defined by Later in this section, each operation is formally defined by identifying
identifying the allowed and expected groups of attributes for each the allowed and expected groups of attributes for each request and
request and response. The model identifies a specific order for each response. The model identifies a specific order for each group in each
group in each request or response, but the attributes within each request or response, but the attributes within each group may be in any
group may be in any order, unless specified otherwise. order, unless specified otherwise.
Each attribute specification includes the attribute's name followed by Each attribute specification includes the attribute's name followed by
the name of its attribute syntax(es) in parenthesizes. In addition, the name of its attribute syntax(es) in parenthesizes. In addition,
each 'integer' attribute is followed by the allowed range in each 'integer' attribute is followed by the allowed range in
parentheses, (m:n), for values of that attribute. Each 'text' or parentheses, (m:n), for values of that attribute. Each 'text' or 'name'
'name' attribute is followed by the maximum size in octets in attribute is followed by the maximum size in octets in parentheses,
parentheses, (size), for values of that attribute. For more details on (size), for values of that attribute. For more details on attribute
attribute syntax notation, see the descriptions of these attributes syntax notation, see the descriptions of these attributes syntaxes in
syntaxes in section 4.1. 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 ordering
purposes. The only operations that support supplying the document purposes. The only operations that support supplying the document data
data within an operation request are Print-Job and Send-Document. within an operation request are Print-Job and Send-Document. There are
There are no operation responses that include document data. no operation responses that include document data.
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
Note: Some operations are REQUIRED for IPP objects to support; the Note: Some operations are REQUIRED for IPP objects to support; the
others are OPTIONAL (see section 5.2.2). Therefore, before using an others are OPTIONAL (see section 5.2.2). Therefore, before using an
OPTIONAL operation, a client SHOULD first use the REQUIRED Get- OPTIONAL operation, a client SHOULD first use the REQUIRED Get-Printer-
Printer-Attributes operation to query the Printer's "operations- Attributes operation to query the Printer's "operations-supported"
supported" attribute in order to determine which OPTIONAL Printer and attribute in order to determine which OPTIONAL Printer and Job
Job operations are actually supported. The client SHOULD NOT use an operations are actually supported. The client SHOULD NOT use an
OPTIONAL operation that is not supported. When an IPP object receives OPTIONAL operation that is not supported. When an IPP object receives a
a request to perform an operation it does not support, it returns the request to perform an operation it does not support, it returns the
'server-error-operation-not-supported' status code (see section 'server-error-operation-not-supported' status code (see section
14.1.5.2). An IPP object is non-conformant if it does not support a 14.1.5.2). An IPP object is non-conformant if it does not support a
REQUIRED operation. 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 names intended for human understanding rather than machine understanding
understanding (see the 'text' and 'name' attribute syntax descriptions (see the 'text' and 'name' attribute syntax descriptions in section
in section 4.1). The following sections describe two special 4.1). The following sections describe two special Operation Attributes
Operation Attributes called "attributes-charset" and "attributes- called "attributes-charset" and "attributes-natural-language". These
natural-language". These attributes are always part of the Operation attributes are always part of the Operation Attributes group. For most
Attributes group. For most attribute groups, the order of the attribute groups, the order of the attributes within the group is not
attributes within the group is not important. However, for these two important. However, for these two attributes within the Operation
attributes within the Operation Attributes group, the order is Attributes group, the order is critical. The "attributes-charset"
critical. The "attributes-charset" attribute MUST be the first attribute MUST be the first attribute in the group and the "attributes-
attribute in the group and the "attributes-natural-language" attribute natural-language" attribute MUST be the second attribute in the group.
MUST be the second attribute in the group. In other words, these In other words, these attributes MUST be supplied in every IPP request
attributes MUST be supplied in every IPP request and response, they and response, they MUST come first in the group, and MUST come in the
MUST come first in the group, and MUST come in the specified order. specified order. For job creation operations, the IPP Printer
For job creation operations, the IPP Printer implementation saves implementation saves these two attributes with the new Job object as Job
these two attributes with the new Job object as Job Description Description attributes. For the sake of brevity in this document, these
attributes. For the sake of brevity in this document, these operation operation attribute descriptions are not repeated with every operation
attribute descriptions are not repeated with every operation request request and response, but have a reference back to this section instead.
and response, but have a reference back to this 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 The client MUST supply and the Printer object MUST support the following
following REQUIRED operation attributes in every IPP/1.0 operation REQUIRED operation attributes in every IPP/1.0 operation request:
request:
"attributes-charset" (charset): "attributes-charset" (charset):
This operation attribute identifies the charset (coded character This operation attribute identifies the charset (coded character
set and encoding method) used by any 'text' and 'name' attributes set and encoding method) used by any 'text' and 'name' attributes
that the client is supplying in this request. It also identifies that the client is supplying in this request. It also identifies
the charset that the Printer object MUST use (if supported) for the charset that the Printer object MUST use (if supported) for all
all 'text' and 'name' attributes and status messages that the '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 specification of the 'text' and 'name' attribute
syntaxes.
Expires December 30, 1998 All clients and IPP objects MUST support the 'utf-8' charset
Printer object returns in the response to this request. See [RFC2044] and MAY support additional charsets provided that they
Sections 4.1.1 and 4.1.2 for the specification of the 'text' and are registered with IANA [IANA-CS]. If the Printer object does not
'name' attribute syntaxes. support the client supplied charset value, the Printer object MUST
reject the request, set the "attributes-charset" to 'utf-8' in the
All IPP objects MUST support the 'utf-8' charset [RFC2044] and Isaacson, Powell Expires May 16, 1999
MAY support additional charsets provided that they are registered response, and return the 'client-error-charset-not-supported'
with IANA [IANA-CS]. If the Printer object does not support the status code and any 'text' or 'name' attributes using the 'utf-8'
client supplied charset value, the Printer object MUST reject the charset. The Printer object MUST indicate the charset(s) supported
request and return the 'client-error-charset-not-supported' as the values of the "charset-supported" Printer attribute (see
status code. The Printer object MUST indicate the charset(s) Section 4.4.15), so that the client can query to determine which
supported as the values of the "charset-supported" Printer charset(s) are supported.
attribute (see Section 4.4.15), so that the client can query to
determine which charset(s) are supported.
Note to client implementers: Since IPP objects are only required Note to client implementers: Since IPP objects are only required to
to support the 'utf-8' charset, in order to maximize support the 'utf-8' charset, in order to maximize interoperability
interoperability with multiple IPP object implementations, a with multiple IPP object implementations, a client may want to
client may want to supply 'utf-8' in the "attributes-charset" supply 'utf-8' in the "attributes-charset" operation attribute,
operation attribute, even though the client is only passing and even though the client is only passing and able to present a
able to present a simpler charset, such as US-ASCII or ISO-8859- simpler charset, such as US-ASCII or ISO-8859-1. Then the client
1. Then the client will have to filter out (or charset convert) will have to filter out (or charset convert) those characters that
those characters that are returned in the response that it cannot are returned in the response that it cannot present to its user.
present to its user. On the other hand, if both the client and On the other hand, if both the client and the IPP objects also
the IPP objects also support a charset in common besides utf-8, support a charset in common besides utf-8, the client may want to
the client may want to use that charset in order to avoid charset use that charset in order to avoid charset conversion or data loss.
conversion or data loss.
See the 'charset' attribute syntax description in Section 4.1.7 See the 'charset' attribute syntax description in Section 4.1.7 for
for the syntax and semantic interpretation of the values of this the syntax and semantic interpretation of the values of this
attribute and for example values. attribute and for example values.
"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 by
any 'text' and 'name' attributes that the client is supplying in any 'text' and 'name' attributes that the client is supplying in
this request. This attribute also identifies the natural this request. This attribute also identifies the natural language
language that the Printer object SHOULD use for all 'text' and that the Printer object SHOULD use for all 'text' and 'name'
'name' attributes and status messages that the Printer object attributes and status messages that the Printer object returns in
returns in the response to this request. the response to this request.
There are no REQUIRED natural languages required for the Printer There are no REQUIRED natural languages required for the Printer
object to support. However, the Printer object's "generated- object to support. However, the Printer object's "generated-
natural-language-supported" attribute identifies the natural natural-language-supported" attribute identifies the natural
languages supported by the Printer object and any contained Job languages supported by the Printer object and any contained Job
objects for all text strings generated by the IPP object. A objects for all text strings generated by the IPP object. A client
client MAY query this attribute to determine which natural MAY query this attribute to determine which natural language(s) are
language(s) are supported for generated messages. supported for generated messages.
Expires December 30, 1998
For any of the attributes for which the Printer object generates For any of the attributes for which the Printer object generates
text, i.e., for the "job-state-message", "printer-state-message", text, i.e., for the "job-state-message", "printer-state-message",
and status messages (see Section 3.1.6), the Printer object MUST and status messages (see Section 3.1.6), the Printer object MUST be
be able to generate these text strings in any of its supported able to generate these text strings in any of its supported natural
natural languages. If the client requests a natural language languages. If the client requests a natural language that is not
that is not supported, the Printer object MUST return these supported, the Printer object MUST return these generated messages
generated messages in the Printer's configured natural language in the Printer's configured natural language as specified by the
as specified by the Printer's "natural-language-configured" Printer's "natural-language-configured" attribute" (see Section
attribute" (see Section 4.4.16). 4.4.16).
For other 'text' and 'name' attributes supplied by the client, For other 'text' and 'name' attributes supplied by the client,
authentication system, operator, system administrator, or authentication system, operator, system administrator, or
manufacturer (i.e., for "job-originating-user-name", "printer- manufacturer (i.e., for "job-originating-user-name", "printer-name"
name" (name), "printer-location" (text), "printer-info" (text), (name), "printer-location" (text), "printer-info" (text), and
and "printer-make-and-model" (text)), the Printer object is only "printer-make-and-model" (text)), the Printer object is only
required to support the configured natural language of the
Printer identified by the Printer object's "natural-language- Isaacson, Powell Expires May 16, 1999
configured" attribute, though support of additional natural required to support the configured natural language of the Printer
languages for these attributes is permitted. identified by the Printer object's "natural-language-configured"
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 'text' or 'name' attribute in the request that is in a
different natural language than the value supplied in the different natural language than the value supplied in the
"attributes-natural-language", the client MUST use the Natural "attributes-natural-language" operation attribute, the client MUST
Language Override mechanism (see sections 4.1.1.2 and 4.1.2.2) use the Natural Language Override mechanism (see sections 4.1.1.2
for each such attribute value supplied. and 4.1.2.2) for each such attribute value supplied. 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.
The IPP object MUST accept any natural language and any Natural The IPP object MUST accept any natural language and any Natural
Language Override, whether the IPP object supports that natural Language Override, whether the IPP object supports that natural
language or not (and independent of the value of the "ipp- language or not (and independent of the value of the "ipp-
attribute-fidelity" Operation attribute). That is the IPP object attribute-fidelity" Operation attribute). That is the IPP object
accepts all client supplied values no matter what the values are accepts all client supplied values no matter what the values are in
in the Printer object's "generated-natural-language-supported" the Printer object's "generated-natural-language-supported"
attribute. That attribute, "generated-natural-language- attribute. That attribute, "generated-natural-language-supported",
supported", only applies to generated messages, not client only applies to generated messages, not client supplied messages.
supplied messages. The IPP object MUST remember that natural The IPP object MUST remember that natural language for all client-
language for all client-supplied attributes, and when returning supplied attributes, and when returning those attributes in
those attributes in response to a query, the IPP object MUST response to a query, the IPP object MUST indicate that natural
indicate that natural language. language.
For example, the "job-name" attribute MAY be supplied by the Each value whose attribute syntax type is .text. or .name. (see
client in a create request. The text value for this attribute sections 4.1.1 and 4.1.2) has an Associated Natural-Language. This
will be in the natural language identified by the "attribute- document does not specify how this association is stored in a
natural-language" attribute, or if different, as identified by Printer or Job object. When such a value is encoded in a request
the Natural Language Override mechanism. If supplied, the IPP or response, the natural language is either implicit or explicit:
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
Expires December 30, 1998 @ In the implicit case, the value contains only the text/name
Override mechanism to specify the natural language, if it is value, and the language is specified by the .attributes-
different from that reported in the "attributes-natural-language" natural-language. operation attribute in the request or
operation attribute of the response. An IPP object MUST NOT response (see sections 4.1.1.1 textWithoutLanguage and
reject a request based on a supplied natural language in an 4.1.2.1 nameWithoutLanguage).
"attributes-natural-language" Operation attribute or in any
attribute that uses the Natural Language Override. @ In the explicit case (also known as the Natural-Language
Override case), the value contains both the language and
the text/name value (see sections 4.1.1.2 textWithLanguage
and 4.1.2.2 nameWithLanguage).
For example, the "job-name" attribute MAY be supplied by the client
in a create request. The text value for this attribute 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
Isaacson, Powell Expires May 16, 1999
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
language in an "attributes-natural-language" Operation attribute or
in any attribute that uses the Natural Language Override.
See the 'naturalLanguage' attribute syntax description in section See the 'naturalLanguage' attribute syntax description in section
4.1.8 for the syntax and semantic interpretation of the values of 4.1.8 for the syntax and semantic interpretation of the values of
this attribute and for example values. this attribute and for example values.
Clients SHOULD NOT supply 'text' or 'name' attributes that use an Clients SHOULD NOT supply 'text' or 'name' attributes that use an
illegal combination of natural language and charset. For example, illegal combination of natural language and charset. For example,
suppose a Printer object supports charsets 'utf-8', 'iso-8859-1', and suppose a Printer object supports charsets 'utf-8', 'iso-8859-1', and
'iso-8859-7'. Suppose also, that it supports natural languages 'en' 'iso-8859-7'. Suppose also, that it supports natural languages 'en'
(English), 'fr' (French), and 'el' (Greek). Although the Printer (English), 'fr' (French), and 'el' (Greek). Although the Printer object
object supports the charset 'iso-8859-1' and natural language 'el', it supports the charset 'iso-8859-1' and natural language 'el', it probably
probably does not support the combination of Greek text strings using does not support the combination of Greek text strings using the 'iso-
the 'iso-8859-1' charset. The Printer object handles this apparent 8859-1' charset. The Printer object handles this apparent
incompatibility differently depending on the context in which it incompatibility differently depending on the context in which it occurs:
occurs:
- In a create request: If the client supplies a text or name - In a create request: If the client supplies a text or name
attribute (for example, the "job-name" operation attribute) that attribute (for example, the "job-name" operation attribute) that
uses an apparently incompatible combination, it is a client uses an apparently incompatible combination, it is a client choice
choice that does not affect the Printer object or its correct that does not affect the Printer object or its correct operation.
operation. Therefore, the Printer object simply accepts the Therefore, the Printer object simply accepts the client supplied
client supplied value, stores it with the Job object, and value, stores it with the Job object, and responds back with the
responds back with the same combination whenever the client (or same combination whenever the client (or any client) queries for
any client) queries for that attribute. that attribute.
-In a query-type operation, like Get-Printer-Attributes: If the -In a query-type operation, like Get-Printer-Attributes: If the
client requests an apparently incompatible combination, the client requests an apparently incompatible combination, the Printer
Printer object responds (as described in section 3.1.4.2) using object responds (as described in section 3.1.4.2) using the
the Printer's configured natural language rather than the natural Printer's configured natural language rather than the natural
language requested by the client. 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 because
of the apparent incompatibility. The potential incompatible of the apparent incompatibility. The potential incompatible combination
combination of charset and natural language can occur either at the of charset and natural language can occur either at the global operation
global operation level or at the Natural Language Override attribute- level or at the Natural Language Override attribute-by-attribute level.
by-attribute level. In addition, since the response always includes In addition, since the response always includes explicit charset and
explicit charset and natural language information, there is never any natural language information, there is never any question or ambiguity
question or ambiguity in how the client interprets the response. in how the client interprets the response.
Expires December 30, 1998
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 The Printer object MUST supply and the client MUST support the following
following REQUIRED operation attributes in every IPP/1.0 operation REQUIRED operation attributes in every IPP/1.0 operation response:
response:
Isaacson, Powell Expires May 16, 1999
"attributes-charset" (charset): "attributes-charset" (charset):
This operation attribute identifies the charset used by any This operation attribute identifies the charset used by any 'text'
'text' and 'name' attributes that the Printer object is returning and 'name' attributes that the Printer object is returning in this
in this response. The value in this response MUST be the same response. The value in this response MUST be the same value as the
value as the "attributes-charset" operation attribute supplied by "attributes-charset" operation attribute supplied by the client in
the client in the request. If this is not possible (i.e., the the request. If this is not possible (i.e., the charset requested
charset requested is not supported), the request would have been is not supported), the request would have been rejected. See
rejected. See "attributes-charset" described in Section 3.1.4.1 "attributes-charset" described in Section 3.1.4.1 above.
above.
If the Printer object supports more than just the 'utf-8' If the Printer object supports more than just the 'utf-8' charset,
charset, the Printer object MUST be able to code convert between the Printer object MUST be able to code convert between each of the
each of the charsets supported on a highest fidelity possible charsets supported on a highest fidelity possible basis in order to
basis in order to return the 'text' and 'name' attributes in the return the 'text' and 'name' attributes in the charset requested by
charset requested by the client. However, some information loss the client. However, some information loss MAY occur during the
MAY occur during the charset conversion depending on the charsets charset conversion depending on the charsets involved. For
involved. For example, the Printer object may convert from a example, the Printer object may convert from a UTF-8 'a' to a US-
UTF-8 'a' to a US-ASCII 'a' (with no loss of information), from ASCII 'a' (with no loss of information), from an ISO Latin 1
an ISO Latin 1 CAPITAL LETTER A WITH ACUTE ACCENT to US-ASCII 'A' CAPITAL LETTER A WITH ACUTE ACCENT to US-ASCII 'A' (losing the
(losing the accent), or from a UTF-8 Japanese Kanji character to accent), or from a UTF-8 Japanese Kanji character to some ISO Latin
some ISO Latin 1 error character indication such as '?', decimal 1 error character indication such as '?', decimal code equivalent,
code equivalent, or to the absence of a character, depending on or to the absence of a character, depending on implementation.
implementation.
Note: Whether an implementation that supports more than one Note: Whether an implementation that supports more than one charset
charset stores the data in the charset supplied by the client or stores the data in the charset supplied by the client or code
code converts to one of the other supported charsets, depends on converts to one of the other supported charsets, depends on
implementation. The strategy should try to minimize loss of implementation. The strategy should try to minimize loss of
information during code conversion. On each response, such an information during code conversion. On each response, such an
implementation converts from its internal charset to that implementation converts from its internal charset to that
requested. 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 by
any 'text' and 'name' attributes that the IPP object is returning any 'text' and 'name' attributes that the IPP object is returning
in this response. Unlike the "attributes-charset" operation in this response. Unlike the "attributes-charset" operation
attribute, the IPP object NEED NOT return the same value as that attribute, the IPP object NEED NOT return the same value as that
supplied by the client in the request. The IPP object MAY return supplied by the client in the request. The IPP object MAY return
the natural language of the Job object or the Printer's the natural language of the Job object or the Printer's configured
configured natural language as identified by the Printer object's natural language as identified by the Printer object's "natural-
"natural-language-configured" attribute, rather than the natural language-configured" attribute, rather than the natural language
language supplied by the client. For any 'text' or 'name' supplied by the client. For any 'text' or 'name' attribute or
status message in the response that is in a different natural
Expires December 30, 1998 language than the value returned in the "attributes-natural-
attribute or status message in the response that is in a language" operation attribute, the IPP object MUST use the Natural
different natural language than the value returned in the Language Override mechanism (see sections 4.1.1.2 and 4.1.2.2) on
"attributes-natural-language" operation attribute, the IPP object each attribute value returned. The IPP object MAY use the Natural
MUST use the Natural Language Override mechanism (see sections Language Override mechanism redundantly, i.e., use it even when the
4.1.1.2 and 4.1.2.2) on each attribute value returned. 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 All IPP operations are directed at IPP objects. For Printer operations,
operations, the operation is always directed at a Printer object using the operation is always directed at a Printer object using one of its
one of its URIs (i.e., one of the values in the Printer object's URIs (i.e., one of the values in the Printer object's "printer-uri-
"printer-uri-supported" attribute). Even if the Printer object
supports more than one URI, the client supplies only one URI as the Isaacson, Powell Expires May 16, 1999
target of the operation. The client identifies the target object by
supplying the correct URI in the "printer-uri (uri)" operation supported" attribute). Even if the Printer object supports more than
attribute. one URI, the client supplies only one URI as the target of the
operation. The client identifies the target 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 objects URI and the Job object's Job ID. Since the Printer
Printer object that created the Job object generated the Job ID, object that created the Job object generated the Job ID, it MUST be
it MUST be able to correctly associate the client supplied Job ID able to correctly associate the client supplied Job ID with the
with the correct Job object. The client supplies the Printer correct Job object. The client supplies the Printer object's URI
object's URI in the "printer-uri (uri)" operation attribute and in the "printer-uri (uri)" operation attribute and the Job object's
the Job object's Job ID in the "job-id (integer(1:MAX))" Job ID in the "job-id (integer(1:MAX))" operation attribute.
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 that
MUST be included in every operation request. Like the charset and MUST be included in every operation request. Like the charset and
natural language attributes (see section 3.1.4), the operation target natural language attributes (see section 3.1.4), the operation target
attributes are specially ordered operation attributes. In all cases, attributes are specially ordered operation attributes. In all cases,
the operation target attributes immediately follow the "attributes- the operation target attributes immediately follow the "attributes-
charset" and "attributes-natural-language" attributes within the charset" and "attributes-natural-language" attributes within the
operation attribute group, however the specific ordering rules are: operation attribute group, however the specific ordering rules are:
- 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 "job- (i.e., either only the "printer-uri" attribute or only the "job-
uri" attribute), that attribute MUST be the third attribute in uri" attribute), that attribute MUST be the third attribute in the
the operation attributes group. operation attributes group.
Expires December 30, 1998
- 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), the attributes (i.e., the "printer-uri" and "job-id" attributes), the
"printer-uri" attribute MUST be the third attribute and the "job- "printer-uri" attribute MUST be the third attribute and the "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 In all cases, the target URIs contained within the body of IPP operation
operation requests and responses must be in absolute format rather requests and responses must be in absolute format rather than relative
than relative format (a relative URL identifies a resource with the format (a relative URL identifies a resource with the scope of the HTTP
scope of the HTTP server, but does not include scheme, host or port). 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 1. If the URI scheme allows the port number to be explicitly included
included in the URI string, and a port number is specified within in the URI string, and a port number is specified within the URI,
the URI, then that port number MUST be used by the client to then that port number MUST be used by the client to contact the IPP
contact the IPP object. object.
2. If the URI scheme allows the port number to be explicitly 2. If the URI scheme allows the port number to be explicitly included
included in the URI string, and a port number is not specified in the URI string, and a port number is not specified within the
within the URI, then default port number implied by that URI
scheme MUST be used by the client to contact the IPP object. Isaacson, Powell Expires May 16, 1999
URI, then default port number implied by that URI 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 by
that URI MUST be used by the client to contact the IPP object. that URI MUST be used by the client to contact the IPP object.
Note: The IPP encoding and transport document [IPP-PRO] shows a Note: The IPP encoding and transport document [IPP-PRO] shows a mapping
mapping of IPP onto HTTP/1.1 and defines a new default port number for of IPP onto HTTP/1.1 and defines a new default port number for using IPP
using IPP over HTTP/1.1. over HTTP/1.1.
3.1.6 Operation Status Codes and Messages 3.1.6 Operation Status Codes and Messages
Every operation response includes a REQUIRED "status-code" parameter Every operation response includes a REQUIRED "status-code" parameter and
and an OPTIONAL "status-message" operation attribute. The "status- an OPTIONAL "status-message" operation attribute. The "status-code"
code" provides information on the processing of a request. A "status- provides information on the processing of a request. A "status-message"
message" attribute provides a short textual description of the status attribute provides a short textual description of the status of the
of the operation. The status code is intended for use by automata, operation. The status code is intended for use by automata, and the
and the status message is intended for the human end user. If a status message is intended for the human end user. If a response does
response does include a "status-message" attribute, an IPP client NEED include a "status-message" attribute, an IPP client NEED NOT examine or
NOT examine or display the message, however it SHOULD do so in some display the message, however it SHOULD do so in some implementation
implementation specific manner. specific manner.
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 4.1 The "status-code" syntax is similar to a "type2 enum" (see section 4.1
on "Attribute Syntaxes") except that values can range only from 0x0000 on "Attribute Syntaxes") except that values can range only from 0x0000
to 0x7FFF. Section 14 describes the status codes, assigns the numeric to 0x7FFF. Section 14 describes the status codes, assigns the numeric
Expires December 30, 1998
values, and suggests a corresponding status message for each status values, and suggests a corresponding status message for each status
code. The "status-message" attribute's syntax is "text(255)". code. The "status-message" attribute's syntax is "text(255)". A client
implementation of IPP SHOULD convert status code values into any
localized message that has semantic meaning to the end user.
A client implementation of IPP SHOULD convert status code values into If the Printer object supports the "status-message" operation attribute,
any localized message that has semantic meaning to the end user. If the Printer object MUST be able to generate this message in any of the
the Printer object supports the status message, the Printer object natural languages identified by the Printer object's "generated-natural-
MUST be able to generate this message in any of the natural languages language-supported" attribute (see the "attributes-natural-language"
identified by the Printer object's "generated-natural-language- operation attribute specified in section 3.1.4.1). As described in
supported" attribute (see the "attributes-natural-language" operation section 3.1.4.1 for any returned 'text' attribute, if there is a choice
attribute specified in section 3.1.4.1). As described in section for generating this message, the Printer object uses the natural
3.1.4.1 for any returned 'text' attribute, if there is a choice for language indicated by the value of the "attributes-natural-language" in
generating this message, the Printer object uses the natural language the client request if supported, otherwise the Printer object uses the
indicated by the value of the "attributes-natural-language" in the
client request if supported, otherwise the Printer object uses the
value in the Printer object's own "natural-language-configured" value in the Printer object's own "natural-language-configured"
attribute. attribute. If the Printer object supports the "status-message"
operation attribute, it SHOULD use the REQUIRED 'utf-8' charset to
return a status message for the following error status codes (see
section 14): 'client-error-bad-request', 'client-error-charset-not-
supported', 'server-error-internal-error', 'server-error-operation-not-
supported', and 'server-error-version-not-supported'. In this case, it
MUST set the value of the "attributes-charset" operation attribute to
'utf-8' in the error response.
Isaacson, Powell Expires May 16, 1999
3.1.7 Versions 3.1.7 Versions
Each operation request and response carries with it a "version-number" Each operation request and response carries with it a "version-number"
parameter. Each value of the "version-number" is in the form "X.Y" parameter. Each value of the "version-number" is in the form "X.Y"
where X is the major version number and Y is the minor version number. where X is the major version number and Y is the minor version number.
By including a version number in the client request, it allows the By including a version number in the client request, it allows the
client to identify which version of IPP it is interested in using. client to identify which version of IPP it is interested in using. If
If the IPP object does not support that version, the object responds the IPP object does not support that version, the object responds with a
with a status code of 'server-error-version-not-supported' along with status code of 'server-error-version-not-supported' along with the
the closest version number that is supported (see section 14.1.5.4). closest version number that is supported (see section 14.1.5.4).
There is no version negotiation per se. However, if after receiving a There is no version negotiation per se. However, if after receiving a
'server-error-version-not-supported' status code from an IPP object, 'server-error-version-not-supported' status code from an IPP object,
there is nothing that prevents a client from trying again with a there is nothing that prevents a client from trying again with a
different version number. In order to conform to IPP/1.0, an different version number. In order to conform to IPP/1.0, an
implementation MUST support at least version '1.0'. implementation MUST support at least version '1.0'.
There is only one notion of "version number" that covers both IPP There is only one notion of "version number" that covers both IPP Model
Model and IPP Protocol changes. Thus the version number MUST change and IPP Protocol changes. Thus the version number MUST change when
when introducing a new version of the Model document or a new version introducing a new version of the Model and Semantics document [IPP-MOD]
of the Protocol document. or a new version of the Encoding and Transport document [IPP-PRO].
Changes to the major version number indicate structural or syntactic Changes to the major version number indicate structural or syntactic
changes that make it impossible for older version of IPP clients and changes that make it impossible for older version of IPP clients and
Printer objects to correctly parse and process the new or changed Printer objects to correctly parse and process the new or changed
attributes, operations and responses. If the major version number attributes, operations and responses. If the major version number
changes, the minor version numbers is set to zero. As an example, changes, the minor version numbers is set to zero. As an example,
adding the "ipp-attribute-fidelity" attribute (if it had not been part adding the "ipp-attribute-fidelity" attribute (if it had not been part
of version '1.0'), would have required a change to the major version of version '1.0'), would have required a change to the major version
number. Items that might affect the changing of the major version number. Items that might affect the changing of the major version
number include any changes to the Model and Semantics document [IPP-MOD]
Expires December 30, 1998 or the Encoding and Transport [IPP-PRO] itself, such as:
number include any changes to the protocol specification itself, such
as:
- reordering of ordered attributes or attribute sets - reordering of ordered attributes or attribute sets
- changes to the syntax of existing attributes - changes to the syntax of existing attributes
- changing Operation or Job Template attributes from OPTIONAL to - changing Operation or Job Template attributes from OPTIONAL to
REQUIRED and vice versa REQUIRED and vice versa
- adding REQUIRED (for an IPP object to support) operation - adding REQUIRED (for an IPP object to support) operation attributes
attributes - adding REQUIRED (for an IPP object to support) operation attribute
- adding REQUIRED (for an IPP object to support) operation groups
attribute groups
- adding values to existing operation attributes - adding values to existing operation attributes
- adding REQUIRED operations - adding REQUIRED operations
Changes to the minor version number indicate the addition of new Changes to the minor version number indicate the addition of new
features, attributes and attribute values that may not be understood features, attributes and attribute values that may not be understood by
by all IPP objects, but which can be ignored if not understood. Items all IPP objects, but which can be ignored if not understood. Items that
that might affect the changing of the minor version number include any might affect the changing of the minor version number include any
changes to the model objects and attributes but not the encoding and changes to the model objects and attributes but not the encoding and
transport rules [IPP-PRO] (except adding attribute syntaxes). transport rules [IPP-PRO] (except adding attribute syntaxes). Examples
Examples of such changes are: of such changes are:
- grouping all extensions not included in a previous version into a - grouping all extensions not included in a previous version into a
new version new version
- adding new attribute values - adding new attribute values
Isaacson, Powell Expires May 16, 1999
- adding new object attributes - adding new object attributes
- adding OPTIONAL (for an IPP object to support) operation - adding OPTIONAL (for an IPP object to support) operation attributes
attributes (i.e., those attributes that an IPP object can ignore (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) 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 new attribute syntaxes
- adding OPTIONAL operations - adding OPTIONAL operations
- changing Job Description attributes or Printer Description - changing Job Description attributes or Printer Description
attributes from OPTIONAL to REQUIRED or vice versa. attributes from OPTIONAL to REQUIRED or vice versa.
The encoding of the "operation-id", the "version-number", the "status- The encoding of the "operation-id", the "version-number", the "status-
code", and the "request-id" MUST NOT change over any version number code", and the "request-id" MUST NOT change over any version number
(either major or minor). This rule guarantees that all future (either major or minor). This rule guarantees that all future versions
versions will be backwards compatible with all previous versions (at will be backwards compatible with all previous versions (at least for
least for checking the "operation-id", the "version-number", and the checking the "operation-id", the "version-number", and the "request-
"request-id"). In addition, any protocol elements (attributes, error id"). In addition, any protocol elements (attributes, error codes,
codes, tags, etc.) that are not carried forward from one version to tags, etc.) that are not carried forward from one version to the next
the next are deprecated so that they can never be reused with new are deprecated so that they can never be reused with new semantics.
semantics.
Expires December 30, 1998
Implementations that support a certain major version NEED NOT support Implementations that support a certain major version NEED NOT support
ALL previous versions. As each new major version is defined (through ALL previous versions. As each new major version is defined (through
the release of a new specification), that major version will specify the release of a new specification), that major version will specify
which previous major versions MUST be supported in compliant which previous major versions MUST be supported in compliant
implementations. implementations.
3.1.8 Job Creation Operations 3.1.8 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 client
issues a create request. A create request is any one of following issues a create request. A create request is any one of following three
three operation requests: operation requests:
- The Print-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 only a single document uses the Print-Job operation. The with only a single document uses the Print-Job operation. The
operation allows for the client to "push" the document data to operation allows for the client to "push" the document data to the
the Printer object by including the document data in the request Printer object by including the document data in the request
itself. itself.
- The Print-URI Request: A client that wants to submit a print job - The Print-URI Request: A client that wants to submit a print job
with only a single document (where the Printer object "pulls" the with only a single document (where the Printer object "pulls" the
document data instead of the client "pushing" the data to the document data instead of the client "pushing" the data to the
Printer object) uses the Print-URI operation. In this case, the Printer object) uses the Print-URI operation. In this case, the
client includes in the request only a URI reference to the client includes in the request only a URI reference to the document
document data (not the document data itself). data (not the document data itself).
- The Create-Job Request: A client that wants to submit a print job - The Create-Job Request: A client that wants to submit a print job
with multiple documents uses the Create-Job operation. This with multiple documents uses the Create-Job operation. This
operation is followed by an arbitrary number of Send-Document operation is followed by an arbitrary number of Send-Document
and/or Send-URI operations (each creating another document for and/or Send-URI operations (each creating another document for the
the newly create Job object). The Send-Document operation newly create Job object). The Send-Document operation includes the
includes the document data in the request (the client "pushes" document data in the request (the client "pushes" the document data
the document data to the printer), and the Send-URI operation to the printer), and the Send-URI operation includes only a URI
includes only a URI reference to the document data in the request
(the Printer "pulls" the document data from the referenced Isaacson, Powell Expires May 16, 1999
location). The last Send-Document or Send-URI request for a reference to the document data in the request (the Printer "pulls"
given Job object includes a "last-document" operation attribute the document data from the referenced location). The last Send-
set to 'true' indicating that this is the last request. 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 specification, the term "create request" is used Throughout this model specification, the term "create request" is used
to refer to any of these three operation requests. to refer to any of these three operation requests.
A Create-Job operation followed by only one Send-Document operation is A Create-Job operation followed by only one Send-Document operation is
semantically equivalent to a Print-Job operation, however, for semantically equivalent to a Print-Job operation, however, for
performance reasons, the client SHOULD use the Print-Job operation for performance reasons, the client SHOULD use the Print-Job operation for
all single document jobs. Also, Print-Job is a REQUIRED operation all single document jobs. Also, Print-Job is a REQUIRED operation (all
(all implementations MUST support it) whereas Create-Job is an implementations MUST support it) whereas Create-Job is an OPTIONAL
OPTIONAL operation, hence some implementations might not support it. operation, hence some implementations might not support it.
Expires December 30, 1998
Job submission time is the point in time when a client issues a create Job submission time is the point in time when a client issues a create
request. The initial state of every Job object is the 'pending' or request. The initial state of every Job object is the 'pending' or
'pending-held' state. Later, the Printer object begins processing the 'pending-held' state. Later, the Printer object begins processing the
print job. At this point in time, the Job object's state moves to print job. At this point in time, the Job object's state moves to
'processing'. This is known as job processing time. There are 'processing'. This is known as job processing time. There are
validation checks that must be done at job submission time and others validation checks that must be done at job submission time and others
that must be performed at job processing time. that must be performed at job processing time.
At job submission time and at the time a Validate-Job operation is At job submission time and at the time a Validate-Job operation is
received, the Printer MUST do the following: received, the Printer MUST do the following:
1. Process the client supplied attributes and either accept or 1. Process the client supplied attributes and either accept or reject
reject the request the request
2. Validate the syntax of and support for the scheme of any client 2. Validate the syntax of and support for the scheme of any client
supplied URI supplied URI
Section 16 describes the rules and issues surrounding the processing At job submission time the Printer object MUST validate whether or not
of client supplied attributes. Section 16.3 presents suggested steps the supplied attributes, attribute syntaxes, and values are supported by
for an IPP object to either accept or reject any request. Section matching them with the Printer object's corresponding "xxx-supported"
16.4 presents suggested additional steps for processing create attributes. See section 3.2.1.2 for details. [IPP-IIG] presents
requests. 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 NEED NOT perform the validation At job submission time the Printer object NEED NOT perform the
checks reserved for job processing time such as: validation checks reserved for job processing time such as:
1. Validating the document data 1. Validating the document data
2. Validating the actual contents of any client supplied URI 2. Validating the actual contents of any client supplied URI (resolve
(resolve the reference and follow the link to the document data) the reference and follow the link to the document data)
At job submission time, these additional job processing time At job submission time, these additional job processing time validation
validation checks are essentially useless, since they require actually checks are essentially useless, since they require actually parsing and
parsing and interpreting the document data, are not guaranteed to be interpreting the document data, are not guaranteed to be 100% accurate,
100% accurate, and MUST be done, yet again, at job processing time. and MUST be done, yet again, at job processing time. Also, in the case
Also, in the case of a URI, checking for availability at job of a URI, checking for availability at job submission time does not
submission time does not guarantee availability at job processing guarantee availability at job processing time. In addition, at job
time. In addition, at job processing time, the Printer object might processing time, the Printer object might discover any of the following
discover any of the following conditions that were not detectable at conditions that were not detectable at job submission time:
job submission time:
Isaacson, Powell Expires May 16, 1999
- runtime errors in the document data, - runtime errors in the document data,
- nested document data that is in an unsupported format, - nested document data that is in an unsupported format,
- the URI reference is no longer valid (i.e., the server hosting - the URI reference is no longer valid (i.e., the server hosting the
the document might be down), or document might be down), or
- any other job processing error - any other job processing error
At job processing time, since the Printer object has already responded At job processing time, since the Printer object has already responded
with a successful status code in the response to the create request, with a successful status code in the response to the create request, if
if the Printer object detects an error, the Printer object is unable the Printer object detects an error, the Printer object is unable to
inform the end user of the error with an operation status code. In
Expires December 30, 1998 this case, the Printer, depending on the error, can set the "job-state",
"job-state-reasons", or "job-state-message" attributes to the
to inform the end user of the error with an operation status code.
In this case, the Printer, depending on the error, can set the "job-
state", "job-state-reasons", or "job-state-message" attributes to the
appropriate value(s) so that later queries can report the correct job appropriate value(s) so that later queries can report the correct job
status. status.
Note: Asynchronous notification of events is outside the scope of Note: Asynchronous notification of events is outside the scope of
IPP/1.0. IPP/1.0.
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 MUST
always supply the "printer-uri" operation attribute in order to always supply the "printer-uri" operation attribute in order to identify
identify the correct target of the operation. 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 This REQUIRED operation allows a client to submit a print job with only
only one document and supply the document data (rather than just a one document and supply the document data (rather than just a reference
reference to the data). See Section 16 for the suggested steps for to the data). See Section 16 for the suggested steps for processing
processing create operations and their Operation and Job Template create operations and their Operation and Job Template attributes.
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- The following groups of attributes are supplied as part of the Print-Job
Job 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. The Printer object attributes as described in section 3.1.4.1. The Printer object
MUST copy these values to the corresponding Job Description MUST copy these values to the corresponding Job Description
attributes described in sections 4.3.23 and 4.3.24. attributes described in sections 4.3.23 and 4.3.24.
Target: Target:
The "printer-uri" (uri) operation attribute which is the target The "printer-uri" (uri) operation attribute which is the target for
for this operation as described in section 3.1.5. this operation as described in section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" (name(MAX)) attribute SHOULD be The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied
supplied by the client as described in section 8.3. by the client as described in section 8.3.
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
"job-name" (name(MAX)): "job-name" (name(MAX)):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. It contains the client MUST support this attribute. It contains the client supplied Job
supplied Job name. If this attribute is supplied by the client, name. If this attribute is supplied by the client, its value is
its value is used for the "job-name" attribute of the newly used for the "job-name" attribute of the newly created Job object.
created Job object. The client MAY automatically include any The client MAY automatically include any information that will help
information that will help the end-user distinguish amongst the end-user distinguish amongst his/her jobs, such as the name of
his/her jobs, such as the name of the application program along the application program along with information from the document,
with information from the document, such as the document name, such as the document name, document subject, or source file name.
document subject, or source file name. If this attribute is not If this attribute is not supplied by the client, the Printer
supplied by the client, the Printer generates a name to use in generates a name to use in the "job-name" attribute of the newly
the "job-name" attribute of the newly created Job object (see created Job object (see Section 4.3.5).
Section 4.3.5).
"ipp-attribute-fidelity" (boolean): "ipp-attribute-fidelity" (boolean):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. The value 'true' indicates MUST support this attribute. The value 'true' indicates that total
that total fidelity to client supplied Job Template attributes fidelity to client supplied Job Template attributes and values is
and values is required, else the Printer object MUST reject the required, else the Printer object MUST reject the Print-Job
Print-Job request. The value 'false' indicates that a reasonable request. The value 'false' indicates that a reasonable attempt to
attempt to print the Job object is acceptable and the Printer print the Job object is acceptable and the Printer object MUST
object MUST accept the Print-job request. If not supplied, the accept the Print-job request. If not supplied, the Printer object
Printer object assumes the value is 'false'. All Printer objects assumes the value is 'false'. All Printer objects MUST support
MUST support both types of job processing. See section 16 for a both types of job processing. See section 16 for a full
full description of "ipp-attribute-fidelity" and its relationship description of "ipp-attribute-fidelity" and its relationship to
to other attributes, especially the Printer object's "pdl- other attributes, especially the Printer object's "pdl-override-
override-supported" attribute. supported" attribute.
"document-name" (name(MAX)): "document-name" (name(MAX)):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. It contains the client MUST support this attribute. It contains the client supplied
supplied document name. The document name MAY be different than document name. The document name MAY be different than the Job
the Job name. Typically, the client software automatically name. Typically, the client software automatically supplies the
supplies the document name on behalf of the end user by using a document name on behalf of the end user by using a file name or an
file name or an application generated name. If this attribute is application generated name. If this attribute is supplied, its
supplied, its value can be used in a manner defined by each value can be used in a manner defined by each implementation.
implementation. Examples include: printed along with the Job Examples include: printed along with the Job (job start sheet, page
(job start sheet, page adornments, etc.), used by accounting or adornments, etc.), used by accounting or resource tracking
resource tracking management tools, or even stored along with the management tools, or even stored along with the document as a
document as a document level attribute. IPP/1.0 does not support document level attribute. IPP/1.0 does not support the concept of
the concept of document level attributes. document level attributes.
"document-format" (mimeMediaType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. The value of this attribute MUST support this attribute. The value of this attribute
identifies the format of the supplied document data. If the identifies the format of the supplied document data. If the client
client does not supply this attribute, the Printer object assumes does not supply this attribute, the Printer object assumes that the
that the document data is in the format defined by the Printer document data is in the format defined by the Printer object's
"document-format-default" attribute. If the client supplies this
Expires December 30, 1998 attribute, but the value is not supported by the Printer object,
object's "document-format-default" attribute. If the client i.e., the value is not one of the values of the Printer object's
supplies this attribute, but the value is not supported by the "document-format-supported" attribute, the Printer object MUST
Printer object, i.e., the value is not one of the values of the reject the request and return the 'client-error-document-format-
Printer object's "document-format-supported" attribute, the not-supported' status code.
Printer object MUST reject the request and return the 'client-
error-document-format-not-supported' status code.
Isaacson, Powell Expires May 16, 1999
"document-natural-language" (naturalLanguage): "document-natural-language" (naturalLanguage):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object OPTIONALLY supports this attribute. This attribute OPTIONALLY supports this attribute. This attribute specifies the
specifies the natural language of the document for those natural language of the document for those document-formats that
document-formats that require a specification of the natural require a specification of the natural language in order to image
language in order to image the document unambiguously. There are the document unambiguously. There are no particular values required
no particular values required for the Printer object to support. for the Printer object to support.
"compression" (type3 keyword) "compression" (type3 keyword)
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object OPTIONALLY supports this attribute and the "compression- OPTIONALLY supports this attribute and the "compression-supported"
supported" attribute (see section 4.4.29). The client supplied attribute (see section 4.4.29). The client supplied "compression"
"compression" operation attribute identifies the compression operation attribute identifies the compression algorithm used on
algorithm used on the document data. If the client omits this the document data. If the client omits this attribute, the Printer
attribute, the Printer object MUST assume that the data is not object MUST assume that the data is not compressed. If the client
compressed. If the client supplies the attribute and the Printer supplies the attribute and the Printer object supports the
object supports the attribute, the Printer object uses the attribute, the Printer object uses the corresponding decompression
corresponding decompression algorithm on the document data. If algorithm on the document data. If the client supplies this
the client supplies this attribute, but the value is not attribute, but the value is not supported by the Printer object,
supported by the Printer object, i.e., the value is not one of i.e., the value is not one of the values of the Printer object's
the values of the Printer object's "compression-supported" "compression-supported" attribute, the Printer object MUST copy the
attribute, the Printer object MUST copy the attribute and its attribute and its value to the Unsupported Attributes response
value to the Unsupported Attributes response group, reject the group, reject the request, and return the 'client-error-attributes-
request, and return the 'client-error-attributes-or-values-not- or-values-not-supported' status code.
supported' status code.
"job-k-octets" (integer(0:MAX)) "job-k-octets" (integer(0:MAX))
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object OPTIONALLY supports this attribute and the "job-k-octets- OPTIONALLY supports this attribute and the "job-k-octets-supported"
supported" attribute (see section 4.4.30). The client supplied attribute (see section 4.4.30). The client supplied "job-k-octets"
"job-k-octets" operation attribute identifies the total size of operation attribute identifies the total size of the document(s) in
the document(s) in K octets being submitted (see section 4.3.17 K octets being submitted (see section 4.3.17 for the complete
for the complete semantics). If the client supplies the semantics). If the client supplies the attribute and the Printer
attribute and the Printer object supports the attribute, the object supports the attribute, the value of the attribute is used
value of the attribute is used to populate the Job object's "job- to populate the Job object's "job-k-octets" Job Description
k-octets" Job Description attribute. attribute.
Note: For this attribute and the following two attributes ("job- Note: 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 the
attribute, but the Printer object does not support the attribute, attribute, but the Printer object does not support the attribute,
the Printer object ignores the client-supplied value. If the the Printer object ignores the client-supplied value. If the
Expires December 30, 1998
client supplies the attribute and the Printer supports the client supplies the attribute and the Printer supports the
attribute, and the value is within the range of the corresponding attribute, and the value is within the range of the corresponding
Printer object's "xxx-supported" attribute, the Printer object Printer object's "xxx-supported" attribute, the Printer object MUST
MUST use the value to populate the Job object's "xxx" attribute. use the value to populate the Job object's "xxx" attribute. If the
If the client supplies the attribute and the Printer supports the client supplies the attribute and the Printer supports the
attribute, but the value is outside the range of the attribute, but the value is outside the range of the corresponding
corresponding Printer object's "xxx-supported" attribute, the Printer object's "xxx-supported" attribute, the Printer object MUST
Printer object MUST copy the attribute and its value to the copy the attribute and its value to the Unsupported Attributes
Unsupported Attributes response group, reject the request, and response group, reject the request, and return the 'client-error-
return the 'client-error-attributes-or-values-not-supported' attributes-or-values-not-supported' status code. If the client
status code. If the client does not supply the attribute, the does not supply the attribute, the Printer object MAY choose to
Printer object MAY choose to populate the corresponding Job populate the corresponding Job object attribute depending on
object attribute depending on whether the Printer object supports whether the Printer object supports the attribute and is able to
the attribute and is able to calculate or discern the correct calculate or discern the correct value.
value.
Isaacson, Powell Expires May 16, 1999
"job-impressions" (integer(0:MAX)) "job-impressions" (integer(0:MAX))
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object OPTIONALLY supports this attribute and the "job- OPTIONALLY supports this attribute and the "job-impressions-
impressions-supported" attribute (see section 4.4.31). The supported" attribute (see section 4.4.31). The client supplied
client supplied "job-impressions" operation attribute identifies "job-impressions" operation attribute identifies the total size in
the total size in number of impressions of the document(s) being number of impressions of the document(s) being submitted (see
submitted (see section 4.3.18 for the complete semantics). section 4.3.18 for the complete semantics).
See note under "job-k-octets". See note under "job-k-octets".
"job-media-sheets" (integer(0:MAX)) "job-media-sheets" (integer(0:MAX))
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object OPTIONALLY supports this attribute and the "job-media- OPTIONALLY supports this attribute and the "job-media-sheets-
sheets-supported" attribute (see section 4.4.32). The client supported" attribute (see section 4.4.32). The client supplied
supplied "job-media-sheets" operation attribute identifies the "job-media-sheets" operation attribute identifies the total number
total number of media sheets to be produced for this job (see of media sheets to be produced for this job (see section 4.3.19 for
section 4.3.19 for the complete semantics). the complete semantics).
See note under "job-k-octets". See note under "job-k-octets".
Group 2: Job Template Attributes Group 2: Job Template Attributes
The client OPTIONALLY supplies a set of Job Template attributes The client OPTIONALLY supplies a set of Job Template attributes as
as defined in section 4.2. 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 Group 3: Document Content
The client MUST supply the document data to be processed. The client MUST supply the document data to be processed.
Note: In addition to the MANDTORY parameters required for every Note: In addition to the MANDATORY parameters required for every
operation request, the simplest Print-Job Request consists of just the operation request, the simplest Print-Job Request consists of just the
"attributes-charset" and "attributes-natural-language" operation "attributes-charset" and "attributes-natural-language" operation
Expires December 30, 1998
attributes; the "printer-uri" target operation attribute; the Document attributes; the "printer-uri" target operation attribute; the Document
Content and nothing else. In this simple case, the Printer object: Content and nothing else. In this simple case, the Printer object:
- creates a new Job object (the Job object contains a single - creates a new Job object (the Job object contains a single
document), document),
- stores a generated Job name in the "job-name" attribute in the - stores a generated Job name in the "job-name" attribute in the
natural language and charset requested (see Section 3.1.4.1) (if natural language and charset requested (see Section 3.1.4.1) (if
those are supported, otherwise using the Printer object's default those are supported, otherwise using the Printer object's default
natural language and charset), and natural language and charset), and
- at job processing time, uses its corresponding default value - at job processing time, uses its corresponding default value
attributes for the supported Job Template attributes that were attributes for the supported Job Template attributes that were not
not supplied by the client as IPP attribute or embedded supplied by the client as IPP attribute or embedded instructions in
instructions in the document data. the document data.
Isaacson, Powell Expires May 16, 1999
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 Group 1: Operation Attributes
Status Message: Status Message:
In addition to the REQUIRED status code returned in every In addition to the REQUIRED status code returned in every response,
response, the response OPTIONALLY includes a "status-message" the response OPTIONALLY includes a "status-message" (text)
(text) operation attribute as described in section 3.1.6. If the operation attribute as described in sections 14 and 3.1.6. If the
client supplies unsupported or conflicting Job Template client supplies unsupported or conflicting Job Template attributes
attributes or values, the Printer object MUST reject or accept or values, the Printer object MUST reject or accept the Print-Job
the Print-Job request depending on the whether the client request depending on the whether the client supplied a 'true' or
supplied a 'true' or 'false' value for the "ipp-attribute- 'false' value for the "ipp-attribute-fidelity" operation attribute.
fidelity" operation attribute. See section 16 for a complete See the Implementer's Guide [IPP-IIG] for a complete description of
description of the suggested steps for processing a create the suggested steps for processing a create request.
request.
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
This is a set of Operation and Job Template attributes supplied This is a set of Operation and Job Template attributes supplied by
by the client (in the request) that are not supported by the the client (in the request) that are not supported by the Printer
Printer object or that conflict with one another (see sections object or that conflict with one another (see the Implementer's
16.3 and 16.4). Guide [IPP-IIG]). If the Printer object is not returning any
Unsupported Attributes in the response, the Printer object SHOULD
omit Group 2 rather than 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:
Expires December 30, 1998 1. The Printer object does not support the supplied attribute (no
1. The Printer object does not support the named attribute (no matter what the attribute syntax or value).
matter what the value).
2. The Printer object does support the attribute, but does not 2. The Printer object does support the attribute, but does not
support some or all of the particular values supplied by the support some or all of the particular attribute syntaxes or
client (i.e., the Printer object does not have those values values supplied by the client (i.e., the Printer object does
in the corresponding supported values attribute). not have those attribute syntaxes or values in its
corresponding "xxx-supported" attribute).
3. The Printer object does support the attributes and values 3. The Printer object does support the attributes and values
supplied, but the particular values are in conflict with one supplied, but the particular values are in conflict with one
another, because they violate a constraint, such as not another, because they violate a constraint, such as not being
being able to staple transparencies. able to staple transparencies.
In the case of an unsupported attribute name, the Printer object In the case of an unsupported attribute name, the Printer object
returns the client-supplied attribute with a substituted "out-of- returns the client-supplied attribute with a substituted "out-of-
band" value of 'unsupported' indicating no support for the band" value of 'unsupported' indicating no support for the
attribute itself (see the beginning of section 4.1). 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
values, the Printer object simply returns the client-supplied attribute syntaxes or values, the Printer object simply returns the
attribute with the unsupported values as supplied by the client. client-supplied attribute with the unsupported attribute syntaxes
This indicates support for the attribute, but no support for that
particular value. If the client supplies a multi-valued attribute
with more than one value and the Printer object supports the
attribute but only supports a subset of the client supplied
values, the Printer object MUST return only those values that are
unsupported.
In the case of two (or more) supported attribute values that are Isaacson, Powell Expires May 16, 1999
in conflict with one another (although each is supported or values as supplied by the client. This indicates support for
the attribute, but no support for that particular attribute syntax
or value. If the client supplies a multi-valued attribute with
more than one value and the Printer object supports the attribute
but only supports a subset of the client-supplied attribute
syntaxes or values, the Printer object MUST return only those
attribute syntaxes or values that are unsupported.
In the case of two (or more) supported attribute values that are in
conflict with one another (although each is supported
independently, the values conflict when requested together within independently, the values conflict when requested together within
the same job), the Printer object MUST return all the values that the same job), the Printer object MUST return all the values that
it ignores or substitutes to resolve the conflict, but not any of it ignores or substitutes to resolve the conflict, but not any of
the values that it is still using. The choice for exactly how to the values that it is still using. The choice for exactly how to
resolve the conflict is implementation dependent. See Section resolve the conflict is implementation dependent. See The
16.4.4 for an example. Implementer's Guide [IPP-IIG] for an example.
In these three cases, the value of the "ipp-attribute-fidelity" In these three cases, the value of the "ipp-attribute-fidelity"
supplied by the client does not affect what the Printer object supplied by the client does not affect what the Printer object
returns. The value of "ipp-attribute-fidelity" only affects returns. The value of "ipp-attribute-fidelity" only affects
whether the Print-Job operation is accepted or rejected. If the whether the Print-Job operation is accepted or rejected. If the
job is accepted, the client may query the job using the Get-Job- job is accepted, the client may query the job using the Get-Job-
Attributes operation requesting the unsupported attributes that Attributes operation requesting the unsupported attributes that
were returned in the create response to see which attributes were were returned in the create response to see which attributes were
ignored (not stored on the Job object) and which attributes were ignored (not stored on the Job object) and which attributes were
stored with other (substituted) values. stored with other (substituted) values.
Group 3: Job Object Attributes Group 3: Job Object Attributes
Expires December 30, 1998
"job-uri" (uri): "job-uri" (uri):
The Printer object MUST return the Job object's URI by returning The Printer object MUST return the Job object's URI by returning
the contents of the REQUIRED "job-uri" Job object attribute. The the contents of the REQUIRED "job-uri" Job object attribute. The
client uses the Job object's URI when directing operations at the client uses the Job object's URI when directing operations at the
Job object. The Printer object always uses its configured Job object. The Printer object always uses its configured security
security policy when creating the new URI. However, if the policy when creating the new URI. However, if the Printer object
Printer object supports more than one URI, the Printer object supports more than one URI, the Printer object also uses
also uses information about which URI was used in the Print-Job information about which URI was used in the Print-Job Request to
Request to generated the new URI so that the new URI references generated the new URI so that the new URI references the correct
the correct access channel. In other words, if the Print-Job access channel. In other words, if the Print-Job Request comes in
Request comes in over a secure channel, the Printer object MUST over a secure channel, the Printer object MUST generate a Job URI
generate a Job URI that uses the secure channel as well. that uses the secure channel as well.
"job-id" (integer(1:MAX)): "job-id" (integer(1:MAX)):
The Printer object MUST return the Job object's Job ID by The Printer object MUST return the Job object's Job ID by returning
returning the REQUIRED "job-id" Job object attribute. The the REQUIRED "job-id" Job object attribute. The client uses this
client uses this "job-id" attribute in conjunction with the "job-id" attribute in conjunction with the "printer-uri" attribute
"printer-uri" attribute used in the Print-Job Request when used in the Print-Job Request when directing Job operations at the
directing Job operations at the Printer object. Printer object.
"job-state": "job-state":
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 state" attribute. The value of this attribute (along with the value
value of the next attribute "job-state-reasons") is taken from a of the next attribute "job-state-reasons") is taken from a
"snapshot" of the new Job object at some meaningful point in time "snapshot" of the new Job object at some meaningful point in time
Isaacson, Powell Expires May 16, 1999
(implementation defined) between when the Printer object receives (implementation defined) between when the Printer object receives
the Print-Job Request and when the Printer object returns the the Print-Job Request and when the Printer object returns the
response. response.
"job-state-reasons": "job-state-reasons":
The Printer object OPTIONALLY returns the Job object's OPTIONAL The Printer object OPTIONALLY returns the Job object's OPTIONAL
"job-state-reasons" attribute. If the Printer object supports "job-state-reasons" attribute. If the Printer object supports this
this attribute then it MUST be returned in the response. If this attribute then it MUST be returned in the response. If this
attribute is not returned in the response, the client can assume attribute is not returned in the response, the client can assume
that the "job-state-reasons" attribute is not supported and will that the "job-state-reasons" attribute is not supported and will
not be returned in a subsequent Job object query. not be returned in a subsequent Job object query.
"job-state-message": "job-state-message":
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 "job-state-message" attribute. If the Printer object supports this
this attribute then it MUST be returned in the response. If this attribute then it MUST be returned in the response. If this
attribute is not returned in the response, the client can assume attribute is not returned in the response, the client can assume
that the "job-state-message" attribute is not supported and will that the "job-state-message" attribute is not supported and will
not be returned in a subsequent Job object query. not be returned in a subsequent Job object query.
"number-of-intervening-jobs": "number-of-intervening-jobs":
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
Expires December 30, 1998
supports this attribute then it MUST be returned in the response. supports this attribute then it MUST be returned in the response.
If this attribute is not returned in the response, the client can If this attribute is not returned in the response, the client can
assume that the "number-of-intervening-jobs" attribute is not assume that the "number-of-intervening-jobs" attribute is not
supported and will not be returned in a subsequent Job object supported and will not be returned in a subsequent Job object
query. 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 attributes, it is sufficient to return only these attributes and no
no specific printer status attributes. specific printer status attributes.
Note: In addition to the MANDTORY 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-ok"
and there is no "status-message" operation attribute. and there is no "status-message" operation attribute.
3.2.2 Print-URI Operation 3.2.2 Print-URI Operation
This OPTIONAL operation is identical to the Print-Job operation This OPTIONAL operation is identical to the Print-Job operation (section
(section 3.2.1) except that a client supplies a URI reference to the 3.2.1) except that a client supplies a URI reference to the document
document data using the "document-uri" (uri) operation attribute (in data using the "document-uri" (uri) operation attribute (in Group 1)
Group 1) rather than including the document data itself. Before rather than including the document data itself. Before returning the
returning the response, the Printer MUST validate that the Printer response, the Printer MUST validate that the Printer supports the
supports the retrieval method (e.g., http, ftp, etc.) implied by the retrieval method (e.g., http, ftp, etc.) implied by the URI, and MUST
URI, and MUST check for valid URI syntax. If the client-supplied URI check for valid URI syntax. If the client-supplied URI scheme is not
scheme is not supported, i.e. the value is not in the Printer object's supported, i.e. the value is not in the Printer object's "referenced-
"referenced-uri-scheme-supported" attribute, the Printer object MUST uri-scheme-supported" attribute, the Printer object MUST reject the
reject the request and return the 'client-error-uri-scheme-not- request and return the 'client-error-uri-scheme-not-supported' status
supported' status code. See Section 16.3.5 for suggested additional
Isaacson, Powell Expires May 16, 1999
code. See The Implementer's Guide [IPP-IIG] for suggested additional
checks. The Printer NEED NOT follow the reference and validate the checks. The Printer NEED NOT follow the reference and validate the
contents of the reference. contents of the reference.
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.24). 4.4.24).
It is up to the IPP object to interpret the URI and subsequently It is up to the IPP object to interpret the URI and subsequently "pull"
"pull" the document from the source referenced by the URI string. 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 (section
3.2.1) except that a client supplies no document data and the Printer 3.2.1) except that a client supplies no document data and the Printer
allocates no resources (i.e., it does not create a new Job object). allocates no resources (i.e., it does not create a new Job object).
Expires December 30, 1998
This operation is used only to verify capabilities of a printer object This operation is used only to verify capabilities of a printer object
against whatever attributes are supplied by the client in the against whatever attributes are supplied by the client in the Validate-
Validate-Job request. By using the Validate-Job operation a client Job request. By using the Validate-Job operation a client can validate
can validate that an identical Print-Job operation (with the document that an identical Print-Job operation (with the document data) would be
data) would be accepted. The Validate-Job operation also performs the accepted. The Validate-Job operation also performs the same security
same security negotiation as the Print-Job operation (see section 8), negotiation as the Print-Job operation (see section 8), so that a client
so that a client can check that the client and Printer object security can check that the client and Printer object security requirements can
requirements can be met before performing a Print-Job operation. be met before performing a Print-Job operation.
Note: The Validate-Job operation does not accept a "document-uri" Note: The Validate-Job operation does not accept a "document-uri"
attribute in order to allow a client to check that the same Print-URI attribute in order to allow a client to check that the same Print-URI
operation will be accepted, since the client doesn't send the data operation will be accepted, since the client doesn't send the data with
with the Print-URI operation. The client SHOULD just issue the Print- the Print-URI operation. The client SHOULD just issue the Print-URI
URI request. request.
The Printer object returns the same status codes, Operation Attributes The Printer object returns the same status codes, Operation Attributes
(Group 1) and Unsupported Attributes (Group 2) as the Print-Job (Group 1) and Unsupported Attributes (Group 2) as the Print-Job
operation. However, no Job Object Attributes (Group 3) are returned, operation. However, no Job Object Attributes (Group 3) are returned,
since no Job object is created. since no Job object is created.
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 (section
3.2.1) except that in the Create-Job request, a client does not supply 3.2.1) except that in the Create-Job request, a client does not supply
document data or any reference to document data. Also, the client document data or any reference to document data. Also, the client does
does not supply any of the "document-name", "document-format", not supply any of the "document-name", "document-format", "compression",
"compression", or "document-natural-language" operation attributes. or "document-natural-language" operation attributes. This operation is
This operation is followed by one or more Send-Document or Send-URI followed by one or more Send-Document or Send-URI operations. In each
operations. In each of those operation requests, the client of those operation requests, the client OPTIONALLY supplies the
OPTIONALLY supplies the "document-name", "document-format", and "document-name", "document-format", and "document-natural-language"
"document-natural-language" attributes for each document in the multi- attributes for each document in the multi-document Job object.
document Job object. If a Printer object supports the Create-Job
operation, it MUST also support the Send-Document operation and also If a Printer object supports the Create-Job operation, it MUST also
MAY support the Send-URI operation. support the Send-Document operation and also MAY support the Send-URI
operation.
Isaacson, Powell Expires May 16, 1999
If the Printer object supports this operation, it MUST support the
"multiple-operation-time-out" Printer attribute (see section 4.4.28).
In addition to the Print-Job status codes in the following additional
error status codes not applicable to Print-Job MAY be returned:
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 the set of Printer attribute names and/or attribute group names in which
which the requester is interested. In the response, the Printer the requester is interested. In the response, the Printer object
object returns a corresponding attribute set with the appropriate returns a corresponding attribute set with the appropriate attribute
attribute values filled in. values filled in.
For Printer objects, the possible names of attribute groups are: For Printer objects, the possible names of attribute groups are:
Expires December 30, 1998 - 'job-template': all of the Job Template attributes that apply to a
- 'job-template': all of the Job Template attributes that apply to Printer object (the last two columns of the table in Section 4.2).
a Printer object (the last two columns of the table in Section
4.2).
- 'printer-description': the attributes specified in Section 4.4. - 'printer-description': the attributes specified in Section 4.4.
- 'all': the special group 'all' that includes all supported - 'all': the special group 'all' that includes all supported
attributes. attributes.
Since a client MAY request specific attributes or named groups, there Since a client MAY request specific attributes or named groups, there is
is a potential that there is some overlap. For example, if a client a potential that there is some overlap. For example, if a client
requests, 'printer-name' and 'all', the client is actually requesting requests, 'printer-name' and 'all', the client is actually requesting
the "printer-name" attribute twice: once by naming it explicitly, and the "printer-name" attribute twice: once by naming it explicitly, and
once by inclusion in the 'all' group. In such cases, the Printer once by inclusion in the 'all' group. In such cases, the Printer object
object NEED NOT return each attribute only once in the response even NEED NOT return each attribute only once in the response even if it is
if it is requested multiple times. The client SHOULD NOT request the requested multiple times. The client SHOULD NOT request the same
same attribute in multiple ways. attribute in multiple ways.
It is NOT REQUIRED that a Printer object support all attributes It is NOT REQUIRED that a Printer object support all attributes
belonging to a group (since some attributes are OPTIONAL). However, belonging to a group (since some attributes are OPTIONAL). However, it
it is REQUIRED that each Printer object support all group names. is REQUIRED that each Printer object support all group names.
3.2.5.1 Get-Printer-Attributes Request 3.2.5.1 Get-Printer-Attributes Request
The following sets of attributes are part of the Get-Printer- The following sets of attributes are part of the Get-Printer-Attributes
Attributes 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 The "printer-uri" (uri) operation attribute which is the target for
for this operation as described in section 3.1.5. this operation as described in section 3.1.5.
Isaacson, Powell Expires May 16, 1999
Requesting User Name: Requesting User Name:
The "requesting-user-name" (name(MAX)) attribute SHOULD be The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied
supplied by the client as described in section 8.3. by the client as described in section 8.3.
"requested-attributes" (1setOf keyword) : "requested-attributes" (1setOf keyword) :
The client OPTIONALLY supplies a set of attribute names and/or The client OPTIONALLY supplies a set of attribute names and/or
attribute group names in whose values the requester is attribute group names in whose values the requester is interested.
interested. The Printer object MUST support this attribute. If The Printer object MUST support this attribute. If the client
the client omits this attribute, the Printer MUST respond as if omits this attribute, the Printer MUST respond as if this attribute
this attribute had been supplied with a value of 'all'. had been supplied with a value of 'all'.
Expires December 30, 1998
"document-format" (mimeMediaType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. This attribute is useful for MUST support this attribute. This attribute is useful for a
a Printer object to determine the set of supported attribute Printer object to determine the set of supported attribute values
values that relate to the requested document format. The Printer that relate to the requested document format. The Printer object
object MUST return the attributes and values that it uses to MUST return the attributes and values that it uses to validate a
validate a job on a create or Validate-Job operation in which job on a create or Validate-Job operation in which this document
this document format is supplied. The Printer object SHOULD format is supplied. The Printer object SHOULD return only (1) those
return only (1) those attributes that are supported for the attributes that are supported for the specified format and (2) the
specified format and (2) the attribute values that are supported attribute values that are supported for the specified document
for the specified document format. By specifying the document format. By specifying the document format, the client can get the
format, the client can get the Printer object to eliminate the Printer object to eliminate the attributes and values that are not
attributes and values that are not supported for a specific supported for a specific document format. For example, a Printer
document format. For example, a Printer object might have object might have multiple interpreters to support both
multiple interpreters to support both 'application/postscript' 'application/postscript' (for PostScript) and 'text/plain' (for
(for PostScript) and 'text/plain' (for text) documents. However, text) documents. However, for only one of those interpreters might
for only one of those interpreters might the Printer object be the Printer object be able to support "number-up" with values of
able to support "number-up" with values of '1', '2', and '4'. '1', '2', and '4'. For the other interpreter it might be able to
For the other interpreter it might be able to only support only support "number-up" with a value of '1'. Thus a client can use
"number-up" with a value of '1'. Thus a client can use the Get- the Get-Printer-Attributes operation to obtain the attributes and
Printer-Attributes operation to obtain the attributes and values values that will be used to accept/reject a create job operation.
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 sets
of supported values for each different document format when of supported values for each different document format when
validating jobs in the create and Validate-Job operations, it validating jobs in the create and Validate-Job operations, it MUST
MUST NOT distinguish between different document formats in the NOT distinguish between different document formats in the Get-
Get-Printer-Attributes operation. If the Printer object does Printer-Attributes operation. If the Printer object does
distinguish between different sets of supported values for each distinguish between different sets of supported values for each
different document format specified by the client, this 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"
Isaacson, Powell Expires May 16, 1999
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
attribute as registered according to section 6.2).
Expires December 30, 1998 If the client omits this "document-format" operation attribute, the
client supplied document format (except for new Printer Printer object MUST respond as if the attribute had been supplied
description attribute as registered according to section 6.2). with the value of the Printer object's "document-format-default"
attribute. It is recommended that the client always supply a value
If the client omits this "document-format" operation attribute, for "document-format", since the Printer object's "document-format-
the Printer object MUST respond as if the attribute had been default" may be 'application/octet-stream', in which case the
supplied with the value of the Printer object's "document-format- returned attributes and values are for the union of the document
default" attribute. It is recommended that the client always formats that the Printer can automatically sense. For more
supply a value for "document-format", since the Printer object's details, see the description of the 'mimeMediaType' attribute
"document-format-default" may be 'application/octet-stream', in syntax in section 4.1.9.
which case the returned attributes and values are for the union
of the document formats that the Printer can automatically sense.
For more details, see the description of the 'mimeMediaType'
attribute syntax in section 4.1.9.
If the client supplies a value for the "document-format" If the client supplies a value for the "document-format" Operation
Operation attribute that is not supported by the Printer, i.e., attribute that is not supported by the Printer, i.e., is not among
is not among the values of the Printer object's "document-format- the values of the Printer object's "document-format-supported"
supported" attribute, the Printer object MUST reject the attribute, the Printer object MUST reject the operation and return
operation and return the 'client-error-document-format-not- the 'client-error-document-format-not-supported' status code.
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 of
the Get-Printer-Attributes Response: the Get-Printer-Attributes Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
In addition to the REQUIRED status code returned in every In addition to the REQUIRED status code returned in every response,
response, the response OPTIONALLY includes a "status-message" the response OPTIONALLY includes a "status-message" (text)
(text) operation attribute as described in section 3.1.5. operation attribute as described in section 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
This is a set of Operation attributes supplied by the client (in This is a set of Operation attributes supplied by the client (in
the request) that are not supported by the Printer object or that the request) that are not supported by the Printer object or that
conflict with one another (see sections 3.2.1.2 and 16). conflict with one another (see sections 3.2.1.2 and 16). 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 is not returning any Unsupported Attributes
in the response, the Printer object SHOULD omit Group 2 rather than
sending an empty group. However, a client MUST be able to accept
an empty group.
Group 3: Printer Object Attributes Group 3: Printer Object Attributes
Isaacson, Powell Expires May 16, 1999
This is the set of requested attributes and their current values. This is the set of requested attributes and their current values.
The Printer object ignores (does not respond with) any requested The Printer object ignores (does not respond with) any requested
Expires December 30, 1998
attribute which is not supported. The Printer object MAY respond attribute which is not supported. The Printer object MAY respond
with a subset of the supported attributes and values, depending with a subset of the supported attributes and values, depending on
on the security policy in force. However, the Printer object the security policy in force. However, the Printer object MUST
MUST respond with the 'unknown' value for any supported attribute respond with the 'unknown' value for any supported attribute
(including all REQUIRED attributes) for which the Printer object (including all REQUIRED attributes) for which the Printer object
does not know the value. Also the Printer object MUST respond does not know the value. Also the Printer object MUST respond with
with the 'no-value' for any supported attribute (including all the 'no-value' for any supported attribute (including all REQUIRED
REQUIRED attributes) for which the system administrator has not attributes) for which the system administrator has not configured a
configured a value. See the description of the "out-of-band" value. See the description of the "out-of-band" values in the
values in the beginning of Section 4.1. 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 group of Job object attributes will be returned for each Job object that
that is returned. 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 that this Get-Jobs operation returns attributes from possibly more than
than one object (see the description of Job attribute group names in one object (see the description of Job attribute group names in section
section 3.3.4). 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: The following groups of attributes are part of the Get-Jobs 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 The "printer-uri" (uri) operation attribute which is the target for
for this operation as described in section 3.1.5. this operation as described in section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" (name(MAX)) attribute SHOULD be The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied
supplied by the client as described in section 8.3. by the client as described in section 8.3.
Expires December 30, 1998
"limit" (integer(1:MAX)): "limit" (integer(1:MAX)):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. It is an integer value that MUST support this attribute. It is an integer value that indicates
indicates a limit to the number of Job objects returned. The a limit to the number of Job objects returned. The limit is a
limit is a "stateless limit" in that if the value supplied by the "stateless limit" in that if the value supplied by the client is
client is 'N', then only the first 'N' jobs are returned in the 'N', then only the first 'N' jobs are returned in the Get-Jobs
Get-Jobs Response. There is no mechanism to allow for the next Response. There is no mechanism to allow for the next 'M' jobs
'M' jobs after the first 'N' jobs. If the client does not supply
this attribute, the Printer object responds with all applicable Isaacson, Powell Expires May 16, 1999
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): "requested-attributes" (1setOf keyword):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. It is a set of Job attribute MUST support this attribute. It is a set of Job attribute names
names and/or attribute groups names in whose values the requester and/or attribute groups names in whose values the requester is
is interested. This set of attributes is returned for each Job interested. This set of attributes is returned for each Job object
object that is returned. The allowed attribute group names are that is returned. The allowed attribute group names are the same
the same as those defined in the Get-Job-Attributes operation in as those defined in the Get-Job-Attributes operation in section
section 3.3.4. If the client does not supply this attribute, the 3.3.4. If the client does not supply this attribute, the Printer
Printer MUST respond as if the client had supplied this attribute MUST respond as if the client had supplied this attribute with two
with two values: 'job-uri' and 'job-id'. values: 'job-uri' and 'job-id'.
"which-jobs" (keyword): "which-jobs" (keyword):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. It indicates which Job MUST support this attribute. It indicates which Job objects MUST
objects MUST be returned by the Printer object. The values for be returned by the Printer object. The values for this attribute
this attribute are: 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', 'canceled',
and 'aborted' states, then it returns no jobs when the and 'aborted' states, then it returns no jobs when the 'completed'
'completed' value is supplied. value is supplied.
If a client supplies some other value, the Printer object MUST If a client supplies some other value, the Printer object MUST copy
copy the attribute and the unsupported value to the Unsupported 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 object
MUST respond as if the client had supplied the attribute with a MUST respond as if the client had supplied the attribute with a
value of 'not-completed'. value of 'not-completed'.
Expires December 30, 1998
"my-jobs" (boolean): "my-jobs" (boolean):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. It indicates whether all MUST support this attribute. It indicates whether all jobs or just
jobs or just the jobs submitted by the requesting user of this the jobs submitted by the requesting user of this request MUST be
request MUST be returned by the Printer object. If the client returned by the Printer object. If the client does not supply this
does not supply this attribute, the Printer object MUST respond attribute, the Printer object MUST respond as if the client had
as if the client had supplied the attribute with a value of supplied the attribute with a value of 'false', i.e., all jobs.
'false', i.e., all jobs. The means for authenticating the The means for authenticating the requesting user and matching the
requesting user and matching the jobs is described in section 8. 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 that match the The Printer object returns all of the Job objects that match the
criteria as defined by the attribute values supplied by the client in criteria as defined by the attribute values supplied by the client in
Isaacson, Powell Expires May 16, 1999
the request. It is possible that no Job objects are returned since the request. It is possible that no Job objects are returned since
there may literally be no Job objects at the Printer, or there may be there may literally be no Job objects at the Printer, or there may be no
no Job objects that match the criteria supplied by the client. If the Job objects that match the criteria supplied by the client. If the
client requests any Job attributes at all, there is a set of Job client requests any Job attributes at all, there is a set of Job Object
Object Attributes returned for each Job object. Attributes returned for each Job object.
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
In addition to the REQUIRED status code returned in every In addition to the REQUIRED status code returned in every response,
response, the response OPTIONALLY includes a "status-message" the response OPTIONALLY includes a "status-message" (text)
(text) operation attribute as described in section 3.1.5. operation attribute as described in sections 14 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
This is a set of Operation attributes supplied by the client (in This is a set of Operation attributes supplied by the client (in
the request) that are not supported by the Printer object or that the request) that are not supported by the Printer object or that
conflict with one another (see sections 3.2.1.2 and 16.3). conflict with one another (see sections 3.2.1.2 and the
Implementer's Guide [IPP-IIG]). 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 is not
returning any Unsupported Attributes in the response, the Printer
object SHOULD omit Group 2 rather than sending an empty group.
However, a client MUST be able to accept an empty group.
Groups 3 to N: Job Object Attributes Groups 3 to N: Job Object Attributes
The Printer object responds with one set of Job Object Attributes The Printer object responds with one set of Job Object Attributes
for each returned Job object. The Printer object ignores (does for each returned Job object. The Printer object ignores (does not
not respond with) any requested attribute or value which is not respond with) any requested attribute or value which is not
supported or which is restricted by the security policy in force, supported or which is restricted by the security policy in force,
including whether the requesting user is the user that submitted including whether the requesting user is the user that submitted
the job (job originating user) or not (see section 8). However, the job (job originating user) or not (see section 8). However,
the Printer object MUST respond with the 'unknown' value for any the Printer object MUST respond with the 'unknown' value for any
supported attribute (including all REQUIRED attributes) for which supported attribute (including all REQUIRED attributes) for which
the Printer object does not know the value, unless it would the Printer object does not know the value, unless it would violate
the security policy. See the description of the "out-of-band"
Expires December 30, 1998 values in the beginning of Section 4.1.
violate the security policy. See the description of the "out-of-
band" values in the beginning of Section 4.1.
For any job submitted in a different natural language than the
natural language that the Printer object is returning in the
"attributes-natural-language" operation attribute in the Get-Jobs
response, the Printer MUST indicate the submitted natural
language by returning the Job object's "attributes-natural-
language" as the first Job object attribute, which overrides the
"attributes-natural-language" operation attribute value being
returned by the Printer object. If any returned 'text' or 'name'
attribute includes a Natural Language Override as described in
the sections 4.1.1.2 and 4.1.2.2, the Natural Language Override
overrides the Job object's "attributes-natural-language" value
and/or the "attributes-natural-language" operation attribute
value.
Jobs are returned in the following order: Jobs are returned in the following order:
- If the client requests all 'completed' Jobs (Jobs in the - If the client requests all 'completed' Jobs (Jobs in the
'completed', 'aborted', or 'canceled' states), then the Jobs 'completed', 'aborted', or 'canceled' states), then the Jobs
are returned newest to oldest (with respect to actual are returned newest to oldest (with respect to actual
completion time) completion time)
- If the client requests all 'not-completed' Jobs (Jobs in the - If the client requests all 'not-completed' Jobs (Jobs in the
'pending', 'processing', 'pending-held', and 'processing- 'pending', 'processing', 'pending-held', and 'processing-
stopped' states), then Jobs are returned in relative stopped' states), then Jobs are returned in relative
chronological order of expected time to complete (based on chronological order of expected time to complete (based on
Isaacson, Powell Expires May 16, 1999
whatever scheduling algorithm is configured for the Printer whatever scheduling algorithm is configured for the Printer
object). object).
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 supply some means of identifying the Job object in order to identify the
the correct target of the operation. That job identification MAY correct target of the operation. That job identification MAY either be
either be a single Job URI or a combination of a Printer URI with a a single Job URI or a combination of a Printer URI with a Job ID. The
Job ID. The IPP object implementation MUST support both forms of IPP object implementation MUST support both forms of identification for
identification for every job. 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 Job
object that is initially "empty" (contains no documents). In the 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 to
Expires December 30, 1998
add, the client uses a Send-Document operation. Each Send-Document add, the client uses a Send-Document operation. Each Send-Document
Request contains the entire stream of document data for one document. Request contains the entire stream of document data for one document.
Since the Create-Job and the send operations (Send-Document or Send- Since the Create-Job and the send operations (Send-Document or Send-URI
URI operations) that follow can occur over arbitrarily long periods of operations) that follow could occur over an arbitrarily long period of
time, each Printer object must decide how long to "wait" for the next time for a particular job, a client MUST send another send operation
send operation. The Printer object OPTIONALLY supports the "multiple- within an IPP Printer defined minimum time interval after the receipt of
operation-timeout" attribute. This attribute indicates the maximum the previous request for the job. If a Printer object supports multiple
number of seconds the Printer object will wait for the next send document jobs, the Printer object MUST support the "multiple-operation-
operation. If the Printer object times-out waiting for the next send time-out" attribute (see section 4.4.28). This attribute indicates the
operation, the Printer object MAY decide on any of the following minimum number of seconds the Printer object will wait for the next send
semantic actions: operation before taking some recovery action.
An IPP object MUST recover from an errant client that does not supply a
send operation, sometime after the minimum time interval specified by
the Printer object's "multiple-operation-time-out" attribute. 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', and clean up all resources changing the job state to 'aborted', add the 'aborted-by-system'
associated with the Job. In this case, if another send operation value to the job's "job-state-reasons" attribute (see section
is finally received, the Printer responds with an "client-error- 4.3.8), if supported, and clean up all resources associated with
not-possible" or "client-error-not-found" depending on whether or the Job. In this case, if another send operation is finally
not the Job object is still around when it finally arrives. received, the Printer responds with an "client-error-not-possible"
2. Assume that the last send operation received was in fact the or "client-error-not-found" depending on whether or not the Job
last document (as if the "last-document" flag had been set to object is still around when the send operation finally arrives.
'true'), close the Job object, and proceed to process it (i.e., 2. Assume that the last send operation received was in fact the last
move the Job's state to 'pending'). document (as if the "last-document" flag had been set to 'true'),
3. 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, close the Job, but move it to the 'pending-held' Job's state to 'pending').
to allow an operator to determine whether or not to continue 3. Assume that the last send operation received was in fact the last
processing the Job by moving it back to the 'pending' state. document, close the Job, but move it to the 'pending-held' and add
the 'submission-interrupted' value to the job's "job-state-reasons"
Isaacson, Powell Expires May 16, 1999
attribute (see section 4.3.8), if supported. This action allows
the user or an operator to determine whether to continue processing
the Job by moving it back to the 'pending' state or to cancel the
job.
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, the value of "ipp-attribute-fidelity", depending on local policy, whether any documents have been added,
and/or any other piece of information available to it. If the choice whether the implementation spools jobs or not, and/or any other piece
is to abort the Job object, it is possible that the Job object may of information available to it. If the choice is to abort the Job
already have been processed to the point that some media sheet pages object, it is possible that the Job object may already have been
have been printed. processed to the point that some media sheet pages have been printed.
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 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.
Expires December 30, 1998
Target: Target:
Either (1) the "printer-uri" (uri) plus "job-id" Either (1) the "printer-uri" (uri) plus "job-id" (integer(1:MAX))or
(integer(1:MAX))or (2) the "job-uri" (uri) operation attribute(s) (2) the "job-uri" (uri) operation attribute(s) which define the
which define the target for this operation as described in target for this operation as described in section 3.1.5.
section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" (name(MAX)) attribute SHOULD be The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied
supplied by the client as described in section 8.3. by the client as described in section 8.3.
"document-name" (name(MAX)): "document-name" (name(MAX)):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. It contains the client MUST support this attribute. It contains the client supplied
supplied document name. The document name MAY be different than document name. The document name MAY be different than the Job
the Job name. It might be helpful, but NEED NOT be unique across name. It might be helpful, but NEED NOT be unique across multiple
multiple documents in the same Job. Typically, the client documents in the same Job. Typically, the client software
software automatically supplies the document name on behalf of automatically supplies the document name on behalf of the end user
the end user by using a file name or an application generated by using a file name or an application generated name. See the
name. See the description of the "document-name" operation description of the "document-name" operation attribute in the
attribute in the Print-Job Request (section 3.2.1.1) for more Print-Job Request (section 3.2.1.1) for more information about this
information about this attribute. attribute.
"document-format" (mimeMediaType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object MUST support this attribute. The value of this attribute MUST support this attribute. The value of this attribute
identifies the format of the supplied document data. If the identifies the format of the supplied document data. If the client
client does not supply this attribute, the Printer object assumes does not supply this attribute, the Printer object assumes that the
that the document data is in the format defined by the Printer document data is in the format defined by the Printer object's
object's "document-format-default" attribute. If the client "document-format-default" attribute. If the client supplies this
supplies this attribute, but the value is not supported by the attribute, but the value is not supported by the Printer object,
Printer object, i.e., the value is not one of the values of the i.e., the value is not one of the values of the Printer object's
Printer object's "document-format-supported" attribute, the "document-format-supported" attribute, the Printer object MUST
Printer object MUST reject the request and return the 'client-
error-document-format-not-supported' status code. Isaacson, Powell Expires May 16, 1999
reject the request and return the 'client-error-document-format-
not-supported' status code.
"document-natural-language" (naturalLanguage): "document-natural-language" (naturalLanguage):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object OPTIONALLY supports this attribute. This attribute OPTIONALLY supports this attribute. This attribute specifies the
specifies the natural language of the document for those natural language of the document for those document-formats that
document-formats that require a specification of the natural require a specification of the natural language in order to image
language in order to image the document unambiguously. There are the document unambiguously. There are no particular values
no particular values required for the Printer object to support. required for the Printer object to support.
"compression" (type3 keyword) "compression" (type3 keyword)
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object OPTIONALLY supports this attribute and the "compression- OPTIONALLY supports this attribute and the "compression-supported"
supported" attribute (see section 4.4.29). The client supplied attribute (see section 4.4.29). The client supplied "compression"
"compression" operation attribute identifies the compression operation attribute identifies the compression algorithm used on
the document data. If the client omits this attribute, the Printer
Expires December 30, 1998 object MUST assume that the data is not compressed. If the client
algorithm used on the document data. If the client omits this supplies the attribute and the Printer object supports the
attribute, the Printer object MUST assume that the data is not attribute, the Printer object MUST use the corresponding
compressed. If the client supplies the attribute and the Printer decompression algorithm on the document data. If the client
object supports the attribute, the Printer object MUST use the supplies this attribute, but the value is not supported by the
corresponding decompression algorithm on the document data. If Printer object, i.e., the value is not one of the values of the
the client supplies this attribute, but the value is not Printer object's "compression-supported" attribute, the Printer
supported by the Printer object, i.e., the value is not one of object MUST copy the attribute and its value to the Unsupported
the values of the Printer object's "compression-supported" Attributes response group, reject the request, and return the
attribute, the Printer object MUST copy the attribute and its 'client-error-attributes-or-values-not-supported' status code.
value to the Unsupported Attributes response group, reject the
request, and return the 'client-error-attributes-or-values-not-
supported' status code.
"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 support this attribute. It is a boolean flag that is set to 'true'
'true' if this is the last document for the Job, 'false' if this is the last document for the Job, 'false' otherwise.
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- that the previous document sent with a Send-Document (or Send-URI)
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- attribute was set to 'false'), it is legal to send a Send-Document
Document request with no document data where the "last-document" request with no document data where the "last-document" flag is set
flag is set to 'true'. Such a request MUST NOT increment the to 'true'. Such a request MUST NOT increment the value of the Job
value of the Job object's "number-of-documents" attribute, since object's "number-of-documents" attribute, since no real document
no real document was added to the job. was added to the job.
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 The following sets of attributes are part of the Send-Document Response:
Response:
Isaacson, Powell Expires May 16, 1999
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
In addition to the REQUIRED status code returned in every In addition to the REQUIRED status code returned in every response,
response, the response OPTIONALLY includes a "status-message" the response OPTIONALLY includes a "status-message" (text)
(text) operation attribute as described in section 3.1.5. operation attribute as described in sections 14 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
Expires December 30, 1998
This is a set of Operation attributes supplied by the client (in This is a set of Operation attributes supplied by the client (in
the request) that are not supported by the Printer object or that the request) that are not supported by the Printer object or that
conflict with one another (see sections 3.2.1.2 and 16.3). conflict with one another (see sections 3.2.1.2 and the
Implementer's Guide [IPP-IIG]). If the Printer object is not
returning any Unsupported Attributes in the response, the Printer
object SHOULD omit Group 2 rather than sending an empty group.
However, a client MUST be able to accept an empty group.
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 This OPTIONAL operation is identical to the Send-Document operation (see
(see section 3.3.1) except that a client MUST supply a URI reference 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 document, the client MUST use the Send-Document operation with no
document data and the "last-document" flag set to 'true' (rather than document data and the "last-document" flag set to 'true' (rather than
using a Send-URI operation with no "document-uri" operation using a Send-URI operation with no "document-uri" operation attribute).
attribute). If a Printer object supports this operation, it MUST also
support the Print-URI operation (see section 3.2.2). If a Printer object supports this operation, it MUST also support the
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. operation.
3.3.3 Cancel-Job Operation 3.3.3 Cancel-Job Operation
This REQUIRED operation allows a client to cancel a Print Job any time This REQUIRED operation allows a client to cancel a Print Job from the
after a create job operation. Since a Job might already be printing time the job is created up to the time it is completed, canceled, or
by the time a Cancel-Job is received, some media sheet pages might be aborted. Since a Job might already be printing by the time a Cancel-Job
printed before the job is actually terminated. is received, some media sheet pages might be printed before the job is
actually terminated.
Isaacson, Powell Expires May 16, 1999
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.
Expires December 30, 1998
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 attribute(s)
which define the target for this operation as described in which define the target for this operation as described in section
section 3.1.5. 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" (name(MAX)) attribute SHOULD be The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied
supplied by the client as described in section 8.3. by the client as described in section 8.3.
"message" (text(127)): "message" (text(127)):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer object
object OPTIONALLY supports this attribute. It is a message to the OPTIONALLY supports this attribute. It is a message to the
operator. This "message" attribute is not the same as the "job- operator. This "message" attribute is not the same as the "job-
message-from-operator" attribute. That attribute is used to message-from-operator" attribute. That attribute is used to report
report a message from the operator to the end user that queries a message from the operator to the end user that queries that
that attribute. This "message" operation attribute is used to attribute. This "message" operation attribute is used to send a
send a message from the client to the operator along with the message from the client to the operator along with the operation
operation request. It is an implementation decision of how or request. It is an implementation decision of how or where to
where to display this message to the operator (if at all). 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 Group 1: Operation Attributes
Status Message: Status Message:
In addition to the REQUIRED status code returned in every In addition to the REQUIRED status code returned in every response,
response, the response OPTIONALLY includes a "status-message" the response OPTIONALLY includes a "status-message" (text)
(text) operation attribute as described in section 3.1.5. operation attribute as described in sections 14 and 3.1.6.
If the job is already in the 'completed', 'aborted', or If the job is already in the 'completed', 'aborted', or 'canceled'
'canceled' state, or the 'process-to-stop-point' value is set in state, or the 'process-to-stop-point' value is set in the Job's
the Job's "job-state-reasons" attribute, the Printer object MUST "job-state-reasons" attribute, the Printer object MUST reject the
reject the request and return the 'client-error-not-possible' request and return the 'client-error-not-possible' error status
error status code. code.
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.
Isaacson, Powell Expires May 16, 1999
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
This is a set of Operation attributes supplied by the client (in This is a set of Operation attributes supplied by the client (in
the request) that are not supported by the Printer object or that the request) that are not supported by the Printer object or that
conflict with one another (see sections 3.2.1.2 and 16.3). conflict with one another (see section 3.2.1.2 and the
Implementer's Guide [IPP-IIG]). If the Printer object is not
Expires December 30, 1998 returning any Unsupported Attributes in the response, the Printer
object SHOULD omit Group 2 rather than sending an empty group.
However, a client MUST be able to accept an empty group.
Once a successful response has been sent, the implementation Once a successful response has been sent, the implementation guarantees
guarantees that the Job will eventually end up in the 'canceled' that the Job will eventually end up in the 'canceled' state. Between the
state. Between the time of the Cancel-Job operation is accepted and time of the Cancel-Job operation is accepted and when the job enters the
when the job enters the 'canceled' job-state (see section 4.3.7), the 'canceled' job-state (see section 4.3.7), the "job-state-reasons"
"job-state-reasons" attribute SHOULD contain the ' processing-to-stop- attribute SHOULD contain the ' processing-to-stop-point ' value which
point ' value which indicates to later queries that although the Job indicates to later queries that although the Job might still be
might still be 'processing', it will eventually end up in the 'processing', it will eventually end up in the 'canceled' state, not the
'canceled' state, not the 'completed' state. 'completed' state.
3.3.4 Get-Job-Attributes Operation 3.3.4 Get-Job-Attributes Operation
This REQUIRED operation allows a client to request the values of This REQUIRED operation allows a client to request the values of
attributes of a Job object and it is almost identical to the Get- attributes of a Job object and it is almost identical to the Get-
Printer-Attributes operation (see section 3.2.5). The only Printer-Attributes operation (see section 3.2.5). The only differences
differences are that the operation is directed at a Job object rather are that the operation is directed at a Job object rather than a Printer
than a Printer object, there is no "document-format" operation object, there is no "document-format" operation attribute used when
attribute used when querying a Job object, and the returned attribute querying a Job object, and the returned attribute group is a set of Job
group is a set of Job object attributes rather than a set of Printer object attributes rather than a set of Printer object attributes.
object attributes.
For Jobs, the possible names of attribute groups are: For Jobs, the possible names of attribute groups are:
- 'job-template': all of the Job Template attributes that apply to - 'job-template': all of the Job Template attributes that apply to a
a Job object (the first column of the table in Section 4.2). Job object (the first column of the table in Section 4.2).
- 'job-description': all of the Job Description attributes - 'job-description': all of the Job Description attributes specified
specified in Section 4.3. in Section 4.3.
- 'all': the special group 'all' that includes all supported - 'all': the special group 'all' that includes all supported
attributes. attributes.
Since a client MAY request specific attributes or named groups, there Since a client MAY request specific attributes or named groups, there is
is a potential that there is some overlap. For example, if a client a potential that there is some overlap. For example, if a client
requests, 'job-name' and 'job-description', the client is actually requests, 'job-name' and 'job-description', the client is actually
requesting the "job-name" attribute once by naming it explicitly, and requesting the "job-name" attribute once by naming it explicitly, and
once by inclusion in the 'job-description' group. In such cases, the once by inclusion in the 'job-description' group. In such cases, the
Printer object NEED NOT return the attribute only once in the response Printer object NEED NOT return the attribute only once in the response
even if it is requested multiple times. The client SHOULD NOT request even if it is requested multiple times. The client SHOULD NOT request
the same attribute in multiple ways. the same attribute in multiple ways.
It is NOT REQUIRED that a Job object support all attributes belonging It is NOT REQUIRED that a Job object support all attributes belonging to
to a group (since some attributes are OPTIONAL). However it is a group (since some attributes are OPTIONAL). However it is REQUIRED
REQUIRED that each Job object support all group names. that each Job object support all group names.
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
3.3.4.1 Get-Job-Attributes Request 3.3.4.1 Get-Job-Attributes Request
The following groups of attributes are part of the Get-Job-Attributes The following groups of attributes are part of the Get-Job-Attributes
Request when the request is directed at a Job object: Request when the request is directed at a Job object:
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" (integer(1:MAX)) Either (1) the "printer-uri" (uri) plus "job-id" (integer(1:MAX))
or (2) the "job-uri" (uri) operation attribute(s) which define or (2) the "job-uri" (uri) operation attribute(s) which define the
the target for this operation as described in section 3.1.5. target 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 The "requesting-user-name" (name(MAX)) attribute SHOULD be supplied
supplied by the client as described in section 8.3. by the client as described in section 8.3.
"requested-attributes" (1setOf keyword) : "requested-attributes" (1setOf keyword) :
The client OPTIONALLY supplies this attribute. The IPP object The client OPTIONALLY supplies this attribute. The IPP object MUST
MUST support this attribute. It is a set of attribute names support this attribute. It is a set of attribute names and/or
and/or attribute group names in whose values the requester is attribute group names in whose values the requester is interested.
interested. If the client omits this attribute, the IPP object If the client omits this attribute, the IPP object MUST respond as
MUST respond as if this attribute had been supplied with a value if this attribute had been supplied with a value of 'all'.
of 'all'.
3.3.4.2 Get-Job-Attributes Response 3.3.4.2 Get-Job-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 of
the Get-Job-Attributes Response: the Get-Job-Attributes Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Message: Status Message:
In addition to the REQUIRED status code returned in every In addition to the REQUIRED status code returned in every response,
response, the response OPTIONALLY includes a "status-message" the response OPTIONALLY includes a "status-message" (text)
(text) operation attribute as described in section 3.1.5. operation attribute as described in sections 14 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. The "attributes- attributes as described in section 3.1.4.2. The "attributes-
natural-language" MAY be the natural language of the Job object, natural-language" MAY be the natural language of the Job object,
rather than the one requested. rather than the one requested.
Expires December 30, 1998
Group 2: Unsupported Attributes Group 2: Unsupported Attributes
This is a set of Operation attributes supplied by the client (in This is a set of Operation attributes supplied by the client (in
the request) that are not supported by the Printer object or that the request) that are not supported by the Printer object or that
conflict with one another (see sections 3.2.1.2 and 16.3). conflict with one another (see sections 3.2.1.2 and the
Implementer's Guide [IPP-IIG]). 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
Isaacson, Powell Expires May 16, 1999
supported by the IPP object. If the Printer object is not
returning any Unsupported Attributes in the response, the Printer
object SHOULD omit Group 2 rather than sending an empty group.
However, a client MUST be able to accept an empty group.
Group 3: Job Object Attributes Group 3: Job Object Attributes
This is the set of requested attributes and their current values. This is the set of requested attributes and their current values.
The IPP object ignores (does not respond with) any requested The IPP object ignores (does not respond with) any requested
attribute or value which is not supported or which is restricted attribute or value which is not supported or which is restricted by
by the security policy in force, including whether the requesting the security policy in force, including whether the requesting user
user is the user that submitted the job (job originating user) or is the user that submitted the job (job originating user) or not
not (see section 8). However, the IPP object MUST respond with (see section 8). However, the IPP object MUST respond with the
the 'unknown' value for any supported attribute (including all 'unknown' value for any supported attribute (including all REQUIRED
REQUIRED attributes) for which the IPP object does not know the attributes) for which the IPP object does not know the value,
value, unless it would violate the security policy. See the unless it would violate the security policy. See the description
description of the "out-of-band" values in the beginning of of the "out-of-band" values in the beginning of Section 4.1.
Section 4.1.
4. Object Attributes 4. Object Attributes
This section describes the attributes with their corresponding This section describes the attributes with their corresponding attribute
attribute syntaxes and values that are part of the IPP model. The syntaxes and values that are part of the IPP model. The sections below
sections below show the objects and their associated attributes which show the objects and their associated attributes which are included
are included within the scope of this protocol. Many of these within the scope of this protocol. Many of these attributes are derived
attributes are derived from other relevant specifications: from other relevant specifications:
- Document Printing Application (DPA) [ISO10175] - Document Printing Application (DPA) [ISO10175]
- RFC 1759 Printer MIB [RFC1759] - RFC 1759 Printer MIB [RFC1759]
Each attribute is uniquely identified in this document using a Each attribute is uniquely identified in this document using a "keyword"
"keyword" (see section 13.2.1) which is the name of the attribute. (see section 13.2.1) which is the name of the attribute. The keyword is
The keyword is included in the section header describing that included in the section header describing that attribute.
attribute.
Note: Not only are keywords used to identify attributes, but one of Note: Not only are keywords used to identify attributes, but one of the
the attribute syntaxes described below is "keyword" so that some attribute syntaxes described below is "keyword" so that some attributes
attributes have keyword values. Therefore, these attributes are have keyword values. Therefore, these attributes are defined as having
defined as having an attribute syntax that is a set of keywords. an attribute syntax that is a set of keywords.
4.1 Attribute Syntaxes 4.1 Attribute Syntaxes
This section defines the basic attribute syntax types that all clients This section defines the basic attribute syntax types that all clients
and IPP objects MUST be able to accept in responses and accept in and IPP objects MUST be able to accept in responses and accept in
requests, respectively. Each attribute description in sections 3 and requests, respectively. Each attribute description in sections 3 and 4
includes the name of attribute syntax(es) in the heading (in
Expires December 30, 1998 parentheses). A conforming implementation of an attribute MUST include
the semantics of the attribute syntax(es) so identified. Section 6.3
4 includes the name of attribute syntax(es) in the heading (in describes how the protocol can be extended with new attribute syntaxes.
parentheses). A conforming implementation of an attribute MUST
include the semantics of the attribute syntax(es) so identified.
Section 6.3 describes how the protocol can be extended with new
attribute syntaxes.
The attribute syntaxes are specified in the following sub-sections, The attribute syntaxes are specified in the following sub-sections,
where the sub-section heading is the keyword name of the attribute where the sub-section heading is the keyword name of the attribute
syntax inside the single quotes. In operation requests and responses syntax inside the single quotes. In operation requests and responses
each attribute value MUST be represented as one of the attribute each attribute value MUST be represented as one of the attribute
Isaacson, Powell Expires May 16, 1999
syntaxes specified in the sub-section heading for the attribute. In syntaxes specified in the sub-section heading for the attribute. In
addition, the value of an attribute in a response (but not in a addition, the value of an attribute in a response (but not in a request)
request) MAY be one of the "out-of-band" values. Standard "out-of- MAY be one of the "out-of-band" values. Standard "out-of-band" values
band" values are: are:
'unknown': The attribute is supported by the IPP object, but the 'unknown': The attribute is supported by the IPP object, but the
value is unknown to the IPP object for some reason. value is unknown to the IPP object for some reason.
'unsupported': The attribute is unsupported by the IPP object. 'unsupported': The attribute is unsupported by the IPP object. This
This value MUST be returned only as the value of an attribute in value MUST be returned only as the value of an attribute in the
the Unsupported Attributes Group. Unsupported Attributes Group.
'no-value': The attribute is supported by the Printer object, but 'no-value': The attribute is supported by the Printer object, but the
the system administrator has not yet configured a value. system administrator has not yet configured a value.
The protocol specification defines mechanisms for passing "out-of- The Encoding and Transport specification [IPP-PRO] defines mechanisms
band" values. All attributes in a request MUST have one or more for passing "out-of-band" values. All attributes in a request MUST have
values as defined in Sections 4.2 to 4.4. Thus clients MUST NOT one or more values as defined in Sections 4.2 to 4.4. Thus clients MUST
supply attributes with "out-of-band" values. All attribute in a NOT supply attributes with "out-of-band" values. All attribute in a
response MUST have one or more values as defined in Sections 4.2 to response MUST have one or more values as defined in Sections 4.2 to 4.4
4.4 or a single "out-of-band" value. or a single "out-of-band" value.
Most attributes are defined to have a single attribute syntax. Most attributes are defined to have a single attribute syntax. However,
However, a few attributes (e.g., "job-sheet", "media", "job-hold- a few attributes (e.g., "job-sheet", "media", "job-hold-until") are
until") are defined to have several attribute syntaxes, depending on defined to have several attribute syntaxes, depending on the value.
the value. These multiple attribute syntaxes are separated by the "|" These multiple attribute syntaxes are separated by the "|" character in
character in the sub-section heading to indicate the choice. Since the sub-section heading to indicate the choice. Since each value MUST
each value MUST be tagged as to its attribute syntax in the protocol, be tagged as to its attribute syntax in the protocol, a single-valued
a single-valued attribute instance may have any one of its attribute attribute instance may have any one of its attribute syntaxes and a
syntaxes and a multi-valued attribute instance may have a mixture of multi-valued attribute instance may have a mixture of its defined
its defined attribute syntaxes. attribute syntaxes.
4.1.1 'text' 4.1.1 'text'
A text attribute is an attribute whose value is a sequence of zero or A text attribute is an attribute whose value is a sequence of zero or
more characters encoded in a maximum of 1023 ('MAX') octets. MAX is more characters encoded in a maximum of 1023 ('MAX') octets. MAX is the
the maximum length for each value of any text attribute. However, if maximum length for each value of any text attribute. However, if an
an attribute will always contain values whose maximum length is much attribute will always contain values whose maximum length is much less
than MAX, the definition of that attribute will include a qualifier that
Expires December 30, 1998 defines the maximum length for values of that attribute. For example:
the "printer-location" attribute is specified as "printer-location
less than MAX, the definition of that attribute will include a (text(127))". In this case, text values for "printer-location" MUST NOT
qualifier that defines the maximum length for values of that exceed 127 octets; if supplied with a longer text string via some
attribute. For example: the "printer-location" attribute is specified external interface (other than the protocol), implementations are free
as "printer-location (text(127))". In this case, text values for to truncate to this shorter length limitation.
"printer-location" MUST NOT exceed 127 octets; if supplied with a
longer text string via some external interface (other than the
protocol), implementations are free to truncate to this shorter length
limitation.
In this specification, all text attributes are defined using the In this specification, all text attributes are defined using the 'text'
'text' syntax. However, 'text' is used only for brevity; the formal syntax. However, 'text' is used only for brevity; the formal
interpretation of 'text' is: 'textWithoutLanguage | textWithLanguage'. interpretation of 'text' is: 'textWithoutLanguage | textWithLanguage'.
That is, for any attribute defined in this specification using the That is, for any attribute defined in this specification using the
'text' attribute syntax, all IPP objects and clients MUST support both 'text' attribute syntax, all IPP objects and clients MUST support both
the 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes. the 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes.
However, in actual usage and protocol execution, objects and clients However, in actual usage and protocol execution, objects and clients
accept and return only one of the two syntax per attribute. The
syntax 'text' never appears "on-the-wire".
Both 'textWithoutLanguage' and 'textWithLanguage' are needed to Isaacson, Powell Expires May 16, 1999
support the real world needs of interoperability between sites and
systems that use different natural languages as the basis for human
communication. Generally, one natural language applies to all text
attributes in a given request or response. The language is indicated
by the "attributes-natural-language" operation attribute defined in
section 3.1.4 or "attributes-natural-language" job attribute defined
in section 4.3.24, and there is no need to identify the natural
language for each text string on a value-by-value basis. In these
cases, the attribute syntax 'textWithoutLanguage' is used for text
attributes. In other cases, the client needs to supply or the Printer
object needs to return a text value in a natural language that is
different from the rest of the text values in the request or response.
In these cases, the client or Printer object uses the attribute syntax
'textWithLanguage' for text attributes (this is the Natural Language
Override mechanism described in section 3.1.4).
The 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes accept and return only one of the two syntax per attribute. The syntax
are described in more detail in the following sections. 'text' never appears "on-the-wire".
Both 'textWithoutLanguage' and 'textWithLanguage' are needed to support
the real world needs of interoperability between sites and systems that
use different natural languages as the basis for human communication.
Generally, one natural language applies to all text attributes in a
given request or response. The language is indicated by the "attributes-
natural-language" operation attribute defined in section 3.1.4 or
"attributes-natural-language" job attribute defined in section 4.3.24,
and there is no need to identify the natural language for each text
string on a value-by-value basis. In these cases, the attribute syntax
'textWithoutLanguage' is used for text attributes. In other cases, the
client needs to supply or the Printer object needs to return a text
value in a natural language that is different from the rest of the text
values in the request or response. In these cases, the client or
Printer object uses the attribute syntax 'textWithLanguage' for text
attributes (this is the Natural Language Override mechanism described in
section 3.1.4).
The 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes are
described in more detail in the following sections.
4.1.1.1 'textWithoutLanguage' 4.1.1.1 'textWithoutLanguage'
The 'textWithoutLanguage' syntax indicates a value that is sequence of The 'textWithoutLanguage' syntax indicates a value that is sequence of
zero or more characters. Text strings are encoded using the rules of zero or more characters. Text strings are encoded using the rules of
some charset. The Printer object MUST support the UTF-8 charset some charset. The Printer object MUST support the UTF-8 charset
[RFC2044] and MAY support additional charsets to represent 'text' [RFC2044] and MAY support additional charsets to represent 'text'
values, provided that the charsets are registered with IANA [IANA-CS]. values, provided that the charsets are registered with IANA [IANA-CS].
Expires December 30, 1998
See Section 4.1.7 for the specification of the 'charset' attribute See Section 4.1.7 for the specification of the 'charset' attribute
syntax, including restricted semantics and examples of charsets. syntax, including restricted semantics and examples of charsets.
4.1.1.2 'textWithLanguage' 4.1.1.2 'textWithLanguage'
The 'textWithLanguage' attribute syntax is a compound attribute syntax The 'textWithLanguage' attribute syntax is a compound attribute syntax
consisting of two parts: a 'textWithoutLanguage' part plus an consisting of two parts: a 'textWithoutLanguage' part plus an additional
additional 'naturalLanguage' (see section 4.1.8) part that overrides 'naturalLanguage' (see section 4.1.8) part that overrides the natural
the natural language in force. The 'naturalLanguage' part explicitly language in force. The 'naturalLanguage' part explicitly identifies the
identifies the natural language that applies to the text part of that natural language that applies to the text part of that value and that
value and that value alone. For any give text attribute, the value alone. For any give text attribute, the 'textWithoutLanguage'
'textWithoutLanguage' part is limited to the maximum length defined part is limited to the maximum length defined for that attribute, but
for that attribute, , but the 'naturalLanguage' part is always limited the 'naturalLanguage' part is always limited to 63 octets. Using the
to 63 octets. Using the 'textWithLanguage' attribute syntax rather 'textWithLanguage' attribute syntax rather than the normal
than the normal 'textWithoutLanguage' syntax is the so-called Natural 'textWithoutLanguage' syntax is the so-called Natural Language Override
Language Override mechanism and MUST be supported by all IPP objects mechanism and MUST be supported by all IPP objects and clients.
and clients.
If the attribute is multi-valued (1setOf text), then the If the attribute is multi-valued (1setOf text), then the
'textWithLanguage' attribute syntax MUST be used to explicitly specify 'textWithLanguage' attribute syntax MUST be used to explicitly specify
each attribute value whose natural language needs to be overridden. each attribute value whose natural language needs to be overridden.
Other values in a multi-valued 'text' attribute in a request or a Other values in a multi-valued 'text' attribute in a request or a
response revert to the natural language of the operation attribute or response revert to the natural language of the operation attribute.
to the "attributes-natural-language" Job attribute, if present, in the
case of a Get-Jobs response. Isaacson, Powell Expires May 16, 1999
In a create request, the Printer object MUST accept and store with the In a create request, the Printer object MUST accept and store with the
Job object any natural language in the "attributes-natural-language" Job object any natural language in the "attributes-natural-language"
operation attribute, whether the Printer object supports that natural operation attribute, whether the Printer object supports that natural
language or not. Furthermore, the Printer object MUST accept and language or not. Furthermore, the Printer object MUST accept and store
store any 'textWithLanguage' attribute value, whether the Printer any 'textWithLanguage' attribute value, whether the Printer object
object supports that natural language or not. These requirements are supports that natural language or not. These requirements are
independent of the value of the "ipp-attribute-fidelity" operation independent of the value of the "ipp-attribute-fidelity" operation
attribute that the client MAY supply. attribute that the client MAY supply.
Example: If the client supplies the "attributes-natural-language" Example: If the client supplies the "attributes-natural-language"
operation attribute with the value: 'en' indicating English, but the operation attribute with the value: 'en' indicating English, but the
value of the "job-name" attribute is in French, the client MUST use value of the "job-name" attribute is in French, the client MUST use the
the 'textWithLanguage' attribute syntax with the following two values: 'textWithLanguage' attribute syntax with the following two values:
'fr': Natural Language Override indicating French 'fr': Natural Language Override indicating French
'Rapport Mensuel': the job name in French 'Rapport Mensuel': the job name in French
See the Protocol document [IPP-PRO] for a detailed example of the See the Encoding and Transport document [IPP-PRO] for a detailed example
'textWithLanguage' attribute syntax. of the 'textWithLanguage' attribute syntax.
Expires December 30, 1998
4.1.2 'name' 4.1.2 'name'
This syntax type is used for user-friendly strings, such as a Printer This syntax type is used for user-friendly strings, such as a Printer
name, that, for humans, are more meaningful than identifiers. Names name, that, for humans, are more meaningful than identifiers. Names are
are usually never translated from one natural language to another. never translated from one natural language to another. The 'name'
The 'name' attribute syntax is essentially the same as 'text', attribute syntax is essentially the same as 'text', including the
including the REQUIRED support of UTF-8 except that the sequence of REQUIRED support of UTF-8 except that the sequence of characters is
characters is limited so that its encoded form MUST NOT exceed 255 limited so that its encoded form MUST NOT exceed 255 (MAX) octets.
(MAX) octets.
Also like 'text', 'name' is really an abbreviated notation for either Also like 'text', 'name' is really an abbreviated notation for either
'nameWithoutLanguage' or 'nameWithLanguage'. That is, all IPP 'nameWithoutLanguage' or 'nameWithLanguage'. That is, all IPP objects
objects and clients MUST support both the 'nameWithoutLanguage' and and clients MUST support both the 'nameWithoutLanguage' and
'nameWithLanguage' attribute syntaxes. However, in actual usage and 'nameWithLanguage' attribute syntaxes. However, in actual usage and
protocol execution, objects and clients accept and return only one of protocol execution, objects and clients accept and return only one of
the two syntax per attribute. The syntax 'name' never appears "on- the two syntax per attribute. The syntax 'name' never appears "on-the-
the-wire". wire".
Note: Only the 'text' and 'name' attribute syntaxes permit the Note: Only the 'text' and 'name' attribute syntaxes permit the Natural
Natural Language Override mechanism. Language Override mechanism.
Some attributes are defined as 'type3 keyword | name'. These Some attributes are defined as 'type3 keyword | name'. These attributes
attributes support values that are either type3 keywords or names. support values that are either type3 keywords or names. This dual-
This dual-syntax mechanism enables a site administrator to extend syntax mechanism enables a site administrator to extend these attributes
these attributes to legally include values that are locally defined by to legally include values that are locally defined by the site
the site administrator. Such names are not registered with IANA. administrator. Such names are not registered with IANA.
4.1.2.1 'nameWithoutLanguage' 4.1.2.1 'nameWithoutLanguage'
The nameWithoutLanguage' syntax indicates a value that is sequence of The nameWithoutLanguage' syntax indicates a value that is sequence of
zero or more characters so that its encoded form does not exceed MAX zero or more characters so that its encoded form does not exceed MAX
octets. octets.
Isaacson, Powell Expires May 16, 1999
4.1.2.2 'nameWithLanguage' 4.1.2.2 'nameWithLanguage'
The 'nameWithLanguage' attribute syntax is a compound attribute syntax The 'nameWithLanguage' attribute syntax is a compound attribute syntax
consisting of two parts: a 'nameWithoutLanguage' part plus an consisting of two parts: a 'nameWithoutLanguage' part plus an additional
additional 'naturalLanguage' (see section 4.1.8) part that overrides 'naturalLanguage' (see section 4.1.8) part that overrides the natural
the natural language in force. The 'naturalLanguage' part explicitly language in force. The 'naturalLanguage' part explicitly identifies the
identifies the natural language that applies to that name value and natural language that applies to that name value and that name value
that name value alone. alone.
The 'nameWithLanguage' attribute syntax behaves the same as the The 'nameWithLanguage' attribute syntax behaves the same as the
'textWithLanguage' syntax. If a name is in a language that is 'textWithLanguage' syntax. If a name is in a language that is different
different than the rest of the object or operation, then this than the rest of the object or operation, then this 'nameWithLanguage'
syntax is used rather than the generic 'nameWithoutLanguage' syntax.
Expires December 30, 1998
'nameWithLanguage' syntax is used rather than the generic
'nameWithoutLanguage' syntax.
Example: If the client supplies the "attributes-natural-language" Example: If the client supplies the "attributes-natural-language"
operation attribute with the value: 'en' indicating English, but the operation attribute with the value: 'en' indicating English, but the
"printer-name" attribute is in German, the client MUST use the "printer-name" attribute is in German, the client MUST use the
'nameWithLanguage' attribute syntax as follows: 'nameWithLanguage' attribute syntax as follows:
'de': Natural Language Override indicating German 'de': Natural Language Override indicating German
'Farbdrucker': the Printer name in German 'Farbdrucker': the Printer name in German
4.1.2.3 Matching 'name' attribute values
For purposes of matching two 'name' attribute values for equality, such
as in job validation (where a client-supplied value for attribute "xxx"
is checked to see if the value is among the values of the Printer
object's corresponding "xxx-supported" attribute), the following match
rules apply:
1. 'keyword' values never match 'name' values.
2. 'name' (nameWithoutLanguage and nameWithLanguage) values match
if (1) the name parts match and (2) the Associated Natural-Language
parts (see section 3.1.4.1) match. The matching rules are:
a. the name parts match if the two names are identical
character by character, except it is RECOMMENDED that case be
ignored. For example: 'Ajax-letter-head-white' MUST match
'Ajax-letter-head-white' and SHOULD match 'ajax-letter-head-
white' and 'AJAX-LETTER-HEAD-WHITE'.
b. the Associated Natural-Language parts match if the shorter
of the two meets the syntactic requirements of RFC 1766
[RFC1766] and matches byte for byte with the longer. For
example, 'en' matches 'en', 'en-us' and 'en-gb', but matches
neither 'fr' nor 'e'.
4.1.3 'keyword' 4.1.3 'keyword'
The 'keyword' attribute syntax is a sequence of characters, length: 1 The 'keyword' attribute syntax is a sequence of characters, length: 1 to
to 255, containing only the US-ASCII [ASCII] encoded values for 255, containing only the US-ASCII [ASCII] encoded values for lowercase
lowercase letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot ("."), and
("."), and underscore ("_"). The first character MUST be a lowercase
letter. Furthermore, keywords MUST be in U.S. English. Isaacson, Powell Expires May 16, 1999
underscore ("_"). The first character MUST be a lowercase letter.
Furthermore, keywords MUST be in U.S. English.
This syntax type is used for enumerating semantic identifiers of This syntax type is used for enumerating semantic identifiers of
entities in the abstract protocol, i.e., entities identified in this entities in the abstract protocol, i.e., entities identified in this
document. Keywords are used as attribute names or values of document. Keywords are used as attribute names or values of attributes.
attributes. Unlike 'text' and 'name' attribute values, 'keyword' Unlike 'text' and 'name' attribute values, 'keyword' values MUST NOT use
values MUST NOT use the Natural Language Override mechanism, since the Natural Language Override mechanism, since they MUST always be US-
they MUST always be US-ASCII and U.S. English. ASCII and U.S. English.
Keywords are for use in the protocol. A user interface will likely Keywords are for use in the protocol. A user interface will likely
provide a mapping between protocol keywords and displayable user- provide a mapping between protocol keywords and displayable user-
friendly words and phrases which are localized to the natural language friendly words and phrases which are localized to the natural language
of the user. While the keywords specified in this document MAY be of the user. While the keywords specified in this document MAY be
displayed to users whose natural language is U.S. English, they MAY be displayed to users whose natural language is U.S. English, they MAY be
mapped to other U.S. English words for U.S. English users, since the mapped to other U.S. English words for U.S. English users, since the
user interface is outside the scope of this document. user interface is outside the scope of this document.
In the definition for each attribute of this syntax type, the full set In the definition for each attribute of this syntax type, the full set
of defined keyword values for that attribute are listed. of defined keyword values for that attribute are listed.
When a keyword is used to represent an attribute (its name), it MUST When a keyword is used to represent an attribute (its name), it MUST be
be unique within the full scope of all IPP objects and attributes. unique within the full scope of all IPP objects and attributes. When a
When a keyword is used to represent a value of an attribute, it MUST keyword is used to represent a value of an attribute, it MUST be unique
be unique just within the scope of that attribute. That is, the same just within the scope of that attribute. That is, the same keyword MUST
keyword MUST NOT be used for two different values within the same NOT be used for two different values within the same attribute to mean
attribute to mean two different semantic ideas. However, the same two different semantic ideas. However, the same keyword MAY be used
keyword MAY be used across two or more attributes, representing across two or more attributes, representing different semantic ideas for
different semantic ideas for each attribute. Section 6.1 describes each attribute. Section 6.1 describes how the protocol can be extended
how the protocol can be extended with new keyword values. Examples of with new keyword values. Examples of attribute name keywords:
attribute name keywords:
Expires December 30, 1998
"job-name" "job-name"
"attributes-charset" "attributes-charset"
Note: This document uses "type1", "type2", and "type3" prefixes to Note: This document uses "type1", "type2", and "type3" prefixes to the
the "keyword" basic syntax to indicate different levels of review for "keyword" basic syntax to indicate different levels of review for
extensions (see section 6.1). extensions (see section 6.1).
4.1.4 'enum' 4.1.4 'enum'
The 'enum' attribute syntax is an enumerated integer value that is in The 'enum' attribute syntax is an enumerated integer value that is in
the range from 1 to 2**31 - 1 (MAX). Each value has an associated the range from 1 to 2**31 - 1 (MAX). Each value has an associated
'keyword' name. In the definition for each attribute of this syntax 'keyword' name. In the definition for each attribute of this syntax
type, the full set of possible values for that attribute are listed. type, the full set of possible values for that attribute are listed.
This syntax type is used for attributes for which there are enum This syntax type is used for attributes for which there are enum values
values assigned by other standards, such as SNMP MIBs. A number of assigned by other standards, such as SNMP MIBs. A number of attribute
attribute enum values in this specification are also used for enum values in this specification are also used for corresponding
corresponding attributes in other standards [RFC1759]. This syntax attributes in other standards [RFC1759]. This syntax type is not used
type is not used for attributes to which the system administrator may for attributes to which the system administrator may assign values.
assign values. Section 6.1 describes how the protocol can be extended Section 6.1 describes how the protocol can be extended with new enum
with new enum values. values.
Enum values are for use in the protocol. A user interface will Isaacson, Powell Expires May 16, 1999
provide a mapping between protocol enum values and displayable user-
friendly words and phrases which are localized to the natural language Enum values are for use in the protocol. A user interface will provide
of the user. While the enum symbols specified in this document MAY be a mapping between protocol enum values and displayable user-friendly
words and phrases which are localized to the natural language of the
user. While the enum symbols specified in this document MAY be
displayed to users whose natural language is U.S. English, they MAY be displayed to users whose natural language is U.S. English, they MAY be
mapped to other U.S. English words for U.S. English users, since the mapped to other U.S. English words for U.S. English users, since the
user interface is outside the scope of this document. user interface is outside the scope of this document.
Note: SNMP MIBs use '2' for 'unknown' which corresponds to the IPP Note: SNMP MIBs use '2' for 'unknown' which corresponds to the IPP "out-
"out-of-band" value 'unknown'. See the description of the "out-of- of-band" value 'unknown'. See the description of the "out-of-band"
band" values at the beginning of Section 4.1. Therefore, attributes values at the beginning of Section 4.1. Therefore, attributes of type
of type 'enum' start at '3'. 'enum' start at '3'.
Note: This document uses "type1", "type2", and "type3" prefixes to Note: This document uses "type1", "type2", and "type3" prefixes to the
the "enum" basic syntax to indicate different levels of review for "enum" basic syntax to indicate different levels of review for
extensions (see section 6.1). extensions (see section 6.1).
4.1.5 'uri' 4.1.5 'uri'
The 'uri' attribute syntax is any valid Uniform Resource Identifier or The 'uri' attribute syntax is any valid Uniform Resource Identifier or
URI [RFC1630]. Most often, URIs are simply Uniform Resource Locators URI [RFC2396]. Most often, URIs are simply Uniform Resource Locators or
or URLs [RFC1738] [RFC1808]. The maximum length of URIs used within URLs. The maximum length of URIs used as values of IPP attributes is
IPP is 1023 octets. Although most other IPP syntax types allow for 1023 octets. Although most other IPP attribute syntax types allow for
only lower-cased values, this syntax type allows for mixed-case only lower-cased values, this attribute syntax type conforms to the
case-sensitive and case-insensitive rules specified in [RFC2396].
Expires December 30, 1998
values. The URI and URL standards allow for mixed-case values that
are case-sensitive.
4.1.6 'uriScheme' 4.1.6 'uriScheme'
The 'uriScheme' attribute syntax is a sequence of characters The 'uriScheme' attribute syntax is a sequence of characters
representing a URI scheme according to RFC 1738 [RFC1738]. Though RFC representing a URI scheme according to RFC 2396 [RFC2396]. Though RFC
1736 requires that the values be case-insensitive, IPP requires all 2396 requires that the values be case-insensitive, IPP requires all
lower case to simplify comparing by IPP clients and Printer objects. lower case values in IPP attributes to simplify comparing by IPP clients
Standard values for this syntax type are the following keywords: and Printer objects. Standard values for this syntax type are the
following keywords:
'http': for HTTP schemed URIs (e.g., "http:_") 'http': for HTTP schemed URIs (e.g., "http:.")
'https': for use with HTTPS schemed URIs (e.g., "https:...") (not 'https': for use with HTTPS schemed URIs (e.g., "https:...") (not on
on standards track) IETF standards track)
'ftp': for FTP schemed URIs (e.g., "ftp:...") 'ftp': for FTP schemed URIs (e.g., "ftp:...")
'mailto': for SMTP schemed URIs (e.g., "mailto:...") 'mailto': for SMTP schemed URIs (e.g., "mailto:...")
'file': for file schemed URIs (e.g., "file:...") 'file': for file schemed URIs (e.g., "file:...")
A Printer object MAY support any URI scheme that has been registered A Printer object MAY support any URI 'scheme' that has been registered
with IANA [IANA-MT]. The maximum length of URI schemes used within IPP with IANA [IANA-MT]. The maximum length of URI 'scheme' values used to
is 63 octets. represent IPP attribute values is 63 octets.
4.1.7 'charset' 4.1.7 'charset'
The 'charset' attribute syntax is a standard identifier for a charset. The 'charset' attribute syntax is a standard identifier for a charset.
A charset is a coded character set and encoding scheme. Charsets are A charset is a coded character set and encoding scheme. Charsets are
used for labeling certain document contents and 'text' and 'name' used for labeling certain document contents and 'text' and 'name'
attribute values. The syntax and semantics of this attribute syntax attribute values. The syntax and semantics of this attribute syntax are
are specified in RFC 2046 [RFC2046] and contained in the IANA
character-set Registry [IANA-CS] according to the IANA procedures
[RFC2278]. Though RFC 2046 requires that the values be case-
insensitive US-ASCII, IPP requires all lower case to simplify
comparing by IPP clients and Printer objects. When a character-set in
the IANA registry has more than one name (alias), the name labeled as
"(preferred MIME name)", if present, MUST be used.
The maximum length of charset values used within IPP is 63 octets. Isaacson, Powell Expires May 16, 1999
specified in RFC 2046 [RFC2046] and contained in the IANA character-set
Registry [IANA-CS] according to the IANA procedures [RFC2278]. Though
RFC 2046 requires that the values be case-insensitive US-ASCII, IPP
requires all lower case values in IPP attributes to simplify comparing
by IPP clients and Printer objects. When a character-set in the IANA
registry has more than one name (alias), the name labeled as "(preferred
MIME name)", if present, MUST be used.
The maximum length of 'charset' values used to represent IPP attribute
values is 63 octets.
Some examples are: Some examples are:
'utf-8': ISO 10646 Universal Multiple-Octet Coded Character Set 'utf-8': ISO 10646 Universal Multiple-Octet Coded Character Set
(UCS) represented as the UTF-8 [RFC2279] transfer encoding scheme (UCS) represented as the UTF-8 [RFC2279] transfer encoding scheme
in which US-ASCII is a subset charset. in which US-ASCII is a subset charset.
'us-ascii': 7-bit American Standard Code for Information 'us-ascii': 7-bit American Standard Code for Information Interchange
Interchange (ASCII), ANSI X3.4-1986 [ASCII]. That standard (ASCII), ANSI X3.4-1986 [ASCII]. That standard defines US-ASCII,
but RFC 2045 [RFC2045] eliminates most of the control characters
Expires December 30, 1998 from conformant usage in MIME and IPP.
defines US-ASCII, but RFC 2045 [46] eliminates most of the 'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet Nr
control characters from conformant usage in MIME and IPP. 1 [ISO8859-1]. That standard defines a coded character set that is
'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet used by Latin languages in the Western Hemisphere and Western
Nr 1 [ISO8859-1]. That standard defines a coded character set Europe. US-ASCII is a subset charset.
that is used by Latin languages in the Western Hemisphere and
Western Europe. US-ASCII is a subset charset.
'iso-10646-ucs-2': ISO 10646 Universal Multiple-Octet Coded 'iso-10646-ucs-2': ISO 10646 Universal Multiple-Octet Coded
Character Set (UCS) represented as two octets (UCS-2), with the Character Set (UCS) represented as two octets (UCS-2), with the
high order octet of each pair coming first (so-called Big Endian high order octet of each pair coming first (so-called Big Endian
integer). integer).
Some attribute descriptions MAY place additional requirements on Some attribute descriptions MAY place additional requirements on charset
charset values that may be used, such as REQUIRED values that MUST be values that may be used, such as REQUIRED values that MUST be supported
supported or additional restrictions, such as requiring that the or additional restrictions, such as requiring that the charset have US-
charset have US-ASCII as a subset charset. ASCII as a subset charset.
4.1.8 'naturalLanguage' 4.1.8 'naturalLanguage'
The 'naturalLanguage' attribute syntax is a standard identifier for a The 'naturalLanguage' attribute syntax is a standard identifier for a
natural language and optionally a country. The values for this syntax natural language and optionally a country. The values for this syntax
type are defined by RFC 1766 [RFC1766]. Though RFC 1766 requires that type are defined by RFC 1766 [RFC1766]. Though RFC 1766 requires that
the values be case-insensitive US-ASCII, IPP requires all lower case the values be case-insensitive US-ASCII, IPP requires all lower case to
to simplify comparing by IPP clients and Printer objects. Examples simplify comparing by IPP clients and Printer objects. Examples
include: include:
'en': for English 'en': for English
'en-us': for US English 'en-us': for US English
'fr': for French 'fr': for French
'de': for German 'de': for German
The maximum length of naturalLanguage values used within IPP is 63 The maximum length of 'naturalLanguage' values used to represent IPP
octets. attribute values is 63 octets.
Isaacson, Powell Expires May 16, 1999
4.1.9 'mimeMediaType' 4.1.9 'mimeMediaType'
The 'mimeMediaType' attribute syntax is the Internet Media Type The 'mimeMediaType' attribute syntax is the Internet Media Type
(sometimes called MIME type) as defined by RFC 2046 [RFC2046] and (sometimes called MIME type) as defined by RFC 2046 [RFC2046] and
registered according to the procedures of RFC 2048 [RFC2048] for registered according to the procedures of RFC 2048 [RFC2048] for
identifying a document format. The value MAY include a charset identifying a document format. The value MAY include a charset
parameter, depending on the specification of the Media Type in the parameter, depending on the specification of the Media Type in the IANA
IANA Registry [IANA-MT]. Although most other IPP syntax types allow Registry [IANA-MT]. Although most other IPP syntax types allow for only
for only lower-cased values, this syntax type allows for mixed-case lower-cased values, this syntax type allows for mixed-case values which
values which are case-insensitive. are case-insensitive.
Examples are: Examples are:
Expires December 30, 1998
'text/html': An HTML document 'text/html': An HTML document
'text/plain': A plain text document in US-ASCII (RFC 2046 indicates 'text/plain': A plain text document in US-ASCII (RFC 2046 indicates
that in the absence of the charset parameter MUST mean US-ASCII that in the absence of the charset parameter MUST mean US-ASCII
rather than simply unspecified) [RFC2046]. rather than simply unspecified) [RFC2046].
'text/plain; charset=US-ASCII': A plain text document in US-ASCII 'text/plain; charset=US-ASCII': A plain text document in US-ASCII
[52, 56]. [52, 56].
'text/plain; charset=ISO-8859-1': A plain text document in ISO 'text/plain; charset=ISO-8859-1': A plain text document in ISO 8859-
8859-1 (Latin 1) [ISO8859-1]. 1 (Latin 1) [ISO8859-1].
'text/plain; charset=utf-8': A plain text document in ISO 10646 'text/plain; charset=utf-8': A plain text document in ISO 10646
represented as UTF-8 [RFC2044] represented as UTF-8 [RFC2044]
'text/plain, charset=iso-10646-ucs-2': A plain text document in 'text/plain, charset=iso-10646-ucs-2': A plain text document in ISO
ISO 10646 represented in two octets (UCS-2) [ISO10646-1] 10646 represented in two octets (UCS-2) [ISO10646-1]
'application/postscript': A PostScript document [RFC2046] 'application/postscript': A PostScript document [RFC2046]
'application/vnd.hp-PCL': A PCL document [IANA-MT] (charset escape 'application/vnd.hp-PCL': A PCL document [IANA-MT] (charset escape
sequence embedded in the document data) sequence embedded in the document data)
'application/octet-stream': Auto-sense - see below 'application/octet-stream': Auto-sense - see below
One special type is 'application/octet-stream'. If the Printer object One special type is 'application/octet-stream'. If the Printer object
supports this value, the Printer object MUST be capable of auto- supports this value, the Printer object MUST be capable of auto-sensing
sensing the format of the document data. If the Printer object's the format of the document data. If the Printer object's default value
default value attribute "document-format-default" is set to attribute "document-format-default" is set to 'application/octet-
'application/octet-stream', the Printer object not only supports auto- stream', the Printer object not only supports auto-sensing of the
sensing of the document format, but will depend on the result of document format, but will depend on the result of applying its auto-
applying its auto-sensing when the client does not supply the sensing when the client does not supply the "document-format" attribute.
"document-format" attribute. If the client supplies a document format If the client supplies a document format value, the Printer MUST rely on
value, the Printer MUST rely on the supplied attribute, rather than the supplied attribute, rather than trust its auto-sensing algorithm.
trust its auto-sensing algorithm. To summarize: To summarize:
1. If the client does not supply a document format value, the 1. If the client does not supply a document format value, the Printer
Printer MUST rely on its default value setting (which may be MUST rely on its default value setting (which may be
'application/octet-stream' indicating an auto-sensing mechanism). 'application/octet-stream' indicating an auto-sensing mechanism).
2. If the client supplies a value other than 'application/octet- 2. If the client supplies a value other than 'application/octet-
stream', the client is supplying valid information about the stream', the client is supplying valid information about the format
format of the document data and the Printer object MUST trust the of the document data and the Printer object MUST trust the client
client supplied value more than the outcome of applying an supplied value more than the outcome of applying an automatic
automatic format detection mechanism. For example, the client format detection mechanism. For example, the client may be
may be requesting the printing of a PostScript file as a requesting the printing of a PostScript file as a 'text/plain'
'text/plain' document. The Printer object MUST print a text document. The Printer object MUST print a text representation of
representation of the PostScript commands rather than interpret the PostScript commands rather than interpret the stream of
the stream of PostScript commands and print the result. PostScript commands and print the result.
3. If the client supplies a value of 'application/octet-stream',
the client is indicating that the Printer object MUST use its
auto-sensing mechanism on the client supplied document data
whether auto-sensing is the Printer object's default or not.
Note: Since the auto-sensing algorithm is probabilistic, if the
client requests both auto-sensing ("document-format" set to
'application/octet-stream') and true fidelity ("ipp-attribute-
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
3. If the client supplies a value of 'application/octet-stream', the
client is indicating that the Printer object MUST use its auto-
sensing mechanism on the client supplied document data whether
auto-sensing is the Printer object's default or not.
fidelity" set to 'true'), the Printer object might not be able to Note: Since the auto-sensing algorithm is probabilistic, if the client
guarantee exactly what the end user intended (the auto-sensing requests both auto-sensing ("document-format" set to 'application/octet-
algorithm might mistake one document format for another ), but it is stream') and true fidelity ("ipp-attribute-fidelity" set to 'true'), the
able to guarantee that its auto-sensing mechanism be used. Printer object might not be able to guarantee exactly what the end user
intended (the auto-sensing algorithm might mistake one document format
for another ), but it is able to guarantee that its auto-sensing
mechanism be used.
The maximum length of a 'mimeMediaType' value in IPP is 255 octets. The maximum length of a 'mimeMediaType' value to represent IPP attribute
values is 255 octets.
4.1.10 'octetString' 4.1.10 'octetString'
The 'octetString' attribute syntax is a sequence of octets encoded in The 'octetString' attribute syntax is a sequence of octets encoded in a
a maximum of 1023 octets which is indicated in sub-section headers maximum of 1023 octets which is indicated in sub-section headers using
using the notation: octetString(MAX). This syntax type is used for the notation: octetString(MAX). This syntax type is used for opaque
opaque data. data.
4.1.11 'boolean' 4.1.11 'boolean'
The 'boolean' attribute syntax is similar to an enum with only two The 'boolean' attribute syntax has only two values: 'true' and 'false'.
values: 'true' and 'false'.
4.1.12 'integer' 4.1.12 'integer'
The 'integer' attribute syntax is an integer value that is in the The 'integer' attribute syntax is an integer value that is in the range
range from -2**31 (MIN) to 2**31 - 1 (MAX). Each individual attribute from -2**31 (MIN) to 2**31 - 1 (MAX). Each individual attribute may
may specify the range constraint explicitly in sub-section headers if specify the range constraint explicitly in sub-section headers if the
the range is different from the full range of possible integer values. range is different from the full range of possible integer values. For
For example: job-priority (integer(1:100)) for the "job-priority" example: job-priority (integer(1:100)) for the "job-priority"
attribute. However, the enforcement of that additional constraint is attribute. However, the enforcement of that additional constraint is up
up to the IPP objects, not the protocol. to the IPP objects, not the protocol.
4.1.13 'rangeOfInteger' 4.1.13 'rangeOfInteger'
The 'rangeOfInteger' attribute syntax is an ordered pair of integers The 'rangeOfInteger' attribute syntax is an ordered pair of integers
that defines an inclusive range of integer values. The first integer that defines an inclusive range of integer values. The first integer
specifies the lower bound and the second specifies the upper bound. specifies the lower bound and the second specifies the upper bound. If
If a range constraint is specified in the header description for an a range constraint is specified in the header description for an
attribute in this document whose attribute syntax is 'rangeOfInteger' attribute in this document whose attribute syntax is 'rangeOfInteger'
(i.e., 'X:Y' indicating X as a minimum value and Y as a maximum (i.e., 'X:Y' indicating X as a minimum value and Y as a maximum value),
value), then the constraint applies to both integers. then the constraint applies to both integers.
4.1.14 'dateTime' 4.1.14 'dateTime'
The 'dateTime' attribute syntax is a standard, fixed length, 11 octet The 'dateTime' attribute syntax is a standard, fixed length, 11 octet
representation of the "DateAndTime" syntax as defined in RFC 1903 representation of the "DateAndTime" syntax as defined in RFC 1903
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
[RFC1903]. RFC 1903 also identifies an 8 octet representation of a [RFC1903]. RFC 1903 also identifies an 8 octet representation of a
"DateAndTime" value, but IPP objects MUST use the 11 octet "DateAndTime" value, but IPP objects MUST use the 11 octet
representation. A user interface will provide a mapping between representation. A user interface will provide a mapping between
protocol dateTime values and displayable user-friendly words or protocol dateTime values and displayable user-friendly words or
presentation values and phrases which are localized to the natural presentation values and phrases which are localized to the natural
language and date format of the user. language and date format of the user.
4.1.15 'resolution' 4.1.15 'resolution'
The 'resolution' attribute syntax specifies a two-dimensional The 'resolution' attribute syntax specifies a two-dimensional resolution
resolution in the indicated units. It consists of 3 integers: a cross in the indicated units. It consists of 3 values: a cross feed direction
feed direction resolution (positive integer value), a feed direction resolution (positive integer value), a feed direction resolution
resolution (positive integer value), and a units value. The semantics (positive integer value), and a units value. The semantics of these
of these three components are taken from the Printer MIB [RFC1759] three components are taken from the Printer MIB [RFC1759] suggested
suggested values. That is, the cross feed direction component values. That is, the cross feed direction component resolution
resolution component is the same as the component is the same as the prtMarkerAddressabilityXFeedDir object in
prtMarkerAddressabilityXFeedDir object in the Printer MIB, the feed the Printer MIB, the feed direction component resolution component is
direction component resolution component is the same as the the same as the prtMarkerAddressabilityFeedDir in the Printer MIB, and
prtMarkerAddressabilityFeedDir in the Printer MIB, and the units the units component is the same as the prtMarkerAddressabilityUnit
component is the same as the prtMarkerAddressabilityUnit object in the object in the Printer MIB (namely, '3' indicates dots per inch and '4'
Printer MIB (namely, '3' indicates dots per inch and '4' indicates indicates dots per centimeter). All three values MUST be present even
dots per centimeter). All three values MUST be present even if the if the first two values are the same. Example: '300', '600', '3'
first two values are the same. Example: '300', '600', '3' indicates indicates a 300 dpi cross-feed direction resolution, a 600 dpi feed
a 300 dpi cross-feed direction resolution, a 600 dpi feed direction direction resolution, since a '3' indicates dots per inch (dpi).
resolution, since a '3' indicates dots per inch (dpi).
4.1.16 '1setOf X' 4.1.16 '1setOf X'
The '1setOf X' attribute syntax is 1 or more values of attribute The '1setOf X' attribute syntax is 1 or more values of attribute syntax
syntax type X. This syntax type is used for multi-valued attributes. type X. This syntax type is used for multi-valued attributes. The
The syntax type is called '1setOf' rather than just 'setOf' as a syntax type is called '1setOf' rather than just 'setOf' as a reminder
reminder that the set of values MUST NOT be empty (i.e., a set of size that the set of values MUST NOT be empty (i.e., a set of size 0). Sets
0). Sets are normally unordered. However each attribute description are normally unordered. However each attribute description of this type
of this type may specify that the values MUST be in a certain order may specify that the values MUST be in a certain order for that
for that attribute. attribute.
4.2 Job Template Attributes 4.2 Job Template Attributes
Job Template attributes describe job processing behavior. Support for Job Template attributes describe job processing behavior. Support for
Job Template attributes by a Printer object is OPTIONAL (see section Job Template attributes by a Printer object is OPTIONAL (see section
13.2.3 for a description of support for OPTIONAL attributes). Also, 13.2.3 for a description of support for OPTIONAL attributes). Also,
clients OPTIONALLY supply Job Template attributes in create requests. clients OPTIONALLY supply Job Template attributes in create requests.
Job Template attributes conform to the following rules. For each Job Job Template attributes conform to the following rules. For each Job
Template attribute called "xxx": Template attribute called "xxx":
Expires December 30, 1998
1. If the Printer object supports "xxx" then it MUST support both a 1. If the Printer object supports "xxx" then it MUST support both a
"xxx-default" attribute (unless there is a "No" in the table "xxx-default" attribute (unless there is a "No" in the table below)
below) and a "xxx-supported" attribute. If the Printer object and a "xxx-supported" attribute. If the Printer object doesn't
doesn't support "xxx", then it MUST support neither an "xxx- support "xxx", then it MUST support neither an "xxx-default"
default" attribute nor an "xxx-supported" attribute, and it MUST attribute nor an "xxx-supported" attribute, and it MUST treat an
treat an attribute "xxx" supplied by a client as unsupported. An attribute "xxx" supplied by a client as unsupported. An attribute
attribute "xxx" may be supported for some document formats and "xxx" may be supported for some document formats and not supported
not supported for other document formats. For example, it is
expected that a Printer object would only support "orientation- Isaacson, Powell Expires May 16, 1999
requested" for some document formats (such as 'text/plain' or for other document formats. For example, it is expected that a
'text/html') but not others (such as 'application/postscript'). Printer object would only support "orientation-requested" for some
document formats (such as 'text/plain' or 'text/html') but not
others (such as 'application/postscript').
2. "xxx" is OPTIONALLY supplied by the client in a create request. 2. "xxx" is OPTIONALLY supplied by the client in a create request.
If "xxx" is supplied, the client is indicating a desired job If "xxx" is supplied, the client is indicating a desired job
processing behavior for this Job. When "xxx" is not supplied, processing behavior for this Job. When "xxx" is not supplied, the
the client is indicating that the Printer object apply its client is indicating that the Printer object apply its default job
default job processing behavior at job processing time if the processing behavior at job processing time if the document content
document content does not contain an embedded instruction does not contain an embedded instruction indicating an xxx-related
indicating an xxx-related behavior. behavior.
Note: Since an administrator MAY change the default value Note: Since an administrator MAY change the default value attribute
attribute after a Job object has been submitted but before it has after a Job object has been submitted but before it has been
been processed, the default value used by the Printer object at processed, the default value used by the Printer object at job
job processing time may be different that the default value in processing time may be different that the default value in effect
effect at job submission time. at job submission time.
3. The "xxx-supported" attribute is a Printer object attribute that 3. The "xxx-supported" attribute is a Printer object attribute that
describes which job processing behaviors are supported by that describes which job processing behaviors are supported by that
Printer object. A client can query the Printer object to find Printer object. A client can query the Printer object to find out
out what xxx-related behaviors are supported by inspecting the what xxx-related behaviors are supported by inspecting the returned
returned values of the "xxx-supported" attribute. values of the "xxx-supported" attribute.
Note: The "xxx" in each "xxx-supported" attribute name is Note: The "xxx" in each "xxx-supported" attribute name is singular,
singular, even though an "xxx-supported" attribute usually has even though an "xxx-supported" attribute usually has more than one
more than one value, such as "job-sheet-supported", unless the value, such as "job-sheet-supported", unless the "xxx" Job Template
"xxx" Job Template attribute is plural, such as "finishings" or attribute is plural, such as "finishings" or "sides". In such
"sides". In such cases the "xxx-supported" attribute names are: cases the "xxx-supported" attribute names are: "finishings-
"finishings-supported" and "sides-supported". supported" and "sides-supported".
4. The "xxx-default" default value attribute describes what will be 4. The "xxx-default" default value attribute describes what will be
done at job processing time when no other job processing done at job processing time when no other job processing
information is supplied by the client (either explicitly as an information is supplied by the client (either explicitly as an IPP
IPP attribute in the create request or implicitly as an embedded attribute in the create request or implicitly as an embedded
instruction within the document data). instruction within the document data).
If an application wishes to present an end user with a list of If an application wishes to present an end user with a list of supported
supported values from which to choose, the application SHOULD query values from which to choose, the application SHOULD query the Printer
the Printer object for its supported value attributes. The object for its supported value attributes. The application SHOULD also
query the default value attributes. If the application then limits
Expires December 30, 1998 selectable values to only those value that are supported, the
application can guarantee that the values supplied by the client in the
application SHOULD also query the default value attributes. If the create request all fall within the set of supported values at the
application then limits selectable values to only those value that are Printer. When querying the Printer, the client MAY enumerate each
supported, the application can guarantee that the values supplied by attribute by name in the Get-Printer-Attributes Request, or the client
the client in the create request all fall within the set of supported MAY just name the "job-template" group in order to get the complete set
values at the Printer. When querying the Printer, the client MAY of supported attributes (both supported and default attributes).
enumerate each attribute by name in the Get-Printer-Attributes
Request, or the client MAY just name the "job-template" group in order
to get the complete set of supported attributes (both supported and
default attributes).
The "finishings" attribute is an example of a Job Template attribute. The "finishings" attribute is an example of a Job Template attribute.
It can take on a set of values such as 'staple', 'punch', and/or It can take on a set of values such as 'staple', 'punch', and/or
'cover'. A client can query the Printer object for the "finishings- 'cover'. A client can query the Printer object for the "finishings-
supported" attribute and the "finishings-default" attribute. The supported" attribute and the "finishings-default" attribute. The
Isaacson, Powell Expires May 16, 1999
supported attribute contains a set of supported values. The default supported attribute contains a set of supported values. The default
value attribute contains the finishing value(s) that will be used for value attribute contains the finishing value(s) that will be used for a
a new Job if the client does not supply a "finishings" attribute in new Job if the client does not supply a "finishings" attribute in the
the create request and the document data does not contain any create request and the document data does not contain any corresponding
corresponding finishing instructions. If the client does supply the finishing instructions. If the client does supply the "finishings"
"finishings" attribute in the create request, the IPP object validates attribute in the create request, the IPP object validates the value or
the value or values to make sure that they are a subset of the values to make sure that they are a subset of the supported values
supported values identified in the Printer object's "finishings- identified in the Printer object's "finishings-supported" attribute.
supported" attribute. See section 3.2.1.2. See section 3.2.1.2.
The table below summarizes the names and relationships for all Job The table below summarizes the names and relationships for all Job
Template attributes. The first column of the table (labeled "Job Template attributes. The first column of the table (labeled "Job
Attribute") shows the name and syntax for each Job Template attribute Attribute") shows the name and syntax for each Job Template attribute in
in the Job object. These are the attributes that can optionally be the Job object. These are the attributes that can optionally be supplied
supplied by the client in a create request. The last two columns by the client in a create request. The last two columns (labeled
(labeled "Printer: Default Value Attribute" and "Printer: Supported "Printer: Default Value Attribute" and "Printer: Supported Values
Values Attribute") shows the name and syntax for each Job Template Attribute") shows the name and syntax for each Job Template attribute in
attribute in the Printer object (the default value attribute and the the Printer object (the default value attribute and the supported values
supported values attribute). A "No" in the table means the Printer attribute). A "No" in the table means the Printer MUST NOT support the
MUST NOT support the attribute (that is, the attribute is simply not attribute (that is, the attribute is simply not applicable). For
applicable). For brevity in the table, the 'text' and 'name' entries brevity in the table, the 'text' and 'name' entries do not show the
do not show the maximum length for each attribute. maximum length for each attribute.
Expires December 30, 1998 Isaacson, Powell Expires May 16, 1999
+===================+======================+======================+ +===================+======================+======================+
| Job Attribute |Printer: Default Value| Printer: Supported | | Job Attribute |Printer: Default Value| Printer: Supported |
| | Attribute | Values Attribute | | | Attribute | Values Attribute |
+===================+======================+======================+ +===================+======================+======================+
| job-priority | job-priority-default |job-priority-supported| | job-priority | job-priority-default |job-priority-supported|
| (integer 1:100) | (integer 1:100) |(integer 1:100) | | (integer 1:100) | (integer 1:100) |(integer 1:100) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| job-hold-until | job-hold-until- |job-hold-until- | | job-hold-until | job-hold-until- |job-hold-until- |
| (type3 keyword | | default | supported | | (type3 keyword | | default | supported |
| name) | (type3 keyword | |(1setOf | | name) | (type3 keyword | |(1setOf |
skipping to change at page 73, line 4 skipping to change at page 65, line 54
| | | rangeOfInteger | | | | rangeOfInteger |
| | | (1:MAX)) | | | | (1:MAX)) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| orientation- |orientation-requested-|orientation-requested-| | orientation- |orientation-requested-|orientation-requested-|
| requested | default | supported | | requested | default | supported |
| (type2 enum) | (type2 enum) | (1setOf type2 enum) | | (type2 enum) | (type2 enum) | (1setOf type2 enum) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| media | media-default | media-supported | | media | media-default | media-supported |
| (type3 keyword | | (type3 keyword | |(1setOf | | (type3 keyword | | (type3 keyword | |(1setOf |
| name) | name) | type3 keyword | name)| | name) | name) | type3 keyword | name)|
Expires December 30, 1998
| | | | | | | |
| | | media-ready | | | | media-ready |
| | |(1setOf | | | |(1setOf |
| | | type3 keyword | name)| | | | type3 keyword | name)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
Isaacson, Powell Expires May 16, 1999
+===================+======================+======================+
| Job Attribute |Printer: Default Value| Printer: Supported |
| | Attribute | Values Attribute |
+===================+======================+======================+
| printer-resolution| printer-resolution- | printer-resolution- | | printer-resolution| printer-resolution- | printer-resolution- |
| (resolution) | default | supported | | (resolution) | default | supported |
| | (resolution) |(1setOf resolution) | | | (resolution) |(1setOf resolution) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| print-quality | print-quality-default| print-quality- | | print-quality | print-quality-default| print-quality- |
| (type2 enum) | (type2 enum) | supported | | (type2 enum) | (type2 enum) | supported |
| | |(1setOf type2 enum) | | | |(1setOf type2 enum) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
4.2.1 job-priority (integer(1:100)) 4.2.1 job-priority (integer(1:100))
This attribute specifies a priority for scheduling the Job. A higher This attribute specifies a priority for scheduling the Job. A higher
value specifies a higher priority. The value 1 indicates the lowest value specifies a higher priority. The value 1 indicates the lowest
possible priority. The value 100 indicates the highest possible possible priority. The value 100 indicates the highest possible
priority. Among those jobs that are ready to print, a Printer MUST priority. Among those jobs that are ready to print, a Printer MUST
print all jobs with a priority value of n before printing those with a print all jobs with a priority value of n before printing those with a
priority value of n-1 for all n. priority value of n-1 for all n.
If the Printer object supports this attribute, it MUST always support If the Printer object supports this attribute, it MUST always support
the full range from 1 to 100. No administrative restrictions are the full range from 1 to 100. No administrative restrictions are
permitted. This way an end-user can always make full use of the permitted. This way an end-user can always make full use of the entire
entire range with any Printer object. If privileged jobs are range with any Printer object. If privileged jobs are implemented
implemented outside IPP/1.0, they MUST have priorities higher than outside IPP/1.0, they MUST have priorities higher than 100, rather than
100, rather than restricting the range available to end-users. restricting the range available to end-users.
If the client does not supply this attribute and this attribute is If the client does not supply this attribute and this attribute is
supported by the Printer object, the Printer object MUST use the value supported by the Printer object, the Printer object MUST use the value
of the Printer object's "job-priority-default" at job submission time of the Printer object's "job-priority-default" at job submission time
(unlike most Job Template attributes that are used if necessary at job (unlike most Job Template attributes that are used if necessary at job
processing time). processing time).
The syntax for the "job-priority-supported" is also integer(1:100). The syntax for the "job-priority-supported" is also integer(1:100).
This single integer value indicates the number of priority levels This single integer value indicates the number of priority levels
supported. The Printer object MUST take the value supplied by the supported. The Printer object MUST take the value supplied by the
client and map it to the closest integer in a sequence of n integers client and map it to the closest integer in a sequence of n integers
values that are evenly distributed over the range from 1 to 100 using values that are evenly distributed over the range from 1 to 100 using
the formula: the formula:
roundToNearestInt((100x+50)/n) roundToNearestInt((100x+50)/n)
Expires December 30, 1998
where n is the value of "job-priority-supported" and x ranges from 0 where n is the value of "job-priority-supported" and x ranges from 0
through n-1. through n-1.
For example, if n=1 the sequence of values is 50; if n=2, the For example, if n=1 the sequence of values is 50; if n=2, the sequence
sequence of values is: 25 and 75; if n = 3, the sequence of values of values is: 25 and 75; if n = 3, the sequence of values is: 17, 50
is: 17, 50 and 83; if n = 10, the sequence of values is: 5, 15, 25, and 83; if n = 10, the sequence of values is: 5, 15, 25, 35, 45, 55,
35, 45, 55, 65, 75, 85, and 95; if n = 100, the sequence of values 65, 75, 85, and 95; if n = 100, the sequence of values is: 1, 2, 3, .
is: 1, 2, 3, _ 100. 100.
If the value of the Printer object's "job-priority-supported" is 10 Isaacson, Powell Expires May 16, 1999
and the client supplies values in the range 1 to 10, the Printer
object maps them to 5, in the range 11 to 20, the Printer object maps If the value of the Printer object's "job-priority-supported" is 10 and
them to 15, etc. the client supplies values in the range 1 to 10, the Printer object maps
them to 5, in the range 11 to 20, the Printer object maps them to 15,
etc.
4.2.2 job-hold-until (type3 keyword | name (MAX)) 4.2.2 job-hold-until (type3 keyword | name (MAX))
This attribute specifies the named time period during which the Job This attribute specifies the named time period during which the Job MUST
MUST become a candidate for printing. become a candidate for printing.
Standard values for named time periods are: Standard keyword values for named time periods are:
'no-hold': immediately, if there are not other reasons to hold the 'no-hold': immediately, if there are not other reasons to hold the
job job
'day-time': during the day 'day-time': during the day
'evening': evening 'evening': evening
'night': night 'night': night
'weekend': weekend 'weekend': weekend
'second-shift': second-shift (after close of business) 'second-shift': second-shift (after close of business)
'third-shift': third-shift (after midnight) 'third-shift': third-shift (after midnight)
An administrator MUST associate allowable print times with a named An administrator MUST associate allowable print times with a named time
time period (by means outside IPP/1.0). An administrator is period (by means outside IPP/1.0). An administrator is encouraged to
encouraged to pick names that suggest the type of time period. An pick names that suggest the type of time period. An administrator MAY
administrator MAY define additional values using the 'name' or define additional values using the 'name' or 'keyword' attribute syntax,
'keyword' attribute syntax, depending on implementation. depending on implementation.
If the value of this attribute specifies a time period that is in the If the value of this attribute specifies a time period that is in the
future, the Printer MUST add the 'job-hold-until-specified' value to future, the Printer MUST add the 'job-hold-until-specified' value to the
the job's "job-state-reasons" attribute, move the job to the 'pending- job's "job-state-reasons" attribute, move the job to the 'pending-held'
held' state, and MUST NOT schedule the job for printing until the state, and MUST NOT schedule the job for printing until the specified
specified time-period arrives. When the specified time period time-period arrives. When the specified time period arrives, the
arrives, the Printer MUST remove the 'job-hold-until-specified' value Printer MUST remove the 'job-hold-until-specified' value from the job's
from the job's "job-state-reason" attribute and, if there are no other "job-state-reason" attribute and, if there are no other job state
job state reasons that keep the job in the 'pending-held' state, the reasons that keep the job in the 'pending-held' state, the Printer MUST
Printer MUST consider the job as a candidate for processing by moving consider the job as a candidate for processing by moving the job to the
the job to the 'pending' state. 'pending' state.
Expires December 30, 1998
If this job attribute value is the named value 'no-hold', or the If this job attribute value is the named value 'no-hold', or the
specified time period has already started, the job MUST be a candidate specified time period has already started, the job MUST be a candidate
for processing immediately. for processing immediately.
If the client does not supply this attribute and this attribute is If the client does not supply this attribute and this attribute is
supported by the Printer object, the Printer object MUST use the value supported by the Printer object, the Printer object MUST use the value
of the Printer object's "job-hold-until-default" at job submission of the Printer object's "job-hold-until-default" at job submission time
time (unlike most Job Template attributes that are used if necessary (unlike most Job Template attributes that are used if necessary at job
at job processing time). processing time).
4.2.3 job-sheets (type3 keyword | name(MAX)) 4.2.3 job-sheets (type3 keyword | name(MAX))
This attribute determines which job start/end sheet(s), if any, MUST This attribute determines which job start/end sheet(s), if any, MUST be
be printed with a job. printed with a job.
Standard values are: Isaacson, Powell Expires May 16, 1999
Standard keyword values are:
'none': no job sheet is printed 'none': no job sheet is printed
'standard': one or more site specific standard job sheets are 'standard': one or more site specific standard job sheets are
printed, e.g. a single start sheet or both start and end sheet is printed, e.g. a single start sheet or both start and end sheet is
printed printed
An administrator MAY define additional values using the 'name' or An administrator MAY define additional values using the 'name' or
'keyword' attribute syntax, depending on implementation. 'keyword' attribute syntax, depending on implementation.
Note: The effect of this attribute on jobs with multiple documents MAY Note: The effect of this attribute on jobs with multiple documents MAY
be affected by the "multiple-document-handling" job attribute (section be affected by the "multiple-document-handling" job attribute (section
4.2.4), depending on the job sheet semantics. 4.2.4), depending on the job sheet semantics.
4.2.4 multiple-document-handling (type2 keyword) 4.2.4 multiple-document-handling (type2 keyword)
This attribute is relevant only if a job consists of two or more This attribute is relevant only if a job consists of two or more
documents. The attribute controls finishing operations and the documents. The attribute controls finishing operations and the placement
placement of one or more print-stream pages into impressions and onto of one or more print-stream pages into impressions and onto media
media sheets. When the value of the "copies" attribute exceeds 1, it sheets. When the value of the "copies" attribute exceeds 1, it also
also controls the order in which the copies that result from controls the order in which the copies that result from processing the
processing the documents are produced. For the purposes of this documents are produced. For the purposes of this explanations, if "a"
explanations, if "a" represents an instance of document data, then the represents an instance of document data, then the result of processing
result of processing the data in document "a" is a sequence of media the data in document "a" is a sequence of media sheets represented by
sheets represented by "a(*)". "a(*)".
Standard values are: Standard keyword values are:
'single-document': If a Job object has multiple documents, say, the 'single-document': If a Job object has multiple documents, say, the
document data is called a and b, then the result of processing document data is called a and b, then the result of processing all
all the document data (a and then b) MUST be treated as a single the document data (a and then b) MUST be treated as a single
Expires December 30, 1998
sequence of media sheets for finishing operations; that is, sequence of media sheets for finishing operations; that is,
finishing would be performed on the concatenation of the finishing would be performed on the concatenation of the sequences
sequences a(*),b(*). The Printer object MUST NOT force the data a(*),b(*). The Printer object MUST NOT force the data in each
in each document instance to be formatted onto a new print-stream document instance to be formatted onto a new print-stream page, nor
page, nor to start a new impression on a new media sheet. If more to start a new impression on a new media sheet. If more than one
than one copy is made, the ordering of the sets of media sheets copy is made, the ordering of the sets of media sheets resulting
resulting from processing the document data MUST be a(*), b(*), from processing the document data MUST be a(*), b(*), a(*), b(*),
a(*), b(*), ..., and the Printer object MUST force each copy ..., and the Printer object MUST force each copy (a(*),b(*)) to
(a(*),b(*)) to start on a new media sheet. start on a new media sheet.
'separate-documents-uncollated-copies': If a Job object has 'separate-documents-uncollated-copies': If a Job object has multiple
multiple documents, say, the document data is called a and b, documents, say, the document data is called a and b, then the
then the result of processing the data in each document instance result of processing the data in each document instance MUST be
MUST be treated as a single sequence of media sheets for treated as a single sequence of media sheets for finishing
finishing operations; that is, the sets a(*) and b(*) would each operations; that is, the sets a(*) and b(*) would each be finished
be finished separately. The Printer object MUST force each copy separately. The Printer object MUST force each copy of the result
of the result of processing the data in a single document to of processing the data in a single document to start on a new media
start on a new media sheet. If more than one copy is made, the sheet. If more than one copy is made, the ordering of the sets of
ordering of the sets of media sheets resulting from processing media sheets resulting from processing the document data MUST be
the document data MUST be a(*), a(*), ..., b(*), b(*) ... . a(*), a(*), ..., b(*), b(*) ... .
'separate-documents-collated-copies': If a Job object has multiple 'separate-documents-collated-copies': If a Job object has multiple
documents, say, the document data is called a and b, then the documents, say, the document data is called a and b, then the
result of processing the data in each document instance MUST be result of processing the data in each document instance MUST be
Isaacson, Powell Expires May 16, 1999
treated as a single sequence of media sheets for finishing treated as a single sequence of media sheets for finishing
operations; that is, the sets a(*) and b(*) would each be operations; that is, the sets a(*) and b(*) would each be finished
finished separately. The Printer object MUST force each copy of separately. The Printer object MUST force each copy of the result
the result of processing the data in a single document to start of processing the data in a single document to start on a new media
on a new media sheet. If more than one copy is made, the sheet. If more than one copy is made, the ordering of the sets of
ordering of the sets of media sheets resulting from processing media sheets resulting from processing the document data MUST be
the document data MUST be a(*), b(*), a(*), b(*), ... . a(*), b(*), a(*), b(*), ... .
'single-document-new-sheet': Same as 'single-document', except that
the Printer object MUST ensure that the first impression of each
document instance in the job is placed on a new media sheet. This
value allows multiple documents to be stapled together with a
single staple where each document starts on a new sheet.
The 'single-document' value is the same as 'separate-documents- The 'single-document' value is the same as 'separate-documents-collated-
collated-copies' with respect to ordering of print-stream pages, but copies' with respect to ordering of print-stream pages, but not media
not media sheet generation, since 'single-document' will put the first sheet generation, since 'single-document' will put the first page of the
page of the next document on the back side of a sheet if an odd number next document on the back side of a sheet if an odd number of pages have
of pages have been produced so far for the job, while 'separate- been produced so far for the job, while 'separate-documents-collated-
documents-collated-copies' always forces the next document or document copies' always forces the next document or document copy on to a new
copy on to a new sheet. In addition, if the "finishings" attribute sheet. In addition, if the "finishings" attribute specifies 'staple',
specifies 'staple', then with 'single-document', documents a and b are then with 'single-document', documents a and b are stapled together as a
stapled together as a single document, but with 'separate-documents- single document with no regard to new sheets, with 'single-document-new-
uncollated-copies' and 'separate-documents-collated-copies', documents sheet', documents a and b are stapled together as a single document, but
a and b are stapled separately. document b starts on a new sheet, but with 'separate-documents-
uncollated-copies' and 'separate-documents-collated-copies', documents a
and b are stapled separately.
Note: None of these values provide means to produce uncollated sheets Note: None of these values provide means to produce uncollated sheets
within a document, i.e., where multiple copies of sheet n are produced within a document, i.e., where multiple copies of sheet n are produced
before sheet n+1 of the same document. before sheet n+1 of the same document.
The relationship of this attribute and the other attributes that The relationship of this attribute and the other attributes that control
control document processing is described in section 16.5. document processing is described in section 16.3.
Expires December 30, 1998
4.2.5 copies (integer(1:MAX)) 4.2.5 copies (integer(1:MAX))
This attribute specifies the number of copies to be printed. This attribute specifies the number of copies to be printed.
On many devices the supported number of collated copies will be On many devices the supported number of collated copies will be limited
limited by the number of physical output bins on the device, and may by the number of physical output bins on the device, and may be
be different from the number of uncollated copies which can be different from the number of uncollated copies which can be supported.
supported.
Note: The effect of this attribute on jobs with multiple documents is Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section controlled by the "multiple-document-handling" job attribute (section
4.2.4) and the relationship of this attribute and the other attributes 4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 16.5. that control document processing is described in section 16.3.
4.2.6 finishings (1setOf type2 enum) 4.2.6 finishings (1setOf type2 enum)
This attribute identifies the finishing operations that the Printer This attribute identifies the finishing operations that the Printer uses
uses for each copy of each printed document in the Job. For Jobs with for each copy of each printed document in the Job. For Jobs with
multiple documents, the "multiple-document-handling" attribute multiple documents, the "multiple-document-handling" attribute
determines what constitutes a "copy" for purposes of finishing. determines what constitutes a "copy" for purposes of finishing.
Standard values are: Isaacson, Powell Expires May 16, 1999
Standard enum values are:
Value Symbolic Name and Description Value Symbolic Name and Description
'3' 'none': Perform no finishing '3' 'none': Perform no finishing
'4' 'staple': Bind the document(s) with one or more staples. '4' 'staple': Bind the document(s) with one or more staples. The
The exact number and placement of the staples is site- exact number and placement of the staples is site-
defined. defined.
'5' 'punch': This value indicates that holes are required in '5' 'punch': This value indicates that holes are required in the
the finished document. The exact number and placement finished document. The exact number and placement of the
of the holes is site-defined The punch specification holes is site-defined The punch specification MAY be
MAY be satisfied (in a site- and implementation- satisfied (in a site- and implementation-specific manner)
specific manner) either by drilling/punching, or by either by drilling/punching, or by substituting pre-
substituting pre-drilled media. drilled media.
'6' 'cover': This value is specified when it is desired to '6' 'cover': This value is specified when it is desired to select
select a non-printed (or pre-printed) cover for the a non-printed (or pre-printed) cover for the document.
document. This does not supplant the specification of a This does not supplant the specification of a printed
printed cover (on cover stock medium) by the document cover (on cover stock medium) by the document itself.
itself. '7' 'bind': This value indicates that a binding is to be applied
'7' 'bind': This value indicates that a binding is to be to the document; the type and placement of the binding is
applied to the document; the type and placement of the site-defined."
binding is site-defined."
Note: The effect of this attribute on jobs with multiple documents is Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section controlled by the "multiple-document-handling" job attribute (section
Expires December 30, 1998
4.2.4) and the relationship of this attribute and the other attributes 4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 16.5. that control document processing is described in section 16.3.
If the client supplies a value of 'none' along with any other If the client supplies a value of 'none' along with any other
combination of values, it is the same as if only that other combination of values, it is the same as if only that other combination
combination of values had been supplied (that is the 'none' value has of values had been supplied (that is the 'none' value has no effect).
no effect).
4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX)) 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))
This attribute identifies the range(s) of print-stream pages that the This attribute identifies the range(s) of print-stream pages that the
Printer object uses for each copy of each document which are to be Printer object uses for each copy of each document which are to be
printed. Nothing is printed for any pages identified that do not printed. Nothing is printed for any pages identified that do not exist
exist in the document(s). Ranges MUST be in ascending order, for in the document(s). Ranges MUST be in ascending order, for example: 1-
example: 1-3, 5-7, 15-19 and MUST NOT overlap, so that a non-spooling 3, 5-7, 15-19 and MUST NOT overlap, so that a non-spooling Printer
Printer object can process the job in a single pass. If the ranges object can process the job in a single pass. If the ranges are not
are not ascending or are overlapping, the IPP object MUST reject the ascending or are overlapping, the IPP object MUST reject the request and
request and return the 'client-error-bad-request' status code. The return the 'client-error-bad-request' status code. The attribute is
attribute is associated with print-stream pages not application- associated with print-stream pages not application-numbered pages (for
numbered pages (for example, the page numbers found in the headers and example, the page numbers found in the headers and or footers for
or footers for certain word processing applications). certain word processing applications).
For Jobs with multiple documents, the "multiple-document-handling" For Jobs with multiple documents, the "multiple-document-handling"
attribute determines what constitutes a "copy" for purposes of the attribute determines what constitutes a "copy" for purposes of the
specified page range(s). When "multiple-document-handling" is specified page range(s). When "multiple-document-handling" is 'single-
'single-document', the Printer object MUST apply each supplied page document', the Printer object MUST apply each supplied page range once
range once to the concatenation of the print-stream pages. For to the concatenation of the print-stream pages. For example, if there
example, if there are 8 documents of 10 pages each, the page-range are 8 documents of 10 pages each, the page-range '41:60' prints the
'41:60' prints the pages in the 5th and 6th documents as a single pages in the 5th and 6th documents as a single document and none of the
document and none of the pages of the other documents are printed. pages of the other documents are printed. When "multiple-document-
When "multiple-document-handling" is 'separate-document-uncollated-
copies' or 'separate-document-collated-copies', the Printer object
MUST apply each supplied page range repeatedly to each document copy.
For the same job, the page-range '1:3, 10:10' would print the first 3
pages and the 10th page of each of the 8 documents in the Job, as 8
separate documents.
In most cases, the exact pages to be printed will be generated by a Isaacson, Powell Expires May 16, 1999
device driver and this attribute would not be required. However, when
printing an archived document which has already been formatted, the
end user may elect to print just a subset of the pages contained in
the document. In this case, if page-range = n.m is specified, the
first page to be printed will be page n. All subsequent pages of the
document will be printed through and including page m.
"page-ranges-supported" is a boolean value indicating whether or not handling" is 'separate-document-uncollated-copies' or 'separate-
the printer is capable of supporting the printing of page ranges. document-collated-copies', the Printer object MUST apply each supplied