draft-ietf-ipp-model-09.txt   draft-ietf-ipp-model-10.txt 
INTERNET-DRAFT INTERNET-DRAFT
draft-ietf-ipp-model-09.txt draft-ietf-ipp-model-10.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
San Diego State University Astart Technologies
January 16, 1998 June 30, 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 its working groups. Note that other groups may also distribute and its working groups. Note that other groups may also distribute
working documents as Internet-Drafts. working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress". material 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), ds.internic.net (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).
This Internet-Draft expires on July 16, 1997.
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 aspects of a new Internet Printing Protocol (IPP). IPP is an all 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. The protocol is heavily
influenced by the printing model introduced in the Document Printing influenced by the printing model introduced in the Document Printing
Application (DPA) [ISO10175] standard. Although DPA specifies both Application (DPA) [ISO10175] standard. Although DPA specifies both
end user and administrative features, IPP version 1.0 (IPP/1.0) end user and administrative features, IPP version 1.0 (IPP/1.0)
focuses only on end user functionality. focuses only on end user functionality.
Expires July 16, 1998 Expires December 30, 1998
The full set of IPP documents includes: The full set of IPP documents includes:
Requirements 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] Printing Protocol [IPP-RAT] (informational)
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: Protocol Specification [IPP-PRO] Internet Printing Protocol/1.0: Encoding and Transport [IPP-PRO]
Mapping between LPD and IPP Protocols [IPP LPD] (informational)
The requirements document, "Requirements for an Internet Printing The design goals document, "Design Goals for an Internet Printing
Protocol", takes a broad look at distributed printing functionality, Protocol", takes a broad look at distributed printing functionality,
and it enumerates real-life scenarios that help to clarify the and it enumerates real-life scenarios that help to clarify the
features that need to be included in a printing protocol for the features that need to be included in a printing protocol for the
Internet. It identifies requirements for three types of users: end Internet. It identifies requirements for three types of users: end
users, operators, and administrators. The requirements document calls users, operators, and administrators. The design goals document calls
out a subset of end user requirements that MUST be satisfied in out a subset of end user requirements that are satisfied in IPP/1.0.
IPP/1.0. Operator and administrator requirements are out of scope for Operator and administrator requirements are out of scope for version
version 1.0. The rationale document, "Rationale for the Structure and 1.0. The rationale document, "Rationale for the Structure and Model
Model and Protocol for the Internet Printing Protocol", describes IPP and Protocol for the Internet Printing Protocol", describes IPP from a
from a high level view, defines a roadmap for the various documents high level view, defines a roadmap for the various documents that form
that form the suite of IPP specifications, and gives background and the suite of IPP specifications, and gives background and rationale
rationale for the IETF working group's major decisions. This for the IETF working group's major decisions. The model and semantics
document, "Internet Printing Protocol/1.0: Model and Semantics", document, "Internet Printing Protocol/1.0: Model and Semantics",
describes a simplified model with abstract objects, their attributes, describes a simplified model with abstract objects, their attributes,
and their operations. The model introduces a Printer and a Job. The and their operations. The model introduces a Printer and a Job. The
Job supports multiple documents per Job. The model document also Job supports multiple documents per Job. The model document also
addresses how security, internationalization, and directory issues are addresses how security, internationalization, and directory issues are
addressed. The protocol specification, " Internet Printing addressed. The protocol specification, " Internet Printing
Protocol/1.0: Protocol Specification", is a formal mapping of the Protocol/1.0: Encoding and Transport", is a formal mapping of the
abstract operations and attributes defined in the model document onto abstract operations and attributes defined in the model document onto
HTTP/1.1. The protocol specification defines the encoding rules for a HTTP/1.1. The protocol specification defines the encoding rules for a
new Internet media type called "application/ipp". new Internet media type called "application/ipp". The LPD mapping
document, "Mapping between LPD and IPP Protocols", gives some advice
to implementers of gateways between IPP and LPD (Line Printer Daemon)
implementations.
Expires July 16, 1998 Expires December 30, 1998
Table of Contents Table of Contents
1. Introduction ...................................................8 1. Introduction ....................................................9
1.1 Simplified Printing Model.....................................10 1.1 Simplified Printing Model ...................................10
2. IPP Objects ...................................................12 2. IPP Objects ....................................................13
2.1 Printer Object................................................13 2.1 Printer Object ..............................................14
2.2 Job Object....................................................14 2.2 Job Object ..................................................15
2.3 Object Relationships..........................................15 2.3 Object Relationships ........................................16
2.4 Object Identity...............................................16 2.4 Object Identity .............................................17
3. IPP Operations ................................................19 3. IPP Operations .................................................20
3.1 Common Semantics..............................................20 3.1 Common Semantics ............................................21
3.1.1 Operation IDs and Request IDs............................20 3.1.1 Required Parameters .......................................21
3.1.2 Attributes...............................................21 3.1.2 Operation IDs and Request IDs .............................22
3.1.3 Operation Targets........................................22 3.1.3 Attributes ................................................22
3.1.4 Character Set and Natural Language Operation Attributes..23 3.1.4 Character Set and Natural Language Operation Attributes ...24
3.1.4.1 Request Operation Attributes ..........................24 3.1.4.1 Request Operation Attributes ...........................24
3.1.4.2 Response Operation Attributes .........................26 3.1.4.2 Response Operation Attributes ..........................28
3.1.5 Operation Status Codes and Messages......................27 3.1.5 Operation Targets .........................................29
3.1.6 Versions.................................................28 3.1.6 Operation Status Codes and Messages .......................30
3.1.7 Job Creation Operations..................................30 3.1.7 Versions ..................................................31
3.2 Printer Operations............................................32 3.1.8 Job Creation Operations ...................................33
3.2.1 Print-Job Operation......................................32 3.2 Printer Operations ..........................................35
3.2.1.1 Print-Job Request .....................................32 3.2.1 Print-Job Operation .......................................35
3.2.1.2 Print-Job Response ....................................36 3.2.1.1 Print-Job Request ......................................35
3.2.2 Print-URI Operation......................................39 3.2.1.2 Print-Job Response .....................................39
3.2.3 Validate-Job Operation...................................39 3.2.2 Print-URI Operation .......................................42
3.2.4 Create-Job Operation.....................................40 3.2.3 Validate-Job Operation ....................................42
3.2.5 Get-Printer-Attributes Operation.........................40 3.2.4 Create-Job Operation ......................................43
3.2.5.1 Get-Printer-Attributes Request ........................41 3.2.5 Get-Printer-Attributes Operation ..........................43
3.2.5.2 Get-Printer-Attributes Response .......................43 3.2.5.1 Get-Printer-Attributes Request .........................44
3.2.6 Get-Jobs Operation.......................................43 3.2.5.2 Get-Printer-Attributes Response ........................46
3.2.6.1 Get-Jobs Request ......................................44 3.2.6 Get-Jobs Operation ........................................47
3.2.6.2 Get-Jobs Response .....................................45 3.2.6.1 Get-Jobs Request .......................................47
3.3 Job Operations................................................47 3.2.6.2 Get-Jobs Response ......................................49
3.3.1 Send-Document Operation..................................47 3.3 Job Operations ..............................................50
3.3.1.1 Send-Document Request .................................48 3.3.1 Send-Document Operation ...................................50
3.3.1.2 Send-Document Response ................................50 3.3.1.1 Send-Document Request ..................................51
3.3.2 Send-URI Operation.......................................50 3.3.1.2 Send-Document Response .................................53
3.3.3 Cancel Job Operation.....................................51 3.3.2 Send-URI Operation ........................................54
3.3.3.1 Cancel-Job Request ....................................51 3.3.3 Cancel-Job Operation ......................................54
3.3.3.2 Cancel-Job Response ...................................52 3.3.3.1 Cancel-Job Request .....................................54
3.3.4 Get-Job-Attributes Operation.............................52 3.3.3.2 Cancel-Job Response ....................................55
3.3.4.1 Get-Job-Attributes Request ............................53 3.3.4 Get-Job-Attributes Operation ..............................56
3.3.4.2 Get-Job-Attributes Response ...........................54 3.3.4.1 Get-Job-Attributes Request .............................57
4. Object Attributes .............................................54 3.3.4.2 Get-Job-Attributes Response ............................57
4.1 Attribute Syntaxes............................................55 4. Object Attributes ..............................................58
4.1.1 'text'...................................................56 4.1 Attribute Syntaxes ..........................................58
4.1.2 'textWithLanguage'.......................................57 4.1.1 'text' ....................................................59
Expires July 16, 1998 Expires December 30, 1998
4.1.3 'name'...................................................58 4.1.1.1 'textWithoutLanguage' ..................................60
4.1.4 'nameWithLanguage'.......................................58 4.1.1.2 'textWithLanguage' .....................................61
4.1.5 'keyword'................................................59 4.1.2 'name' ....................................................62
4.1.6 'enum'...................................................60 4.1.2.1 'nameWithoutLanguage' ..................................62
4.1.7 'uri'....................................................60 4.1.2.2 'nameWithLanguage' .....................................62
4.1.8 'uriScheme'..............................................60 4.1.3 'keyword' .................................................63
4.1.9 'charset'................................................61 4.1.4 'enum' ....................................................64
4.1.10 'naturalLanguage'........................................62 4.1.5 'uri' .....................................................64
4.1.11 'mimeMediaType'..........................................62 4.1.6 'uriScheme' ...............................................65
4.1.12 'octetString'............................................63 4.1.7 'charset' .................................................65
4.1.13 'boolean'................................................64 4.1.8 'naturalLanguage' .........................................66
4.1.14 'integer'................................................64 4.1.9 'mimeMediaType' ...........................................66
4.1.15 'rangeOfInteger'.........................................64 4.1.10 'octetString' .............................................68
4.1.16 'dateTime'...............................................64 4.1.11 'boolean' .................................................68
4.1.17 'resolution'.............................................64 4.1.12 'integer' .................................................68
4.1.18 '1setOf X'..............................................65 4.1.13 'rangeOfInteger' ..........................................68
4.2 Job Template Attributes.......................................65 4.1.14 'dateTime' ................................................68
4.2.1 job-priority (integer(1:100))............................69 4.1.15 'resolution' ..............................................69
4.2.2 job-hold-until (type4 keyword | name (MAX))..............70 4.1.16 '1setOf X' ...............................................69
4.2.3 job-sheets (type4 keyword | name(MAX))...................71 4.2 Job Template Attributes .....................................69
4.2.4 multiple-document-handling (type2 keyword)...............71 4.2.1 job-priority (integer(1:100)) .............................73
4.2.5 copies (integer(1:MAX))..................................73 4.2.2 job-hold-until (type3 keyword | name (MAX)) ...............74
4.2.6 finishings (1setOf type2 enum)...........................73 4.2.3 job-sheets (type3 keyword | name(MAX)) ....................75
4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))..............74 4.2.4 multiple-document-handling (type2 keyword) ................75
4.2.8 sides (type2 keyword)....................................75 4.2.5 copies (integer(1:MAX)) ...................................77
4.2.9 number-up (integer(1:MAX))...............................75 4.2.6 finishings (1setOf type2 enum) ............................77
4.2.10 orientation-requested (type2 enum).......................76 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX)) ...............78
4.2.11 media (type4 keyword | name(MAX))........................77 4.2.8 sides (type2 keyword) .....................................79
4.2.12 printer-resolution (resolution)..........................78 4.2.9 number-up (integer(1:MAX)) ................................80
4.2.13 print-quality (type2 enum)...............................78 4.2.10 orientation-requested (type2 enum) ........................80
4.3 Job Description Attributes....................................79 4.2.11 media (type3 keyword | name(MAX)) .........................81
4.3.1 job-uri (uri)............................................81 4.2.12 printer-resolution (resolution) ...........................82
4.3.2 job-id (integer(1:MAX))..................................81 4.2.13 print-quality (type2 enum) ................................82
4.3.3 job-printer-uri (uri)....................................81 4.3 Job Description Attributes ..................................83
4.3.4 job-more-info (uri)......................................82 4.3.1 job-uri (uri) .............................................85
4.3.5 job-name (name(MAX)).....................................82 4.3.2 job-id (integer(1:MAX)) ...................................85
4.3.6 job-originating-user-name (name(MAX))....................82 4.3.3 job-printer-uri (uri) .....................................85
4.3.7 job-state (type1 enum)...................................83 4.3.4 job-more-info (uri) .......................................86
4.3.8 job-state-reasons (1setOf type2 keyword)................85 4.3.5 job-name (name(MAX)) ......................................86
4.3.9 job-state-message (text(MAX))............................88 4.3.6 job-originating-user-name (name(MAX)) .....................86
4.3.10 number-of-documents (integer(0:MAX)).....................88 4.3.7 job-state (type1 enum) ....................................87
4.3.11 output-device-assigned (name(127)).......................88 4.3.8 job-state-reasons (1setOf type2 keyword) .................90
4.3.12 time-at-creation (integer(0:MAX))........................89 4.3.9 job-state-message (text(MAX)) .............................92
4.3.13 time-at-processing (integer(0:MAX))......................89 4.3.10 number-of-documents (integer(0:MAX)) ......................92
4.3.14 time-at-completed (integer(0:MAX)).......................89 4.3.11 output-device-assigned (name(127)) ........................93
4.3.15 number-of-intervening-jobs (integer(0:MAX))..............89 4.3.12 time-at-creation (integer(0:MAX)) .........................93
4.3.16 job-message-from-operator (text(127))....................89 4.3.13 time-at-processing (integer(0:MAX)) .......................93
4.3.17 job-k-octets (integer(0:MAX))............................90 4.3.14 time-at-completed (integer(0:MAX)) ........................93
Expires July 16, 1998 Expires December 30, 1998
4.3.18 job-impressions (integer(0:MAX)).........................90 4.3.15 number-of-intervening-jobs (integer(0:MAX)) ...............94
4.3.19 job-media-sheets (integer(0:MAX))........................91 4.3.16 job-message-from-operator (text(127)) .....................94
4.3.20 job-k-octets-processed (integer(0:MAX))..................91 4.3.17 job-k-octets (integer(0:MAX)) .............................94
4.3.21 job-impressions-completed (integer(0:MAX))...............92 4.3.18 job-impressions (integer(0:MAX)) ..........................95
4.3.22 job-media-sheets-completed (integer(0:MAX))..............92 4.3.19 job-media-sheets (integer(0:MAX)) .........................95
4.3.23 attributes-charset (charset).............................92 4.3.20 job-k-octets-processed (integer(0:MAX)) ...................96
4.3.24 attributes-natural-language (naturalLanguage)............93 4.3.21 job-impressions-completed (integer(0:MAX)) ................96
4.4 Printer Description Attributes................................93 4.3.22 job-media-sheets-completed (integer(0:MAX)) ...............96
4.4.1 printer-uri-supported (uri)..............................95 4.3.23 attributes-charset (charset) ..............................96
4.4.2 uri-security-supported (1setOf type2 keyword)............95 4.3.24 attributes-natural-language (naturalLanguage) .............97
4.4.3 printer-name (name(127)).................................97 4.4 Printer Description Attributes ..............................97
4.4.4 printer-location (text(127)).............................97 4.4.1 printer-uri-supported (1setOf uri) ........................99
4.4.5 printer-info (text(127)).................................97 4.4.2 uri-security-supported (1setOf type2 keyword) .............99
4.4.6 printer-more-info (uri)..................................98 4.4.3 printer-name (name(127)) .................................101
4.4.7 printer-driver-installer (uri)...........................98 4.4.4 printer-location (text(127)) .............................101
4.4.8 printer-make-and-model (text(127)).......................98 4.4.5 printer-info (text(127)) .................................101
4.4.9 printer-more-info-manufacturer (uri).....................98 4.4.6 printer-more-info (uri) ..................................101
4.4.10 printer-state (type1 enum)...............................98 4.4.7 printer-driver-installer (uri) ...........................102
4.4.11 printer-state-reasons (1setOf type2 keyword)............100 4.4.8 printer-make-and-model (text(127)) .......................102
4.4.12 printer-state-message (text(MAX)).......................102 4.4.9 printer-more-info-manufacturer (uri) .....................102
4.4.13 operations-supported (1setOf type2 enum)................102 4.4.10 printer-state (type1 enum) ...............................102
4.4.14 charset-configured (charset)............................103 4.4.11 printer-state-reasons (1setOf type2 keyword) .............103
4.4.15 charset-supported (1setOf charset)......................103 4.4.12 printer-state-message (text(MAX)) ........................106
4.4.16 natural-language-configured (naturalLanguage)...........104 4.4.13 operations-supported (1setOf type2 enum) .................106
4.4.17 generated-natural-language-supported (1setOf 4.4.14 charset-configured (charset) .............................107
naturalLanguage)........................................104 4.4.15 charset-supported (1setOf charset) .......................107
4.4.18 document-format-default (mimeMediaType).................105 4.4.16 natural-language-configured (naturalLanguage) ............107
4.4.19 document-format-supported (1setOf mimeMediaType)........105 4.4.17 generated-natural-language-supported
4.4.20 printer-is-accepting-jobs (boolean).....................105 (1setOf naturalLanguage) .................................108
4.4.21 queued-job-count (integer(0:MAX)).......................105 4.4.18 document-format-default (mimeMediaType) ..................108
4.4.22 printer-message-from-operator (text(127))...............106 4.4.19 document-format-supported (1setOf mimeMediaType) .........109
4.4.23 color-supported (boolean)...............................106 4.4.20 printer-is-accepting-jobs (boolean) ......................109
4.4.24 reference-uri-schemes-supported (1setOf uriScheme)......106 4.4.21 queued-job-count (integer(0:MAX)) ........................109
4.4.25 pdl-override-supported (type2 keyword)..................106 4.4.22 printer-message-from-operator (text(127)) ................109
4.4.26 printer-up-time (integer(1:MAX))........................107 4.4.23 color-supported (boolean) ................................109
4.4.27 printer-current-time (dateTime).........................107 4.4.24 reference-uri-schemes-supported (1setOf uriScheme) .......110
4.4.28 multiple-operation-time-out (integer(1:MAX))............108 4.4.25 pdl-override-supported (type2 keyword) ...................110
4.4.29 compression-supported (1setOf type3 keyword)............108 4.4.26 printer-up-time (integer(1:MAX)) .........................110
4.4.30 job-k-octets-supported (rangeOfInteger(0:MAX))..........108 4.4.27 printer-current-time (dateTime) ..........................111
4.4.31 job-impressions-supported (rangeOfInteger(0:MAX)).......108 4.4.28 multiple-operation-time-out (integer(1:MAX)) .............111
4.4.32 job-media-sheets-supported (rangeOfInteger(0:MAX))......109 4.4.29 compression-supported (1setOf type3 keyword) .............111
5. Conformance ..................................................109 4.4.30 job-k-octets-supported (rangeOfInteger(0:MAX)) ...........112
5.1 Client Conformance Requirements..............................109 4.4.31 job-impressions-supported (rangeOfInteger(0:MAX)) ........112
5.2 IPP Object Conformance Requirements..........................110 4.4.32 job-media-sheets-supported (rangeOfInteger(0:MAX)) .......112
5.2.1 Objects.................................................110 5. Conformance ...................................................112
5.2.2 Operations..............................................110 5.1 Client Conformance Requirements ............................113
5.2.3 IPP Object Attributes...................................111 5.2 IPP Object Conformance Requirements ........................113
5.2.4 Extensions..............................................111 5.2.1 Objects ..................................................113
Expires July 16, 1998 Expires December 30, 1998
5.2.5 Attribute Syntaxes......................................111 5.2.2 Operations ...............................................114
5.3 Charset and Natural Language Requirements....................111 5.2.3 IPP Object Attributes ....................................114
5.4 Security Conformance Requirements............................112 5.2.4 Extensions ...............................................115
6. IANA Considerations (registered and private extensions) ......112 5.2.5 Attribute Syntaxes .......................................115
6.1 Typed Extensions.............................................112 5.3 Charset and Natural Language Requirements ..................115
6.2 Registration of MIME types/sub-types for document-formats....114 5.4 Security Conformance Requirements ..........................115
6.3 Attribute Extensibility......................................114 6. IANA Considerations (registered and private extensions) .......116
6.4 Attribute Syntax Extensibility...............................115 6.1 Typed 'keyword' and 'enum' Extensions ......................116
7. Internationalization Considerations ..........................115 6.2 Attribute Extensibility ....................................118
8. Security Considerations ......................................118 6.3 Attribute Syntax Extensibility .............................119
8.1 Security Scenarios...........................................119 6.4 Operation Extensibility ....................................120
8.1.1 Client and Server in the Same Security Domain...........119 6.5 Status Code Extensibility ..................................120
8.1.2 Client and Server in Different Security Domains.........119 6.6 Registration of MIME types/sub-types for document-formats ..121
8.1.3 Print by Reference......................................120 6.7 Registration of charsets for use in 'charset' attribute
8.2 URIs for TLS and non-TLS Access..............................120 values .....................................................121
8.3 The "requesting-user-name" Operation Attribute...............120 7. Internationalization Considerations ...........................121
8.4 Restricted Queries...........................................122 8. Security Considerations .......................................124
8.5 IPP Security Application Profile for TLS.....................122 8.1 Security Scenarios .........................................125
9. References ...................................................123 8.1.1 Client and Server in the Same Security Domain ............125
10. Copyright Notice .............................................126 8.1.2 Client and Server in Different Security Domains ..........126
11. Author's Address .............................................126 8.1.3 Print by Reference .......................................126
12. APPENDIX A: Terminology ......................................130 8.2 URIs for TLS and non-TLS Access ............................126
12.1 Conformance Terminology......................................130 8.3 The "requesting-user-name" (name(MAX)) Operation Attribute .126
12.1.1 MUST....................................................130 8.4 Restricted Queries .........................................128
12.1.2 MUST NOT................................................130 8.5 IPP Security Application Profile for TLS ...................128
12.1.3 SHOULD..................................................130 9. References ....................................................129
12.1.4 SHOULD NOT..............................................130 10.Copyright Notice ..............................................133
12.1.5 MAY.....................................................131 11.Author's Address ..............................................133
12.1.6 NEED NOT................................................131 12.Formats for IPP Registration Proposals ........................136
12.2 Model Terminology............................................131 12.1 Type2 keyword attribute values registration ................136
12.2.1 Keyword.................................................131 12.2 Type3 keyword attribute values registration ................136
12.2.2 Attributes..............................................131 12.3 Type2 enum attribute values registration ...................137
12.2.2.1 Attribute Name .......................................132 12.4 Type3 enum attribute values registration ...................137
12.2.2.2 Attribute Group Name .................................132 12.5 Attribute registration .....................................137
12.2.2.3 Attribute Value ......................................132 12.6 Attribute Syntax registration ..............................138
12.2.2.4 Attribute Syntax .....................................132 12.7 Operation registration .....................................138
12.2.3 Supports................................................132 12.8 Status code registration ...................................139
12.2.4 print-stream page.......................................134 13.APPENDIX A: Terminology .......................................139
12.2.5 impression..............................................135 13.1 Conformance Terminology ....................................139
13. APPENDIX B: Status Codes and Suggested Status Code Messages .135 13.1.1 NEED NOT .................................................139
13.1 Status Codes.................................................136 13.2 Model Terminology ..........................................139
13.1.1 Informational...........................................136 13.2.1 Keyword ..................................................139
13.1.2 Successful Status Codes.................................136 13.2.2 Attributes ...............................................140
13.1.2.1 successful-ok (0x0000) ...............................136 13.2.2.1 Attribute Name ........................................140
13.1.2.2 successful-ok-ignored-or-substituted-attributes 13.2.2.2 Attribute Group Name ..................................140
(0x0001) .............................................137 13.2.2.3 Attribute Value .......................................140
13.1.2.3 successful-ok-conflicting-attributes (0x0002) ........137 13.2.2.4 Attribute Syntax ......................................140
13.1.3 Redirection Status Codes................................137 13.2.3 Supports .................................................141
Expires July 16, 1998 Expires December 30, 1998
13.1.4 Client Error Status Codes...............................137 13.2.4 print-stream page ........................................143
13.1.4.1 client-error-bad-request (0x0400) ....................137 13.2.5 impression ...............................................143
13.1.4.2 client-error-forbidden (0x0401) ......................137 14.APPENDIX B: Status Codes and Suggested Status Code Messages ..143
13.1.4.3 client-error-not-authenticated (0x0402) ..............138 14.1 Status Codes ...............................................144
13.1.4.4 client-error-not-authorized (0x0403) .................138 14.1.1 Informational ............................................144
13.1.4.5 client-error-not-possible (0x0404) ...................138 14.1.2 Successful Status Codes ..................................145
13.1.4.6 client-error-timeout (0x0405) ........................138 14.1.2.1 successful-ok (0x0000) ................................145
13.1.4.7 client-error-not-found (0x0406) ......................139 14.1.2.2 successful-ok-ignored-or-substituted-attributes
13.1.4.8 client-error-gone (0x0407) ...........................139 (0x0001) ..............................................145
13.1.4.9 client-error-request-entity-too-large (0x0408) .......139 14.1.2.3 successful-ok-conflicting-attributes (0x0002) .........145
13.1.4.10 client-error-request-uri-too-long (0x0409) ...........140 14.1.3 Redirection Status Codes .................................145
13.1.4.11 client-error-document-format-not-supported (0x040A) ..140 14.1.4 Client Error Status Codes ................................145
13.1.4.12 client-error-attributes-or-values-not-supported 14.1.4.1 client-error-bad-request (0x0400) .....................146
(0x040B) .............................................140 14.1.4.2 client-error-forbidden (0x0401) .......................146
13.1.4.13 client-error-uri-scheme-not-supported (0x040C) .......141 14.1.4.3 client-error-not-authenticated (0x0402) ...............146
13.1.4.14 client-error-charset-not-supported (0x040D) ..........141 14.1.4.4 client-error-not-authorized (0x0403) ..................146
13.1.4.15 client-error-conflicting-attributes (0x040E) .........141 14.1.4.5 client-error-not-possible (0x0404) ....................146
13.1.5 Server Error Status Codes...............................141 14.1.4.6 client-error-timeout (0x0405) .........................147
13.1.5.1 server-error-internal-error (0x0500) .................141 14.1.4.7 client-error-not-found (0x0406) .......................147
13.1.5.2 server-error-operation-not-supported (0x0501) ........141 14.1.4.8 client-error-gone (0x0407) ............................147
13.1.5.3 server-error-service-unavailable (0x0502) ............142 14.1.4.9 client-error-request-entity-too-large (0x0408) ........148
13.1.5.4 server-error-version-not-supported (0x0503) ..........142 14.1.4.10 client-error-request-value-too-long (0x0409) ..........148
13.1.5.5 server-error-device-error (0x0504) ...................142 14.1.4.11 client-error-document-format-not-supported (0x040A) ...148
13.1.5.6 server-error-temporary-error (0x0505) ................143 14.1.4.12 client-error-attributes-or-values-not-supported
13.1.5.7 server-error-not-accepting-jobs (0x0506) .............143 (0x040B) ..............................................149
13.2 Status Codes for IPP Operations..............................144 14.1.4.13 client-error-uri-scheme-not-supported (0x040C) ........149
14. APPENDIX C: "media" keyword values ..........................144 14.1.4.14 client-error-charset-not-supported (0x040D) ...........149
15. APPENDIX D: Processing IPP Attributes ........................149 14.1.4.15 client-error-conflicting-attributes (0x040E) ..........149
15.1 Fidelity.....................................................150 14.1.5 Server Error Status Codes ................................149
15.2 Page Description Language (PDL) Override.....................151 14.1.5.1 server-error-internal-error (0x0500) ..................150
15.3 Suggested Operation Processing Steps for All Operations......153 14.1.5.2 server-error-operation-not-supported (0x0501) .........150
15.3.1 Validate version number.................................153 14.1.5.3 server-error-service-unavailable (0x0502) .............150
15.3.2 Validate operation identifier...........................154 14.1.5.4 server-error-version-not-supported (0x0503) ...........150
15.3.3 Validate the request identifier.........................154 14.1.5.5 server-error-device-error (0x0504) ....................151
15.3.4 Validate attribute group and attribute presence and 14.1.5.6 server-error-temporary-error (0x0505) .................151
order...................................................154 14.1.5.7 server-error-not-accepting-jobs (0x0506) ..............151
15.3.4.1 Validate the presence and order of attribute groups ..155 14.1.5.8 server-error-busy (0x0507) ............................151
15.3.4.2 Ignore unknown attribute groups in the expected 14.2 Status Codes for IPP Operations ............................152
position .............................................155 15.APPENDIX C: "media" keyword values ...........................153
15.3.4.3 Validate the presence of a single occurrence of 16.APPENDIX D: Processing IPP Attributes .........................157
required Operation attributes ........................156 16.1 Fidelity ...................................................158
15.3.5 Validate the values of the MANDATORY Operation 16.2 Page Description Language (PDL) Override ...................159
attributes..............................................161 16.3 Suggested Operation Processing Steps for All Operations ....161
15.3.6 Validate the values of the OPTIONAL Operation 16.3.1 Validate version number ..................................162
attributes..............................................164 16.3.2 Validate operation identifier ............................162
15.4 Suggested Additional Processing Steps for Operations that 16.3.3 Validate the request identifier ..........................162
Create/Validate Jobs and Add Documents.......................166 16.3.4 Validate attribute group and attribute presence and order 163
15.4.1 Default "ipp-attribute-fidelity" if not supplied........166 16.3.4.1 Validate the presence and order of attribute groups ...163
Expires July 16, 1998 Expires December 30, 1998
15.4.2 Check that the Printer object is accepting jobs.........167 16.3.4.2 Ignore unknown attribute groups in the expected
15.4.3 Validate the values of the Job Template attributes......167 position ..............................................163
15.4.4 Check for conflicting Job Template attributes values....171 16.3.4.3 Validate the presence of a single occurrence of
15.4.5 Decide whether to REJECT the request....................172 required Operation attributes .........................164
15.4.6 For the Validate-Job operation, RETURN one of the 16.3.5 Validate the values of the REQUIRED Operation attributes .169
success status codes....................................172 16.3.6 Validate the values of the OPTIONAL Operation attributes .172
15.4.7 Create the Job object with attributes to support........173 16.4 Suggested Additional Processing Steps for Operations that
15.4.8 Return one of the success status codes..................174 Create/Validate Jobs and Add Documents .....................175
15.4.9 Accept appended Document Content........................175 16.4.1 Default "ipp-attribute-fidelity" if not supplied .........175
15.4.10 Scheduling and Starting to Process the Job..............175 16.4.2 Check that the Printer object is accepting jobs ..........175
15.4.11 Completing the Job......................................175 16.4.3 Validate the values of the Job Template attributes .......175
15.4.12 Destroying the Job after completion.....................175 16.4.4 Check for conflicting Job Template attributes values .....180
15.4.13 Interaction with "ipp-attribute-fidelity"...............176 16.4.5 Decide whether to REJECT the request .....................181
15.5 Using Job Template Attributes During Document Processing.....176 16.4.6 For the Validate-Job operation, RETURN one of the
16. APPENDIX E: Generic Directory Schema .........................178 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
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:
Requirements 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] Printing Protocol [IPP-RAT] (informational)
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: Protocol Specification [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 Anyone reading this document for the first time is strongly encouraged
to read the IPP documents in the following order: to read the IPP documents in the following order:
1. The requirements document, "Requirements for an Internet 1. The design goals document, "Design Goals for an Internet
Printing Protocol". That document takes a broad look at Printing Protocol". That document takes a broad look at
distributed printing functionality, and it enumerates real-life distributed printing functionality, and it enumerates real-life
scenarios that help to clarify the features that need to be scenarios that help to clarify the features that need to be
included in a printing protocol for the Internet. It identifies included in a printing protocol for the Internet. It identifies
requirements for three types of users: end users, operators, and requirements for three types of users: end users, operators, and
administrators. The requirements document calls out a subset of administrators. The design goals document calls out a subset of
end user requirements that MUST be satisfied in IPP/1.0. end user requirements that are satisfied in IPP/1.0. Operator
Operator and administrator requirements are out of scope for and administrator requirements are out of scope for version 1.0.
version 1.0.
2. The rationale document, "Rationale for the Structure and Model 2. The rationale document, "Rationale for the Structure and Model
and Protocol for the Internet Printing Protocol". That document and Protocol for the Internet Printing Protocol". That document
describes IPP from a high level view, defines a roadmap for the describes IPP from a high level view, defines a roadmap for the
various documents that form the suite of IPP specifications, and various documents that form the suite of IPP specifications, and
Expires July 16, 1998
gives background and rationale for the IETF working group's major gives background and rationale for the IETF working group's major
decisions. decisions.
3. This document, the "Internet Printing Protocol/1.0: Model and 3. This document, the "Internet Printing Protocol/1.0: Model and
Semantics" document. It describes a simplified model with Semantics" document. This document describes a simplified model
abstract objects, their attributes, and their operations. The with abstract objects, their attributes, and their operations.
model introduces a Printer and a Job. The Job supports multiple The model introduces a Printer and a Job. A Job optionally
documents per Job. The model document also addresses how supports multiple documents per Job. The model document also
security, internationalization, and directory issues are describes how security, internationalization, and directory
addressed. issues are addressed.
4. The protocol specification, " Internet Printing Protocol/1.0: 4. The protocol specification, " Internet Printing Protocol/1.0:
Protocol Specification". That document is a formal mapping of Encoding and Transport". That document defines the encoding
the abstract operations and attributes defined in the model rules for a new Internet media type called "application/ipp" and
document onto HTTP/1.1. The protocol specification defines the shows a formal mapping of the abstract operations and attributes
encoding rules for a new Internet media type called defined in the model document onto HTTP/1.1.
"application/ipp".
Expires December 30, 1998
The LPD mapping document, "Mapping between LPD and IPP Protocols", is
an informational document that recommends a mapping between the
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 in the model and their - Section 2 introduces the object types covered in the model with
basic behaviors, attributes, and interactions. their basic behaviors, attributes, and interactions.
- Section 3 defines the operations supported by 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 a both request and a response. is 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 in the model. used in the model.
- Sections 5 - 6 summarizes the implementation conformance - Sections 5 - 6 summarizes the implementation conformance
requirements for objects that support the protocol and IANA requirements for objects that support the protocol and IANA
considerations, respectively. considerations, respectively.
- Sections 7 - 11 cover the Internationalization and Security - Sections 7 - 11 cover the Internationalization and Security
considerations as well as References, Copyright Notice, and considerations as well as References, Copyright Notice, and
Author contact information. Author contact information.
- Sections 12 - 14 are appendices that cover Terminology, Status - Sections 12 - 14 are appendices that cover Terminology, Status
Codes and Messages, and "media" keyword values. This document Codes and Messages, and "media" keyword values. This document
uses terms such as "attributes", "keywords", and "support". uses terms such as "attributes", "keywords", and "support".
These terms have special meaning and are defined in the model These terms have special meaning and are defined in the model
terminology section. Capitalized terms such as MANDATORY, SHALL, terminology section. Capitalized terms, such as MUST and
and OPTIONAL have special meaning relating to conformance. These OPTIONAL, have special meaning relating to conformance. These
terms are defined in the section on conformance terminology, most terms are defined in the section on conformance terminology, most
of which is taken from RFC 2119 [RFC2119]. of which is taken from RFC 2119 [RFC2119].
- Section 15 is an appendix that defines the rules and suggested - Section 15 is an appendix that defines the rules and suggested
techniques for the processing of attributes in client requests by techniques for the processing of attributes in client requests by
IPP objects. This section helps to clarify the affects of IPP objects. This section 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 a subset of Printer - Section 16 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 are useful when registering a Printer so that a client attributes are useful when registering a Printer so that a client
Expires July 16, 1998
can find the Printer not just by name, but by filtered searches can find the Printer not just by name, but by filtered searches
as well. as well.
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 complex "n-tier" client/server systems. An important simplifying be complex "n-tier" client/server systems. An important simplifying
step in the IPP model is to expose only the key objects and interfaces step in the IPP model is to expose only the key objects and interfaces
required for printing. The model described in this model document required for printing. The model described in this model document
does not include features, interfaces, and relationships that are does not include features, interfaces, and relationships that are
beyond the scope of the first version of IPP (IPP/1.0). IPP/1.0 beyond the scope of the first version of IPP (IPP/1.0). IPP/1.0
incorporates many of the relevant ideas and lessons learned from other incorporates many of the relevant ideas and lessons learned from other
skipping to change at page 11, line 5 skipping to change at page 12, line 5
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 attributes (see section 4). and 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 July 16, 1998 Expires December 30, 1998
+--------------+ +--------------+
| 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 11, line 41 skipping to change at page 12, line 41
| --+ | --+
+-----------------+ +-----------------+
| Output Device(s)| | Output Device(s)|
+-----------------+ +-----------------+
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 16). 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, etc.. The more dynamic information is directly capabilities, etc. The more dynamic information, such as state,
associated with the Printer object itself (as compared to the entry in currently loaded and ready media, number of jobs at the Printer,
the directory which only represents the Printer object). This more errors, warnings, and so forth, is directly associated with the
dynamic information includes state, currently loaded and ready media, Printer object itself rather than with the entry in the directory
number of jobs at the Printer, errors, warnings, and so forth. which only represents the Printer object.
IPP clients implement the IPP protocol on the client side, and give IPP clients implement the IPP protocol on the client side and give end
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
Expires July 16, 1998 Expires December 30, 1998
query Printer objects and submit and manage print jobs. An IPP server query Printer objects and submit and manage print jobs. An IPP server
is just that part of the Printer object that implements the server- is just that part of the Printer object that implements the server-
side protocol. The rest of the Printer object implements (or gateways side protocol. The rest of the Printer object implements (or gateways
into) the application semantics of the print service itself. The into) the application semantics of the print service itself. The
Printer objects may be embedded in an output device or may be Printer objects may be embedded in an output device or may be
implemented on a host on the network that communicates with the output implemented on a host on the network that communicates with an output
device. 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 object to query its status and monitor the progress of the job. Job object to query its status and monitor the progress of the job.
End users may also cancel the print job by using the Job object's End users may also cancel the print job by using the Job object's
Cancel-Job operation. The notification service(s) are out of scope Cancel-Job operation. The notification service is out of scope for
for IPP/1.0, but using such a notification service, the end user is IPP/1.0, but using such a notification service, the end user is able
able to register for and receive Printer specific and Job specific to register for and receive Printer specific and Job specific events.
events. An end user can query the status of Printer objects and can An end user can query the status of Printer objects and can follow the
follow the progress of Job objects by polling using the Get-Printer- progress of Job objects by polling using the Get-Printer-Attributes,
Attributes, Get-Jobs, and Get-Job-Attributes operations. Get-Jobs, and Get-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 of object models relevant aspects of a real-world entity such as type of object models relevant aspects of a real-world entity such as
a real printer or real print job. Each object type is defined as a a real printer or real print job. Each object type is defined as a
set of possible attributes that may be supported by instances of that set of possible attributes that may be supported by instances of that
object type. For each object (instance), the actual set of supported object type. For each object (instance), the actual set of supported
attributes and values describe a specific implementation. The attributes and values describe a specific implementation. The
object's attributes and values describe its state, capabilities, object's attributes and values describe its state, capabilities,
realizable features, job processing functions, and default behaviors realizable features, job processing functions, and default behaviors
and characteristics. For example, the Printer object type is defined and characteristics. For example, the Printer object type is defined
as a set of attributes that each Printer object potentially supports. as a set of attributes that each Printer object potentially supports.
In the same manner, the Job object type is defined as a set of In the same manner, the Job object type is defined as a set of
attributes that are potentially supported by each Job object. attributes that are potentially supported by each Job object.
Each attribute included in the set of attributes defining an object Each attribute included in the set of attributes defining an object
type is labeled as: type is labeled as:
- "MANDATORY": each object SHALL support the attribute. - "REQUIRED": each object MUST support the attribute.
- "OPTIONAL": each object OPTIONALLY supports 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 July 16, 1998 Expires December 30, 1998
2.1 Printer Object 2.1 Printer Object
A 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 IPP/1.0 protocol. Using the protocol, Printer object implements the server-side of the IPP/1.0 protocol.
end users may query the attributes of the Printer object and submit Using the protocol, end users may query the attributes of the Printer
print jobs to the Printer object. The actual implementation object and submit print jobs to the Printer object. The actual
components behind the Printer abstraction may take on different forms implementation components behind the Printer abstraction may take on
and different configurations. However, the model abstraction allows different forms and different configurations. However, the model
the details of the configuration of real components to remain opaque abstraction allows the details of the configuration of real components
to the end user. Section 3 describes each of the Printer operations to remain opaque to the end user. Section 3 describes each of the
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 - "job-template" attributes: These attributes describe supported
job processing capabilities and defaults for the Printer object. job processing capabilities and defaults for the Printer object.
(See section 4.2) (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 Printer object, such as a fax device, an imager, or even a CD the 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 might or might not be capable 3a) The associated output devices may or may not be capable of
of spooling jobs spooling jobs
3b) The associated output devices might or might 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 configuration 3. fan-out figures below represent configurations 3a and 3b.
Expires July 16, 1998 Expires December 30, 1998
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 5 skipping to change at page 16, line 5
########### 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 can contain one or
more documents. The information required to create a Job object is more documents. The information required to create a Job object is
Expires July 16, 1998 Expires December 30, 1998
sent in a create request from the end user via an IPP Client to the sent in a create request from the end user via an IPP Client to the
Printer object. The Printer object validates the create request, and Printer object. The Printer object validates the create request, and
if the Printer object accepts the request, the Printer object creates if the Printer object accepts the request, the Printer object creates
the new Job object. Section 3 describes each of the Job operations in the new Job object. Section 3 describes each of the Job operations in
detail. 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 are OPTIONALLY - "job-template" attributes: These attributes can be supplied by
supplied by the client or end user and include job processing the client or end user and include job processing instructions
instructions which are intended to override any Printer object which are intended to override any Printer object defaults and/or
defaults and/or instructions embedded within the document data. instructions embedded within the document data. (See section 4.2)
(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 of these attributes, and the Printer object generates some of these attributes, and the Printer object generates
others. (See section 4.3) others. (See section 4.3)
A Job object contains at least one document, but may contain multiple A Job object contains at least one document, but may contain multiple
documents. A document consists of either: documents. 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 no object identifier or associated attributes. All job processing has 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 called Job Template attributes and they apply equally to all are called Job Template attributes and they apply equally to all
documents within a Job object. documents within a Job object.
2.3 Object Relationships 2.3 Object Relationships
IPP objects have relationships that MUST be maintained persistently IPP objects have relationships that are maintained persistently along
along with the persistent storage of the object attributes. with the persistent storage of the object attributes.
A Printer object MAY represent one or more output devices. A Printer A Printer object can represent either one or more physical output
object MAY represent a logical device which "processes" jobs but never devices or a logical device which "processes" jobs but never actually
actually uses a physical output device to put marks on paper (for uses a physical output device to put marks on paper. Examples of
example a Web page publisher or an interface into an online document logical devices include a Web page publisher or a gateway into an
archive or repository). A Printer object contains zero or more Job online document archive or repository. A Printer object contains zero
objects. or more Job objects.
A Job object is contained by exactly one Printer object, however the A Job object is contained by exactly one Printer object, however the
identical document data associated with a Job object could be sent to identical document data associated with a Job object could be sent to
either the same or a different Printer object. In this case, a new 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
Expires July 16, 1998 Expires December 30, 1998
Job object would be created which would be almost identical to the first Job object, however it would have new (different) Job object
existing Job object, however it would have new (different) Job object
identifiers (see section 2.4). identifiers (see section 2.4).
A Job object contains one or more documents. If the contained A Job object contains one or more documents. If the contained
document is a stream of document data, that stream can be contained in document is a stream of document data, that stream can be contained in
only one document. However, there can be copies of the stream in only one document. However, there can be identical copies of the
other documents in the same or different Job objects. If the stream in other documents in the same or different Job objects. If
contained document is a reference to a stream of document data, other the contained document is just a reference to a stream of document
documents (in the same or different Job object(s)) may reference the data, other documents (in the same or different Job object(s)) may
same stream. contain the same reference.
2.4 Object Identity 2.4 Object Identity
All Printer and Job objects are identified by an identifier so that All Printer and Job objects are identified by a Uniform Resource
they can be persistently and unambiguously referenced. The IPP/1.0 Identifier (URI) [RFC1630] so that they can be persistently and
model requires that these identifiers be Uniform Resource Identifiers unambiguously referenced. The notion of a URI is a useful concept,
(URIs) [RFC1630]. Often, the URI is a URL [RFC1738] [RFC1808]. however, until the notion of URI is more stable (i.e., defined more
completely and deployed more widely), it is expected that the URIs
An administrators configure Printer objects to either support or not used for IPP objects will actually be URLs [RFC1738] [RFC1808]. Since
support authentication and/or message privacy using TLS [TLS] and every URL is a specialized form of a URI, even though the more generic
other security mechanisms via a single communication channel that has term URI is used throughout the rest of this document, its usage is
some sort of negotiation mechanism or multiple communication channels, intended to cover the more specific notion of URL as well.
one for each type of security configuration. The mechanism for such
configuration is outside the scope of IPP/1.0. Section 8 provides a
full description of all security considerations. However, it must be
mentioned here that if a Printer object supports more than one
communication channel, some or all of those channels might support
and/or require different security mechanisms. In such cases, an
administrator could expose the simultaneous support for these multiple
communication channels as:
- A single URI for the Printer object over which clients and An administrator configures Printer objects to either support or not
Printer objects negotiate to determine a mutually agreeable support authentication and/or message privacy using TLS [TLS] (the
security mechanism (if any), or mechanism for security configuration is outside the scope of IPP/1.0).
- Multiple URIs for the Printer object where each URI represents In some situations, both types of connections (both authenticated and
each of the communication channels to the Printer object (each unauthenticated) can be established using a single communication
with possibly different security characteristics and channel that has some sort of negotiation mechanism. In other
configurations). situations, multiple communication channels are used, one for each
type of security configuration. Section 8 provides a full description
of all security considerations and configurations. ,
To support this flexibility, the IPP Printer object type defines a If a Printer object supports more than one communication channel, some
multi-valued identification attribute called the "printer-uri- or all of those channels might support and/or require different
supported" attribute. It MUST contain at least one URI. It MAY security mechanisms. In such cases, an administrator could expose the
contain more than one URI. That is, every Printer object will have at simultaneous support for these multiple communication channels as
least one URI which identifies it, but it may have more than one URI multiple URIs for a single Printer object where each URI represents
where each URI identifies a different communication channel to the one of the communication channels to the Printer object. To support
Printer. The "printer-uri-supported" attribute has a companion this flexibility, the IPP Printer object type defines a multi-valued
identification attribute called the "printer-uri-supported" attribute.
It MUST contain at least one URI. It MAY contain more than one URI.
That is, every Printer object will have at least one URI that
identifies at least one communication channel to the Printer object,
but it may have more than one URI where each URI identifies a
different communication channel to the Printer object. The "printer-
uri-supported" attribute has a companion attribute, the "uri-security-
Expires July 16, 1998 Expires December 30, 1998
attribute, the "uri-security-supported" attribute, that has the same supported" attribute, that has the same cardinality as "printer-uri-
cardinality as "printer-uri-supported". The purpose of the "uri- supported". The purpose of the "uri-security-supported" attribute is
security-supported" attribute is to indicate the security mechanisms to indicate the security mechanisms (if any) used for each URI listed
(if any) used for each URI listed in "printer-uri-supported". These in "printer-uri-supported". These two attributes are fully described
two attributes are fully described in sections 4.4.1 and 4.4.2. in 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 client MUST supply only a single Printer object URI. The client the client supplies only a single Printer object URI. The client
supplied Printer object URI MUST be one of the values in the "printer- supplied Printer object URI MUST be one of the values in the "printer-
uri-supported" Printer attribute. uri-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 as an entry in a directory service. End-users and programs registered as an entry in a directory service. End-users and programs
can then interrogate the directory searching for Printers. Section 16 can then interrogate the directory searching for Printers. Section 17
defines a generic schema for Printer object entries in the directory defines a generic schema for Printer object entries in the directory
service and describes how the entry acts as a bridge to the actual IPP service and describes how the entry acts as a bridge to the actual IPP
Printer object. The entry in the directory that represents the IPP Printer object. The entry in the directory that represents the IPP
Printer object includes the possibly many URIs for that Printer object Printer object includes the possibly many URIs for that Printer object
values of one its attributes. 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 Printer object assigns the new Job object a URI which is stored in The Printer object assigns the new Job object a URI which is stored in
the "job-uri" Job attribute. This URI is then used by clients as the the "job-uri" Job attribute. This URI is then used by clients as the
target for subsequent Job operations. The Printer object generates a target for subsequent Job operations. The Printer object generates a
Job URI based on its configured security policy and the URI used by Job URI based on its configured security policy and the URI used by
the client in the create request (if there is more than one URI for the client in the create request.
the Printer object).
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 SSL3 (using an "https" communication channel secured by the use of TLS (using a standard URI
schemed URI) and another open communication channel that is not indicating the use of HTTP over TLS) and another open communication
secured with SSL3 (using an simple "http" schemed URI). If a channel that is not secured with TLS (using an simple "http" schemed
client were to submit a job using the secure URI, the Printer URI). If a client were to submit a job using the secure URI, the
object would assign the new Job object a secure URI as well. If a Printer object would assign the new Job object a secure URI as well.
client were to submit a job using the open-channel URI, the Printer If a client were to submit a job using the open-channel URI, the
would assign the new Job object an open-channel URI. Printer would assign the new Job object an open-channel URI.
In addition, the Printer object also fills in 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 that created the Job object. If a client only has access to a object that created the Job object. If a client only has access to a
Job object's "job-uri" identifier, the client can query the "job- Job object's "job-uri" identifier, the client can query the Job's
printer-uri" attribute in order to determine which Printer object "job-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 populate the "job-printer-uri" attribute. creating the job to build the value for and to populate the Job's
"job-printer-uri" attribute.
Expires July 16, 1998 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 (the URI used by the submitting composition of the Printer's URI and some unique component for the Job
client if the Printer object supports more than one URI) and some object, such as the unique 32-bit positive integer mentioned later in
unique component for the Job object, such as the unique 32-bit this paragraph. In other implementations, the Printer object might be
positive integer mentioned later in this paragraph. In other a central clearing-house for validating all Job object creation
implementations, the Printer object might be a central clearing-house requests, but the Job object itself might be created in some
for validating all Job object creation requests, and the Job object environment that is remote from the Printer object. In this case, the
itself might be created in some environment that is remote from the Job object's URI may have no physical-location relationship at all to
Printer object. In this case, the Job object's URI may have no the Printer object's URI. Again, the fact that Job objects have URIs
physical-location relationship at all to the Printer object's URI. allows for flexibility and scalability, however, many existing
Again, this allows for flexibility and scalability, however, many printing systems have local models or interface constraints that force
existing printing systems have local models or interface constraints print jobs to be identified using only a 32-bit positive integer
that force print jobs to be identified using only a 32-bit positive rather than an independent URI. This numeric Job ID is only unique
integer rather than a URI. This numeric Job ID is only unique within within the context of the Printer object to which the create request
the context of the Printer object to which the create request was was originally submitted. Therefore, in order to allow both types of
originally submitted. Therefore, in order to allow both types of
client access to IPP Job objects (either by Job URI or by numeric Job client access to IPP Job objects (either by Job URI or by numeric Job
ID), when the Printer object successfully processes a create request ID), when the Printer object successfully processes a create request
and creates a new Job object, the Printer object SHALL generate both a and creates a new Job object, the Printer object MUST generate both a
Job URI and a Job ID. The Job ID (stored in the "job-id" attribute) Job URI and a Job ID. The Job ID (stored in the "job-id" attribute)
only has meaning in the context of the Printer object to which the only has meaning in the context of the Printer object to which the
create request was originally submitted. This requirement to support create request was originally submitted. This requirement to support
both Job URIs and Job IDs allows all types of clients to access both Job URIs and Job IDs allows all types of clients to access
Printer objects and Job objects no matter the local constraints Printer objects and Job objects no matter the local constraints
imposed on the client implementation. imposed on the client implementation.
In addition to identifiers, Printer objects and Job objects have In addition to identifiers, Printer objects and Job objects have names
names. An object name need not be unique across all instances of all ("printer-name" and "job-name"). An object name NEED NOT be unique
objects. A Printer object's name is chosen and set by an administrator across all instances of all objects. A Printer object's name is chosen
through some mechanism outside the scope of IPP/1.0. A Job object's and set by an administrator through some mechanism outside the scope
name is optionally chosen and supplied by the IPP client submitting of IPP/1.0. A Job object's name is optionally chosen and supplied by
the job. If the client does not supply a Job object name, the Printer the IPP client submitting the job. If the client does not supply a
object generates a name for the new Job object. In all cases, the Job object name, the Printer object generates a name for the new Job
name only has local meaning; the name is not constrained to be unique. object. In all cases, the name only has local meaning.
To summarize: To summarize:
- Each Printer object is identified with one or more URIs. The - Each Printer object is identified with one or more URIs. The
Printer's "printer-uri-supported" attribute contains the URI(s). Printer's "printer-uri-supported" attribute contains the URI(s).
- The Printer object's "uri-security-supported" attribute - The Printer object's "uri-security-supported" attribute
identifies the communication channel security protocols that may identifies the communication channel security protocols that may
or may not have been configured for various Printer object URIs or may not have been configured for the various Printer object
(e.g., 'tls' or 'none'). URIs (e.g., 'tls' 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" attribute contains the URI. uri" attribute contains the URI.
Expires July 16, 1998 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 (using one of its URIs) 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 when creating 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 for operations on charsets, and operations which are supported on that Job (the
that Job - the basis for such support comes from the creating basis for such support comes from the creating Printer object).
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 outside the scope of IPP/1.0 itself. The Printer mechanism outside the scope of IPP/1.0 itself. The Printer
object's "printer-name" attribute contains the name. object's "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 client optionally supplies this name in the create request. The client optionally supplies this name in the create request.
If the client does not supply this name, the Printer object If the client does not supply this name, the Printer object
generates a name for the Job object. The Job object's "job-name" generates a name for the Job object. The Job object's "job-name"
attribute contains the name. attribute 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 a response. When a client communicates with an IPP object, the and a response. When a client communicates with an IPP object, the
client issues an operation request to the URI for that object. client issues an operation request to the URI for that object.
Operations have attributes that supply information about the operation Operation requests and responses have parameters that identify the
itself. These attributes are called operation attributes (as compared operation. Operations also have attributes that affect the run-time
to object attributes such as Printer object attributes or Job object characteristics of the operation (the intended target, localization
attributes). Each request carries along with it any operation information, etc.). These operation-specific attributes are called
attributes, object attributes, and/or document data required by the operation attributes (as compared to object attributes such as Printer
object to perform the operation. Each request requires a response object attributes or Job object attributes). Each request carries
from the object. Each response indicates success or failure of the along with it any operation attributes, object attributes, and/or
operation with a status code. The response contains any operation document data required to perform the operation. Each request
attributes, object attributes, and/or status messages generated by the requires a response from the object. Each response indicates success
execution of the operation request. or failure of the operation with a status 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 attributes and other data requests and responses, in terms of the parameters, attributes, and
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)
Expires July 16, 1998
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)
Cancel-Job (section 3.3.3) Cancel-Job (section 3.3.3)
Get-Job-Attributes (section 3.3.4) Get-Job-Attributes (section 3.3.4)
The Send-Document and Send-URI Job operations are used to add a new The Send-Document and Send-URI Job operations are used to add a new
document to an existing multi-document Job object created with the document to an existing multi-document Job object created using the
Create-Job operation. Create-Job operation.
3.1 Common Semantics 3.1 Common Semantics
The following sections describe the common elements and features of All IPP operations require some common parameters and operation
all IPP operations. Operations are always used in request/response attributes. These common elements and their semantic characteristics
pairs. are defined and described in more detail in the following sections.
3.1.1 Operation IDs and Request IDs 3.1.1 Required Parameters
Each IPP operation type is defined as one of the values of the Every operation request contains the following REQUIRED parameters:
"operations-supported" Printer attribute (see section 4.4.13). The
client specifies the operation by including an "operation-id"
attribute. . The "operation-id" is passed in every request and each
corresponding response. Each operation request also carries with it a
"request-id" attribute. This "request-id" attribute allows clients to
manage multiple outstanding requests. For each operation request, the
client chooses an integer (possibly unique depending on client
requirements) in the range from 1 to 2**31 - 1 (inclusive). The
receiving IPP object, copies the client supplied "request-id"
attribute into the response so that the client can match up the
correct response with the outstanding request. In some cases, the
transport protocol underneath IPP might be a connection oriented
protocol that would make it impossible for a client to receive
responses in any order other than the order in which the corresponding
requests were sent. In such cases, the "request-id" attribute would
not be essential for correct protocol operation, however, in other
mappings, the operation responses can come back in any order. In
these cases, the "request-id" would be essential.
Expires July 16, 1998 - a "version-number",
- an "operation-id",
- a "request-id", and
- the attributes that are REQUIRED for that type of request.
3.1.2 Attributes Every operation response contains the following REQUIRED parameters:
- a "version-number",
- a "status-code",
- the "request-id" that was supplied in the corresponding request,
and
- the attributes that are REQUIRED for that type of response.
The encoding and transport document [IPP-PRO] defines special rules
for the encoding of these parameters. All other operation elements
are represented using the more generic encoding rules for attributes
and groups of attributes.
Expires December 30, 1998
3.1.2 Operation IDs and Request IDs
Each IPP operation request includes an identifying "operation-id"
value. Valid values are defined in the "operations-supported" Printer
attribute section (see section 4.4.13). The client specifies which
operation is being requested by supplying the correct "operation-id"
value.
In addition, every invocation of an operation is identified by a
"request-id" value. For each request, the client chooses the "request-
id" which is an integer (possibly unique depending on client
requirements) in the range from 1 to 2**31 - 1 (inclusive). This
"request-id" allows clients to manage multiple outstanding requests.
The receiving IPP object copies the client supplied "request-id"
attribute into the response so that the client can match the response
with the correct outstanding request.
Note: In some cases, the transport protocol underneath IPP might be a
connection oriented protocol that would make it impossible for a
client to receive responses in any order other than the order in which
the corresponding requests were sent. In such cases, the "request-id"
attribute would not be essential for correct protocol operation.
However, in other mappings, the operation responses can come back in
any order. In these cases, the "request-id" would be essential.
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 and affect the IPP object's behavior while processing operation and affect the IPP object's behavior while processing
the operation request and MAY affect other attributes or groups the operation request and may affect other attributes or groups
of attributes. Some operation attributes describe the document of attributes. Some operation attributes describe the document
data associated with the print job and are associated with new data associated with the print job and are associated with new
Job objects, however most operation attributes do not persist Job objects, however most operation attributes do not persist
beyond the life of the operation. The description of each beyond the life of the operation. The description of each
operation attribute includes conformance statements indicating operation attribute includes conformance statements indicating
which operation attributes are MANDATORY and which are OPTIONAL which operation attributes are REQUIRED and which are OPTIONAL
for an IPP object to support and which attributes a client MUST for an IPP object to support and which attributes a client MUST
supply in a request and an IPP object MUST supply in a response. supply in a request and an IPP object MUST supply in a response.
- Job Template Attributes: These attributes affect the processing - Job Template Attributes: These attributes affect the processing
of a job. A client OPTIONALLY supplies Job Template Attributes of a job. A client OPTIONALLY supplies Job Template Attributes
in a create request, and the receiving object MUST be prepared to 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 of job processing capabilities are supported and/or what the type 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 15 for a client-supplied Job Template attributes (see section 16 for a
full description of "ipp-attribute-fidelity" and its relationship full description of "ipp-attribute-fidelity" and its relationship
to other attributes). to other attributes).
- Job Object Attributes: These attributes are returned in response - Job Object Attributes: These attributes are returned in response
to a query operation directed at a Job object. to 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 set of Operation and Job Template attributes. If any of these a set of Operation and Job Template attributes. If any of these
attributes or their values are 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 response. Section 15 gives a full description of how Job the response. Section 16 gives a full description of how Job
Template attributes supplied by the client in a create request Template attributes supplied by the client in a create request
are processed by the Printer object and how unsupported are processed by the Printer object and how unsupported
attributes are returned to the client. Because of extensibility, attributes are returned to the client. Because of extensibility,
any IPP object might receive a request that contains new (or for any IPP object might receive a request that contains new or
any reason unknown) attributes or values that it does not unknown attributes or values for which it has no support. In such
support. In such cases for any operation request (not just cases, the IPP object processes what it can and returns the
create requests), the IPP object MUST return these unsupported unsupported attributes in the response.
attributes.
Expires July 16, 1998
Later in this section, each operation is formally defined by Later in this section, each operation is formally defined by
identifying the allowed and expected groups of attributes for each identifying the allowed and expected groups of attributes for each
request and response. The model identifies a specific order for each request and response. The model identifies a specific order for each
group in each request or response, but the attributes within each group in each request or response, but the attributes within each
group may be in any order, unless specified otherwise. group may be in any 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,
the 'integer' attributes are followed by the allowed range in each 'integer' attribute is followed by the allowed range in
parenthesizes, (m:n), for the integer value. The 'text' and 'name' parentheses, (m:n), for values of that attribute. Each 'text' or
attributes are followed by the (size) in octets in parenthesizes. For 'name' attribute is followed by the maximum size in octets in
more details on attribute syntax notation, see the descriptions of parentheses, (size), for values of that attribute. For more details on
these attributes syntaxes in section 4.1. It is an operation error attribute syntax notation, see the descriptions of these attributes
for clients to supply in operation requests and/or IPP objects to syntaxes in section 4.1.
returns in operations responses attribute value(s) that do not match
the syntax(es) defined for that attribute (see section 3 for operation
attributes and section 4 for IPP object attributes).
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 within an operation request are Print-Job and Send-Document. data within an operation request are Print-Job and Send-Document.
There are no operation responses that include document data. There are no operation responses that include document data.
Note: Some operations are MANDATORY for IPP objects to support; the Expires December 30, 1998
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 MANDATORY Get- OPTIONAL operation, a client SHOULD first use the REQUIRED Get-
Printer-Attributes operation to query the Printer's "operations- Printer-Attributes operation to query the Printer's "operations-
supported" attribute in order to determine which OPTIONAL Printer and supported" attribute in order to determine which OPTIONAL Printer and
Job operations are actually supported. The client SHOULD NOT use an Job operations are actually supported. The client SHOULD NOT use an
OPTIONAL operation that is not supported. When an IPP object OPTIONAL operation that is not supported. When an IPP object receives
receives a request to perform an operation it does not support, it a request to perform an operation it does not support, it returns the
returns the 'server-error-operation-not-supported' status code (see 'server-error-operation-not-supported' status code (see section
section 13.1.5.2). An IPP object is non-conformant if it does not 14.1.5.2). An IPP object is non-conformant if it does not support a
support a MANDATORY operation. REQUIRED operation.
3.1.3 Operation Targets
All IPP operations are directed at IPP objects. For Printer
operations, the operation is always directed at a Printer object using
one of its URIs (i.e., one of the values in the Printer object's
"printer-uri-supported" attribute). Even if the Printer object
supports more than 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" operation attribute.
Expires July 16, 1998
For Job operations, the operation is directed at either:
- The Job object itself using the Job object's URI. In this case,
the client identifies the target object by supplying the correct
URI in the "job-uri" operation attribute.
- The Printer object that created the Job object using both the
Printer objects URI and the Job object's Job ID. Since the
Printer object that created the Job object generated the Job ID,
it MUST be able to correctly associate the client supplied Job ID
with the correct Job object. The client supplies the Printer
object's URI in the "printer-uri" operation attribute and the Job
object's Job ID in the "job-id" operation attribute.
If the operation is directed at the Job object directly using the Job
object's URI, the client SHALL NOT include the redundant "job-id"
operation attribute.
The operation target is a MANDATORY operation attribute that MUST be
included in every operation request.
The following rules apply to the use of port numbers in URIs that
identify IPP objects:
1. If the protocol scheme for the URI allows the port number to be
explicitly included in the URI string, and an explicit port
number is specified within the syntax of the URI, then that port
number MUST be used by the client to contact the IPP object.
2. If the protocol scheme for the URI does not allow an explicit
port number specification, then the default port number for the
protocol MUST be used.
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 (see the 'text' and 'name' attribute syntax descriptions understanding (see the 'text' and 'name' attribute syntax descriptions
in section 4.1). The following sections describe two MANDATORY in section 4.1). The following sections describe two special
operation attributes for every IPP request and response. These Operation Attributes called "attributes-charset" and "attributes-
attributes are "attributes-charset" and "attributes-natural-language" natural-language". These attributes are always part of the Operation
which SHALL be stored as Job Description attributes. For the sake of Attributes group. For most attribute groups, the order of the
brevity in this document, these operation attribute descriptions are attributes within the group is not important. However, for these two
not repeated with every operation request and response, but have a attributes within the Operation Attributes group, the order is
reference back to this section instead. critical. The "attributes-charset" attribute MUST be the first
attribute in the group and the "attributes-natural-language" attribute
Expires July 16, 1998 MUST be the second attribute in the group. In other words, these
attributes MUST be supplied in every IPP request and response, they
MUST come first in the group, and MUST come in the specified order.
For job creation operations, the IPP Printer implementation saves
these two attributes with the new Job object as Job Description
attributes. For the sake of brevity in this document, these operation
attribute descriptions are not repeated with every operation request
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 SHALL supply and the Printer object SHALL support the The client MUST supply and the Printer object MUST support the
following MANDATORY operation attributes in every IPP/1.0 operation following 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 SHALL use (if supported) for the charset that the Printer object MUST use (if supported) for
all 'text' and 'name' attributes and status messages that the all 'text' and 'name' attributes and status messages that the
Expires December 30, 1998
Printer object returns in the response to this request. See 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 Sections 4.1.1 and 4.1.2 for the specification of the 'text' and
'name' attribute syntaxes. 'name' attribute syntaxes.
All IPP objects SHALL support the 'utf-8' charset [RFC2044] and All IPP objects MUST support the 'utf-8' charset [RFC2044] and
MAY support additional charsets provided that they are registered MAY support additional charsets provided that they are registered
with IANA [IANA-CS]. If the Printer object does not support the with IANA [IANA-CS]. If the Printer object does not support the
client supplied charset value, the Printer object SHALL reject client supplied charset value, the Printer object MUST reject the
the request and return the 'client-error-charset-not-supported' request and return the 'client-error-charset-not-supported'
status code. The Printer object SHALL indicate the charset(s) status code. The Printer object MUST indicate the charset(s)
supported as the values of the "charset-supported" Printer supported as the values of the "charset-supported" Printer
attribute (see Section 4.4.15), so that the client MAY query attribute (see Section 4.4.15), so that the client can query to
which charset(s) are supported. 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 support the 'utf-8' charset, in order to maximize to support the 'utf-8' charset, in order to maximize
interoperability with multiple IPP object implementations, a interoperability with multiple IPP object implementations, a
client may want to supply 'utf-8' in the "attributes-charset" client may want to supply 'utf-8' in the "attributes-charset"
operation attribute, even though the client is only passing and operation attribute, even though the client is only passing and
able to present a simpler charset, such as US-ASCII or ISO-8859- able to present a simpler charset, such as US-ASCII or ISO-8859-
1. Then the client will have to filter out (or charset convert) 1. Then the client will have to filter out (or charset convert)
those characters that are returned in the response that it cannot those characters that are returned in the response that it cannot
present to its user. On the other hand, if both the client and present to its user. On the other hand, if both the client and
the IPP objects also support a charset in common besides utf-8, the IPP objects also support a charset in common besides utf-8,
the client MAY want to use that charset in order to avoid charset the client may want to 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.9 See the 'charset' attribute syntax description in Section 4.1.7
for the syntax and semantic interpretation of the values of this for 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 that the Printer object SHOULD use for all 'text' and language that the Printer object SHOULD use for all 'text' and
Expires July 16, 1998
'name' attributes and status messages that the Printer object 'name' attributes and status messages that the Printer object
returns in the response to this request. returns in the response to this request.
There are no MANDATORY 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 SHALL identify 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 MAY query this attribute to determine which natural client MAY query this attribute to determine which natural
language(s) are supported for generated messages. language(s) are 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.5), the Printer object SHALL and status messages (see Section 3.1.6), the Printer object MUST
be able to generate these text strings in any of its supported be able to generate these text strings in any of its supported
natural languages. If the client requests a natural language natural languages. If the client requests a natural language
that is not supported, the Printer object SHALL return these that is not supported, the Printer object MUST return these
generated messages in the Printer's configured natural language generated messages in the Printer's configured natural language
as specified by the Printer's "natural-language-configured" as specified by the Printer's "natural-language-configured"
attribute" (see Section 4.4.16). attribute" (see Section 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), "printer-location" (text), "printer-info" (text), name" (name), "printer-location" (text), "printer-info" (text),
and "printer-make-and-model" (text), the Printer object is only and "printer-make-and-model" (text)), the Printer object is only
required to support the configured natural language of the required to support the configured natural language of the
Printer identified by the Printer object's "natural-language- Printer identified by the Printer object's "natural-language-
configured" attribute, though support of additional natural configured" attribute, though support of additional natural
languages for these attributes is permitted. 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 SHALL use the Natural "attributes-natural-language", the client MUST use the Natural
Language Override mechanism (see sections 4.1.2 and 4.1.4) for Language Override mechanism (see sections 4.1.1.2 and 4.1.2.2)
each such attribute value supplied. for each such attribute value supplied.
The IPP object SHALL 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 the Printer object's "generated-natural-language-supported" in the Printer object's "generated-natural-language-supported"
attribute. That attribute, "generated-natural-language- attribute. That attribute, "generated-natural-language-
supported", only applies to generated messages, not client supported", only applies to generated messages, not client
supplied messages. The IPP object SHALL remember that natural supplied messages. The IPP object MUST remember that natural
language for all client supplied attributes, and when returning language for all client-supplied attributes, and when returning
those attributes in response to a query, the IPP object MUST
Expires July 16, 1998
those attributes in response to a query, the IPP object SHALL
indicate that natural language. indicate that natural language.
For example, the "job-name" attribute MAY be supplied by the For example, the "job-name" attribute MAY be supplied by the
client in a create request. The text value for this attribute client in a create request. The text value for this attribute
will be in the natural language identified by the "attribute- will be in the natural language identified by the "attribute-
natural-language" attribute, or if different, as identified by natural-language" attribute, or if different, as identified by
the Natural Language Override mechanism. If supplied, the IPP the Natural Language Override mechanism. If supplied, the IPP
object will use the value of the "job-name" attribute to populate object will use the value of the "job-name" attribute to populate
the Job object's "job-name" attribute. Whenever any client the Job object's "job-name" attribute. Whenever any client
queries the Job object's "job-name" attribute, the IPP object queries the Job object's "job-name" attribute, the IPP object
returns the attribute as stored and uses the Natural Language returns the attribute as stored and uses the Natural Language
Expires December 30, 1998
Override mechanism to specify the natural language, if it is Override mechanism to specify the natural language, if it is
different from that reported in the "attributes-natural-language" different from that reported in the "attributes-natural-language"
operation attribute of the response. An IPP object SHALL NOT operation attribute of the response. An IPP object MUST NOT
reject a request based on a supplied natural language in an reject a request based on a supplied natural language in an
"attributes-natural-language" Operation attribute or in any "attributes-natural-language" Operation attribute or in any
attribute that uses the Natural Language Override. 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.10 for the syntax and semantic interpretation of the values 4.1.8 for the syntax and semantic interpretation of the values of
of this attribute and for example values. this attribute and for example values.
Clients SHOULD NOT request an illegal combination of natural language Clients SHOULD NOT supply 'text' or 'name' attributes that use an
and charset. For example, suppose a Printer object supports charsets illegal combination of natural language and charset. For example,
'utf-8', 'iso-8859-1', and 'iso-8859-7'. Suppose it also supports suppose a Printer object supports charsets 'utf-8', 'iso-8859-1', and
natural languages 'en' (English), 'fr' (French), and 'el' (Greek). If 'iso-8859-7'. Suppose also, that it supports natural languages 'en'
the client requests 'iso-8859-1' and 'el', it is an invalid (English), 'fr' (French), and 'el' (Greek). Although the Printer
combination of charset and natural language. In this case, the IPP object supports the charset 'iso-8859-1' and natural language 'el', it
object SHALL NOT change either of these attribute values and SHALL probably does not support the combination of Greek text strings using
accept them as if they were valid. the 'iso-8859-1' charset. The Printer object handles this apparent
incompatibility differently depending on the context in which it
occurs:
- In a create request: If the client supplies a text or name
attribute (for example, the "job-name" operation attribute) that
uses an apparently incompatible combination, it is a client
choice that does not affect the Printer object or its correct
operation. Therefore, the Printer object simply accepts the
client supplied value, stores it with the Job object, and
responds back with the same combination whenever the client (or
any client) queries for that attribute.
-In a query-type operation, like Get-Printer-Attributes: If the
client requests an apparently incompatible combination, the
Printer object responds (as described in section 3.1.4.2) using
the Printer's configured natural language rather than the natural
language requested by the client.
In either case, the Printer object does not reject the request because
of the apparent incompatibility. The potential incompatible
combination of charset and natural language can occur either at the
global operation level or at the Natural Language Override attribute-
by-attribute level. In addition, since the response always includes
explicit charset and natural language information, there is never any
question or ambiguity 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 SHALL supply and the client SHALL support the The Printer object MUST supply and the client MUST support the
following MANDATORY operation attributes in every IPP/1.0 operation following REQUIRED operation attributes in every IPP/1.0 operation
response: response:
"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' and 'name' attributes that the Printer object is returning 'text' and 'name' attributes that the Printer object is returning
in this response. The value in this response SHALL be the same in this response. The value in this response MUST be the same
value as the "attributes-charset" operation attribute supplied by value as the "attributes-charset" operation attribute supplied by
the client in the request. If this is not possible (i.e., the the client in the request. If this is not possible (i.e., the
charset requested is not supported), the request SHALL be charset requested is not supported), the request would have been
rejected. See "attributes-charset" described in Section 3.1.4.1 rejected. See "attributes-charset" described in Section 3.1.4.1
above. above.
Expires July 16, 1998
If the Printer object supports more than just the 'utf-8' If the Printer object supports more than just the 'utf-8'
charset, the Printer object SHALL be able to code convert between charset, the Printer object MUST be able to code convert between
each of the charsets supported on a highest fidelity possible each of the charsets supported on a highest fidelity possible
basis in order to return the 'text' and 'name' attributes in the basis in order to return the 'text' and 'name' attributes in the
charset requested by the client. However, some information loss charset requested by the client. However, some information loss
MAY occur during the charset conversion depending on the charsets MAY occur during the charset conversion depending on the charsets
involved. For example, the Printer object may convert from a involved. For example, the Printer object may convert from a
UTF-8 'a' to a US-ASCII 'a' (with no loss of information), from UTF-8 'a' to a US-ASCII 'a' (with no loss of information), from
an ISO Latin 1 CAPITAL LETTER A WITH ACUTE ACCENT to US-ASCII 'A' an ISO Latin 1 CAPITAL LETTER A WITH ACUTE ACCENT to US-ASCII 'A'
(losing the accent), or from a UTF-8 Japanese Kanji character to (losing the accent), or from a UTF-8 Japanese Kanji character to
some ISO Latin 1 error character indication such as '?', decimal some ISO Latin 1 error character indication such as '?', decimal
code equivalent, or to the absence of a character, depending on code equivalent, 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 stores the data in the charset supplied by the client or charset stores the data in the charset supplied by the client or
code converts to one of the other supported charsets, depends on code 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 natural language as identified by the Printer object's configured natural language as identified by the Printer object's
"natural-language-configured" attribute, rather than the natural "natural-language-configured" attribute, rather than the natural
language supplied by the client. For any 'text' or 'name' language supplied by the client. For any 'text' or 'name'
Expires December 30, 1998
attribute or status message in the response that is in a attribute or status message in the response that is in a
different natural language than the value returned in the different natural language than the value returned in the
"attributes-natural-language" operation attribute, the IPP object "attributes-natural-language" operation attribute, the IPP object
SHALL use the Natural Language Override mechanism (see sections MUST use the Natural Language Override mechanism (see sections
4.1.2 and 4.1.4) on each attribute value returned. 4.1.1.2 and 4.1.2.2) on each attribute value returned.
3.1.5 Operation Status Codes and Messages 3.1.5 Operation Targets
Every operation response returns a MANDATORY "status-code" operation All IPP operations are directed at IPP objects. For Printer
attribute and an OPTIONAL "status-message" operation attribute. The operations, the operation is always directed at a Printer object using
"status-code" attribute provides information on the processing of a one of its URIs (i.e., one of the values in the Printer object's
request. A "status-message" attribute provides a short textual "printer-uri-supported" attribute). Even if the Printer object
description of the status of the operation. The status code is supports more than one URI, the client supplies only one URI as the
intended for use by automata, and the status message is intended for target of the operation. The client identifies the target object by
the human end user. If a response does include a "status-message" supplying the correct URI in the "printer-uri (uri)" operation
attribute.
Expires July 16, 1998 For Job operations, the operation is directed at either:
attribute, an IPP client NEED NOT examine or display the message, - The Job object itself using the Job object's URI. In this case,
however it SHOULD do so in some implementation specific manner. the client identifies the target object by supplying the correct
URI in the "job-uri (uri)" operation attribute.
- The Printer object that created the Job object using both the
Printer objects URI and the Job object's Job ID. Since the
Printer object that created the Job object generated the Job ID,
it MUST be able to correctly associate the client supplied Job ID
with the correct Job object. The client supplies the Printer
object's URI in the "printer-uri (uri)" operation attribute and
the Job object's Job ID in the "job-id (integer(1:MAX))"
operation attribute.
The value of a "status-code" attribute is a numeric value that has If the operation is directed at the Job object directly using the Job
semantic meaning. The "status-code" syntax is similar to a "type2 object's URI, the client MUST NOT include the redundant "job-id"
enum" (see section 4.1 on "Attribute Syntaxes") except that values can operation attribute.
range only from 0x0000 to 0x7FFF. Section 13 describes the status
codes, assigns the numeric values, and suggests a corresponding status The operation target attributes are REQUIRED operation attributes that
message for each status code. The "status-message" attribute's syntax MUST be included in every operation request. Like the charset and
is text(255). natural language attributes (see section 3.1.4), the operation target
attributes are specially ordered operation attributes. In all cases,
the operation target attributes immediately follow the "attributes-
charset" and "attributes-natural-language" attributes within the
operation attribute group, however the specific ordering rules are:
- In the case where there is only one operation target attribute
(i.e., either only the "printer-uri" attribute or only the "job-
uri" attribute), that attribute MUST be the third attribute in
the operation attributes group.
Expires December 30, 1998
- In the case where Job operations use two operation target
attributes (i.e., the "printer-uri" and "job-id" attributes), the
"printer-uri" attribute MUST be the third attribute and the "job-
id" attribute MUST be the fourth attribute.
In all cases, the target URIs contained within the body of IPP
operation requests and responses must be in absolute format rather
than relative format (a relative URL identifies a resource with the
scope of the HTTP server, but does not include scheme, host or port).
The following rules apply to the use of port numbers in URIs that
identify IPP objects:
1. If the URI scheme allows the port number to be explicitly
included in the URI string, and a port number is specified within
the URI, then that port number MUST be used by the client to
contact the IPP object.
2. If the URI scheme allows the port number to be explicitly
included in the URI string, and a port number is not specified
within the 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
specified within the URI, then the default port number implied by
that URI MUST be used by the client to contact the IPP object.
Note: The IPP encoding and transport document [IPP-PRO] shows a
mapping of IPP onto HTTP/1.1 and defines a new default port number for
using IPP over HTTP/1.1.
3.1.6 Operation Status Codes and Messages
Every operation response includes a REQUIRED "status-code" parameter
and an OPTIONAL "status-message" operation attribute. The "status-
code" provides information on the processing of a request. A "status-
message" attribute provides a short textual description of the status
of the operation. The status code is intended for use by automata,
and the status message is intended for the human end user. If a
response does include a "status-message" attribute, an IPP client NEED
NOT examine or display the message, however it SHOULD do so in some
implementation specific manner.
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
on "Attribute Syntaxes") except that values can range only from 0x0000
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
code. The "status-message" attribute's syntax is "text(255)".
A client implementation of IPP SHOULD convert status code values into A client implementation of IPP SHOULD convert status code values into
any localized message that has semantic meaning to the end user. If any localized message that has semantic meaning to the end user. If
the Printer object supports the status message, the Printer object the Printer object supports the status message, the Printer object
MUST be able to generate this message in any of the natural languages MUST be able to generate this message in any of the natural languages
identified by the Printer object's "generated-natural-language- identified by the Printer object's "generated-natural-language-
supported" attribute (see the "attributes-natural-language" operation supported" attribute (see the "attributes-natural-language" operation
attribute specified in section 3.1.4.1). As described in section attribute specified in section 3.1.4.1). As described in section
3.1.4.1 for any returned 'text' attribute, if there is a choice for 3.1.4.1 for any returned 'text' attribute, if there is a choice for
generating this message, the Printer object uses the natural language generating this message, the Printer object uses the natural language
indicated by the value of the "attributes-natural-language" in the indicated by the value of the "attributes-natural-language" in the
client request if supported, otherwise the Printer object uses 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.
3.1.6 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"
attribute. Each value of the "version-number" attribute is in the parameter. Each value of the "version-number" is in the form "X.Y"
form "X.Y" where X is the major version number and Y is the minor where X is the major version number and Y is the minor version number.
version number. By including a version number in the client request, By including a version number in the client request, it allows the
it allows the client (the requester) to identify which version of IPP client to identify which version of IPP it is interested in using.
it is interested in using. If the IPP object does not support that If the IPP object does not support that version, the object responds
version, the object responds with a status code of 'server-error- with a status code of 'server-error-version-not-supported' along with
version-not-supported'. the 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 that covers both IPP Model and IPP There is only one notion of "version number" that covers both IPP
Protocol changes. Thus the version number MUST change when introducing Model and IPP Protocol changes. Thus the version number MUST change
a new version of the Model document or a new version of the Protocol when introducing a new version of the Model document or a new version
document. of the Protocol document.
Expires July 16, 1998
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
Expires December 30, 1998
number include any changes to the protocol specification itself, such number include any changes to the protocol specification itself, such
as: 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
MANDATORY and vice versa REQUIRED and vice versa
- adding MANDATORY (for an IPP object to support) operation - adding REQUIRED (for an IPP object to support) operation
attributes attributes
- adding MANDATORY (for an IPP object to support) operation - adding REQUIRED (for an IPP object to support) operation
attribute groups attribute groups
- adding values to existing operation attributes - adding values to existing operation attributes
- adding MANDATORY 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 all IPP objects, but which can be ignored if not understood. Items by all IPP objects, but which can be ignored if not understood. Items
that might affect the changing of the minor version number include any that might affect the changing of the minor version number include any
changes to the model objects and attributes but not the protocol changes to the model objects and attributes but not the encoding and
specification itself (except adding attribute syntaxes), such as: transport rules [IPP-PRO] (except adding attribute syntaxes).
Examples 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
- 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 (i.e., those attributes that an IPP object can ignore attributes (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 - adding OPTIONAL (for an IPP object to support) operation
attribute groups (i.e., those attributes that an IPP object can attribute groups (i.e., those attributes that an IPP object can
ignore without confusing clients) 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 MANDATORY or vice versa. attributes from OPTIONAL to REQUIRED or vice versa.
The encoding of the "operation-id", the "version-number", and the
"request-id" SHALL NOT change over any version number (either major or
minor). This rule guarantees that all future versions will be
backwards compatible with all previous versions (at least for checking
Expires July 16, 1998 The encoding of the "operation-id", the "version-number", the "status-
code", and the "request-id" MUST NOT change over any version number
(either major or minor). This rule guarantees that all future
versions will be backwards compatible with all previous versions (at
least for checking the "operation-id", the "version-number", and the
"request-id"). In addition, any protocol elements (attributes, error
codes, tags, etc.) that are not carried forward from one version to
the next are deprecated so that they can never be reused with new
semantics.
the "operation-id", the "version-number", and the "request-id"). In Expires December 30, 1998
addition, any protocol elements (attributes, error codes, tags, etc.)
that are not carried forward from one version to the next are
deprecated so that they can never be reused with new semantics.
Implementations that support a certain 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.7 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 operation requests: three 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 Printer object by including the document data in the request the Printer object by including the document data in the request
itself. itself.
skipping to change at page 31, line 5 skipping to change at page 33, line 48
the document data to the printer), and the Send-URI operation the document data to the printer), and the Send-URI operation
includes only a URI reference to the document data in the request includes only a URI reference to the document data in the request
(the Printer "pulls" the document data from the referenced (the Printer "pulls" the document data from the referenced
location). The last Send-Document or Send-URI request for a location). The last Send-Document or Send-URI request for a
given Job object includes a "last-document" operation attribute given Job object includes a "last-document" operation attribute
set to 'true' indicating that this is the last request. 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.
Expires July 16, 1998
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 MANDATORY operation all single document jobs. Also, Print-Job is a REQUIRED operation
(all implementations MUST support it) whereas Create-Job is an (all implementations MUST support it) whereas Create-Job is an
OPTIONAL operation, hence some implementations might not support it. OPTIONAL 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 the request reject 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 15 describes the rules and issues surrounding the processing Section 16 describes the rules and issues surrounding the processing
of client supplied attributes. Section 15.3 presents suggested steps of client supplied attributes. Section 16.3 presents suggested steps
for an IPP object to either accept or reject any request. Section for an IPP object to either accept or reject any request. Section
15.4 presents suggested additional steps for processing create 16.4 presents suggested additional steps for processing create
requests. requests.
At job submission time the Printer SHOULD NOT perform the validation At job submission time the Printer NEED NOT perform the validation
checks reserved for job processing time such as: checks reserved for job processing time such as:
1. Validate the document data 1. Validating the document data
2. Validate the actual contents of any client supplied URI (resolve 2. Validating the actual contents of any client supplied URI
the reference and follow the link to the document data) (resolve 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 checks are essentially useless, since they require actually validation checks are essentially useless, since they require actually
parsing and interpreting the document data, are not guaranteed to be parsing and interpreting the document data, are not guaranteed to be
100% accurate, and MUST yet be done again at job processing time. 100% accurate, and MUST be done, yet again, at job processing time.
Also, in the case of a URI, checking for availability at job Also, in the case of a URI, checking for availability at job
submission time does not guarantee availability at job processing submission time does not guarantee availability at job processing
time. In addition, at job processing time, the Printer object might time. In addition, at job processing time, the Printer object might
discover any of the following conditions that were not detectable at discover any of the following conditions that were not detectable at
job submission time: job submission time:
- 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,
Expires July 16, 1998
- 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 document might be down), or the 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 the Printer object detects an error, the Printer object is unable if the Printer object detects an error, the Printer object is unable
Expires December 30, 1998
to inform the end user of the error with an operation status code. 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- In this case, the Printer, depending on the error, can set the "job-
state", "job-state-reasons", or "job-state-message" attributes to the 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 the correct target of the operation. identify the correct target of the operation.
3.2.1 Print-Job Operation 3.2.1 Print-Job Operation
This MANDATORY operation allows a client to submit a print job with This REQUIRED operation allows a client to submit a print job with
only one document and supply the document data (rather than just a only one document and supply the document data (rather than just a
reference to the data). See Section 15 for the suggested steps for reference to the data). See Section 16 for the suggested steps for
processing create operations and their Operation and Job Template processing 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 Request: Job Request:
Group 1: Operation Attributes Group 1: Operation Attributes
Target:
The "printer-uri" operation attribute which is the target for
this operation as described in section 3.1.3.
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
Expires July 16, 1998
SHALL 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:
The "printer-uri" (uri) operation attribute which is the target
for this operation as described in section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" (name(MAX)) attribute SHOULD be
client as described in section 8.3. supplied by the client as described in section 8.3.
Expires December 30, 1998
"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 MUST support this attribute. It contains the client object MUST support this attribute. It contains the client
supplied Job name. If this attribute is supplied by the client, supplied Job name. If this attribute is supplied by the client,
its value is used for the "job-name" attribute of the newly its value is used for the "job-name" attribute of the newly
created Job object. The client MAY automatically include any created Job object. The client MAY automatically include any
information that will help the end-user distinguish amongst information that will help the end-user distinguish amongst
his/her jobs, such as the name of the application program along his/her jobs, such as the name of the application program along
with information from the document, such as the document name, with information from the document, such as the document name,
document subject, or source file name. If this attribute is not document subject, or source file name. If this attribute is not
supplied by the client, the Printer generates a name to use in supplied by the client, the Printer generates a name to use in
the "job-name" attribute of the newly created Job object (see the "job-name" attribute of the newly 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 MUST support this attribute. The value 'true' indicates object MUST support this attribute. The value 'true' indicates
that total fidelity to client supplied Job Template attributes that total fidelity to client supplied Job Template attributes
and values is required, else the Printer object SHALL reject the and values is required, else the Printer object MUST reject the
Print-Job request. The value 'false' indicates that a reasonable Print-Job request. The value 'false' indicates that a reasonable
attempt to print the Job object is acceptable and the Printer attempt to print the Job object is acceptable and the Printer
object SHALL accept the Print-job request. If not supplied, the object MUST accept the Print-job request. If not supplied, the
Printer object assumes the value is 'false'. All Printer objects Printer object assumes the value is 'false'. All Printer objects
MUST support both types of job processing. See section 15 for a MUST support both types of job processing. See section 16 for a
full description of "ipp-attribute-fidelity" and its relationship full description of "ipp-attribute-fidelity" and its relationship
to other attributes, especially the Printer object's "pdl- to other attributes, especially the Printer object's "pdl-
override-supported" attribute. override-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 MUST support this attribute. It contains the client object MUST support this attribute. It contains the client
supplied document name. The document name MAY be different than supplied document name. The document name MAY be different than
the Job name. Typically, the client software automatically the Job name. Typically, the client software automatically
supplies the document name on behalf of the end user by using a supplies the document name on behalf of the end user by using a
file name or an application generated name. If this attribute is file name or an application generated name. If this attribute is
supplied, its value can be used in a manner defined by each supplied, its value can be used in a manner defined by each
implementation. Examples include: printed along with the Job implementation. Examples include: printed along with the Job
(job start sheet, page adornments, etc.), used by accounting or (job start sheet, page adornments, etc.), used by accounting or
resource tracking management tools, or even stored along with the resource tracking management tools, or even stored along with the
document as a document level attribute. IPP/1.0 does not support document as a document level attribute. IPP/1.0 does not support
the concept of document level attributes. the concept of document level attributes.
Expires July 16, 1998
"document-format" (mimeMediaType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer
object MUST support this attribute. The value of this attribute object 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 does not supply this attribute, the Printer object assumes client does not supply this attribute, the Printer object assumes
that the document data is in the format defined by the Printer that the document data is in the format defined by the Printer
Expires December 30, 1998
object's "document-format-default" attribute. If the client object's "document-format-default" attribute. If the client
supplies this attribute, but the value is not supported by the supplies this attribute, but the value is not supported by the
Printer object, i.e., the value is not one of the values of the Printer object, i.e., the value is not one of the values of the
Printer object's "document-format-supported" attribute, the Printer object's "document-format-supported" attribute, the
Printer object SHALL reject the request and return the 'client- Printer object MUST reject the request and return the 'client-
error-document-format-not-supported' status code. 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 OPTIONALLY supports this attribute. This attribute object OPTIONALLY supports this attribute. This attribute
specifies the natural language of the document for those specifies the natural language of the document for those
document-formats that require a specification of the natural document-formats that require a specification of the natural
language in order to image the document unambiguously. There are language in order to image the document unambiguously. There are
no particular values required for the Printer object to support. no particular values 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 OPTIONALLY supports the "compression-supported" attribute object OPTIONALLY supports this attribute and the "compression-
(see section 4.4.29). The client supplied "compression" supported" attribute (see section 4.4.29). The client supplied
operation attribute identifies the compression algorithm used on "compression" operation attribute identifies the compression
the document data. If the client omits this attribute, the algorithm used on the document data. If the client omits this
Printer object SHALL assume that the data is not compressed. If attribute, the Printer object MUST assume that the data is not
the client supplies the attribute and the Printer object supports compressed. If the client supplies the attribute and the Printer
the attribute, the Printer object uses the corresponding object supports the attribute, the Printer object uses the
decompression algorithm on the document data. If the client corresponding decompression algorithm on the document data. If
supplies this attribute, but the value is not supported by the the client supplies this attribute, but the value is not
Printer object, i.e., the value is not one of the values of the supported by the Printer object, i.e., the value is not one of
Printer object's "compression-supported" attribute, the Printer the values of the Printer object's "compression-supported"
object SHALL copy the attribute and its value to the Unsupported attribute, the Printer object MUST copy the attribute and its
Attributes response group, reject the request, and return the value to the Unsupported Attributes response group, reject the
'client-error-attributes-or-values-not-supported' status code. request, and return the 'client-error-attributes-or-values-not-
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 OPTIONALLY supports the "job-k-octets-supported" attribute object OPTIONALLY supports this attribute and the "job-k-octets-
(see section 4.4.30). The client supplied "job-k-octets" supported" attribute (see section 4.4.30). The client supplied
operation attribute identifies the total size of the document(s) "job-k-octets" operation attribute identifies the total size of
in K octets being submitted (see section 4.3.17 for the complete the document(s) in K octets being submitted (see section 4.3.17
semantics). If the client supplies the attribute and the Printer for the complete semantics). If the client supplies the
object supports the attribute, the value of the attribute is used attribute and the Printer object supports the attribute, the
value of the attribute is used to populate the Job object's "job-
Expires July 16, 1998 k-octets" Job Description attribute.
to populate the Job object's "job-k-octets" Job Description
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
SHALL use the value to populate the Job object's "xxx" attribute. MUST use the value to populate the Job object's "xxx" attribute.
If the client supplies the attribute and the Printer supports the If 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 Printer object's "xxx-supported" attribute, the corresponding Printer object's "xxx-supported" attribute, the
Printer object SHALL copy the attribute and its value to the Printer object MUST copy the attribute and its value to the
Unsupported Attributes response group, reject the request, and Unsupported Attributes response group, reject the request, and
return the 'client-error-attributes-or-values-not-supported' return the 'client-error-attributes-or-values-not-supported'
status code. If the client does not supply the attribute, the status code. If the client does not supply the attribute, the
Printer object might choose to populate the corresponding Job Printer object MAY choose to populate the corresponding Job
object attribute depending on whether the Printer object supports object attribute depending on whether the Printer object supports
the attribute and is able to calculate or discern the correct the attribute and is able to calculate or discern the correct
value. value.
"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 OPTIONALLY supports the "job-impressions-supported" object OPTIONALLY supports this attribute and the "job-
attribute (see section 4.4.31). The client supplied "job- impressions-supported" attribute (see section 4.4.31). The
impressions" operation attribute identifies the total size in client supplied "job-impressions" operation attribute identifies
number of impressions of the document(s) being submitted (see the total size in number of impressions of the document(s) being
section 4.3.18 for the complete semantics). submitted (see 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 OPTIONALLY supports the "job-media-sheets-supported" object OPTIONALLY supports this attribute and the "job-media-
attribute (see section 4.4.32). The client supplied "job-media- sheets-supported" attribute (see section 4.4.32). The client
sheets" operation attribute identifies the total number of media supplied "job-media-sheets" operation attribute identifies the
sheets to be produced for this job (see section 4.3.19 for the total number of media sheets to be produced for this job (see
complete semantics). section 4.3.19 for 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 defined in section 4.2. as defined in section 4.2.
Expires July 16, 1998
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: The simplest Print-Job Request consists of just the Document Note: In addition to the MANDTORY parameters required for every
Content, the "attributes-charset" and "attributes-natural-language" operation request, the simplest Print-Job Request consists of just the
operation attributes, and nothing else. In this case, the Printer "attributes-charset" and "attributes-natural-language" operation
object:
Expires December 30, 1998
attributes; the "printer-uri" target operation attribute; the Document
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 supplied by the client as IPP attribute or embedded not supplied by the client as IPP attribute or embedded
instructions in the document data. instructions in the document data.
3.2.1.2 Print-Job Response 3.2.1.2 Print-Job Response
The Printer object SHALL 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 Code and Message: Status Message:
The response includes the MANDATORY status code and an OPTIONAL In addition to the REQUIRED status code returned in every
"status-message" (text) operation attribute as described in response, the response OPTIONALLY includes a "status-message"
section 3.1.5. If the client supplies unsupported or conflicting (text) operation attribute as described in section 3.1.6. If the
Job Template attributes or values, the Printer object SHALL client supplies unsupported or conflicting Job Template
reject or accept the Print-Job request depending on the whether attributes or values, the Printer object MUST reject or accept
the client supplied a 'true' or 'false' value for the "ipp- the Print-Job request depending on the whether the client
attribute-fidelity" operation attribute. See section 15 for a supplied a 'true' or 'false' value for the "ipp-attribute-
complete description of the suggested steps for processing a fidelity" operation attribute. See section 16 for a complete
create request. description of the suggested steps for processing a create
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 the client (in the request) that are not supported by the by the client (in the request) that are not supported by the
Expires July 16, 1998
Printer object or that conflict with one another (see sections Printer object or that conflict with one another (see sections
15.3 and 15.4). 16.3 and 16.4).
Unsupported attributes fall into three categories: Unsupported attributes fall into three categories:
Expires December 30, 1998
1. The Printer object does not support the named attribute (no 1. The Printer object does not support the named attribute (no
matter what the 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 values supplied by the
client (i.e., the Printer object does not have those values client (i.e., the Printer object does not have those values
in the corresponding supported values attribute). in the corresponding supported values 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 able to staple transparencies. being able to staple transparencies.
skipping to change at page 37, line 34 skipping to change at page 40, line 29
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 values, the Printer object simply returns the client-supplied
attribute with the unsupported values as supplied by the client. attribute with the unsupported values as supplied by the client.
This indicates support for the attribute, but no support for that This indicates support for the attribute, but no support for that
particular value. If the client supplies a multi-valued attribute particular value. If the client supplies a multi-valued attribute
with more than one value and the Printer object supports the with more than one value and the Printer object supports the
attribute but only supports a subset of the client supplied attribute but only supports a subset of the client supplied
values, the Printer object SHALL return only those values that values, the Printer object MUST return only those values that are
are unsupported. unsupported.
In the case of two (or more) supported attribute values that are In the case of two (or more) supported attribute values that are
in conflict with one another because they cannot be used together in conflict with one another (although each is supported
in the same job, the Printer object SHALL return all the values independently, the values conflict when requested together within
that it ignores or substitutes to resolve the conflict, but not the same job), the Printer object MUST return all the values that
any of the values that it is still using. The choice for exactly it ignores or substitutes to resolve the conflict, but not any of
how to resolve the conflict is implementation dependent. See the values that it is still using. The choice for exactly how to
Section 15.4.4 for an example. resolve the conflict is implementation dependent. See Section
16.4.4 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.
Expires July 16, 1998
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 MANDATORY "job-uri" Job object attribute. the contents of the REQUIRED "job-uri" Job object attribute. The
The client uses the Job object's URI when directing operations at client uses the Job object's URI when directing operations at the
the Job object. The Printer object always uses is configured Job object. The Printer object always uses its configured
security policy when creating the new URI. However, if the security policy when creating the new URI. However, if the
Printer object supports more than one URI, the Printer object Printer object supports more than one URI, the Printer object
also uses information about which URI was used in the Print-Job also uses information about which URI was used in the Print-Job
Request to generated the new URI so that the new URI references Request to generated the new URI so that the new URI references
the correct access channel. In other words, if the Print-Job the correct access channel. In other words, if the Print-Job
Request comes in over a secure channel, the Printer object MUST Request comes in over a secure channel, the Printer object MUST
generate a Job URI that uses the secure channel as well. generate a Job URI that uses the secure channel as well.
"job-id": "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 the MANDATORY "job-id" Job object attribute. The returning the REQUIRED "job-id" Job object attribute. The
client uses this "job-id" attribute in conjunction with the client uses this "job-id" attribute in conjunction with the
"printer-uri" attribute used in the Print-Job Request when "printer-uri" attribute used in the Print-Job Request when
directing Job operations at the Printer object. directing Job operations at the Printer object.
"job-state": "job-state":
The Printer object MUST return the Job object's MANDATORY "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 of the next attribute "job-state-reasons") is taken from a value 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
(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
skipping to change at page 39, line 5 skipping to change at page 41, line 51
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 attribute then it MUST be returned in the response. If this 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.
Expires July 16, 1998
"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 specific printer status attributes. no specific printer status attributes.
Note: The simplest response consists of the just the MANDATORY Job Note: In addition to the MANDTORY parameters required for every
Object Attributes, the MANDATORY "attributes-charset" and "attributes- operation response, the simplest response consists of the just the
natural-language" operation attributes, and a status code of "attributes-charset" and "attributes-natural-language" operation
"successful-ok". attributes and the "job-uri", "job-id", and "job-state" Job Object
Attributes. In this simplest case, the status code is "successful-ok"
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 3.2.1) except that a client supplies a URI reference to the (section 3.2.1) except that a client supplies a URI reference to the
document data using the "document-uri" (uri) operation attribute document data using the "document-uri" (uri) operation attribute (in
rather than including the document data itself. Before returning the Group 1) rather than including the document data itself. Before
response, the Printer MUST validate that the Printer supports the returning the response, the Printer MUST validate that the Printer
retrieval method (e.g., http, ftp, etc.) implied by the URI, and MUST supports the retrieval method (e.g., http, ftp, etc.) implied by the
check for valid URI syntax. If the client-supplied URI scheme is not URI, and MUST check for valid URI syntax. If the client-supplied URI
supported, i.e. the value is not in the Printer object's "referenced- scheme is not supported, i.e. the value is not in the Printer object's
uri-scheme-supported" attribute, the Printer object SHALL reject the "referenced-uri-scheme-supported" attribute, the Printer object MUST
request and return the 'client-error-uri-scheme-not-supported' status reject the request and return the 'client-error-uri-scheme-not-
code. See Section 15.3.5 for suggested additional checks. The supported' status code. See Section 16.3.5 for suggested additional
Printer NEED NOT follow the reference and validate the contents of the checks. The Printer NEED NOT follow the reference and validate 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" the document from the source referenced by the URI string. "pull" the document from the source referenced by the URI string.
3.2.3 Validate-Job Operation 3.2.3 Validate-Job Operation
This MANDATORY operation is similar to the Print-Job operation This REQUIRED operation is similar to the Print-Job operation (section
(section 3.2.1) except that a client supplies no document data and the 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).
Expires July 16, 1998 Expires December 30, 1998
Printer allocates no resources (i.e., it does not create a new Job This operation is used only to verify capabilities of a printer object
object). This operation is used only to verify capabilities of a against whatever attributes are supplied by the client in the
printer object against whatever attributes are supplied by the client Validate-Job request. By using the Validate-Job operation a client
in the Validate-Job request. By using the Validate-Job operation a can validate that an identical Print-Job operation (with the document
client can check that the same Print-Job operation will be accepted data) would be accepted. The Validate-Job operation also performs the
without having to send the document data. The Validate-Job operation same security negotiation as the Print-Job operation (see section 8),
also performs the same security negotiation as the Print-Job operation so that a client can check that the client and Printer object security
(see section 8), so that a client can check that the client and requirements can be met before performing a Print-Job operation.
Printer object security requirements can 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 the Print-URI operation. The client SHOULD just issue the Print- with the Print-URI operation. The client SHOULD just issue the Print-
URI request. URI 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 not supply any of the "document-name", "document-format", does not supply any of the "document-name", "document-format",
"compression", or "document-natural-language" operation attributes. "compression", or "document-natural-language" operation attributes.
This operation is followed by one or more Send-Document or Send-URI This operation is followed by one or more Send-Document or Send-URI
operations. In each of those operation requests, the client operations. In each of those operation requests, the client
OPTIONALLY supplies the "document-name", "document-format", and OPTIONALLY supplies the "document-name", "document-format", and
"document-natural-language" attributes for each document in the multi- "document-natural-language" attributes for each document in the multi-
document Job object. If a Printer object supports the Create-Job document Job object. If a Printer object supports the Create-Job
operation, it MUST also support the Send-Document operation and also operation, it MUST also support the Send-Document operation and also
MAY support the Send-URI operation. MAY support the Send-URI operation.
3.2.5 Get-Printer-Attributes Operation 3.2.5 Get-Printer-Attributes Operation
This MANDATORY 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 the requester is interested. In the response, the Printer which the requester is interested. In the response, the Printer
object returns a corresponding attribute set with the appropriate object returns a corresponding attribute set with the appropriate
attribute values filled in. attribute values filled in.
Expires July 16, 1998
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 - 'job-template': all of the Job Template attributes that apply to
a Printer object (the last two columns of the table in Section a Printer object (the last two columns of the table in Section
4.2). 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 a potential that there is some overlap. For example, if a client is 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 NEED NOT return each attribute only once in the response even object NEED NOT return each attribute only once in the response even
if it is requested multiple times. The client SHOULD NOT request the if it is requested multiple times. The client SHOULD NOT request the
same attribute in multiple ways. same 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 is MANDATORY that each Printer object support all group names. it 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 Request when the request is directed to a Printer object: Attributes Request:
Group 1: Operation Attributes Group 1: Operation Attributes
Target:
The "printer-uri" operation attribute which is the target for
this operation as described in section 3.1.3.
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:
The "printer-uri" (uri) operation attribute which is the target
for this operation as described in section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" (name(MAX)) attribute SHOULD be
client as described in section 8.3. supplied 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. The Printer object MUST support this attribute. If interested. The Printer object MUST support this attribute. If
the client omits this attribute, the Printer SHALL respond as if the client omits this attribute, the Printer MUST respond as if
this attribute had been supplied with a value of 'all'. this attribute had been supplied with a value of 'all'.
Expires July 16, 1998 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 MUST support this attribute. This attribute is useful for object MUST support this attribute. This attribute is useful for
a Printer object to determine the set of supported attribute a Printer object to determine the set of supported attribute
values that relate to the requested document format. The Printer values that relate to the requested document format. The Printer
object SHALL return the attributes and values that it uses to object MUST return the attributes and values that it uses to
validate a job on a create or Validate-Job operation in which validate a job on a create or Validate-Job operation in which
this document format is supplied. The Printer object SHOULD this document format is supplied. The Printer object SHOULD
return only (1) those attributes that are supported for the return only (1) those attributes that are supported for the
specified format and (2) the attribute values that are supported specified format and (2) the attribute values that are supported
for the specified document format. By specifying the document for the specified document format. By specifying the document
format, the client can get the Printer object to eliminate the format, the client can get the Printer object to eliminate the
attributes and values that are not supported for a specific attributes and values that are not supported for a specific
document format. For example, a Printer object might have document format. For example, a Printer object might have
multiple interpreters to support both 'application/postscript' multiple interpreters to support both 'application/postscript'
(for PostScript) and 'text/plain' (for text) documents. However, (for PostScript) and 'text/plain' (for text) documents. However,
for only one of those interpreters might the Printer object be for only one of those interpreters might the Printer object be
able to support "number-up" with values of '1', '2', and '4'. able to support "number-up" with values of '1', '2', and '4'.
For the other interpreter it might be able to only support For the other interpreter it might be able to only support
"number-up" with a value of '1'. "number-up" with a value of '1'. Thus a client can use the Get-
Printer-Attributes operation to obtain the attributes and values
that will be used to accept/reject a create job operation.
If the Printer object does not distinguish between different If the Printer object does not distinguish between different sets
document formats when validating jobs in the create and Validate- of supported values for each different document format when
Job operations, it SHALL NOT distinguish between document formats validating jobs in the create and Validate-Job operations, it
in the Get-Printer-Attributes operation. Thus a client can use MUST NOT distinguish between different document formats in the
the Get-Printer-Attributes operation to obtain the attributes and Get-Printer-Attributes operation. If the Printer object does
values that will be used to accept/reject a create job operation. distinguish between different sets of supported values for each
different document format specified by the client, this
specialization applies only to the following Printer object
attributes:
If the client omits this attribute, the Printer object SHALL - Printer attributes that are Job Template attributes ("xxx-
respond as if the attribute had been supplied with a value equal default" "xxx-supported", and "xxx-ready" in the Table in
to the value of the Printer object's "document-format-default" Section 4.2),
attribute. It is recommended that the client always supply a - "pdl-override-supported",
value for "document-format", since the Printer object's - "compression-supported",
- "job-k-octets-supported",
- "job-impressions-supported,
- "job-media-sheets-supported"
- "printer-driver-installer",
- "color-supported", and
- "reference-uri-schemes-supported"
The values of all other Printer object attributes (including
"document-format-supported") remain invariant with respect to the
Expires December 30, 1998
client supplied document format (except for new Printer
description attribute as registered according to section 6.2).
If the client omits this "document-format" operation attribute,
the Printer object MUST respond as if the attribute had been
supplied with the value of the Printer object's "document-format-
default" attribute. It is recommended that the client always
supply a value for "document-format", since the Printer object's
"document-format-default" may be 'application/octet-stream', in "document-format-default" may be 'application/octet-stream', in
which case the returned attributes and values are for the union which case the returned attributes and values are for the union
of the document formats that the Printer can automatically sense. of the document formats that the Printer can automatically sense.
For more details, see the description of the 'mimeMediaType' For more details, see the description of the 'mimeMediaType'
attribute syntax in section 4.1.11. 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 attribute that is not supported by the Printer, i.e., Operation attribute that is not supported by the Printer, i.e.,
is not among the values of the Printer object's "document-format- is not among the values of the Printer object's "document-format-
supported" attribute, the Printer object SHALL reject the supported" attribute, the Printer object MUST reject the
operation and return the 'client-error-document-format-not- operation and return the 'client-error-document-format-not-
supported' status code. supported' status code.
Expires July 16, 1998
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 Code and Message: Status Message:
The response includes the MANDATORY status code and an OPTIONAL In addition to the REQUIRED status code returned in every
"status-message" (text) operation attribute as described in response, the response OPTIONALLY includes a "status-message"
section 3.1.5. (text) operation attribute as described in section 3.1.5.
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 15). conflict with one another (see sections 3.2.1.2 and 16).
Group 3: Printer Object Attributes Group 3: Printer 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 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 the security policy in force. However, the Printer object on the security policy in force. However, the Printer object
SHALL respond with the 'unknown' value for any supported MUST respond with the 'unknown' value for any supported attribute
attribute (including all MANDATORY attributes) for which the (including all REQUIRED attributes) for which the Printer object
Printer object does not know the value. Also the Printer object does not know the value. Also the Printer object MUST respond
SHALL respond with the 'no-value' for any supported attribute with the 'no-value' for any supported attribute (including all
(including all MANDATORY attributes) for which the system REQUIRED attributes) for which the system administrator has not
administrator has not configured a value. See the description of configured a value. See the description of the "out-of-band"
the "out-of-band" values in the beginning of Section 4.1. values in the beginning of Section 4.1.
3.2.6 Get-Jobs Operation 3.2.6 Get-Jobs Operation
This MANDATORY 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 is returned. that is returned.
This operation is similar to the Get-Job-Attributes operation, except This operation is similar to the Get-Job-Attributes operation, except
that this Get-Jobs operation returns attributes from possibly more that this Get-Jobs operation returns attributes from possibly more
Expires July 16, 1998
than one object (see the description of Job attribute group names in than one object (see the description of Job attribute group names in
section 3.3.4). section 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
Target:
The "printer-uri" operation attribute which is the target for
this operation as described in section 3.1.3.
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:
The "printer-uri" (uri) operation attribute which is the target
for this operation as described in section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" (name(MAX)) attribute SHOULD be
client as described in section 8.3. supplied 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 MUST support this attribute. It is an integer value that object MUST support this attribute. It is an integer value that
indicates a limit to the number of Job objects returned. The indicates a limit to the number of Job objects returned. The
limit is a "stateless limit" in that if the value supplied by the limit is a "stateless limit" in that if the value supplied by the
client is 'N', then only the first 'N' jobs are returned in the client is 'N', then only the first 'N' jobs are returned in the
Get-Jobs Response. There is no mechanism to allow for the next Get-Jobs Response. There is no mechanism to allow for the next
'M' jobs after the first 'N' jobs. If the client does not supply 'M' jobs after the first 'N' jobs. If the client does not supply
this attribute, the Printer object responds with all applicable this attribute, the Printer object responds with all applicable
jobs. 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 MUST support this attribute. It is a set of Job attribute object MUST support this attribute. It is a set of Job attribute
names and/or attribute groups names in whose values the requester names and/or attribute groups names in whose values the requester
is interested. This set of attributes is returned for each Job is interested. This set of attributes is returned for each Job
object that is returned. The allowed attribute group names are object that is returned. The allowed attribute group names are
the same as those defined in the Get-Job-Attributes operation in the same as those defined in the Get-Job-Attributes operation in
section 3.3.4. If the client does not supply this attribute, the section 3.3.4. If the client does not supply this attribute, the
Printer SHALL respond as if the client had supplied this Printer MUST respond as if the client had supplied this attribute
attribute with two values: 'job-uri' and 'job-id'. with two values: 'job-uri' and 'job-id'.
Expires July 16, 1998
"which-jobs" (keyword): "which-jobs" (keyword):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer
object MUST support this attribute. It indicates which Job object MUST support this attribute. It indicates which Job
objects SHALL be returned by the Printer object. The values for objects MUST be returned by the Printer object. The values for
this attribute are: this attribute are:
'completed': This includes any Job object whose state is 'completed': This includes any Job object whose state is
'completed', 'canceled', or 'aborted'. 'completed', 'canceled', or 'aborted'.
'not-completed': This includes any Job object whose state is 'not-completed': This includes any Job object whose state is
'pending', 'processing', 'processing-stopped', or 'pending- 'pending', 'processing', 'processing-stopped', or 'pending-
held'. held'.
A Printer object SHALL 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' value is supplied. 'completed' value is supplied.
If a client supplies some other value, the Printer object SHALL If a client supplies some other value, the Printer object MUST
copy the attribute and the unsupported value to the Unsupported copy the attribute and the unsupported value to the Unsupported
Attributes response group, reject the request, and return the Attributes response group, reject the request, and return the
'client-error-attributes-or-values-not-supported' status code. 'client-error-attributes-or-values-not-supported' status code.
If the client does not supply this attribute, the Printer object If the client does not supply this attribute, the Printer object
SHALL 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 MUST support this attribute. It indicates whether all object MUST support this attribute. It indicates whether all
jobs or just the jobs submitted by the requesting user of this jobs or just the jobs submitted by the requesting user of this
request SHALL be returned by the Printer object. If the client request MUST be returned by the Printer object. If the client
does not supply this attribute, the Printer object SHALL respond does not supply this attribute, the Printer object MUST respond
as if the client had supplied the attribute with a value of as if the client had supplied the attribute with a value of
'false', i.e., all jobs. The means for authenticating the 'false', i.e., all jobs. The means for authenticating the
requesting user and matching the jobs is described in section 8. requesting user and matching the jobs is described in section 8.
3.2.6.2 Get-Jobs Response 3.2.6.2 Get-Jobs Response
The Printer object returns all of the Job objects 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
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 Job objects that match the criteria supplied by the client. If the no 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 Attributes returned for each Job object. Object Attributes returned for each Job object.
Group 1: Operation Attributes Group 1: Operation Attributes
Expires July 16, 1998 Status Message:
Status Code and Message: In addition to the REQUIRED status code returned in every
The response includes the MANDATORY status code and an OPTIONAL response, the response OPTIONALLY includes a "status-message"
"status-message" (text) operation attribute as described in (text) operation attribute as described in section 3.1.5.
section 3.1.5.
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 15.3). conflict with one another (see sections 3.2.1.2 and 16.3).
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 respond with) any requested attribute or value which is not 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 SHALL respond with the 'unknown' value for any the Printer object MUST respond with the 'unknown' value for any
supported attribute (including all MANDATORY attributes) for supported attribute (including all REQUIRED attributes) for which
which the Printer object does not know the value, unless it would the Printer object does not know the value, unless it would
Expires December 30, 1998
violate the security policy. See the description of the "out-of- violate the security policy. See the description of the "out-of-
band" values in the beginning of Section 4.1. band" values in the beginning of Section 4.1.
For any job submitted in a different natural language than the For any job submitted in a different natural language than the
natural language that the Printer object is returning in the natural language that the Printer object is returning in the
"attributes-natural-language" operation attribute in the Get-Jobs "attributes-natural-language" operation attribute in the Get-Jobs
response, the Printer SHALL indicate the submitted natural response, the Printer MUST indicate the submitted natural
language by returning the Job object's "attributes-natural- language by returning the Job object's "attributes-natural-
language" as the first Job object attribute, which overrides the language" as the first Job object attribute, which overrides the
"attributes-natural-language" operation attribute value being "attributes-natural-language" operation attribute value being
returned by the Printer object. If any returned 'text' or 'name' returned by the Printer object. If any returned 'text' or 'name'
attribute includes a Natural Language Override as described in attribute includes a Natural Language Override as described in
the sections 4.1.2 and 4.1.4, the Natural Language Override the sections 4.1.1.2 and 4.1.2.2, the Natural Language Override
overrides the Job object's "attributes-natural-language" value overrides the Job object's "attributes-natural-language" value
and/or the "attributes-natural-language" operation attribute and/or the "attributes-natural-language" operation attribute
value. 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
Expires July 16, 1998
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
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
skipping to change at page 47, line 31 skipping to change at page 51, line 4
Job ID. The IPP object implementation MUST support both forms of Job ID. The IPP object implementation MUST support both forms of
identification for every job. identification for every job.
3.3.1 Send-Document Operation 3.3.1 Send-Document Operation
This OPTIONAL operation allows a client to create a multi-document Job This OPTIONAL operation allows a client to create a multi-document 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 operations) that follow can occur over arbitrarily long periods of URI operations) that follow can occur over arbitrarily long periods of
time, each Printer object must decide how long to "wait" for the next time, each Printer object must decide how long to "wait" for the next
send operation. The Printer object OPTIONALLY supports the "multiple- send operation. The Printer object OPTIONALLY supports the "multiple-
operation-timeout" attribute. This attribute indicates the maximum operation-timeout" attribute. This attribute indicates the maximum
number of seconds the Printer object will wait for the next send number of seconds the Printer object will wait for the next send
operation. If the Printer object times-out waiting for the next send operation. If the Printer object times-out waiting for the next send
skipping to change at page 48, line 4 skipping to change at page 51, line 28
semantic actions: semantic 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', and clean up all resources
associated with the Job. In this case, if another send operation associated with the Job. In this case, if another send operation
is finally received, the Printer responds with an "client-error- is finally received, the Printer responds with an "client-error-
not-possible" or "client-error-not-found" depending on whether or not-possible" or "client-error-not-found" depending on whether or
not the Job object is still around when it finally arrives. not the Job object is still around when it finally arrives.
2. Assume that the last send operation received was in fact the 2. Assume that the last send operation received was in fact the
last document (as if the "last-document" flag had been set to last document (as if the "last-document" flag had been set to
Expires July 16, 1998
'true'), close the Job object, and proceed to process it (i.e., 'true'), close the Job object, and proceed to process it (i.e.,
move the Job's state to 'pending'). move the Job's state to 'pending').
3. Assume that the last send operation received was in fact the 3. Assume that the last send operation received was in fact the
last document, close the Job, but move it to the 'pending-held' last document, close the Job, but move it to the 'pending-held'
to allow an operator to determine whether or not to continue to allow an operator to determine whether or not to continue
processing the Job by moving it back to the 'pending' state. processing the Job by moving it back to the 'pending' state.
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, the value of "ipp-attribute-fidelity",
and/or any other piece of information available to it. If the choice and/or any other piece of information available to it. If the choice
is to abort the Job object, it is possible that the Job object may is to abort the Job object, it is possible that the Job object may
already have been processed to the point that some media sheet pages already have been processed to the point that some media sheet pages
have been printed. 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
Target:
Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
operation attribute(s) which define the target for this operation
as described in section 3.1.3.
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:
Either (1) the "printer-uri" (uri) plus "job-id"
(integer(1:MAX))or (2) the "job-uri" (uri) operation attribute(s)
which define the target for this operation as described in
section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" (name(MAX)) attribute SHOULD be
client as described in section 8.3. supplied 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 MUST support this attribute. It contains the client object MUST support this attribute. It contains the client
supplied document name. The document name MAY be different than supplied document name. The document name MAY be different than
the Job name. It might be helpful, but NEED NOT be unique across the Job name. It might be helpful, but NEED NOT be unique across
multiple documents in the same Job. Typically, the client multiple documents in the same Job. Typically, the client
software automatically supplies the document name on behalf of software automatically supplies the document name on behalf of
the end user by using a file name or an application generated the end user by using a file name or an application generated
name. See the description of the "document-name" operation name. See the description of the "document-name" operation
attribute in the Print-Job Request (section 3.2.1.1) for more attribute in the Print-Job Request (section 3.2.1.1) for more
information about this attribute. information about this attribute.
Expires July 16, 1998
"document-format" (mimeMediaType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer
object MUST support this attribute. The value of this attribute object 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 does not supply this attribute, the Printer object assumes client does not supply this attribute, the Printer object assumes
that the document data is in the format defined by the Printer that the document data is in the format defined by the Printer
object's "document-format-default" attribute. If the client object's "document-format-default" attribute. If the client
supplies this attribute, but the value is not supported by the supplies this attribute, but the value is not supported by the
Printer object, i.e., the value is not one of the values of the Printer object, i.e., the value is not one of the values of the
Printer object's "document-format-supported" attribute, the Printer object's "document-format-supported" attribute, the
Printer object SHALL reject the request and return the 'client- Printer object MUST reject the request and return the 'client-
error-document-format-not-supported' status code. 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 OPTIONALLY supports this attribute. This attribute object OPTIONALLY supports this attribute. This attribute
specifies the natural language of the document for those specifies the natural language of the document for those
document-formats that require a specification of the natural document-formats that require a specification of the natural
language in order to image the document unambiguously. There are language in order to image the document unambiguously. There are
no particular values required for the Printer object to support. no particular values 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 OPTIONALLY supports the "compression-supported" attribute object OPTIONALLY supports this attribute and the "compression-
(see section 4.4.29). The client supplied "compression" supported" attribute (see section 4.4.29). The client supplied
operation attribute identifies the compression algorithm used on "compression" operation attribute identifies the compression
the document data. If the client omits this attribute, the
Printer object SHALL assume that the data is not compressed. If Expires December 30, 1998
the client supplies the attribute and the Printer object supports algorithm used on the document data. If the client omits this
the attribute, the Printer object SHALL use the corresponding attribute, the Printer object MUST assume that the data is not
decompression algorithm on the document data. If the client compressed. If the client supplies the attribute and the Printer
supplies this attribute, but the value is not supported by the object supports the attribute, the Printer object MUST use the
Printer object, i.e., the value is not one of the values of the corresponding decompression algorithm on the document data. If
Printer object's "compression-supported" attribute, the Printer the client supplies this attribute, but the value is not
object SHALL copy the attribute and its value to the Unsupported supported by the Printer object, i.e., the value is not one of
Attributes response group, reject the request, and return the the values of the Printer object's "compression-supported"
'client-error-attributes-or-values-not-supported' status code. attribute, the Printer object MUST copy the attribute and its
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' if this is the last document for the Job, 'false' 'true' 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
Expires July 16, 1998
that the previous document sent with a Send-Document (or Send- that the previous document sent with a Send-Document (or Send-
URI) operation was the last document (i.e., the "last-document" URI) 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 request with no document data where the "last-document" Document request with no document data where the "last-document"
flag is set to 'true'. Such a request SHALL NOT increment the flag is set to 'true'. Such a request MUST NOT increment the
value of the Job object's "number-of-documents" attribute, since value of the Job object's "number-of-documents" attribute, since
no real document was added to the job. no real document 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:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Code and Message: Status Message:
The response includes the MANDATORY status code and an OPTIONAL In addition to the REQUIRED status code returned in every
"status-message" (text) operation attribute as described in response, the response OPTIONALLY includes a "status-message"
section 3.1.5. (text) operation attribute as described in section 3.1.5.
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 15.3). conflict with one another (see sections 3.2.1.2 and 16.3).
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 section 3.3.1) except that a client MUST supply a URI reference (see section 3.3.1) except that a client MUST supply a URI reference
("document-uri" operation attribute) rather than the document data ("document-uri" operation attribute) rather than the document data
itself. If a Printer object supports this operation, clients can use itself. If a Printer object supports this operation, clients can use
both Send-URI or Send-Document operations to add new documents to an both Send-URI or Send-Document operations to add new documents to an
existing multi-document Job object. However, if a client needs to existing multi-document Job object. However, if a client needs to
indicate that the previous Send-URI or Send-Document was the last indicate that the previous Send-URI or Send-Document was the last
document, the client MUST use the Send-Document operation with no 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
Expires July 16, 1998
attribute). If a Printer object supports this operation, it MUST also attribute). If a Printer object supports this operation, it MUST also
support the Print-URI operation (see section 3.2.2). 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 MANDATORY operation allows a client to cancel a Print Job any This REQUIRED operation allows a client to cancel a Print Job any time
time after a create job operation. Since a Job might already be after a create job operation. Since a Job might already be printing
printing by the time a Cancel-Job is received, some media sheet pages by the time a Cancel-Job is received, some media sheet pages might be
might be printed before the job is actually terminated. printed before the job is actually terminated.
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
Target:
Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
operation attribute(s) which define the target for this operation
as described in section 3.1.3.
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:
Either (1) the "printer-uri" (uri) plus "job-id"
(integer(1:MAX))or (2) the "job-uri" (uri) operation attribute(s)
which define the target for this operation as described in
section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" (name(MAX)) attribute SHOULD be
client as described in section 8.3. supplied by the client as described in section 8.3.
"message" (text(127)): "message" (text(127)):
The client OPTIONALLY supplies this attribute. The Printer The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute. It is a message to the object 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 a message from the operator to the end user that queries report a message from the operator to the end user that queries
that attribute. This "message" operation attribute is used to that attribute. This "message" operation attribute is used to
send a message from the client to the operator along with the send a message from the client to the operator along with the
operation request. It is an implementation decision of how or operation request. It is an implementation decision of how or
where to display this message to the operator (if at all). where to display this message to the operator (if at all).
Expires July 16, 1998
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 Code and Message: Status Message:
The response includes the MANDATORY status code and an OPTIONAL In addition to the REQUIRED status code returned in every
"status-message" (text) operation attribute as described in response, the response OPTIONALLY includes a "status-message"
section 3.1.5. (text) operation attribute as described in section 3.1.5.
If the job is already in the 'completed', 'aborted', or If the job is already in the 'completed', 'aborted', or
'canceled' state, or the 'process-to-stop-point' value is set in 'canceled' state, or the 'process-to-stop-point' value is set in
the Job's "job-state-reasons" attribute, the Printer object SHALL the Job's "job-state-reasons" attribute, the Printer object MUST
reject the request and return the 'client-error-not-possible' reject the request and return the 'client-error-not-possible'
error status code. error status 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.
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 15.3). conflict with one another (see sections 3.2.1.2 and 16.3).
Expires December 30, 1998
Once a successful response has been sent, the implementation Once a successful response has been sent, the implementation
guarantees that the Job will eventually end up in the 'canceled' guarantees that the Job will eventually end up in the 'canceled'
state. Between the time of the Cancel-Job operation is accepted and state. Between the time of the Cancel-Job operation is accepted and
when the job enters the 'canceled' job-state (see section 4.3.7), the when the job enters the 'canceled' job-state (see section 4.3.7), the
"job-state-reasons" attribute SHOULD contain the ' processing-to-stop- "job-state-reasons" attribute SHOULD contain the ' processing-to-stop-
point ' value which indicates to later queries that although the Job point ' value which indicates to later queries that although the Job
might still be 'processing', it will eventually end up in the might still be 'processing', it will eventually end up in the
'canceled' state, not the 'completed' state. 'canceled' state, not the 'completed' state.
3.3.4 Get-Job-Attributes Operation 3.3.4 Get-Job-Attributes Operation
This MANDATORY 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 are that the operation is directed at a Job object rather differences are that the operation is directed at a Job object rather
than a Printer object, there is no "document-format" operation than a Printer object, there is no "document-format" operation
attribute used when querying a Job object, and the returned attribute attribute used when querying a Job object, and the returned attribute
group is a set of Job object attributes rather than a set of Printer group is a set of Job object attributes rather than a set of Printer
object attributes. object attributes.
Expires July 16, 1998
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 Job object (the first column of the table in Section 4.2). a 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 in Section 4.3. specified 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 a potential that there is some overlap. For example, if a client is 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 a group (since some attributes are OPTIONAL). However it is to a group (since some attributes are OPTIONAL). However it is
MANDATORY that each Job object support all group names. REQUIRED that each Job object support all group names.
Expires December 30, 1998
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
Target:
Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
operation attribute(s) which define the target for this operation
as described in section 3.1.3.
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:
Either (1) the "printer-uri" (uri) plus "job-id" (integer(1:MAX))
or (2) the "job-uri" (uri) operation attribute(s) which define
the target for this operation as described in section 3.1.5.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" (name(MAX)) attribute SHOULD be
client as described in section 8.3. supplied 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 support this attribute. It is a set of attribute names MUST support this attribute. It is a set of attribute names
and/or attribute group names in whose values the requester is and/or attribute group names in whose values the requester is
interested. If the client omits this attribute, the IPP object interested. If the client omits this attribute, the IPP object
MUST respond as if this attribute had been supplied with a value
Expires July 16, 1998
SHALL respond as 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 Code and Message: Status Message:
The response includes the MANDATORY status code and an OPTIONAL In addition to the REQUIRED status code returned in every
"status-message" (text) operation attribute as described in response, the response OPTIONALLY includes a "status-message"
section 3.1.5. (text) operation attribute as described in section 3.1.5.
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 15.3). conflict with one another (see sections 3.2.1.2 and 16.3).
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 the security policy in force, including whether the requesting by the security policy in force, including whether the requesting
user is the user that submitted the job (job originating user) or user is the user that submitted the job (job originating user) or
not (see section 8). However, the IPP object SHALL respond with not (see section 8). However, the IPP object MUST respond with
the 'unknown' value for any supported attribute (including all the 'unknown' value for any supported attribute (including all
MANDATORY attributes) for which the IPP object does not know the REQUIRED attributes) for which the IPP object does not know the
value, unless it would violate the security policy. See the value, unless it would violate the security policy. See the
description of the "out-of-band" values in the beginning of description 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 syntaxes and values that are part of the IPP model. The attribute syntaxes and values that are part of the IPP model. The
Expires July 16, 1998
sections below show the objects and their associated attributes which sections below show the objects and their associated attributes which
are included within the scope of this protocol. Many of these are included within the scope of this protocol. Many of these
attributes are derived from other relevant specifications: attributes are derived 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" (see section 12.2.1) which is the name of the attribute. "keyword" (see section 13.2.1) which is the name of the attribute.
The keyword is included in the section header describing that The keyword is 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 attribute syntaxes described below is "keyword" so that some the attribute syntaxes described below is "keyword" so that some
attributes have keyword values. Therefore, these attributes are attributes have keyword values. Therefore, these attributes are
defined as having an attribute syntax that is a set of keywords. defined as having 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 SHALL 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
Expires December 30, 1998
4 includes the name of attribute syntax(es) in the heading (in 4 includes the name of attribute syntax(es) in the heading (in
parentheses). A conforming implementation of an attribute SHALL parentheses). A conforming implementation of an attribute MUST
include the semantics of the attribute syntax(es) so identified. include the semantics of the attribute syntax(es) so identified.
Section 6 describes how the protocol can be extended with new Section 6.3 describes how the protocol can be extended with new
attribute syntaxes. 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
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) MAY be one of the "out-of-band" values. Standard "out-of- request) MAY be one of the "out-of-band" values. Standard "out-of-
band" values are: band" values 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 value SHALL be returned only as the value of an attribute in This value MUST be returned only as the value of an attribute in
the Unsupported Attributes Group. the 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 system administrator has not yet configured a value. the system administrator has not yet configured a value.
Expires July 16, 1998
The protocol specification defines mechanisms for passing "out-of- The protocol specification defines mechanisms for passing "out-of-
band" values. All attributes in a request SHALL have one or more band" values. All attributes in a request MUST have one or more
values as defined in Sections 4.2 to 4.4. Thus clients SHALL not values as defined in Sections 4.2 to 4.4. Thus clients MUST NOT
supply attributes with "out-of-band" values. All attribute in a supply attributes with "out-of-band" values. All attribute in a
response SHALL 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 or a single "out-of-band" value. 4.4 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, a few attributes (e.g., "job-sheet", "media", "job-hold- However, a few attributes (e.g., "job-sheet", "media", "job-hold-
until") are defined to have several attribute syntaxes, depending on until") are defined to have several attribute syntaxes, depending on
the value. These multiple attribute syntaxes are separated by the "|" the value. These multiple attribute syntaxes are separated by the "|"
character in the sub-section heading to indicate the choice. Since character in the sub-section heading to indicate the choice. Since
each value SHALL be tagged as to its attribute syntax in the protocol, each value MUST be tagged as to its attribute syntax in the protocol,
a single-valued attribute instance may have any one of its attribute a single-valued attribute instance may have any one of its attribute
syntaxes and a multi-valued attribute instance may have a mixture of syntaxes and a multi-valued attribute instance may have a mixture of
its defined attribute syntaxes. its defined attribute syntaxes.
4.1.1 'text' 4.1.1 'text'
The 'text' attribute syntax is a sequence of one or more characters A text attribute is an attribute whose value is a sequence of zero or
encoded in a maximum of 1023 octets which is indicated in sub-section more characters encoded in a maximum of 1023 ('MAX') octets. MAX is
headers using the notation: text(MAX). If an attribute is specified the maximum length for each value of any text attribute. However, if
to have a smaller maximum in its sub-section header description, the an attribute will always contain values whose maximum length is much
explicit number of octets is indicated. For example: the "printer-
location" attribute is specified as: printer-location (text(127)).
The Printer object SHALL support the UTF-8 charset [RFC2044] and MAY Expires December 30, 1998
support additional charsets to represent 'text' values, provided that
the charsets are registered with IANA [IANA-CS]. See Section 4.1.9
for the specification of the 'charset' attribute syntax, including
restricted semantics and examples of charsets.
In this specification, attributes that are indicated to have the less than MAX, the definition of that attribute will include a
'text' attribute syntax, also automatically have the qualifier that defines the maximum length for values of that
'textWithLanguage' attribute syntax. See section 4.1.2. attribute. For example: the "printer-location" attribute is specified
as "printer-location (text(127))". In this case, text values for
"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.
If the client needs to supply or the Printer object needs to return a In this specification, all text attributes are defined using the
'text' attribute in a different natural language from the rest of the 'text' syntax. However, 'text' is used only for brevity; the formal
'text' attributes in the request or response as indicated by the interpretation of 'text' is: 'textWithoutLanguage | textWithLanguage'.
"attributes-natural-language" operation attribute (see Section 3.1.4) That is, for any attribute defined in this specification using the
or job attribute (see Section 4.3.24), the client or Printer object 'text' attribute syntax, all IPP objects and clients MUST support both
SHALL identify the natural language for that attribute. This the 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes.
MANDATORY mechanism for identifying the natural language of a single However, in actual usage and protocol execution, objects and clients
attribute value is called the Natural Language Override mechanism. accept and return only one of the two syntax per attribute. The
This mechanism uses an alternate attribute syntax, called syntax 'text' never appears "on-the-wire".
'textWithLanguage', which is described in section 4.1.2.
Expires July 16, 1998 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).
4.1.2 'textWithLanguage' The 'textWithoutLanguage' and 'textWithLanguage' attribute syntaxes
are described in more detail in the following sections.
The 'textWithLanguage' attribute syntax is a compound attribute syntax 4.1.1.1 'textWithoutLanguage'
consisting of two parts: a 'text' part plus an additional
'naturalLanguage' (see section 4.1.10) part that overrides the natural
language in force. The 'naturalLanguage' part explicitly identifies
the natural language that applies to the text part of that value and
that value alone. The 'text' part is limited to 1023 octets, and the
'naturalLanguage' part is limited to 63 octets. If the sub-section
header specifying an attribute with attribute syntax 'text' with a
smaller explicit value than MAX, that value applies to the 'text' part
of the 'textWithLanguage' as well.
If the client needs to supply or the Printer object needs to return a The 'textWithoutLanguage' syntax indicates a value that is sequence of
'text' attribute value in a different natural language from the rest zero or more characters. Text strings are encoded using the rules of
of the 'text' attribute values in the request or response as indicated some charset. The Printer object MUST support the UTF-8 charset
by the "attributes-natural-language" operation attribute (see Section [RFC2044] and MAY support additional charsets to represent 'text'
3.1.4) or to the "attributes-natural-language" Job attribute, if values, provided that the charsets are registered with IANA [IANA-CS].
present, in the case of a Get-Jobs response, the client or IPP object
SHALL identify the natural language for that attribute using the
'textWithLanguage' attribute syntax.
The 'textWithLanguage' attribute syntax is the so-called Natural Expires December 30, 1998
Language Override mechanism for the 'text' attribute syntax and MUST
be supported by IPP objects. See Section 4.1.7 for the specification of the 'charset' attribute
syntax, including restricted semantics and examples of charsets.
4.1.1.2 'textWithLanguage'
The 'textWithLanguage' attribute syntax is a compound attribute syntax
consisting of two parts: a 'textWithoutLanguage' part plus an
additional 'naturalLanguage' (see section 4.1.8) part that overrides
the natural language in force. The 'naturalLanguage' part explicitly
identifies the natural language that applies to the text part of that
value and that value alone. For any give text attribute, the
'textWithoutLanguage' part is limited to the maximum length defined
for that attribute, , but the 'naturalLanguage' part is always limited
to 63 octets. Using the 'textWithLanguage' attribute syntax rather
than the normal 'textWithoutLanguage' syntax is the so-called Natural
Language Override mechanism and MUST be supported by all IPP objects
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 or
to the "attributes-natural-language" Job attribute, if present, in the to the "attributes-natural-language" Job attribute, if present, in the
case of a Get-Jobs response. case of a Get-Jobs response.
Any attribute that is specified to have the 'text' attribute syntax in
this document, automatically also has the 'textWithLanguage' attribute
syntax. IPP objects SHALL accept, support, and return both the 'text'
and 'textWithLanguage' attribute syntaxes for any attribute in this
specification that is indicated to have the 'text' attribute syntax.
For brevity in this specification, only the 'text' attribute syntax is
indicated for attributes. However, the interpretation of 'text' SHALL
be as if it were: 'text | textWithLanguage'.
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 any 'textWithLanguage' attribute value, whether the Printer store any 'textWithLanguage' attribute value, whether the Printer
Expires July 16, 1998
object supports that natural language or not. These requirements are object 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 'textWithLanguage' attribute syntax with the following two values: the '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 Protocol document [IPP-PRO] for a detailed example of the
'textWithLanguage' attribute syntax. 'textWithLanguage' attribute syntax.
4.1.3 'name' Expires December 30, 1998
The 'name' attribute syntax is the same as 'text', including the 4.1.2 'name'
MANDATORY support of UTF-8 and the Natural Language Override
mechanism, except that the sequence of characters is limited so that
its encoded form is of length 1 to 255 octets which is indicated in
sub-section headers using the notation: name(MAX). If an attribute is
specified to have a smaller maximum, the explicit number of octets is
indicated. For example: the "printer-name" attribute is specified as:
printer-name (name(127)). This syntax type is used for user-friendly
strings, such as a Printer name, that, for humans, are more meaningful
than identifiers.
In this specification, attributes that are indicated to have the This syntax type is used for user-friendly strings, such as a Printer
'name' attribute syntax, also automatically have the name, that, for humans, are more meaningful than identifiers. Names
'nameWithLanguage' attribute syntax. See section 4.1.4. are usually never translated from one natural language to another.
The 'name' attribute syntax is essentially the same as 'text',
including the REQUIRED support of UTF-8 except that the sequence of
characters is limited so that its encoded form MUST NOT exceed 255
(MAX) octets.
Also like 'text', 'name' is really an abbreviated notation for either
'nameWithoutLanguage' or 'nameWithLanguage'. That is, all IPP
objects and clients MUST support both the 'nameWithoutLanguage' and
'nameWithLanguage' attribute syntaxes. However, in actual usage and
protocol execution, objects and clients accept and return only one of
the two syntax per attribute. The syntax 'name' never appears "on-
the-wire".
Note: Only the 'text' and 'name' attribute syntaxes permit the Note: Only the 'text' and 'name' attribute syntaxes permit the
Natural Language Override mechanism. Natural Language Override mechanism.
4.1.4 'nameWithLanguage' Some attributes are defined as 'type3 keyword | name'. These
attributes support values that are either type3 keywords or names.
This dual-syntax mechanism enables a site administrator to extend
these attributes to legally include values that are locally defined by
the site administrator. Such names are not registered with IANA.
The 'nameWithLanguage' attribute syntax is the same as 4.1.2.1 'nameWithoutLanguage'
'textWithLanguage', including the MANDATORY support of UTF-8, except
that the length of the 'name' part SHALL not exceed 255 octets. This
attribute syntax is the so-called Natural Language Override mechanism
for the 'name' attribute syntax and MUST be supported by IPP objects.
Example: If the client supplies the "attributes-natural-language" The nameWithoutLanguage' syntax indicates a value that is sequence of
operation attribute with the value: 'en' indicating English, but the zero or more characters so that its encoded form does not exceed MAX
octets.
Expires July 16, 1998 4.1.2.2 'nameWithLanguage'
The 'nameWithLanguage' attribute syntax is a compound attribute syntax
consisting of two parts: a 'nameWithoutLanguage' part plus an
additional 'naturalLanguage' (see section 4.1.8) part that overrides
the natural language in force. The 'naturalLanguage' part explicitly
identifies the natural language that applies to that name value and
that name value alone.
The 'nameWithLanguage' attribute syntax behaves the same as the
'textWithLanguage' syntax. If a name is in a language that is
different than the rest of the object or operation, then this
Expires December 30, 1998
'nameWithLanguage' syntax is used rather than the generic
'nameWithoutLanguage' syntax.
Example: If the client supplies the "attributes-natural-language"
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.5 '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 255, containing only the US-ASCII [ASCII] encoded values for to 255, containing only the US-ASCII [ASCII] encoded values for
lowercase letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot lowercase letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot
("."), and underscore ("_"). The first character MUST be a lowercase ("."), and underscore ("_"). The first character MUST be a lowercase
letter. Furthermore, keywords SHALL be in U.S. English. 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. Unlike 'text' and 'name' attribute values, 'keyword' attributes. Unlike 'text' and 'name' attribute values, 'keyword'
values SHALL NOT use the Natural Language Override mechanism, since values MUST NOT use the Natural Language Override mechanism, since
they SHALL always be US-ASCII and U.S. English. they MUST always be US-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 unique within the full scope of all IPP objects and attributes. be unique within the full scope of all IPP objects and attributes.
When a keyword is used to represent a value of an attribute, it MUST When a keyword is used to represent a value of an attribute, it MUST
be unique just within the scope of that attribute. That is, the same be unique just within the scope of that attribute. That is, the same
keyword SHALL not be used for two different values within the same keyword MUST NOT be used for two different values within the same
attribute to mean two different semantic ideas. However, the same attribute to mean two different semantic ideas. However, the same
keyword MAY be used across two or more attributes, representing keyword MAY be used across two or more attributes, representing
different semantic ideas for each attribute. Section 6 describes how different semantic ideas for each attribute. Section 6.1 describes
the protocol can be extended with new keyword values. Examples of how the protocol can be extended with new keyword values. Examples of
attribute name keywords: attribute name keywords:
Expires December 30, 1998
"job-name" "job-name"
"attributes-charset" "attributes-charset"
Expires July 16, 1998 Note: This document uses "type1", "type2", and "type3" prefixes to
the "keyword" basic syntax to indicate different levels of review for
extensions (see section 6.1).
4.1.6 '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 -2**31 (MIN) to 2**31 - 1 (MAX). Each value has an the range from 1 to 2**31 - 1 (MAX). Each value has an associated
associated 'keyword' name. In the definition for each attribute of 'keyword' name. In the definition for each attribute of this syntax
this syntax type, the full set of possible values for that attribute type, the full set of possible values for that attribute are listed.
are listed. This syntax type is used for attributes for which there This syntax type is used for attributes for which there are enum
are enum values assigned by other standards, such as SNMP MIBs. A values assigned by other standards, such as SNMP MIBs. A number of
number of attribute enum values in this specification are also used attribute enum values in this specification are also used for
for corresponding attributes in other standards [RFC1759]. This corresponding attributes in other standards [RFC1759]. This syntax
syntax type is not used for attributes to which the system type is not used for attributes to which the system administrator may
administrator may assign values. Section 6 describes how the protocol assign values. Section 6.1 describes how the protocol can be extended
can be extended with new enum values. with new enum values.
Enum values are for use in the protocol. A user interface will Enum values are for use in the protocol. A user interface will
provide a mapping between protocol enum values and displayable user- provide a mapping between protocol enum values 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 enum symbols specified in this document MAY be 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-of-band" value 'unknown'. See the description of the "out-of- "out-of-band" value 'unknown'. See the description of the "out-of-
band" values at the beginning of Section 4.1. Therefore, attributes band" values at the beginning of Section 4.1. Therefore, attributes
of type 'enum' start at '3'. of type 'enum' start at '3'.
4.1.7 'uri' Note: This document uses "type1", "type2", and "type3" prefixes to
the "enum" basic syntax to indicate different levels of review for
extensions (see section 6.1).
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 [RFC1630]. Most often, URIs are simply Uniform Resource Locators
or URLs [RFC1738] [RFC1808]. The maximum length of URIs used within or URLs [RFC1738] [RFC1808]. The maximum length of URIs used within
IPP is 1023 octets. IPP is 1023 octets. Although most other IPP syntax types allow for
only lower-cased values, this syntax type allows for mixed-case
4.1.8 'uriScheme' Expires December 30, 1998
values. The URI and URL standards allow for mixed-case values that
are case-sensitive.
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 1738 [RFC1738]. Though RFC
1736 requires that the values be case-insensitive, IPP requires all 1736 requires that the values be case-insensitive, IPP requires all
lower case to simplify comparing by IPP clients and Printer objects. lower case to simplify comparing by IPP clients and Printer objects.
Standard values for this syntax type are the following keywords: 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 HTTPS schemed URIs (e.g., "https:...") 'https': for use with HTTPS schemed URIs (e.g., "https:...") (not
on 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:...")
Expires July 16, 1998
'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 schemes used within IPP
is 63 octets. is 63 octets.
4.1.9 '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 specified in RFC 2046 [RFC2046] and contained in the IANA are specified in RFC 2046 [RFC2046] and contained in the IANA
character-set Registry [IANA-CS] according to the IANA procedures character-set Registry [IANA-CS] according to the IANA procedures
[IANA-CSa]. Though RFC 2046 requires that the values be case- [RFC2278]. Though RFC 2046 requires that the values be case-
insensitive US-ASCII, IPP requires all lower case to simplify insensitive US-ASCII, IPP requires all lower case to simplify
comparing by IPP clients and Printer objects. When a character-set in 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 the IANA registry has more than one name (alias), the name labeled as
"(preferred MIME name)", if present, SHALL be used. "(preferred MIME name)", if present, MUST be used.
The maximum length of charset values used within IPP is 63 octets. The maximum length of charset values used within IPP 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 [RFC2044] transfer encoding scheme (UCS) represented as the UTF-8 [RFC2279] transfer encoding scheme
in which US-ASCII is a subset charset. The 'utf-8' charset value in which US-ASCII is a subset charset.
supplied in the "attributes-charset" operation attribute (see
Section 3.1.4), which is used to identify the charset of 'text'
and 'name' attributes, SHALL be restricted to any characters
defined by ISO 10646 [ISO10646-1].
'us-ascii': 7-bit American Standard Code for Information 'us-ascii': 7-bit American Standard Code for Information
Interchange (ASCII), ANSI X3.4-1986 [ASCII]. That standard Interchange (ASCII), ANSI X3.4-1986 [ASCII]. That standard
Expires December 30, 1998
defines US-ASCII, but RFC 2045 [46] eliminates most of the defines US-ASCII, but RFC 2045 [46] eliminates most of the
control characters from conformant usage in MIME and IPP. control characters from conformant usage in MIME and IPP.
'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet 'iso-8859-1': 8-bit One-Byte Coded Character Set, Latin Alphabet
Nr 1 [ISO8859-1]. That standard defines a coded character set Nr 1 [ISO8859-1]. That standard defines a coded character set
that is used by Latin languages in the Western Hemisphere and that is used by Latin languages in the Western Hemisphere and
Western Europe. US-ASCII is a subset charset. 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 values that may be used, such as MANDATORY values that MUST be charset values that may be used, such as REQUIRED values that MUST be
Expires July 16, 1998
supported or additional restrictions, such as requiring that the supported or additional restrictions, such as requiring that the
charset have US-ASCII as a subset charset. charset have US-ASCII as a subset charset.
4.1.10 '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 taken from 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 simplify comparing by IPP clients and Printer objects. Examples to 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 within IPP is 63
octets. octets.
4.1.11 '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 Registry [IANA-MT]. Examples: IANA Registry [IANA-MT]. Although most other IPP syntax types allow
for only lower-cased values, this syntax type allows for mixed-case
values which are case-insensitive.
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 SHALL 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-1 (Latin 1) [ISO8859-1]. 8859-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 10646 represented in two octets (UCS-2) [ISO10646-1] ISO 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
Expires July 16, 1998
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 SHALL be capable of auto- supports this value, the Printer object MUST be capable of auto-
sensing the format of the document data. If the Printer object's sensing the format of the document data. If the Printer object's
default value attribute "document-format-default" is set to default value attribute "document-format-default" is set to
'application/octet-stream', the Printer object not only supports auto- 'application/octet-stream', the Printer object not only supports auto-
sensing of the document format, but will depend on the result of sensing of the document format, but will depend on the result of
applying its auto-sensing when the client does not supply the applying its auto-sensing when the client does not supply the
"document-format" attribute. If the client supplies a document format "document-format" attribute. If the client supplies a document format
value, the Printer SHALL rely on the supplied attribute, rather than value, the Printer MUST rely on the supplied attribute, rather than
trust its auto-sensing algorithm. To summarize: trust its auto-sensing algorithm. 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 MUST rely on its default value setting (which may be Printer 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 of the document data and the Printer object SHALL trust format of the document data and the Printer object MUST trust the
the client supplied value more than the outcome of applying an client supplied value more than the outcome of applying an
automatic format detection mechanism. For example, the client automatic format detection mechanism. For example, the client
may be requesting the printing of a PostScript file as a may be requesting the printing of a PostScript file as a
'text/plain' document. The Printer object SHALL print a text 'text/plain' document. The Printer object MUST print a text
representation of the PostScript commands rather than interpret representation of the PostScript commands rather than interpret
the stream of PostScript commands and print the result. the stream of PostScript commands and print the result.
3. If the client supplies a value of 'application/octet-stream', 3. If the client supplies a value of 'application/octet-stream',
the client is indicating that the Printer object SHALL use its the client is indicating that the Printer object MUST use its
auto-sensing mechanism on the client supplied document data auto-sensing mechanism on the client supplied document data
whether auto-sensing is the Printer object's default or not. whether auto-sensing is the Printer object's default or not.
Note: Since the auto-sensing algorithm is probabilistic, if the Note: Since the auto-sensing algorithm is probabilistic, if the
client requests both auto-sensing ("document-format" set to client requests both auto-sensing ("document-format" set to
'application/octet-stream') and true fidelity ("ipp-attribute- 'application/octet-stream') and true fidelity ("ipp-attribute-
Expires December 30, 1998
fidelity" set to 'true'), the Printer object might not be able to fidelity" set to 'true'), the Printer object might not be able to
guarantee exactly what the end user intended (the auto-sensing guarantee exactly what the end user intended (the auto-sensing
algorithm might mistake one document format for another ), but it is algorithm might mistake one document format for another ), but it is
able to guarantee that its auto-sensing mechanism be used. able to guarantee that its auto-sensing mechanism be used.
The maximum length of a 'mimeMediaType' value in IPP is 63 octets. The maximum length of a 'mimeMediaType' value in IPP is 255 octets.
4.1.12 '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 maximum of 1023 octets which is indicated in sub-section headers a maximum of 1023 octets which is indicated in sub-section headers
using the notation: octetString(MAX). This syntax type is used for using the notation: octetString(MAX). This syntax type is used for
opaque data. opaque data.
Expires July 16, 1998 4.1.11 'boolean'
4.1.13 'boolean'
The 'boolean' attribute syntax is similar to an enum with only two The 'boolean' attribute syntax is similar to an enum with only two
values: 'true' and 'false'. values: 'true' and 'false'.
4.1.14 '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 from -2**31 (MIN) to 2**31 - 1 (MAX). Each individual attribute range from -2**31 (MIN) to 2**31 - 1 (MAX). Each individual attribute
may specify the range constraint explicitly in sub-section headers if may specify the range constraint explicitly in sub-section headers if
the range is different from the full range of possible integer values. the range is different from the full range of possible integer values.
For example: job-priority (integer(1:100)) for the "job-priority" For 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 to the IPP objects, not the protocol. up to the IPP objects, not the protocol.
4.1.15 '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 a range constraint is specified in the header description for an If 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), then the constraint applies to both integers. value), then the constraint applies to both integers.
4.1.16 '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
[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.17 'resolution' 4.1.15 'resolution'
The 'resolution' attribute syntax specifies a two-dimensional The 'resolution' attribute syntax specifies a two-dimensional
resolution in the indicated units. It consists of 3 integers: a cross resolution in the indicated units. It consists of 3 integers: a cross
feed direction resolution (positive integer value), a feed direction feed direction resolution (positive integer value), a feed direction
resolution (positive integer value), and a units value. The semantics resolution (positive integer value), and a units value. The semantics
of these three components are taken from the Printer MIB [RFC1759] of these three components are taken from the Printer MIB [RFC1759]
suggested values. That is, the cross feed direction component suggested values. That is, the cross feed direction component
Expires July 16, 1998
resolution component is the same as the resolution component is the same as the
prtMarkerAddressabilityXFeedDir object in the Printer MIB, the feed prtMarkerAddressabilityXFeedDir object in the Printer MIB, the feed
direction component resolution component is the same as the direction component resolution component is the same as the
prtMarkerAddressabilityFeedDir in the Printer MIB, and the units prtMarkerAddressabilityFeedDir in the Printer MIB, and the units
component is the same as the prtMarkerAddressabilityUnit object in the component is the same as the prtMarkerAddressabilityUnit object in the
Printer MIB (namely, '3' indicates dots per inch and '4' indicates Printer MIB (namely, '3' indicates dots per inch and '4' indicates
dots per centimeter). All three values MUST be present even if the dots per centimeter). All three values MUST be present even if the
first two values are the same. Example: '300', '600', '3' indicates first two values are the same. Example: '300', '600', '3' indicates
a 300 dpi cross-feed direction resolution, a 600 dpi feed direction a 300 dpi cross-feed direction resolution, a 600 dpi feed direction
resolution, since a '3' indicates dots per inch (dpi). resolution, since a '3' indicates dots per inch (dpi).
4.1.18 '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 type X. This syntax type is used for multi-valued attributes. syntax type X. This syntax type is used for multi-valued attributes.
The syntax type is called '1setOf' rather than just 'setOf' as a The syntax type is called '1setOf' rather than just 'setOf' as a
reminder that the set of values SHALL NOT be empty (i.e., a set of reminder that the set of values MUST NOT be empty (i.e., a set of size
size 0). Sets are normally unordered. However each attribute 0). Sets are normally unordered. However each attribute description
description of this type may specify that the values MUST be in a of this type may specify that the values MUST be in a certain order
certain order for that attribute. for that 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
12.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":
1. If the Printer object supports "xxx" then it SHALL support both Expires December 30, 1998
a "xxx-default" attribute (unless there is a "No" in the table 1. If the Printer object supports "xxx" then it MUST support both a
"xxx-default" attribute (unless there is a "No" in the table
below) and a "xxx-supported" attribute. If the Printer object below) and a "xxx-supported" attribute. If the Printer object
doesn't support "xxx", then it SHALL support neither an "xxx- doesn't support "xxx", then it MUST support neither an "xxx-
default" attribute nor an "xxx-supported" attribute, and it SHALL default" attribute nor an "xxx-supported" attribute, and it MUST
treat an attribute "xxx" supplied by a client as unsupported. An treat an attribute "xxx" supplied by a client as unsupported. An
attribute "xxx" may be supported for some document formats and attribute "xxx" may be supported for some document formats and
not supported for other document formats. For example, it is not supported for other document formats. For example, it is
expected that a Printer object would only support "orientations- expected that a Printer object would only support "orientation-
requested" for some document formats (such as 'text/plain' or requested" for some document formats (such as 'text/plain' or
'text/html') but not others (such as 'application/postscript'). '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,
Expires July 16, 1998
the client is indicating that the Printer object apply its the client is indicating that the Printer object apply its
default job processing behavior at job processing time if the default job processing behavior at job processing time if the
document content does not contain an embedded instruction document content does not contain an embedded instruction
indicating an xxx-related behavior. indicating an xxx-related behavior.
Note: Since an administrator MAY change the default value Note: Since an administrator MAY change the default value
attribute after a Job object has been submitted but before it has attribute after a Job object has been submitted but before it has
been processed, the default value used by the Printer object at been processed, the default value used by the Printer object at
job processing time may be different that the default value in job processing time may be different that the default value in
effect at job submission time. effect at job submission time.
skipping to change at page 66, line 39 skipping to change at page 71, line 4
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 attribute in the create request or implicitly as an embedded IPP 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 values from which to choose, the application SHOULD query supported values from which to choose, the application SHOULD query
the Printer object for its supported value attributes. The the Printer object for its supported value attributes. The
Expires December 30, 1998
application SHOULD also query the default value attributes. If the application SHOULD also query the default value attributes. If the
application then limits selectable values to only those value that are application then limits selectable values to only those value that are
supported, the application can guarantee that the values supplied by supported, the application can guarantee that the values supplied by
the client in the create request all fall within the set of supported the client in the create request all fall within the set of supported
values at the Printer. When querying the Printer, the client MAY values at the Printer. When querying the Printer, the client MAY
enumerate each attribute by name in the Get-Printer-Attributes enumerate each attribute by name in the Get-Printer-Attributes
Request, or the client MAY just name the "job-template" group in order Request, or the client MAY just name the "job-template" group in order
to get the complete set of supported attributes (both supported and to get the complete set of supported attributes (both supported and
default attributes). 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
supported attribute contains a set of supported values. The default supported attribute contains a set of supported values. The default
Expires July 16, 1998
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 new Job if the client does not supply a "finishings" attribute in a new Job if the client does not supply a "finishings" attribute in
the create request and the document data does not contain any the create request and the document data does not contain any
corresponding finishing instructions. If the client does supply the corresponding finishing instructions. If the client does supply the
"finishings" attribute in the create request, the IPP object validates "finishings" attribute in the create request, the IPP object validates
the value or values to make sure that they are a subset of the the value or values to make sure that they are a subset of the
supported values identified in the Printer object's "finishings- supported values identified in the Printer object's "finishings-
supported" attribute. See section 3.2.1.2. supported" attribute. 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 the Job object. These are the attributes that can optionally be in the Job object. These are the attributes that can optionally be
supplied by the client in a create request. The last two columns supplied by the client in a create request. The last two columns
(labeled "Printer: Default Value Attribute" and "Printer: Supported (labeled "Printer: Default Value Attribute" and "Printer: Supported
Values Attribute") shows the name and syntax for each Job Template Values Attribute") shows the name and syntax for each Job Template
attribute in the Printer object (the default value attribute and the attribute in the Printer object (the default value attribute and the
supported values attribute). A "No" in the table means the Printer supported values attribute). A "No" in the table means the Printer
SHALL NOT support the attribute (that is, the attribute is simply not MUST NOT support the attribute (that is, the attribute is simply not
applicable). For brevity in the table, the 'text' and 'name' entries applicable). For brevity in the table, the 'text' and 'name' entries
do not show (MAX). do not show the maximum length for each attribute.
Expires July 16, 1998 Expires December 30, 1998
+===================+======================+======================+ +===================+======================+======================+
| 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- |
| (type4 keyword | | default | supported | | (type3 keyword | | default | supported |
| name) | (type4 keyword | |(1setOf | | name) | (type3 keyword | |(1setOf |
| | name) | type4 keyword | name)| | | name) | type3 keyword | name)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| job-sheets | job-sheets-default |job-sheets-supported | | job-sheets | job-sheets-default |job-sheets-supported |
| (type4 keyword | | (type4 keyword | |(1setOf | | (type3 keyword | | (type3 keyword | |(1setOf |
| name) | name) | type4 keyword | name)| | name) | name) | type3 keyword | name)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
|multiple-document- |multiple-document- |multiple-document- | |multiple-document- |multiple-document- |multiple-document- |
| handling | handling-default |handling-supported | | handling | handling-default |handling-supported |
| (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)| | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| copies | copies-default | copies-supported | | copies | copies-default | copies-supported |
| (integer (1:MAX)) | (integer (1:MAX)) | (integer (1:MAX)) | | (integer (1:MAX)) | (integer (1:MAX)) | (rangeOfInteger |
| | | (1:MAX)) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| finishings | finishings-default | finishings-supported | | finishings | finishings-default | finishings-supported |
|(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) | |(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| page-ranges | No | page-ranges- | | page-ranges | No | page-ranges- |
| (1setOf | | supported (boolean) | | (1setOf | | supported (boolean) |
| rangeOfInteger | | | | rangeOfInteger | | |
| (1:MAX)) | | | | (1:MAX)) | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| sides | sides-default | sides-supported | | sides | sides-default | sides-supported |
| (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)| | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| number-up | number-up-default | number-up-supported | | number-up | number-up-default | number-up-supported |
| (integer (0:MAX)) | (integer (0:MAX)) |(1setOf integer | | (integer (1:MAX)) | (integer (1:MAX)) |(1setOf integer |
| | | (0:MAX) | | | | | (1:MAX) | |
| | | rangeOfInteger | | | | rangeOfInteger |
| | | (0: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 |
| (type4 keyword | | (type4 keyword | |(1setOf | | (type3 keyword | | (type3 keyword | |(1setOf |
| name) | name) | type4 keyword | name)| | name) | name) | type3 keyword | name)|
| | | |
Expires July 16, 1998 Expires December 30, 1998
| | | |
| | | media-ready | | | | media-ready |
| | |(1setOf | | | |(1setOf |
| | | type4 keyword | name)| | | | type3 keyword | name)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| 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 SHALL 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 SHALL 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 range with any Printer object. If privileged jobs are entire range with any Printer object. If privileged jobs are
implemented outside IPP/1.0, they SHALL have priorities higher than implemented outside IPP/1.0, they MUST have priorities higher than
100, rather than restricting the range available to end-users. 100, rather than 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 SHALL use the supported by the Printer object, the Printer object MUST use the value
value of the Printer object's "job-priority-default" at job submission of the Printer object's "job-priority-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).
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 SHALL 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.
Expires July 16, 1998
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 of values is: 25 and 75; if n = 3, the sequence of values sequence of values is: 25 and 75; if n = 3, the sequence of values
is: 17, 50 and 83; if n = 10, the sequence of values is: 5, 15, 25, is: 17, 50 and 83; if n = 10, the sequence of values is: 5, 15, 25,
35, 45, 55, 65, 75, 85, and 95; if n = 100, the sequence of values 35, 45, 55, 65, 75, 85, and 95; if n = 100, the sequence of values
is: 1, 2, 3, _ 100. is: 1, 2, 3, _ 100.
If the value of the Printer object's "job-priority-supported" is 10 If the value of the Printer object's "job-priority-supported" is 10
and the client supplies values in the range 1 to 10, the Printer 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 object maps them to 5, in the range 11 to 20, the Printer object maps
them to 15, etc. them to 15, etc.
4.2.2 job-hold-until (type4 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
SHALL become a candidate for printing. MUST become a candidate for printing.
Standard values for named time periods are: Standard 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 SHALL associate allowable print times with a named An administrator MUST associate allowable print times with a named
time period (by means outside IPP/1.0). An administrator is time period (by means outside IPP/1.0). An administrator is
encouraged to pick names that suggest the type of time period. An encouraged to pick names that suggest the type of time period. An
administrator MAY define additional values using the 'name' or administrator MAY define additional values using the 'name' or
'keyword' attribute syntax, depending on implementation. 'keyword' attribute syntax, 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 SHALL add the 'job-hold-until-specified' value to future, the Printer MUST add the 'job-hold-until-specified' value to
the job's "job-state-reasons" attribute, move the job to the 'pending- the job's "job-state-reasons" attribute, move the job to the 'pending-
held' state, and SHALL NOT schedule the job for printing until the held' state, and MUST NOT schedule the job for printing until the
specified time-period arrives. When the specified time period specified time-period arrives. When the specified time period
arrives, the Printer SHALL remove the 'job-hold-until-specified' value arrives, the Printer MUST remove the 'job-hold-until-specified' value
from the job's "job-state-reason" attribute and, if there are no other from the job's "job-state-reason" attribute and, if there are no other
job state reasons that keep the job in the 'pending-held' state, the job state reasons that keep the job in the 'pending-held' state, the
Printer SHALL consider the job as a candidate for processing by moving Printer MUST consider the job as a candidate for processing by moving
the job to the 'pending' state. the job to the 'pending' state.
Expires July 16, 1998 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 SHALL be a specified time period has already started, the job MUST be a candidate
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 SHALL use the supported by the Printer object, the Printer object MUST use the value
value of the Printer object's "job-hold-until-default" at job of the Printer object's "job-hold-until-default" at job submission
submission time (unlike most Job Template attributes that are used if time (unlike most Job Template attributes that are used if necessary
necessary at job processing time). at job processing time).
4.2.3 job-sheets (type4 keyword | name(MAX)) 4.2.3 job-sheets (type3 keyword | name(MAX))
This attribute determines which job start/end sheet(s), if any, SHALL This attribute determines which job start/end sheet(s), if any, MUST
be printed with a job. be printed with a job.
Standard values are: Standard 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
skipping to change at page 71, line 52 skipping to change at page 75, line 52
also controls the order in which the copies that result from also controls the order in which the copies that result from
processing the documents are produced. For the purposes of this processing the documents are produced. For the purposes of this
explanations, if "a" represents an instance of document data, then the explanations, if "a" represents an instance of document data, then the
result of processing the data in document "a" is a sequence of media result of processing the data in document "a" is a sequence of media
sheets represented by "a(*)". sheets represented by "a(*)".
Standard values are: Standard 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 the document data (a and then b) SHALL be treated as a single all the document data (a and then b) MUST be treated as a single
Expires July 16, 1998 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 a(*),b(*). The Printer object SHALL NOT force the data sequences a(*),b(*). The Printer object MUST NOT force the data
in each document instance to be formatted onto a new print-stream in each document instance to be formatted onto a new print-stream
page, nor to start a new impression on a new media sheet. If more page, nor to start a new impression on a new media sheet. If more
than one copy is made, the ordering of the sets of media sheets than one copy is made, the ordering of the sets of media sheets
resulting from processing the document data SHALL be a(*), b(*), resulting from processing the document data MUST be a(*), b(*),
a(*), b(*), ..., and the Printer object SHALL force each copy a(*), b(*), ..., and the Printer object MUST force each copy
(a(*),b(*)) to start on a new media sheet. (a(*),b(*)) to 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 documents, say, the document data is called a and b, multiple documents, say, the document data is called a and b,
then the result of processing the data in each document instance then the result of processing the data in each document instance
SHALL be treated as a single sequence of media sheets for MUST be treated as a single sequence of media sheets for
finishing operations; that is, the sets a(*) and b(*) would each finishing operations; that is, the sets a(*) and b(*) would each
be finished separately. The Printer object SHALL force each copy be finished separately. The Printer object MUST force each copy
of the result of processing the data in a single document to of the result of processing the data in a single document to
start on a new media sheet. If more than one copy is made, the start on a new media sheet. If more than one copy is made, the
ordering of the sets of media sheets resulting from processing ordering of the sets of media sheets resulting from processing
the document data SHALL be a(*), a(*), ..., b(*), b(*) ... . the document data MUST be 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 SHALL be result of processing the data in each document instance MUST be
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 separately. The Printer object SHALL force each copy of finished separately. The Printer object MUST force each copy of
the result of processing the data in a single document to start the result of processing the data in a single document to start
on a new media sheet. If more than one copy is made, the on a new media sheet. If more than one copy is made, the
ordering of the sets of media sheets resulting from processing ordering of the sets of media sheets resulting from processing
the document data SHALL be a(*), b(*), a(*), b(*), ... . the document data MUST be a(*), b(*), a(*), b(*), ... .
The 'single-document' value is the same as 'separate-documents- The 'single-document' value is the same as 'separate-documents-
collated-copies' with respect to ordering of print-stream pages, but collated-copies' with respect to ordering of print-stream pages, but
not media sheet generation, since 'single-document' will put the first not media sheet generation, since 'single-document' will put the first
page of the next document on the back side of a sheet if an odd number page of the next document on the back side of a sheet if an odd number
of pages have been produced so far for the job, while 'separate- of pages have been produced so far for the job, while 'separate-
documents-collated-copies' always forces the next document or document documents-collated-copies' always forces the next document or document
copy on to a new sheet. In addition, if the "finishings" attribute copy on to a new sheet. In addition, if the "finishings" attribute
specifies 'staple', then with 'single-document', documents a and b are specifies 'staple', then with 'single-document', documents a and b are
stapled together as a single document, but with 'separate-documents- stapled together as a single document, but with 'separate-documents-
uncollated-copies' and 'separate-documents-collated-copies', documents uncollated-copies' and 'separate-documents-collated-copies', documents
a and b are stapled separately. 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 document processing is described in section 15.5. control document processing is described in section 16.5.
Expires July 16, 1998 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 by the number of physical output bins on the device, and may limited by the number of physical output bins on the device, and may
be different from the number of uncollated copies which can be 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 15.5. that control document processing is described in section 16.5.
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 for each copy of each printed document in the Job. For Jobs with uses 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: Standard values are:
skipping to change at page 74, line 5 skipping to change at page 78, line 5
document. This does not supplant the specification of a document. This does not supplant the specification of a
printed cover (on cover stock medium) by the document printed cover (on cover stock medium) by the document
itself. itself.
'7' 'bind': This value indicates that a binding is to be '7' 'bind': This value indicates that a binding is to be
applied to the document; the type and placement of the applied to the document; the type and placement of the
binding is 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 July 16, 1998 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 15.5. that control document processing is described in section 16.5.
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 of values had been supplied (that is the 'none' value has combination 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 in the document(s). Ranges SHALL be in ascending order, for exist in the document(s). Ranges MUST be in ascending order, for
example: 1-3, 5-7, 15-19 and SHALL NOT overlap, so that a non-spooling example: 1-3, 5-7, 15-19 and MUST NOT overlap, so that a non-spooling
Printer object can process the job in a single pass. If the ranges Printer object can process the job in a single pass. If the ranges
are not ascending or are overlapping, the IPP object SHALL reject the are not ascending or are overlapping, the IPP object MUST reject the
request and return the 'client-error-bad-request' status code. request and return the 'client-error-bad-request' status code. The
attribute is associated with print-stream pages not application-
numbered pages (for example, the page numbers found in the headers and
or footers for 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-document', the Printer object SHALL apply each supplied page 'single-document', the Printer object MUST apply each supplied page
range once to the concatenation of the print-stream pages. For range once to the concatenation of the print-stream pages. For
example, if there are 8 documents of 10 pages each, the page-range example, if there are 8 documents of 10 pages each, the page-range
'41:60' prints the pages in the 5th and 6th documents as a single '41:60' prints the pages in the 5th and 6th documents as a single
document and none of the pages of the other documents are printed. document and none of the pages of the other documents are printed.
When "multiple-document-handling" is 'separate-document-uncollated- When "multiple-document-handling" is 'separate-document-uncollated-
copies' or 'separate-document-collated-copies', the Printer object copies' or 'separate-document-collated-copies', the Printer object
SHALL apply each supplied page range repeatedly to each document copy. 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 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 pages and the 10th page of each of the 8 documents in the Job, as 8
separate documents. separate documents.
In most cases, the exact pages to be printed will be generated by a In most cases, the exact pages to be printed will be generated by a
device driver and this attribute would not be required. However, when device driver and this attribute would not be required. However, when
printing an archived document which has already been formatted, the printing an archived document which has already been formatted, the
end user may elect to print just a subset of the pages contained in 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 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 first page to be printed will be page n. All subsequent pages of the
document will be printed through and including page m. document will be printed through and including page m.
"page-ranges-supported" is a boolean value indicating whether or not "page-ranges-supported" is a boolean value indicating whether or not
the printer is capable of supporting the printing of page ranges. the printer is capable of supporting the printing of page ranges.
Expires December 30, 1998
This capability may differ from one PDL to another. There is no "page- This capability may differ from one PDL to another. There is no "page-
ranges-default" attribute. If the "page-ranges" attribute is not ranges-default" attribute. If the "page-ranges" attribute is not
supplied by the client, all pages of the document will be printed. supplied by the client, all pages of the document will be printed.
Expires July 16, 1998
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 15.5. that control document processing is described in section 16.5.
4.2.8 sides (type2 keyword) 4.2.8 sides (type2 keyword)
This attribute specifies how print-stream pages are to be imposed upon This attribute specifies how print-stream pages are to be imposed upon
the sides of an instance of a selected medium, i.e., an impression. the sides of an instance of a selected medium, i.e., an impression.
The standard values are: The standard values are:
'one-sided': imposes each consecutive print-stream page upon the 'one-sided': imposes each consecutive print-stream page upon the
same side of consecutive media sheets. same side of consecutive media sheets.
skipping to change at page 75, line 43 skipping to change at page 79, line 47
'two-sided-long-edge', 'two-sided-short-edge', 'tumble', and 'duplex' 'two-sided-long-edge', 'two-sided-short-edge', 'tumble', and 'duplex'
all work the same for portrait or landscape. However 'head-to-toe' is all work the same for portrait or landscape. However 'head-to-toe' is
'tumble' in portrait but 'duplex' in landscape. 'head-to-head' also 'tumble' in portrait but 'duplex' in landscape. 'head-to-head' also
switches between 'duplex' and 'tumble' when using portrait and switches between 'duplex' and 'tumble' when using portrait and
landscape modes. landscape modes.
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 15.5. that control document processing is described in section 16.5.
Expires December 30, 1998
4.2.9 number-up (integer(1:MAX)) 4.2.9 number-up (integer(1:MAX))
This attribute specifies the number of print-stream pages to impose This attribute specifies the number of print-stream pages to impose
upon a single side of an instance of a selected medium. For example, upon a single side of an instance of a selected medium. For example,
if the value is if the value is
Value Description Value Description
Expires July 16, 1998 '1' The Printer MUST place one print-stream page on a single
'1' The Printer SHALL place one print-stream page on a single
side of an instance of the selected medium (MAY add side of an instance of the selected medium (MAY add
some sort of translation, scaling, or rotation). some sort of translation, scaling, or rotation).
'2' The Printer SHALL place two print-stream pages on a single '2' The Printer MUST place two print-stream pages on a single
side of an instance of the selected medium (MAY add side of an instance of the selected medium (MAY add
some sort of translation, scaling, or rotation). some sort of translation, scaling, or rotation).
'4' The Printer SHALL place four print-stream pages on a single '4' The Printer MUST place four print-stream pages on a single
side of an instance of the selected medium (MAY add side of an instance of the selected medium (MAY add
some sort of translation, scaling, or rotation). some sort of translation, scaling, or rotation).
This attribute primarily controls the translation, scaling and This attribute primarily controls the translation, scaling and
rotation of print-stream pages. rotation of print-stream pages.
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 15.5. that control document processing is described in section 16.5.
4.2.10 orientation-requested (type2 enum) 4.2.10 orientation-requested (type2 enum)
This attribute indicates the desired orientation for printed print- This attribute indicates the desired orientation for printed print-
stream pages; it does not describe the orientation of the client- stream pages; it does not describe the orientation of the client-
supplied print-stream pages. supplied print-stream pages.
For some document formats (such as 'application/postscript'), the For some document formats (such as 'application/postscript'), the
desired orientation of the print-stream pages is specified within the desired orientation of the print-stream pages is specified within the
document data. This information is generated by a device driver prior document data. This information is generated by a device driver prior
skipping to change at page 76, line 45 skipping to change at page 81, line 4
the document data. In the latter case it is possible for the Printer the document data. In the latter case it is possible for the Printer
object to bind the desired orientation to the document data after it object to bind the desired orientation to the document data after it
has been submitted. It is expected that a Printer object would only has been submitted. It is expected that a Printer object would only
support "orientations-requested" for some document formats (e.g., support "orientations-requested" for some document formats (e.g.,
'text/plain' or 'text/html') but not others (e.g., 'text/plain' or 'text/html') but not others (e.g.,
'application/postscript'). This is no different than any other Job 'application/postscript'). This is no different than any other Job
Template attribute since section 4.2, item 1, points out that a Template attribute since section 4.2, item 1, points out that a
Printer object may support or not support any Job Template attribute Printer object may support or not support any Job Template attribute
based on the document format supplied by the client. However, a based on the document format supplied by the client. However, a
special mention is made here since it is very likely that a Printer special mention is made here since it is very likely that a Printer
object will supported "orientation-requested" for only a subset of the
Expires December 30, 1998
object will support "orientation-requested" for only a subset of the
supported document formats. supported document formats.
Standard values are: Standard values are:
Value Symbolic Name and Description Value Symbolic Name and Description
Expires July 16, 1998
'3' 'portrait': The content will be imaged across the short '3' 'portrait': The content will be imaged across the short
edge of the medium. edge of the medium.
'4' 'landscape': The content will be imaged across the long '4' 'landscape': The content will be imaged across the long
edge of the medium. Landscape is defined to be a edge of the medium. Landscape is defined to be a
rotation of the print-stream page to be imaged by +90 rotation of the print-stream page to be imaged by +90
degrees with respect to the medium (i.e. anti- degrees with respect to the medium (i.e. anti-
clockwise) from the portrait orientation. Note: The clockwise) from the portrait orientation. Note: The
+90 direction was chosen because simple finishing on +90 direction was chosen because simple finishing on
the long edge is the same edge whether portrait or the long edge is the same edge whether portrait or
landscape landscape
'5' 'reverse-landscape': The content will be imaged across the '5' 'reverse-landscape': The content will be imaged across the
long edge of the medium. Reverse-landscape is defined long edge of the medium. Reverse-landscape is defined
to be a rotation of the print-stream page to be imaged to be a rotation of the print-stream page to be imaged
by -90 degrees with respect to the medium (i.e. by -90 degrees with respect to the medium (i.e.
clockwise) from the portrait orientation. Note: The clockwise) from the portrait orientation. Note: The
'reverse-landscape' value was added because some 'reverse-landscape' v