draft-ietf-ipp-model-07.txt   draft-ietf-ipp-model-08.txt 
INTERNET-DRAFT INTERNET-DRAFT
draft-ietf-ipp-model-07.txt draft-ietf-ipp-model-08.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 San Diego State University
November 7, 1997 December 19, 1997
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.
skipping to change at page 1, line 38 skipping to change at page 1, line 38
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), ds.internic.net (US East Coast), or
ftp.isi.edu (US West Coast). ftp.isi.edu (US West Coast).
This Internet-Draft expires on June 19, 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 May 7, 1998 Expires June 19, 1998
The full set of IPP documents includes: The full set of IPP documents includes:
Requirements for an Internet Printing Protocol [IPP-REQ] Requirements for an Internet Printing Protocol [IPP-REQ]
Internet Printing Protocol/1.0: Model and Semantics (this document)
Internet Printing Protocol/1.0: Protocol Specification [IPP-PRO]
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]
Internet Printing Protocol/1.0: Model and Semantics (this document)
Internet Printing Protocol/1.0: Protocol Specification [IPP-PRO]
The requirements document, ''Requirements for an Internet Printing The requirements document, "Requirements 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 requirements document calls
out a subset of end user requirements that MUST be satisfied in out a subset of end user requirements that MUST be satisfied in
IPP/1.0. Operator and administrator requirements are out of scope for IPP/1.0. Operator and administrator requirements are out of scope for
version 1.0. This document, ''Internet Printing Protocol/1.0: Model and version 1.0. The rationale document, "Rationale for the Structure and
Semantics'', describes a simplified model with abstract objects, their Model and Protocol for the Internet Printing Protocol", describes IPP
attributes, and their operations. The model introduces a Printer and from a high level view, defines a roadmap for the various documents
a Job. The Job supports multiple documents per Job. The model that form the suite of IPP specifications, and gives background and
document also addresses how security, internationalization, and rationale for the IETF working group's major decisions. This
directory issues are addressed. The protocol specification, '' document, "Internet Printing Protocol/1.0: Model and Semantics",
Internet Printing Protocol/1.0: Protocol Specification'', is a formal describes a simplified model with abstract objects, their attributes,
mapping of the abstract operations and attributes defined in the model and their operations. The model introduces a Printer and a Job. The
document onto HTTP/1.1. The protocol specification defines the Job supports multiple documents per Job. The model document also
encoding rules for a new Internet media type called ''application/ipp''. addresses how security, internationalization, and directory issues are
addressed. The protocol specification, " Internet Printing
Protocol/1.0: Protocol Specification", is a formal mapping of the
abstract operations and attributes defined in the model document onto
HTTP/1.1. The protocol specification defines the encoding rules for a
new Internet media type called "application/ipp".
Expires June 19, 1998
Expires May 7, 1998
Table of Contents Table of Contents
1. Simplified Printing Model ......................................8 1. Introduction ...................................................9
2. IPP Objects ...................................................10 1.1 Simplified Printing Model.....................................10
2.1 Printer Object................................................11 2. IPP Objects ...................................................13
2.2 Job Object....................................................12 2.1 Printer Object................................................14
2.3 Object Relationships..........................................13 2.2 Job Object....................................................15
2.4 Object Identity...............................................14 2.3 Object Relationships..........................................16
3. IPP Operations ................................................15 2.4 Object Identity...............................................17
3.1 General Semantics.............................................16 3. IPP Operations ................................................18
3.1.1 Operation Characteristics................................16 3.1 Common Semantics..............................................19
3.1.2 Operation Targets........................................18 3.1.1 Operation Characteristics................................19
3.1.3 Character Set and Natural Language Operation Attributes..19 3.1.2 Operation Targets........................................21
3.1.3.1 Request Operation Attributes ..........................19 3.1.3 Character Set and Natural Language Operation Attributes..22
3.1.3.2 Response Operation Attributes .........................22 3.1.3.1 Request Operation Attributes ..........................22
3.1.4 Operation Status Codes and Messages......................23 3.1.3.2 Response Operation Attributes .........................25
3.1.5 Security Concerns for IPP Operations.....................23 3.1.4 Operation Status Codes and Messages......................26
3.1.5.1 Authenticated Requester Identity ......................23 3.1.5 Versions.................................................27
3.1.5.2 The "requesting-user-name" Operation Attribute ........24 3.1.6 Job Creation Operations..................................29
3.1.5.3 Restricted Queries ....................................25 3.2 Printer Operations............................................31
3.1.6 Versions.................................................25 3.2.1 Print-Job Operation......................................31
3.1.7 Job Creation Operations..................................26 3.2.1.1 Print-Job Request .....................................31
3.2 Printer Operations............................................28 3.2.1.2 Print-Job Response ....................................35
3.2.1 Print-Job Operation......................................29 3.2.2 Print-URI Operation......................................37
3.2.1.1 Print-Job Request .....................................29 3.2.3 Validate-Job Operation...................................38
3.2.1.2 Print-Job Response ....................................31 3.2.4 Create-Job Operation.....................................38
3.2.2 Print-URI Operation......................................34 3.2.5 Get-Printer-Attributes Operation.........................39
3.2.3 Validate-Job Operation...................................34 3.2.5.1 Get-Printer-Attributes Request ........................39
3.2.4 Create-Job Operation.....................................35 3.2.5.2 Get-Printer-Attributes Response .......................41
3.2.5 Get-Attributes Operation (for Printer objects)...........35 3.2.6 Get-Jobs Operation.......................................42
3.2.5.1 Get-Attributes Request ................................36 3.2.6.1 Get-Jobs Request ......................................42
3.2.5.2 Get-Attributes Response ...............................37 3.2.6.2 Get-Jobs Response .....................................44
3.2.6 Get-Jobs Operation.......................................37 3.3 Job Operations................................................45
3.2.6.1 Get-Jobs Request ......................................38 3.3.1 Send-Document Operation..................................45
3.2.6.2 Get-Jobs Response .....................................39 3.3.1.1 Send-Document Request .................................46
3.3 Job Operations................................................40 3.3.1.2 Send-Document Response ................................48
3.3.1 Send-Document Operation..................................41 3.3.2 Send-URI Operation.......................................48
3.3.1.1 Send-Document Request .................................42 3.3.3 Cancel Job Operation.....................................49
3.3.1.2 Send-Document Response ................................43 3.3.3.1 Cancel-Job Request ....................................49
3.3.2 Send-URI Operation.......................................43 3.3.3.2 Cancel-Job Response ...................................49
3.3.3 Cancel Job Operation.....................................44 3.3.4 Get-Job-Attributes Operation.............................50
3.3.3.1 Cancel-Job Request ....................................44 3.3.4.1 Get-Job-Attributes Request ............................51
3.3.3.2 Cancel-Job Response ...................................45 3.3.4.2 Get-Job-Attributes Response ...........................51
3.3.4 Get-Attributes Operation (for Job objects)...............45 4. Object Attributes .............................................52
3.3.4.1 Get-Attributes Request ................................46 4.1 Attribute Syntaxes............................................53
3.3.4.2 Get-Attributes Response ...............................46 4.1.1 'text'...................................................54
4. Object Attributes .............................................47 4.1.2 'textWithLanguage'.......................................54
4.1 Attribute Syntaxes............................................47 4.1.3 'name'...................................................56
Expires May 7, 1998 Expires June 19, 1998
4.1.1 'text'...................................................48
4.1.2 'name'...................................................49
4.1.3 'keyword'................................................50
4.1.4 'enum'...................................................50
4.1.5 'uri'....................................................51
4.1.6 'uriScheme'..............................................51
4.1.7 'charset'................................................52
4.1.8 'naturalLanguage'........................................52
4.1.9 'mimeMediaType'..........................................53
4.1.10 'octetString'............................................54
4.1.11 'boolean'................................................54
4.1.12 'integer'................................................54
4.1.13 'rangeOfInteger'.........................................54
4.1.14 'dateTime'...............................................55
4.1.15 'resolution'.............................................55
4.1.16 '1setOf X'..............................................55
4.2 Job Template Attributes.......................................56
4.2.1 job-priority (integer(1:100))............................59
4.2.2 job-hold-until (type4 keyword | name)....................60
4.2.3 job-sheets (type4 keyword | name)........................61
4.2.4 multiple-document-handling (type2 keyword)...............61
4.2.5 copies (integer(1:MAX))..................................63
4.2.6 finishings (1setOf type2 enum)...........................63
4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))..............64
4.2.8 sides (type2 keyword)....................................65
4.2.9 number-up (integer(0:MAX))...............................66
4.2.10 orientation (type2 enum).................................67
4.2.11 media (type4 keyword | name).............................67
4.2.12 printer-resolution (resolution)..........................68
4.2.13 print-quality (type2 enum)...............................68
4.2.14 compression (type3 keyword)..............................69
4.2.15 job-k-octets (integer(0:MAX))............................69
4.2.16 job-impressions (integer(0:MAX)).........................70
4.2.17 job-media-sheets (integer(0:MAX))........................70
4.3 Job Description Attributes....................................70
4.3.1 job-uri (uri)............................................73
4.3.2 job-id (integer(1:MAX))..................................73
4.3.3 job-more-info (uri)......................................73
4.3.4 job-name (name)..........................................73
4.3.5 job-originating-user-name (name).........................74
4.3.6 job-state (type1 enum)...................................74
4.3.7 job-state-reasons (1setOf type2 keyword)................77
4.3.8 job-state-message (text).................................79
4.3.9 number-of-documents (integer(0:MAX)).....................80
4.3.10 containing-printer-uri (uri).............................80
4.3.11 output-device-assigned (name)............................80
4.3.12 time-at-creation (integer(0:MAX))........................80
4.3.13 time-at-processing (integer(0:MAX))......................80
Expires May 7, 1998 4.1.4 'nameWithLanguage'.......................................56
4.3.14 time-at-completed (integer(0:MAX)).......................81 4.1.5 'keyword'................................................56
4.3.15 number-of-intervening-jobs (integer(0:MAX))..............81 4.1.6 'enum'...................................................57
4.3.16 job-message-from-operator (text).........................81 4.1.7 'uri'....................................................58
4.3.17 job-k-octets-processed (integer(0:MAX))..................81 4.1.8 'uriScheme'..............................................58
4.3.18 job-impressions-completed (integer(0:MAX))..............82 4.1.9 'charset'................................................58
4.3.19 job-media-sheets-completed (integer(0:MAX))..............82 4.1.10 'naturalLanguage'........................................59
4.3.20 attributes-charset (charset).............................82 4.1.11 'mimeMediaType'..........................................60
4.3.21 attributes-natural-language (naturalLanguage)............83 4.1.12 'octetString'............................................61
4.4 Printer Description Attributes................................83 4.1.13 'boolean'................................................61
4.4.1 printer-uri (uri)........................................85 4.1.14 'integer'................................................61
4.4.2 printer-name (name)......................................85 4.1.15 'rangeOfInteger'.........................................62
4.4.3 printer-location (text)..................................85 4.1.16 'dateTime'...............................................62
4.4.4 printer-info (text)......................................85 4.1.17 'resolution'.............................................62
4.4.5 printer-more-info (uri)..................................86 4.1.18 '1setOf X'..............................................63
4.4.6 printer-driver-installer (uri)...........................86 4.2 Job Template Attributes.......................................63
4.4.7 printer-make-and-model (text)............................86 4.2.1 job-priority (integer(1:100))............................67
4.4.8 printer-more-info-manufacturer (uri).....................86 4.2.2 job-hold-until (type4 keyword | name (MAX))..............68
4.4.9 printer-state (type1 enum)...............................86 4.2.3 job-sheets (type4 keyword | name(MAX))...................69
4.4.10 printer-state-reasons (1setOf type2 keyword).............88 4.2.4 multiple-document-handling (type2 keyword)...............70
4.4.11 printer-state-message (text).............................90 4.2.5 copies (integer(1:MAX))..................................71
4.4.12 operations-supported (1setOf type2 enum).................90 4.2.6 finishings (1setOf type2 enum)...........................71
4.4.13 charset (charset)........................................91 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))..............72
4.4.14 charset-supported (1setOf charset).......................91 4.2.8 sides (type2 keyword)....................................73
4.4.15 natural-language (naturalLanguage).......................92 4.2.9 number-up (integer(1:MAX))...............................74
4.4.16 natural-language-supported (1setOf naturalLanguage)......92 4.2.10 orientation (type2 enum).................................74
4.4.17 document-format (mimeMediaType)..........................93 4.2.11 media (type4 keyword | name(MAX))........................75
4.4.18 document format-supported (1setOf mimeMediaType).........93 4.2.12 printer-resolution (resolution)..........................76
4.4.19 printer-is-accepting-jobs (boolean)......................93 4.2.13 print-quality (type2 enum)...............................76
4.4.20 queued-job-count (integer(0:MAX))........................93 4.3 Job Description Attributes....................................76
4.4.21 printer-message-from-operator (text).....................93 4.3.1 job-uri (uri)............................................79
4.4.22 color-supported (boolean)................................94 4.3.2 job-id (integer(1:MAX))..................................79
4.4.23 reference-uri-schemes-supported (1setOf uriScheme).......94 4.3.3 job-more-info (uri)......................................79
4.4.24 pdl-override (type2 keyword).............................94 4.3.4 job-name (name(MAX)).....................................79
4.4.25 printer-up-time (integer(1:MAX)).........................95 4.3.5 job-originating-user-name (name(MAX))....................80
4.4.26 printer-current-time (dateTime)..........................95 4.3.6 job-state (type1 enum)...................................80
4.4.27 multiple-operation-time-out (integer(1:MAX)).............95 4.3.7 job-state-reasons (1setOf type2 keyword)................83
5. Conformance ...................................................96 4.3.8 job-state-message (text(MAX))............................85
5.1 Client Conformance Requirements...............................96 4.3.9 number-of-documents (integer(0:MAX)).....................86
5.2 IPP Object Conformance Requirements...........................97 4.3.10 containing-printer-uri (uri).............................86
5.2.1 Objects..................................................97 4.3.11 output-device-assigned (name(127)).......................86
5.2.2 Operations...............................................97 4.3.12 time-at-creation (integer(0:MAX))........................86
5.2.3 IPP Object Attributes....................................97 4.3.13 time-at-processing (integer(0:MAX))......................87
5.2.4 Extensions...............................................98 4.3.14 time-at-completed (integer(0:MAX)).......................87
5.2.5 Attribute Syntaxes.......................................98 4.3.15 number-of-intervening-jobs (integer(0:MAX))..............87
5.3 charset and Natural Language Requirements.....................98 4.3.16 job-message-from-operator (text(127))....................87
5.4 Security Conformance Requirements.............................99 4.3.17 compression (type3 keyword)..............................87
6. IANA Considerations (registered and private extensions) .......99 4.3.18 job-k-octets (integer(0:MAX))............................88
6.1 Typed Extensions..............................................99
Expires May 7, 1998 Expires June 19, 1998
6.2 Registration of MIME types/sub-types for document-formats....101
6.3 Attribute Extensibility......................................101 4.3.19 job-impressions (integer(0:MAX)).........................88
6.4 Attribute Syntax Extensibility...............................101 4.3.20 job-media-sheets (integer(0:MAX))........................89
7. Internationalization Considerations ..........................101 4.3.21 job-k-octets-processed (integer(0:MAX))..................89
8. Security Considerations ......................................102 4.3.22 job-impressions-completed (integer(0:MAX))...............90
8.1 Client and Printer in the Same Security Domain...............104 4.3.23 job-media-sheets-completed (integer(0:MAX))..............90
8.2 Client and Printer in Different Security Domains.............104 4.3.24 attributes-charset (charset).............................90
8.3 Print by Reference...........................................104 4.3.25 attributes-natural-language (naturalLanguage)............91
8.3.1 Unprotected Documents...................................104 4.4 Printer Description Attributes................................91
8.3.2 Protected Documents.....................................105 4.4.1 printer-uri (uri)........................................93
8.4 Common Security Scenarios....................................105 4.4.2 printer-tls-uri (uri)....................................93
8.4.1 No Security.............................................105 4.4.3 printer-name (name(127)).................................94
8.4.2 Message Protection During Transmission..................105 4.4.4 printer-location (text(127)).............................94
8.4.3 Client Authentication and Authorization.................106 4.4.5 printer-info (text(127)).................................95
8.4.4 Mutual Authentication, Authorization and Message 4.4.6 printer-more-info (uri)..................................95
Protection.........................................106 4.4.7 printer-driver-installer (uri)...........................95
8.5 Recommended Security Mechanisms..............................106 4.4.8 printer-make-and-model (text(127)).......................95
9. References ...................................................107 4.4.9 printer-more-info-manufacturer (uri).....................95
10. Copyright Notice .............................................110 4.4.10 printer-state (type1 enum)...............................96
11. Author's Address .............................................110 4.4.11 printer-state-reasons (1setOf type2 keyword).............97
12. APPENDIX A: Terminology ......................................113 4.4.12 printer-state-message (text(MAX))........................99
12.1 Conformance Terminology......................................113 4.4.13 operations-supported (1setOf type2 enum)................100
12.1.1 MUST....................................................113 4.4.14 charset-configured (charset)............................100
12.1.2 MUST NOT................................................113 4.4.15 charset-supported (1setOf charset)......................101
12.1.3 SHOULD..................................................113 4.4.16 natural-language-configured (naturalLanguage)...........101
12.1.4 SHOULD NOT..............................................113 4.4.17 generated-natural-language-supported (1setOf
12.1.5 MAY.....................................................114 naturalLanguage)........................................101
12.1.6 NEED NOT................................................114 4.4.18 document-format-default (mimeMediaType).................102
12.2 Model Terminology............................................114 4.4.19 document-format-supported (1setOf mimeMediaType)........102
12.2.1 Keyword.................................................114 4.4.20 printer-is-accepting-jobs (boolean).....................102
12.2.2 Attributes..............................................114 4.4.21 queued-job-count (integer(0:MAX)).......................103
12.2.2.1 Attribute Name .......................................115 4.4.22 printer-message-from-operator (text(127))...............103
12.2.2.2 Attribute Group Name .................................115 4.4.23 color-supported (boolean)...............................103
12.2.2.3 Attribute Value ......................................115 4.4.24 reference-uri-schemes-supported (1setOf uriScheme)......103
12.2.2.4 Attribute Syntax .....................................115 4.4.25 pdl-override (type2 keyword)............................104
12.2.3 Supports................................................115 4.4.26 printer-up-time (integer(1:MAX))........................104
12.2.4 print-stream page.......................................117 4.4.27 printer-current-time (dateTime).........................105
12.2.5 impression..............................................118 4.4.28 multiple-operation-time-out (integer(1:MAX))............105
13. APPENDIX B: Status Codes and Suggested Status Code Messages .118 5. Conformance ..................................................105
13.1 Status Codes.................................................119 5.1 Client Conformance Requirements..............................105
13.1.1 Informational...........................................119 5.2 IPP Object Conformance Requirements..........................106
13.1.2 Successful Status Codes.................................119 5.2.1 Objects.................................................106
13.1.2.1 successful-ok (0x0000) ...............................119 5.2.2 Operations..............................................106
5.2.3 IPP Object Attributes...................................107
5.2.4 Extensions..............................................107
5.2.5 Attribute Syntaxes......................................107
5.3 Charset and Natural Language Requirements....................108
5.4 Security Conformance Requirements............................108
6. IANA Considerations (registered and private extensions) ......108
Expires June 19, 1998
6.1 Typed Extensions.............................................108
6.2 Registration of MIME types/sub-types for document-formats....110
6.3 Attribute Extensibility......................................110
6.4 Attribute Syntax Extensibility...............................110
7. Internationalization Considerations ..........................111
8. Security Considerations ......................................113
8.1 Security Scenarios...........................................115
8.1.1 Client and Server in the Same Security Domain...........115
8.1.2 Client and Server in Different Security Domains.........115
8.1.3 Print by Reference......................................116
8.2 URIs for TLS and non-TLS access..............................116
8.3 The "requesting-user-name" Operation Attribute...............116
8.4 Restricted Queries...........................................118
8.5 IPP Security Application Profile for TLS.....................118
9. References ...................................................118
10. Copyright Notice .............................................121
11. Author's Address .............................................122
12. APPENDIX A: Terminology ......................................125
12.1 Conformance Terminology......................................125
12.1.1 MUST....................................................125
12.1.2 MUST NOT................................................125
12.1.3 SHOULD..................................................125
12.1.4 SHOULD NOT..............................................125
12.1.5 MAY.....................................................126
12.1.6 NEED NOT................................................126
12.2 Model Terminology............................................126
12.2.1 Keyword.................................................126
12.2.2 Attributes..............................................126
12.2.2.1 Attribute Name .......................................127
12.2.2.2 Attribute Group Name .................................127
12.2.2.3 Attribute Value ......................................127
12.2.2.4 Attribute Syntax .....................................127
12.2.3 Supports................................................127
12.2.4 print-stream page.......................................129
12.2.5 impression..............................................130
13. APPENDIX B: Status Codes and Suggested Status Code Messages .130
13.1 Status Codes.................................................131
13.1.1 Informational...........................................131
13.1.2 Successful Status Codes.................................131
13.1.2.1 successful-ok (0x0000) ...............................131
13.1.2.2 successful-ok-ignored-or-substituted- 13.1.2.2 successful-ok-ignored-or-substituted-
attributes (0x0001) .............................120 attributes (0x0001) ..................................132
13.1.2.3 successful-ok-conflicting-attributes (0x0002) ........120 13.1.2.3 successful-ok-conflicting-attributes (0x0002) ........132
13.1.3 Redirection Status Codes................................120 13.1.3 Redirection Status Codes................................132
13.1.4 Client Error Status Codes...............................120 13.1.4 Client Error Status Codes...............................132
13.1.4.1 client-error-bad-request (0x0400) ....................132
13.1.4.2 client-error-forbidden (0x0401) ......................132
13.1.4.3 client-error-not-authenticated (0x0402) ..............133
Expires May 7, 1998 Expires June 19, 1998
13.1.4.1 client-error-bad-request (0x0400) ....................120
13.1.4.2 client-error-forbidden (0x0401) ......................120
13.1.4.3 client-error-not-authenticated (0x0402) ..............121
13.1.4.4 client-error-not-authorized (0x0403) .................121
13.1.4.5 client-error-not-possible (0x0404) ...................121
13.1.4.6 client-error-timeout (0x0405) ........................121
13.1.4.7 client-error-not-found (0x0406) ......................122
13.1.4.8 client-error-gone (0x0407) ...........................122
13.1.4.9 client-error-request-entity-too-large (0x0408) .......122
13.1.4.10 client-error-request-uri-too-long (0x0409) ...........123
13.1.4.11 client-error-document-format-not-supported (0x040A) ..123
13.1.4.12 client-error-attribute-not-supported (0x040B) ........123
13.1.4.13 client-error-uri-scheme-not-supported (0x040C) .......124
13.1.4.14 client-error-charset-not-supported (0x040D) ..........124
13.1.4.15 client-error-conflicting-attributes (0x040E) .........124
13.1.5 Server Error Status Codes...............................124
13.1.5.1 server-error-internal-error (0x0500) .................124
13.1.5.2 server-error-operation-not-supported (0x0501) ........124
13.1.5.3 server-error-service-unavailable (0x0502) ............125
13.1.5.4 server-error-version-not-supported (0x0503) ..........125
13.1.5.5 server-error-device-error (0x0504) ...................125
13.1.5.6 server-error-temporary-error (0x0505) ................126
13.2 Status Codes for IPP Operations..............................127
14. APPENDIX C: "media" keyword values ..........................127
15. APPENDIX D: Processing IPP Attributes ........................132
15.1 Fidelity.....................................................133
15.2 Page Description Language (PDL) Override.....................134
15.3 Suggested Operation Processing Algorithm for Create and
Validate-Job operations.................................136
15.4 Using Job Template Attributes During Document Processing.....141
16. APPENDIX E: Generic Directory Schema .........................143
Expires May 7, 1998 13.1.4.4 client-error-not-authorized (0x0403) .................133
1. Simplified Printing Model 13.1.4.5 client-error-not-possible (0x0404) ...................133
13.1.4.6 client-error-timeout (0x0405) ........................133
13.1.4.7 client-error-not-found (0x0406) ......................134
13.1.4.8 client-error-gone (0x0407) ...........................134
13.1.4.9 client-error-request-entity-too-large (0x0408) .......134
13.1.4.10 client-error-request-uri-too-long (0x0409) ...........135
13.1.4.11 client-error-document-format-not-supported (0x040A) ..135
13.1.4.12 client-error-attributes-or-values-not-
supported (0x040B) ...................................135
13.1.4.13 client-error-uri-scheme-not-supported (0x040C) .......136
13.1.4.14 client-error-charset-not-supported (0x040D) ..........136
13.1.4.15 client-error-conflicting-attributes (0x040E) .........136
13.1.5 Server Error Status Codes...............................136
13.1.5.1 server-error-internal-error (0x0500) .................136
13.1.5.2 server-error-operation-not-supported (0x0501) ........136
13.1.5.3 server-error-service-unavailable (0x0502) ............137
13.1.5.4 server-error-version-not-supported (0x0503) ..........137
13.1.5.5 server-error-device-error (0x0504) ...................137
13.1.5.6 server-error-temporary-error (0x0505) ................138
13.1.5.7 server-error-not-accepting-jobs (0x0506) .............138
13.2 Status Codes for IPP Operations..............................139
14. APPENDIX C: "media" keyword values ..........................139
15. APPENDIX D: Processing IPP Attributes ........................144
15.1 Fidelity.....................................................145
15.2 Page Description Language (PDL) Override.....................146
15.3 Suggested Operation Processing Steps for All Operations......148
15.3.1 Validate version number.................................148
15.3.2 Validate operation code.................................149
15.3.3 Validate attribute group and attribute presence and
order...................................................149
15.3.3.1 Validate the presence and order of attribute groups ..149
15.3.3.2 Ignore unknown attribute groups in the expected
position .............................................150
15.3.3.3 Validate the presence of a single occurrence of
required Operation attributes ........................150
15.3.4 Validate the values of the MANDATORY Operation
attributes..............................................156
15.3.5 Validate the values of the OPTIONAL Operation
attributes..............................................159
15.4 Suggested Additional Processing Steps for Operations
that Create/Validate Jobs and add Documents..................161
15.4.1 Default "ipp-attribute-fidelity" if not supplied........161
15.4.2 Validate the values of the Job Template attributes......161
15.4.3 Check for conflicting Job Template attributes values....166
15.4.4 Decide whether to REJECT the request....................167
15.4.5 For the Validate-Job operation, RETURN one of
the success status codes................................167
Expires June 19, 1998
15.4.6 Create the Job object with attributes to support........167
15.4.7 Return one of the success status codes..................169
15.4.8 Accept appended Document Content........................170
15.4.9 Scheduling and Starting to Process the Job..............170
15.4.10 Completing the Job......................................170
15.4.11 Destroying the Job after completion.....................170
15.4.12 Interaction with "ipp-attribute-fidelity"...............170
15.5 Using Job Template Attributes During Document Processing.....171
16. APPENDIX E: Generic Directory Schema .........................172
Expires June 19, 1998
1. Introduction
The Internet Printing Protocol (IPP) is an application level protocol
that can be used for distributed printing using Internet tools and
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
fully define IPP. The full set of IPP documents includes:
Requirements for an Internet Printing Protocol [IPP-REQ]
Rationale for the Structure and Model and Protocol for the Internet
Printing Protocol [IPP-RAT]
Internet Printing Protocol/1.0: Model and Semantics (this document)
Internet Printing Protocol/1.0: Protocol Specification [IPP-PRO]
Anyone reading this document for the first time is strongly encouraged
to read the IPP documents in the following order:
1. The requirements document, "Requirements for an Internet
Printing Protocol". That document takes a broad look at
distributed printing functionality, and it enumerates real-life
scenarios that help to clarify the features that need to be
included in a printing protocol for the Internet. It identifies
requirements for three types of users: end users, operators, and
administrators. The requirements document calls out a subset of
end user requirements that MUST be satisfied in IPP/1.0.
Operator and administrator requirements are out of scope for
version 1.0.
2. The rationale document, "Rationale for the Structure and Model
and Protocol for the Internet Printing Protocol". That document
describes IPP from a high level view, defines a roadmap for the
various documents that form the suite of IPP specifications, and
gives background and rationale for the IETF working group's major
decisions.
3. This document, the "Internet Printing Protocol/1.0: Model and
Semantics" document. It describes a simplified model with
abstract objects, their attributes, and their operations. The
model introduces a Printer and a Job. The Job supports multiple
documents per Job. The model document also addresses how
security, internationalization, and directory issues are
addressed.
4. The protocol specification, " Internet Printing Protocol/1.0:
Protocol Specification". That document is a formal mapping of
the abstract operations and attributes defined in the model
document onto HTTP/1.1. The protocol specification defines the
encoding rules for a new Internet media type called
"application/ipp".
Expires June 19, 1998
This document is laid out as follows:
- The rest of Section 1 is an introduction to the IPP simplified
model for distributed printing.
- Section 2 introduces the object types in the model and their
basic behaviors, attributes, and interactions.
- Section 3 defines the operations supported by IPP/1.0. IPP
operations are synchronous, therefore, for each operation, there
is a both request and a and response.
- Section 4 defines the attributes (and their syntaxes) that are
used in the model.
- Sections 5 - 6 summarizes the implementation conformance
requirements for objects that support the protocol and IANA
considerations, respectively.
- Sections 7 - 11 cover the Internationalization and Security
considerations as well as References, Copyright Notice, and
Author contact information.
- Sections 12 - 14 are appendices that cover Terminology, Status
Codes and Messages, and "media" keyword values.
- Section 15 is an appendix that defines the rules and suggested
techniques for the processing by IPP object of attributes in
client requests. This section helps to clarify the affects of
interactions between significant attributes and their values.
- Section 16 is an appendix that enumerates a subset of Printer
attributes that form a generic directory schema. These
attributes are useful when registering a Printer so that a client
can find the Printer not just by name, but by filtered searches
as well.
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
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
specification and development efforts [HTPP] [ISO10175] [LDPA] specification and development efforts [HTPP] [ISO10175] [LDPA]
[P1387.4] [PSIS] [RFC1179] [SWP]. [P1387.4] [PSIS] [RFC1179] [SWP].
Expires June 19, 1998
The IPP/1.0 model encapsulates the important components of distributed The IPP/1.0 model encapsulates the important components of distributed
printing into two object types: printing into two object types:
- Printer (Section 2.1) - Printer (Section 2.1)
- Job (Section 2.2) - Job (Section 2.2)
Each object type has an associated set of operations (see section 3) Each object type has an associated set of operations (see section 3)
and attributes (see section 4). and attributes (see section 4).
The terminology used in the remainder of this document is defined in The terminology used in the remainder of this document is defined in
skipping to change at page 9, line 5 skipping to change at page 12, line 5
MANDATORY, SHALL, and OPTIONAL have special meaning relating to MANDATORY, SHALL, and OPTIONAL have special meaning relating to
conformance. These terms are defined in the section on conformance conformance. These terms are defined in the section on conformance
terminology, most of which is taken from RFC 2119 [RFC2119]. terminology, most of which is taken from RFC 2119 [RFC2119].
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 May 7, 1998 Expires June 19, 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 10, line 5 skipping to change at page 13, line 5
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 is directly
associated with the Printer object itself (as compared to the entry in associated with the Printer object itself (as compared to the entry in
the directory which only represents the Printer object). This more the directory which only represents the Printer object). This more
dynamic information includes state, currently loaded and ready media, dynamic information includes state, currently loaded and ready media,
number of jobs at the Printer, errors, warnings, and so forth. number of jobs at the Printer, errors, warnings, and so forth.
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 users (or programs running on behalf of end users) the ability to end users (or programs running on behalf of end users) the ability to
Expires May 7, 1998 Expires June 19, 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 the 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(s) are out of scope
for IPP/1.0, but using such a notification service, the end user is for IPP/1.0, but using such a notification service, the end user is
able to register for and receive Printer specific and Job specific able to register for and receive Printer specific and Job specific
events. An end user can query the status of Printer objects and can events. An end user can query the status of Printer objects and can
follow the progress of Job objects by polling using the Get-Attributes follow the progress of Job objects by polling using the Get-Printer-
and Get-Jobs operations. Attributes, 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,
skipping to change at page 11, line 5 skipping to change at page 14, line 5
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. - "MANDATORY": each object SHALL support the attribute.
- "OPTIONAL": each object OPTIONALLY supports the attribute. - "OPTIONAL": each object OPTIONALLY supports 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 May 7, 1998 Expires June 19, 1998
2.1 Printer Object 2.1 Printer Object
A major component of the IPP/1.0 model is the Printer object. A A 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 IPP/1.0 protocol. Using the protocol,
end users may query the attributes of the Printer object and submit end users may query the attributes of the Printer object and submit
print jobs to the Printer object. The actual implementation print jobs to the Printer object. The actual implementation
components behind the Printer abstraction may take on different forms components behind the Printer abstraction may take on different forms
and different configurations. However, the model abstraction allows and different configurations. However, the model abstraction allows
the details of the configuration of real components to remain opaque the details of the configuration of real components to remain opaque
to the end user. Section 3 describes each of the Printer operations to the end user. Section 3 describes each of the Printer operations
skipping to change at page 12, line 5 skipping to change at page 15, line 5
devices devices
3a) The associated output devices might or might not be capable 3a) The associated output devices might or might not be capable
of spooling jobs of spooling jobs
3b) The associated output devices might or might not support IPP 3b) The associated output devices might or might 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 configuration 3.
Expires May 7, 1998 Expires June 19, 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 13, 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 May 7, 1998 Expires June 19, 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. Section 3 describes each of the Job operations in Printer 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 are OPTIONALLY
supplied by the client or end user and include job processing supplied by the client or end user and include job processing
instructions which are intended to override any Printer object instructions which are intended to override any Printer object
skipping to change at page 14, line 5 skipping to change at page 17, line 5
actually uses a physical output device to put marks on paper (for actually uses a physical output device to put marks on paper (for
example a Web page publisher or an interface into an online document example a Web page publisher or an interface into an online document
archive or repository). A Printer object contains zero or more Job archive or repository). A Printer object contains zero or more Job
objects. 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 new
Job object would be created which would be almost identical to the Job object would be created which would be almost identical to the
Expires May 7, 1998 Expires June 19, 1998
existing 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 copies of the stream in
other documents in the same or different Job objects. If the other documents in the same or different Job objects. If the
contained document is a reference to a stream of document data, other contained document is a reference to a stream of document data, other
documents (in the same or different Job object(s)) may reference the documents (in the same or different Job object(s)) may reference the
same stream. same stream.
2.4 Object Identity 2.4 Object Identity
All Printer and Job objects be identified by an identifier so that All Printer and Job objects are identified by an identifier so that
they can be persistently and unambiguously referenced. The IPP/1.0 they can be persistently and unambiguously referenced. The IPP/1.0
model requires that these identifiers be Uniform Resource Identifiers model requires that these identifiers be Uniform Resource Identifiers
(URIs) [RFC1630]. Often, the URI is a URL [RFC1738] [RFC1808]. (URIs) [RFC1630]. Often, the URI is a URL [RFC1738] [RFC1808].
Note: The IPP/1.0 protocol specification [IPP-PRO] defines a mapping
of the IPP/1.0 model and semantics onto HTTP/1.1. Therefore, all
conforming Printer and Job objects SHALL support HTTP schemed URIs to
identify themselves. For example, a Printer object's URI could be
"http://www.some-domain.org/printer-one". A Printer object's URI
could not be "ftp://ftp.some-domain.org/printer-one".
IPP/1.0 does not specify how the URI is obtained, but it is IPP/1.0 does not specify how the URI is obtained, but it is
RECOMMENDED that a Printer object is registered in a directory service RECOMMENDED that a Printer object is registered in a directory service
which end users and programs can interrogate. Section 16 defines a which end users and programs can interrogate. Section 16 defines a
generic schema for Printer object entries in the directory service. generic schema for Printer object entries in the directory service.
Allowing Job objects to have URIs allows for flexibility and Allowing Job objects to have URIs allows for flexibility and
scalability. In some implementations, the Printer object might create scalability. In some implementations, the Printer object might create
Jobs that are processed in the same local environment as the Printer Jobs that are processed in the same local environment as the Printer
object itself. In this case, the Job URI might just be a composition object itself. In this case, the Job URI might just be a composition
of the Printer's URI and some unique component for the Job object, of the Printer's URI and some unique component for the Job object,
skipping to change at page 15, line 4 skipping to change at page 17, line 47
central clearing-house for validating all Job object creation central clearing-house for validating all Job object creation
requests, and the Job object itself might be created in some requests, and the Job object itself might be created in some
environment that is remote from the Printer object. In this case, the environment that is remote from the Printer object. In this case, the
Job object's URI may have no relationship at all to the Printer Job object's URI may have no relationship at all to the Printer
object's URI. However, many existing printing systems have local object's URI. However, many existing printing systems have local
models or interface constraints that force Job objects to be models or interface constraints that force Job objects to be
identified using only a 32-bit positive integer rather than a URI. identified using only a 32-bit positive integer rather than a URI.
This numeric Job ID is only unique within the context of the Printer This numeric Job ID is only unique within the context of the Printer
object to which the create request was originally submitted. In order object to which the create request was originally submitted. In order
to allow both types of client access to Jobs (either by Job URI or by to allow both types of client access to Jobs (either by Job URI or by
Expires May 7, 1998
numeric Job ID), when the Printer object successfully processes a numeric Job ID), when the Printer object successfully processes a
create request and creates a new Job, the Printer object SHALL create request and creates a new Job, the Printer object SHALL
generate both a Job URI and a Job ID for the new Job object. This generate both a Job URI and a Job ID for the new Job object. This
requirement allows all clients to access Printer objects and Job requirement allows all clients to access Printer objects and Job
objects no matter the local constraints imposed on the client objects no matter the local constraints imposed on the client
implementation. implementation.
Expires June 19, 1998
In addition to a unique identifier, Printer objects and Job objects In addition to a unique identifier, Printer objects and Job objects
have names. An object name need not be unique across all instances of have names. An object name need not be unique across all instances of
all objects. A Printer object's name is chosen and set by an all objects. A Printer object's name is chosen and set by an
administrator through some mechanism outside the scope of IPP/1.0. A administrator through some mechanism outside the scope of IPP/1.0. A
Job object's name is optionally chosen and supplied by the IPP client Job object's name is optionally chosen and supplied by the IPP client
submitting the job. If the client does not supply a Job object name, submitting the job. If the client does not supply a Job object name,
the Printer object generates a name for the new Job object. In all the Printer object generates a name for the new Job object. In all
cases, the name only has local meaning; the name is not constrained to cases, the name only has local meaning; the name is not constrained to
be unique. be unique.
To summarize: To summarize:
- Each Printer object is uniquely identified with a URI. The - Each Printer object is uniquely identified with a URI. The
Printer's "printer-uri" attribute contains the URI. Printer's "printer-uri" attribute contains the URI.
- Each Job object is uniquely identified with a URI. The Job's - Each Job object is uniquely identified with a URI. The Job's
"job-uri" attribute contains the URI. "job-uri" attribute contains the URI.
- Each Job object is also uniquely identified with a combination of - Each Job object is also uniquely identified with a combination of
the URI of the Printer object to which the create request was the URI of the Printer object to which the create request was
originally submitted along with a Job ID (a 32-bit, positive originally submitted along with a Job ID (a 32-bit, positive
number) that is unique within the context of that Printer object. integer) that is unique within the context of that Printer
The Printer object's "printer-uri" contains the Printer URI. The object. The Printer object's "printer-uri" contains the Printer
Job object's "job-id" attribute contains the numeric Job ID. URI. The Job object's "job-id" attribute contains the numeric
Job ID.
- 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 Operations have attributes that supply information about the operation
itself. These attributes are called operation attributes (as compared itself. These attributes are called operation attributes (as compared
Expires May 7, 1998
to object attributes such as Printer object attributes or Job object to object attributes such as Printer object attributes or Job object
attributes). Each request carries along with it any operation attributes). Each request carries along with it any operation
attributes, object attributes, and/or document data required by the attributes, object attributes, and/or document data required by the
object to perform the operation. Each request requires a response object to perform the operation. Each request requires a response
from the object. Each response indicates success or failure of the from the object. Each response indicates success or failure of the
operation with a status code. The response contains any operation operation with a status code. The response contains any operation
Expires June 19, 1998
attributes, object attributes, and/or status messages generated by the attributes, object attributes, and/or status messages generated by the
execution of the operation request. 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 attributes and other data
associated with each operation. associated with each operation.
Note: The IPP/1.0 protocol specification [IPP-PRO] describes a mapping
and encoding of IPP/1.0 operations onto HTTP/1.1 POST commands. Other
mappings for IPP/1.0 operations to additional transport mechanisms are
possible.
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)
Print-URI (section 3.2.2) Print-URI (section 3.2.2)
Validate-Job (section 3.2.3) Validate-Job (section 3.2.3)
Create-Job (section 3.2.4) Create-Job (section 3.2.4)
Get-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-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 with the
Create-Job operation. Create-Job operation.
3.1 General Semantics 3.1 Common Semantics
The following sections describe the common elements and features of
all IPP operations.
3.1.1 Operation Characteristics 3.1.1 Operation Characteristics
Each IPP operation is defined as both a request and a response. Both Each type of IPP operation is identified by an operation code (section
requests and responses are composed of groups of attributes and/or 4.4.13). Operations are always used in request/response pairs. Each
document data. The attributes groups are: operation request carries with it a request ID. This request id
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 0 to 2**31 - 1
(inclusive). The receiving IPP object, copies the client supplied
request id into the response so that the client can match up the
correct response with the right 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 which case the request id would not be essential for correct
Expires June 19, 1998
protocol operation). However, in other mappings, the operation
responses can come back in any order (in which case the request id
would be essential).
Operation requests and responses are both composed of groups of
attributes and/or document data. The attributes groups are:
Expires May 7, 1998
- Operation Attributes: These attributes are passed in the - Operation Attributes: These attributes are passed in the
operation, and usually do not persist beyond the life of the operation and affect the IPP object's behavior while processing
operation. Operation attributes may also affect other attributes the operation request and MAY affect other attributes or groups
or groups of attributes since values in the operation attributes of attributes. Some operation attributes describe the document
usually affect the behavior of the object that processes the data associated with the print job and are associated new Job
operation. All IPP objects that accept IPP operation requests objects, however most operation attributes do not persist beyond
MUST support all operation attributes. Some operation attributes the life of the operation. The description of each operation
are OPTIONAL for the client to supply, but the IPP object MUST attribute includes conformance statements indicating which
support the attribute by being prepared to handle the client operation attributes are MANDATORY and which are OPTIONAL for an
supplied operation attribute by realizing the corresponding IPP object to support and which attributes a client MUST supply
feature or function. The addition of new operation attributes in a request and an IPP object MUST supply in a response.
(either OPTIONAL or MANDATORY for the client to supply) will
cause a change to the major version number. Because some
operation attributes are MANDATORY for the client to supply,
every request and response MUST contain those operation
attributes.
- 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
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.. returned in the response as Printer Object Attributes. The "ipp-
attribute-fidelity" operation attribute affects processing of all
client supplied Job Template attributes (see section 15 for a
full description of "ipp-attribute-fidelity" and its relationship
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 - Unsupported Attributes: In a create request, the client supplies
OPTIONALLY supplies a set of Job Template attributes. If any of a set of Operation and Job Template attributes. If any of these
these are unsupported by the Printer object, the Printer object attributes or their values are unsupported by the Printer object,
returns the set of unsupported attributes in the response. the Printer object returns the set of unsupported attributes in
Section 15 gives a full description of how Job Template the response. Section 15 gives a full description of how Job
attributes supplied by the client in a create request are Template attributes supplied by the client in a create request
processed by the Printer object and how unsupported attributes are processed by the Printer object and how unsupported
are returned to the client. attributes are returned to the client.
Because of extensibility, any IPP object might receive a request
that contains new (or for any reason unknown) attributes or
values that it does not support. In such cases for any operation
Expires June 19, 1998
request (not just create requests), the IPP object MUST return
these unsupported attributes.
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. It is an operation error for clients to group may be in any order.
supply in operation requests and/or IPP objects to returns in
operations responses attribute value(s) that do not match the
Expires May 7, 1998 Each attribute specification includes the attribute's name followed by
syntax(es) defined for that attribute (see section 3 for operation the name of its attribute syntax(es) in parenthesizes. In addition,
the 'integer' attributes are followed by the allowed range in
parenthesizes, (m:n), for the integer value. The 'text' and 'name'
attributes are followed by the (size) in octets in parenthesizes. For
more details on attribute syntax notation, see the descriptions of
these attributes syntaxes in section 4.1. It is an operation error
for clients to supply in operation requests and/or IPP objects to
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). 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 Note: Some operations are MANDATORY 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 MANDATORY Get-
Attributes operation to query the Printer's "operations-supported" Printer-Attributes operation to query the Printer's "operations-
attribute in order to determine which OPTIONAL Printer and Job supported" attribute in order to determine which OPTIONAL Printer and
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 a request to perform an operation it does not support, it receives a request to perform an operation it does not support, it
returns the 'server-error-operation-not-supported' status code (see returns the 'server-error-operation-not-supported' status code (see
section 13.1.5.2). It is non-conformance when an object does not section 13.1.5.2). It is non-conformance when an object does not
support a MANDATORY operation. support a MANDATORY operation.
3.1.2 Operation Targets 3.1.2 Operation Targets
All IPP operations are directed at IPP objects. For Printer All IPP operations are directed at IPP objects. For Printer
operations, the operation is always directed at a Printer object using operations, the operation is always directed at a Printer object using
its URI (the "printer-uri" attribute). For Job operations, the its URI (the "printer-uri" attribute). For Job operations, the
operation is directed at either: operation is directed at either:
Expires June 19, 1998
- the Job object itself using the Job object's URI (the "job-uri" - the Job object itself using the Job object's URI (the "job-uri"
attribute assigned by the Printer object), or attribute assigned by the Printer object), or
- the Printer object to which the job was originally submitted - the Printer object to which the job was originally submitted
using the URI of the Printer ("printer-uri") in combination with using the URI of the Printer ("printer-uri") in combination with
the 32-bit numeric Job ID (the "job-id" attribute assigned by the the 32-bit numeric Job ID (the "job-id" attribute assigned by the
Printer object). Printer object).
If the operation is directed at the Job object directly using the Job If the operation is directed at the Job object directly using the Job
object's URI, the client SHALL NOT include the redundant "job-id" object's URI, the client SHALL NOT include the redundant "job-id"
operation attribute. operation attribute.
Note: In the mapping of IPP/1.0 over HTTP/1.1, the object's URI is The operation target is a MANDATORY operation attribute that MUST be
actually encoded as the "request-URI" field of the HTTP POST included in every operation request.
operation. In the case of Printer operations directed at a Printer
object, the Printer object's "printer-uri" attribute is mapped to the
"request-URI" attribute in the HTTP header. In the case of Job
operations directed at the Job object, the Job object's "job-uri"
attribute is mapped to the "request-URI" attribute in the HTTP header.
In the case of Job operations directed at the Printer object that
Expires May 7, 1998
created the Job, the Printer object's "printer-uri" attribute is sent
in the HTTP header, and the "job-id" attribute is sent as an operation
attribute in the request body. In other mappings of IPP operations
onto other transport mechanisms, the target URI is encoded using some
other transport specific addressing mechanism.
The following rules apply to the use of port numbers in URIs that The following rules apply to the use of port numbers in URIs that
identify IPP objects: identify IPP objects:
1. If the protocol scheme for the URI allows the port number to be 1. If the protocol scheme for the URI allows the port number to be
explicitly included in the URI string, and an explicit port explicitly included in the URI string, and an explicit port
number is specified within the syntax of the URI, then that 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. 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 2. If the protocol scheme for the URI does not allow an explicit
skipping to change at page 19, line 43 skipping to change at page 23, line 5
brevity in this document, these operation attribute descriptions are brevity in this document, these operation attribute descriptions are
not repeated with every operation request and response, but have a not repeated with every operation request and response, but have a
reference back to this section instead. reference back to this section instead.
3.1.3.1 Request Operation Attributes 3.1.3.1 Request Operation Attributes
The client SHALL supply and the Printer object SHALL support the The client SHALL supply and the Printer object SHALL support the
following MANDATORY operation attributes in every IPP/1.0 operation following MANDATORY operation attributes in every IPP/1.0 operation
request: request:
Expires June 19, 1998
"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 SHALL use (if supported) for
all 'text' and 'name' attributes and status messages that the all 'text' and 'name' attributes and status messages that the
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.
Expires May 7, 1998
All IPP objects SHALL support the 'utf-8' charset [RFC2044] and All IPP objects SHALL 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 SHALL reject
the request and return the 'client-error-charset-not-supported' the request and return the 'client-error-charset-not-supported'
status code. The Printer object SHALL indicate the charset(s) status code. The Printer object SHALL 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.14), so that the client MAY query attribute (see Section 4.4.15), so that the client MAY query
which charset(s) are supported. 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.7 See the 'charset' attribute syntax description in Section 4.1.9
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
'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 MANDATORY natural languages required for the Printer
object to support. However, the Printer object's "natural- object to support. However, the Printer object's "generated-
language-supported" attribute SHALL list the natural languages natural-language-supported" attribute SHALL identify the natural
supported by the Printer object and any contained Job objects, so
that the client MAY query which natural language(s) are Expires June 19, 1998
supported. languages supported by the Printer object and any contained Job
objects for all text strings generated by the IPP object. A
client MAY query this attribute to determine which natural
language(s) are supported for generated messages.
For any of the attributes for which the Printer object generates 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.4), the Printer object SHALL and status messages (see Section 3.1.4), the Printer object SHALL
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 SHALL return these
Expires May 7, 1998
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" attribute" (see as specified by the Printer's "natural-language-configured"
Section 4.4.15). 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-
attribute, though support of additional natural languages for configured" attribute, though support of additional natural
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 SHALL use the Natural
Language Override mechanism (see section 4.1.1 on the 'text' Language Override mechanism (see sections 4.1.2 and 4.1.4) for
attribute syntax) on each attribute value supplied. each such attribute value supplied.
The IPP object SHALL accept any natural language and any Natural The IPP object SHALL 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), i.e., whether the attribute-fidelity" Operation attribute). That is the IPP object
Printer object's "natural-language-supported" contains the value accepts all client supplied values no matter what the values are
supplied by the client in the "attributes-natural-language" in the Printer object's "generated-natural-language-supported"
Operation attribute or in a Natural Language Override. In some attribute. That attribute, "generated-natural-language-
cases, the client supplies an attribute with a natural language supported", only applies to generated messages, not client
that is not supported. In these cases, the IPP object SHALL supplied messages. The IPP object SHALL remember that natural
remember that natural language for that attribute, and SHALL language for all client supplied attributes, and when returning
indicate that natural language when returning the attribute in those attributes in response to a query, the IPP object SHALL
response to a query. For example, the "job-name" attribute is indicate that natural language.
supplied by the client in a create request, and its value, if
supplied, is used to populate the Job objects "job-name" For example, the "job-name" attribute MAY be supplied by the
attribute. If the client supplies a Job name in an unsupported client in a create request. The text value for this attribute
natural language, Printer object SHALL accept the create request will be in the natural language identified by the "attribute-
and remember the client supplied natural language. There is no natural-language" attribute, or if different, as identified by
need for the Printer object to reject the create request just
because the client choose to pick some unsupported natural Expires June 19, 1998
language for the Job name. Whenever a client queries the "job- the Natural Language Override mechanism. If supplied, the IPP
name" attribute, the IPP object returns the attribute and object will use the value of the "job-name" attribute to populate
indicates the natural language of the attribute as a Natural the Job object's "job-name" attribute. Whenever any client
Language Override if it is different than the natural language of queries the Job object's "job-name" attribute, the IPP object
the other attributes in the response. returns the attribute as stored and uses the Natural Language
Override mechanism to specify the natural language, if it is
different from that reported in the "attributes-natural-language"
operation attribute of the response. An IPP object SHALL NOT
reject a request based on a supplied natural language in an
"attributes-natural-language" Operation attribute or in any
attribute that uses the Natural Language Override .
See the 'naturalLanguage' attribute syntax description in Section See the 'naturalLanguage' attribute syntax description in Section
4.1.8 for the syntax and semantic interpretation of the values of 4.1.10 for the syntax and semantic interpretation of the values
this attribute and for example values. of this attribute and for example values.
Clients SHOULD NOT request an illegal combination of natural language
and charset. For example, suppose a Printer object supports charsets
'utf-8', 'iso-8859-1', and 'iso-8859-7'. Suppose it also supports
natural languages 'en' (English), 'fr' (French), and 'el' (Greek). If
the client requests 'iso-8859-1' and 'el', it is an invalid
combination of charset and natural language. In this case, the IPP
object SHALL NOT change either of these attribute values and SHALL
accept them as if they were valid.
Expires May 7, 1998
3.1.3.2 Response Operation Attributes 3.1.3.2 Response Operation Attributes
The Printer object SHALL supply and the client SHALL support the The Printer object SHALL supply and the client SHALL support the
following MANDATORY operation attributes in every IPP/1.0 operation following MANDATORY 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 SHALL 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. See "attributes-charset" described in the client in the request. If this is not possible (i.e., the
Section 3.1.3.1 above. charset requested is not supported), the request SHALL be
rejected. See "attributes-charset" described in Section 3.1.3.1
above.
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 SHALL 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
Expires June 19, 1998
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. In any case, responses SHALL information during code conversion. On each response, such an
always be in the charset requested. If this is not possible implementation converts from its internal charset to that
(i.e., the charset requested is not supported), the request SHALL requested.
be rejected.
"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 default, the natural language of the Job object or the Printer's
rather than the natural language supplied by the client. For any configured natural language as identified by the Printer object's
'text' or 'name' attribute or status message in the response that "natural-language-configured" attribute, rather than the natural
language supplied by the client. For any 'text' or 'name'
Expires May 7, 1998 attribute or status message in the response that is in a
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 section SHALL use the Natural Language Override mechanism (see sections
4.1.1 on the 'text' attribute syntax) on each attribute value 4.1.2 and 4.1.4) on each attribute value returned.
returned.
3.1.4 Operation Status Codes and Messages 3.1.4 Operation Status Codes and Messages
Every operation response returns a MANDATORY status code and an Every operation response returns a MANDATORY status code and an
OPTIONAL status message. A status code provides information on the OPTIONAL status message represented as the "status-message" text(255)
processing of a request. A status message provides a short textual operation attribute. A status code provides information on the
description of the status of the operation. The status code is processing of a request. A "status-message" attribute provides a
intended for use by automata, and the status message is intended for short textual description of the status of the operation. The status
the human end user. If a response does include a status message, an code is intended for use by automata, and the status message is
IPP client NEED NOT examine or display the status message, however it intended for the human end user. If a response does include a
SHOULD do so in some implementation specific manner. "status-message" attribute, an IPP client NEED NOT examine or display
the status message, however it SHOULD do so in some implementation
specific manner.
The status code is a numeric value that has semantic meaning. The The status code is a numeric value that has semantic meaning. The
Model specification does not give the status code a name, so it is not
like other attributes; it is only a numeric code by itself. The
Expires June 19, 1998
status code is similar to a "type2 enum" (see section 4.1 on status code is similar to a "type2 enum" (see section 4.1 on
"Attribute Syntaxes") except that values can range only from 0x0000 to "Attribute Syntaxes") except that values can range only from 0x0000 to
0x7FFF. Section 13 describes the status codes, assigns the numeric 0x7FFF. Section 13 describes the status codes, assigns the numeric
values, and suggests a corresponding status message for each status values, and suggests a corresponding status message for each status
code. code.
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 "natural-language-supported" identified by the Printer object's "generated-natural-language-
attribute (see the "attributes-natural-language" operation attribute supported" attribute (see the "attributes-natural-language" operation
specified in Section 3.1.3.1). As described in Section 3.1.3.1 for attribute specified in Section 3.1.3.1). As described in Section
any returned 'text' attribute, if there is a choice for generating 3.1.3.1 for any returned 'text' attribute, if there is a choice for
this message, the Printer object uses the natural language indicated generating this message, the Printer object uses the natural language
by the value of the "attributes-natural-language" in the client indicated by the value of the "attributes-natural-language" in the
request if supported, otherwise the Printer object uses the value in client request if supported, otherwise the Printer object uses the
the Printer object's own "natural-language" attribute. value in the Printer object's own "natural-language-configured"
3.1.5 Security Concerns for IPP Operations
3.1.5.1 Authenticated Requester Identity
IPP is layered on top of security services that supply the requester's
identity. It is assumed that the identity supplied by the
authentication service is the most authenticated identity required by
a given site's configuration and current policy. It is also assumed
that the layering allows for a single IPP implementation to be run
Expires May 7, 1998
over a consistent interface that supplies the authenticated identity.
The authentication interface SHOULD allow for various modular and
extensible authentication service implementations without requiring
changes to the IPP implementation.
Once the authenticated identity of the requester has been supplied to
the IPP implementation, the implementation uses that identity to
enforce any authorization policy(ies) that might be in place. When a
Job object is created, the identity of the requester from the create
request is persistently stored in the Job object in an internal
implementation-dependent attribute. This attribute can be used to
match the requester's identity of subsequent operations on that Job
object in order to enforce the local authorization policy(ies), if
any. For example, one site's policy might be that only the job owner
is allowed to cancel a job. Another site's policy might be that any
end user is allowed to cancel any job. There are operation status
codes that allow an IPP object to return information back to the
operation requester about what has been forbidden, not allowed, or not
authorized. The details of and mechanisms to set up authorization
policy(ies) are not part of IPP/1.0, and must be established via some
mechanism outside the scope of IPP/1.0.
3.1.5.2 The "requesting-user-name" Operation Attribute
A Printer object SHALL support the MANDATORY "requesting-user-name"
operation attribute that a client SHOULD supply in all operations.
This operation attribute is provided in case (1) there is no security
service being used, (2) the client and Printer object negotiate to no
authorization, or (3) the authentication service does not make
available to the Printer object an authenticated printable
representation of the user's name that is making the request. The
client SHALL obtain the value for this attribute from an environmental
or network login name for the user, rather than allowing the user to
supply any value.
For create requests the Printer object, upon creating a new Job
object, SHALL store the originating user's name in the MANDATORY "job-
originating-user-name" Job Description attribute. The "job-
originating-user-name" attribute is used for presentation only, such
as returning in queries or printing on start sheets, and is not used
for matching the authenticated principal of subsequent operations. If
the Printer object has access to a more authenticated printable
representation of the user's name, the Printer object SHALL store that
value instead of the value supplied by the client in the "requesting-
user-name" operation attribute.
Expires May 7, 1998
The Printer object, upon creating a new Job object, SHALL store the
originating user's principal credential in an internal implementation-
dependent Job Description attribute. This attribute is not specified
as part of IPP, since it is not of any interest to clients. However,
the Printer object uses this internal attribute for matching the
authenticated principal id of subsequent operations. If the Printer
object has access to a more authenticated representation of the user's
id, the Printer object SHALL store that value instead of the value
supplied by the client in the "requesting-user-name" operation
attribute. Otherwise, the Printer object SHALL store the value
supplied by the client in the "requesting-user-name" operation
attribute. attribute.
3.1.5.3 Restricted Queries 3.1.5 Versions
In many of these IPP operations, a client supplies a list of
attributes to be returned in the response. An IPP object may be
configured, for security reasons, not to return all attributes that a
client requests. The job attributes returned MAY depend on whether
the requesting user is the same as the user that submitted the job.
The IPP object MAY even return none of the requested attributes. In
such cases, the status returned is the same as if the object had
returned all requested attributes. The client cannot tell by such a
response whether the requested attribute was present or absent on the
object.
3.1.6 Versions
Each operation request carries with it a version number. Each version Each operation request and response carries with it a version number.
number is in the form "X.Y" where X is the major version number and Y Each version number is in the form "X.Y" where X is the major version
is the minor version number. By including a version number in the number and Y is the minor version number. By including a version
client request, it allows the client (the requester) to identify which number in the client request, it allows the client (the requester) to
version of IPP it is interested in using. If the IPP object does not identify which version of IPP it is interested in using. If the IPP
support that version, the object responds with a status code of object does not support that version, the object responds with a
'server-error-version-not-supported'. status code of 'server-error-version-not-supported'.
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 the Printer, '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 that covers both IPP Model and IPP
Protocol changes. Thus the version number MUST change when introducing Protocol changes. Thus the version number MUST change when introducing
a new version of the Model document or a new version of the Protocol a new version of the Model document or a new version of the Protocol
document. document.
Expires May 7, 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 interpret 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
Expires June 19, 1998
of version '1.0'), would have required a change to the major version of version '1.0'), would have required a change to the major version
number. . Items that might affect the changing of the major version number. Items that might affect the changing of the major version
number include any changes to the 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 OPTIONAL to MANDATORY and vice versa - changing Operation or Job Template attributes from OPTIONAL to
- adding new operation attributes MANDATORY and vice versa
- adding MANDATORY (for an IPP object to support) operation
attributes
- adding MANDATORY (for an IPP object to support) operation
attribute groups
- adding values to existing operation attributes - adding values to existing operation attributes
- adding MANDATORY operations - adding MANDATORY 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 protocol
specification itself (except adding attribute syntaxes), such as: specification itself (except adding attribute syntaxes), such as:
- 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
- changing any of the type1 attributes
- adding new object attributes - adding new object attributes
- adding OPTIONAL (for an IPP object to support) operation
attributes (i.e., those attributes that an IPP object can ignore
without confusing clients)
- adding OPTIONAL (for an IPP object to support) operation
attribute groups (i.e., those attributes that an IPP object can
ignore without confusing clients)
- adding new attribute syntaxes - adding new attribute syntaxes
- adding OPTIONAL operations - adding OPTIONAL operations
- changing Job Description attributes or Printer Description
attributes from OPTIONAL to MANDATORY or vice versa.
3.1.7 Job Creation Operations The encoding of the operation code, 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
the operation code, 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.
Expires June 19, 1998
Implementations that support a certain major version NEED NOT support
ALL previous versions. As each new major version is defined (through
the release of a new specification), that major version will specify
which previous major versions MUST be supported in compliant
implementations.
3.1.6 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.
- The Print-URI Request: A client that wants to submit a print job - The Print-URI Request: A client that wants to submit a print job
with only a single document (where the Printer object "pulls" the with only a single document (where the Printer object "pulls" the
Expires May 7, 1998
document data instead of the client "pushing" the data to the document data instead of the client "pushing" the data to the
Printer object) uses the Print-URI operation. In this case, the Printer object) uses the Print-URI operation. In this case, the
client includes in the request only a URI reference to the client includes in the request only a URI reference to the
document data (not the document data itself). document data (not the document data itself).
- The Create-Job Request: A client that wants to submit a print job - The Create-Job Request: A client that wants to submit a print job
with multiple documents uses the Create-Job operation. This with multiple documents uses the Create-Job operation. This
operation is followed by an arbitrary number of Send-Document operation is followed by an arbitrary number of Send-Document
and/or Send-URI operations (each creating another document for and/or Send-URI operations (each creating another document for
the newly create Job object). The Send-Document operation the newly create Job object). The Send-Document operation
includes the document data in the request (the client "pushes" includes the document data in the request (the client "pushes"
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 document. set to 'true' indicating that this is the last request.
Throughout this model specification, the term "create request" is used Throughout this model specification, the term "create request" is used
to refer to any of these three operation requests. to refer to any of these three operation requests.
A Create-Job operation followed by only one Send-Document operation is A Create-Job operation followed by only one Send-Document operation is
semantically equivalent to a Print-Job operation, however, for semantically equivalent to a Print-Job operation, however, for
performance reasons, the client SHOULD use the Print-Job operation for performance reasons, the client SHOULD use the Print-Job operation for
all single Document Jobs. Also, Print-Job is a MANDATORY operation all single Document Jobs. Also, Print-Job is a MANDATORY 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.
Section 15 describes the rules and issues surrounding the processing Expires June 19, 1998
of client supplied attributes and how a Printer object either accepts
or rejects a create request.
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 using the rules supplied 1. Process the client supplied attributes and either accept or
in section 15 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
Expires May 7, 1998 Section 15 describes the rules and issues surrounding the processing
of client supplied attributes. Section 15.3 presents suggested steps
for an IPP object to either accept or reject any request. Section
15.4 presents suggested additional steps for processing create
requests.
At job submission time the Printer SHOULD NOT perform the validation At job submission time the Printer SHOULD 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. Validate the document data
2. Validate the actual contents of any client supplied URI (resolve 2. Validate the actual contents of any client supplied URI (resolve
the reference and follow the link to the document data) the reference and follow the link to the document data)
At job submission time, these additional job processing time At job submission time, these additional job processing time
validation 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
skipping to change at page 28, line 32 skipping to change at page 31, line 4
- runtime errors in the document data, - runtime errors in the document data,
- nested document data that is in an unsupported format, - nested document data that is in an unsupported format,
- the URI reference is no longer valid (i.e., the server hosting - the URI reference is no longer valid (i.e., the server hosting
the 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 June 19, 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" attribute in order to identify the always supply the "printer-uri" attribute in order to identify the
correct target of the operation. correct target of the operation.
Note: In the HTTP/1.1 mapping of IPP/1.0, this attribute is not
supplied in the body of the operation as other operation attributes
are -- it is supplied in the "request-URI" field in the HTTP header.
Expires May 7, 1998
3.2.1 Print-Job Operation 3.2.1 Print-Job Operation
When an end user desires to submit a print job with only one document This MANDATORY operation allows a client to submit a print job with
and the client supplies the document data (rather than just a only one document and supply the document data (rather than just a
reference to the data), the client uses a Print-Job operation. See reference to the data). See Section 15 for a suggested steps for
Section 15 for a suggested processing algorithm for the create processing create operations and their Operation and Job Template
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: Target:
The "printer-uri" target for this operation as described in The "printer-uri" target for this operation as described in
section 3.1.2. section 3.1.2.
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.3.1. The Printer object attributes as described in section 3.1.3.1. The Printer object
SHALL copy these values to the corresponding Job Description SHALL copy these values to the corresponding Job Description
attributes described in sections 4.3.20 and 4.3.21. attributes described in sections 4.3.24 and 4.3.25.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2. client as described in section 8.3.
"job-name" (name): Expires June 19, 1998
This attribute is OPTIONALLY supplied by the client, and it "job-name" (name(MAX)):
contains the client supplied Job name. If this attribute is The client OPTIONALLY supplies this attribute. The Printer
supplied by the client, its value is used for the "job-name" object MUST support this attribute. It contains the client
attribute of the newly created Job object. The client MAY supplied Job name. If this attribute is supplied by the client,
automatically include any information that will help the end-user its value is used for the "job-name" attribute of the newly
distinguish amongst his/her jobs, such as the name of the created Job object. The client MAY automatically include any
application program along with information from the document, information that will help the end-user distinguish amongst
such as the document name, document subject, or source file name. his/her jobs, such as the name of the application program along
If this attribute is not supplied by the client, the Printer with information from the document, such as the document name,
generates a name to use in the "job-name" attribute of the newly document subject, or source file name. If this attribute is not
created Job object (see Section 4.3.4). supplied by the client, the Printer generates a name to use in
the "job-name" attribute of the newly created Job object (see
Section 4.3.4).
"document-name" (name): "ipp-attribute-fidelity" (boolean):
This attribute is OPTIONALLY supplied by the client, and it The client OPTIONALLY supplies this attribute. The Printer
contains the client supplied document name. The document name object MUST support this attribute. The value 'true' indicates
MAY be different than the Job name. Typically, the client that total fidelity to client supplied Job Template attributes
software automatically supplies the document name on behalf of and values is required, else the Printer object SHALL reject the
Print-Job request. The value 'false' indicates that a reasonable
attempt to print the Job object is acceptable and the Printer
object SHALL accept the Print-job request. If not supplied, the
Printer object assumes the value is 'false'. All Printer objects
MUST support both types of job processing. See section 15 for a
full description of "ipp-attribute-fidelity" and its relationship
to other attributes, especially the Printer object's "pdl-
override" attribute.
Expires May 7, 1998 "document-name" (name(MAX)):
the end user by using a file name or an application generated The client OPTIONALLY supplies this attribute. The Printer
name. If this attribute is supplied, its value can be used in a object MUST support this attribute. It contains the client
manner defined by each implementation. Examples include: printed supplied document name. The document name MAY be different than
along with the Job (job start sheet, page adornments, etc.), used the Job name. Typically, the client software automatically
by accounting or resource tracking management tools, or even supplies the document name on behalf of the end user by using a
stored along with the document as a document level attribute. file name or an application generated name. If this attribute is
IPP/1.0 does not support the concept of document level supplied, its value can be used in a manner defined by each
attributes. implementation. Examples include: printed along with the Job
(job start sheet, page adornments, etc.), used by accounting or
resource tracking management tools, or even stored along with the
document as a document level attribute. IPP/1.0 does not support
the concept of document level attributes.
"document-format" (mimeMediaType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. The value of this The client OPTIONALLY supplies this attribute. The Printer
attribute describes the format of the supplied document data. If object MUST support this attribute. The value of this attribute
the client does not supply this attribute, the Printer object identifies the format of the supplied document data. If the
assumes that the document data is in the format defined by the client does not supply this attribute, the Printer object assumes
Printer object's "document-format" attribute. that the document data is in the format defined by the Printer
"ipp-attribute-fidelity" (boolean): Expires June 19, 1998
This attribute is OPTIONALLY supplied by the client. If not object's "document-format-default" attribute. If the client
supplied, the Printer object assumes the value is 'false'. The supplies this attribute, but the value is not supported by the
value 'true' indicates that total fidelity to client supplied Printer object, i.e., the value is not one of the values of the
attributes and values is required, else the Printer object SHALL Printer object's "document-format-supported" attribute, the
reject the Print-Job request. The value 'false' indicates that a Printer object SHALL reject the request and return the 'client-
reasonable attempt to print the Job object is acceptable and the error-document-format-not-supported' status code.
Printer object SHALL accept the Print-job request. All Printer
objects MUST support both types of job processing. See section
15 for a full description of "ipp-attribute-fidelity" and its
relationship to other attributes, especially the Printer object's
"pdl-override" attribute.
"document-natural-language" (naturalLanguage): "document-natural-language" (naturalLanguage):
This attribute is OPTIONALLY supplied by the client. There are The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute. This attribute
specifies the natural language of the document for those
document-formats that require a specification of the natural
language in order to image the document unambiguously. There are
no particular values required for the Printer object to support. no particular values required for the Printer object to support.
This attribute specifies the natural language of the document for
those document-formats that require a specification of the "compression" (type3 keyword)
natural language in order to image the document unambiguously. The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute. It identifies the
compression algorithm used on the document data (see section
4.3.17). If the client omits this attribute, the Printer object
SHALL assume that the data is not compressed. If the client
supplies the attribute and the Printer object supports the
attribute, the value of the attribute is used to populate the Job
object's "compression" Job Description attribute. If the client
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's "compression-supported" attribute, the Printer
object SHALL 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.
"job-k-octets" (integer(0:MAX))
The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute. It identifies the
total size of the document(s) in K octets being submitted (see
section 4.3.18 for the complete semantics). If the client
supplies the attribute and the Printer object supports the
attribute, the value of the attribute is used to populate the Job
object's "job-k-octets" Job Description attribute.
Note: For this attribute and the following two attributes ("job-
impressions", and "job-media-sheets"), if the client supplies the
attribute, but the Printer object does not support the attribute,
the Printer object ignores the client-supplied value. If the
client supplies the attribute and the Printer supports the
attribute, but the value is outside the range of the
corresponding Printer object's "xxx-supported" attribute, the
Printer object SHALL use the value to populate the Job object's
Expires June 19, 1998
"xxx" attribute. If the client supplies the attribute and the
Printer supports the attribute, but the value is outside the
range of the corresponding Printer object's "xxx-supported"
attribute, the Printer object SHALL 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. If the client does not supply the
attribute, the Printer object might choose to populate the
corresponding Job object attribute depending on whether the
Printer object supports the attribute and is able to calculate or
discern the correct value.
"job-impressions" (integer(0:MAX))
The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute. It identifies the
total size in number of impressions of the document(s) being
submitted (see section 4.3.19 for the complete semantics).
See note under "job-k-octets".
"job-media-sheets" (integer(0:MAX))
The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute. It identifies the
total number of media sheets to be produced for this job (see
section 4.3.20 for the complete semantics).
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.
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: The simplest Print-Job Request consists of just the Document
Content, the "attributes-charset" and "attributes-natural-language" Content, the "attributes-charset" and "attributes-natural-language"
Expires May 7, 1998
operation attributes, and nothing else. In this case, the Printer operation attributes, and nothing else. In this case, the Printer
object: 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.3.1) (if natural language and charset requested (see Section 3.1.3.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
Expires June 19, 1998
- 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 SHALL 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 Code and Message:
The response includes the MANDATORY status code and an OPTIONAL The response includes the MANDATORY status code and an OPTIONAL
"status-message" (text) operation attribute as described in "status-message" (text) operation attribute as described in
section 3.1.4. If the client supplies unsupported or conflicting section 3.1.4. If the client supplies unsupported or conflicting
attributes or values, the Printer object SHALL reject or accept Job Template attributes or values, the Printer object SHALL
the Print-Job request depending on the whether the client reject or accept the Print-Job request depending on the whether
supplied a 'true' or 'false' value for the "ipp-attribute- the client supplied a 'true' or 'false' value for the "ipp-
fidelity" operation attribute. See section 15 for a complete attribute-fidelity" operation attribute. See section 15 for a
description of the processing algorithm. complete 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.3.2. attributes as described in section 3.1.3.2.
Group 2: Job Object Attributes Group 2: Unsupported Attributes
This is a set of Operation and Job Template attributes supplied
by the client (in the request) that are not supported by the
Printer object or that conflict with one another (see sections
15.3 and 15.4).
Unsupported attributes fall into three categories:
1. The Printer object does not support the named attribute (no
matter what the value).
2. The Printer object does support the attribute, but does not
support some or all of the particular values supplied by the
client (i.e., the Printer object does not have those values
in the corresponding supported values attribute).
3. The Printer object does support the attributes and values
supplied, but the particular values are in conflict with one
another, because they violate a constraint, such as not
being able to staple transparencies.
Expires June 19, 1998
In the case of an unsupported attribute name, the Printer object
returns the client-supplied attribute with a substituted special
value of 'unsupported' indicating no support for the attribute
itself.
In the case of a supported attribute with one or more unsupported
values, the Printer object simply returns the client-supplied
attribute with the unsupported values as supplied by the client.
This indicates support for the attribute, but no support for that
particular value. If the client supplies a multi-valued attribute
with more than one value and the Printer object supports the
attribute but only supports a subset of the client supplied
values, the Printer object SHALL return only those values that
are unsupported.
In the case of two (or more) supported attribute values that are
in conflict with one another because they cannot be used together
in the same job, the Printer object SHALL return all the values
that it ignores or substitutes to resolve the conflict, but not
any of the values that it is still using. The choice for exactly
how to resolve the conflict is implementation dependent. See
Section 15.4.3 for an example.
In these three cases, the value of the "ipp-attribute-fidelity"
supplied by the client does not affect what the Printer object
returns. The value of "ipp-attribute-fidelity" only affects
whether the Print-Job operation is accepted or rejected. If the
job is accepted, the client may query the job using the Get-Job-
Attributes operation requesting the unsupported attributes that
were returned in the create response to see which attributes were
ignored (not stored on the Job object) and which attributes were
stored with other (substituted) values.
Group 3: Job Object Attributes
"job-uri" (uri): "job-uri" (uri):
The Printer object MUST return the Job object's MANDATORY "job- The Printer object MUST return the Job object's MANDATORY "job-
uri" attribute. uri" attribute.
"job-id": "job-id":
The Printer object MUST return the Job object's MANDATORY "job- The Printer object MUST return the Job object's MANDATORY "job-
id" attribute. id" attribute.
Expires May 7, 1998
"job-state": "job-state":
The Printer object MUST return the Job object's MANDATORY "job- The Printer object MUST return the Job object's MANDATORY "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
Expires June 19, 1998
"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
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
skipping to change at page 32, line 45 skipping to change at page 37, line 41
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.
Group 3: Unsupported Attributes
This is a set of Job Template attributes supplied by the client
(in the request) that are not supported by the Printer object or
that conflict with one another (see section 15).
Unsupported attributes fall into three categories:
Expires May 7, 1998
1. The Printer object does not support the named attribute (no
matter what the value), or
2. The Printer object does support the attribute, but does not
support some or all of the particular values supplied by the
client (i.e., the Printer object does not have those values in
the corresponding supported values attribute).
3. The Printer object does support the attributes and values
supplied, but the particular values are in conflict with one
another, because they violate a constraint, such as not being
able to staple transparencies.
In the case of an unsupported attribute name, the Printer object
returns the client-supplied attribute with a substituted special
value of 'unsupported' indicating no support for the attribute
itself.
In the case of a supported attribute with one or more unsupported
values, the Printer object simply returns the client-supplied
attribute with the unsupported values as supplied by the client.
This indicates support for the attribute, but no support for that
particular value. If the client supplies a multi-valued attribute
with more than one value and the Printer object supports the
attribute but only supports a subset of the client supplied
values, the Printer object SHALL return only those values that
are unsupported.
In the case of two (or more) supported attribute values that are
in conflict because they cannot be used, the Printer object SHALL
return all the values that it ignores or substitutes to resolve
the conflict.
In these three cases, the value of the "ipp-attribute-fidelity"
supplied by the client does not affect what the Printer object
returns. The value of "ipp-attribute-fidelity" only affects
whether the Print-Job operation is accepted or rejected. If the
job is accepted, the client may query the job using the Get-
Attributes operation requesting the attributes returned in the
create response to see which attributes were ignored (not stored
on the Job object) and which attributes were stored with other
(substituted) values.
Note: The simplest response consists of the just the MANDATORY Job Note: The simplest response consists of the just the MANDATORY Job
Attributes, the MANDATORY "attributes-charset" and "attributes- Attributes, the MANDATORY "attributes-charset" and "attributes-
natural-language" operation attributes, and a status code of natural-language" operation attributes, and a status code of
"successful-ok". "successful-ok".
Expires May 7, 1998
3.2.2 Print-URI Operation 3.2.2 Print-URI Operation
This operation is identical to the Print-Job operation (section 3.2.1) This OPTIONAL operation is identical to the Print-Job operation
except that a client supplies a URI reference to the document data (section 3.2.1) except that a client supplies a URI reference to the
using the "document-uri" (uri) operation attribute rather than document data using the "document-uri" (uri) operation attribute
including the document data itself. Before returning the response, rather than including the document data itself. Before returning the
the Printer MUST validate that the Printer supports the retrieval response, the Printer MUST validate that the Printer supports the
method (e.g., http, ftp, etc.) implied by the URI, and SHOULD check
for valid URI syntax. The Printer NEED NOT follow the reference and Expires June 19, 1998
validate the contents of the reference.
retrieval method (e.g., http, ftp, etc.) implied by the URI, and MUST
check for valid URI syntax. If the client-supplied URI scheme is not
supported, i.e. the value is not in the Printer object's "referenced-
uri-scheme-supported" attribute, the Printer object SHALL reject the
request and return the 'client-error-uri-scheme-not-supported' status
code. See Section 15.3.4 for suggested additional checks. The
Printer NEED NOT follow the reference and validate the 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" attribute (see section 4.4.23). "reference-uri-schemes-supported" Printer attribute (see section
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 operation is similar to the Print-Job operation (section 3.2.1) This MANDATORY operation is similar to the Print-Job operation
except that a client supplies no document data and the Printer (section 3.2.1) except that a client supplies no document data and the
allocates no resources (i.e., it does not create a new Job object). 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 check that the same Print-Job operation will be accepted without client can check that the same Print-Job operation will be accepted
having to send the document data. The Validate-Job operation also without having to send the document data. The Validate-Job operation
performs the same security negotiation as the Print-Job operation (see also performs the same security negotiation as the Print-Job operation
section 8), so that a client can check that the client and Printer (see section 8), so that a client can check that the client and
object security requirements can be met before performing a Print-Job Printer object security requirements can be met before performing a
operation. 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 3) as the Print-Job (Group 1) and Unsupported Attributes (Group 2) as the Print-Job
operation. However, no Job Object Attributes (Group 2) are returned, operation. However, no Job Object Attributes (Group 3) are returned,
since no Job object is created. since no Job object is created.
Expires May 7, 1998
3.2.4 Create-Job Operation 3.2.4 Create-Job Operation
This operation is similar to the Print-Job operation (section 3.2.1) This OPTIONAL operation is similar to the Print-Job operation (section
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
Expires June 19, 1998
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 either of the "document-name" or "document-natural- does not supply any of the "document-name", "document-format", or
language" attributes. This operation is followed by one or more Send- "document-natural-language" attributes. This operation is followed by
Document or Send-URI operations. In each of those operation requests, one or more Send-Document or Send-URI operations. In each of those
the client OPTIONALLY supplies the "document-name" and "document- operation requests, the client OPTIONALLY supplies the "document-
natural-language" attributes for each document in the multi-document name", "document-format", and "document-natural-language" attributes
Job object. If a Printer object supports the Create-Job operation, it for each document in the multi-document Job object. If a Printer
MUST also support the Send-Document operation and also MAY support the object supports the Create-Job operation, it MUST also support the
Send-URI operation. Send-Document operation and also MAY support the Send-URI operation.
3.2.5 Get-Attributes Operation (for Printer objects) 3.2.5 Get-Printer-Attributes Operation
The Get-Attributes operation allows a client to request the values of This MANDATORY operation allows a client to request the values of the
the attributes of a Printer or Job object. This section describes the attributes of a Printer or Job object. This section describes the
former and section 3.3.4 describes the latter. In the request, the former and section 3.3.4 describes the latter. In the request, the
client supplies the set of Printer attribute names and/or attribute client supplies the set of Printer attribute names and/or attribute
group names in which the requester is interested. In the response, group names in which the requester is interested. In the response,
the Printer object returns a corresponding attribute set with the the Printer object returns a corresponding attribute set with the
appropriate attribute values filled in. appropriate attribute values filled in.
For Printer objects, the possible names of attribute groups are: For Printer objects, 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 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
attributes.
There is also the special group 'all' that includes all supported Since a client MAY request specific attributes or named groups, there
attributes. Since a client MAY request specific attributes or named is a potential that there is some overlap. For example, if a client
groups, there is a potential that there is some overlap. For example, requests, 'printer-name' and 'all', the client is actually requesting
if a client requests, 'printer-name' and 'all', the client is actually the "printer-name" attribute twice: once by naming it explicitly, and
requesting the "printer-name" attribute twice: once by naming it once by inclusion in the 'all' group. In such cases, the Printer
explicitly, and once by inclusion in the 'all' group. In such cases, object NEED NOT return each attribute only once in the response even
the Printer object NEED NOT return each attribute only once in the if it is requested multiple times. The client SHOULD NOT request the
response even if it is requested multiple times. The client SHOULD same attribute in multiple ways.
NOT request the 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, it belonging to a group (since some attributes are OPTIONAL). However,
is MANDATORY that each Printer object support all group names. it is MANDATORY that each Printer object support all group names.
Expires May 7, 1998 3.2.5.1 Get-Printer-Attributes Request
3.2.5.1 Get-Attributes Request
The following sets of attributes are part of the Get-Attributes The following sets of attributes are part of the Get-Printer-
Request when the request is directed to a Printer object: Attributes Request when the request is directed to a Printer object:
Expires June 19, 1998
Group 1: Operation Attributes Group 1: Operation Attributes
Target: Target:
The "printer-uri" target for this operation as described in The "printer-uri" target for this operation as described in
section 3.1.2. section 3.1.2.
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.3.1. attributes as described in section 3.1.3.1.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2. 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. If the client omits this attribute, the Printer interested. The Printer object MUST support this attribute. If
SHALL respond as if this attribute had been supplied with a value the client omits this attribute, the Printer SHALL respond as if
of 'all'. this attribute had been supplied with a value of 'all'.
"document-format" (mimeMediaType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. This attribute is The client OPTIONALLY supplies this attribute. The Printer
useful for a Printer object to determine the set of supported object MUST support this attribute. This attribute is useful for
attribute values that relate to the requested document format. a Printer object to determine the set of supported attribute
The Printer object SHOULD return only (1) those attributes that values that relate to the requested document format. The Printer
are supported for that format and (2) the attribute values that object SHALL return the attributes and values that it uses to
are supported for the specified document format. By specifying validate a job on a create or Validate-Job operation in which
the document format, the client can get the Printer object to this document format is supplied. The Printer object SHOULD
eliminate the attributes and values that are not supported for a return only (1) those attributes that are supported for the
specific document format. For example, a Printer object might specified format and (2) the attribute values that are supported
have multiple interpreters to support both for the specified document format. By specifying the document
'application/postscript' (for PostScript) and 'text/plain' (for format, the client can get the Printer object to eliminate the
text) documents. However, for only one of those interpreters attributes and values that are not supported for a specific
might the Printer object be able to support "number-up" with document format. For example, a Printer object might have
values of '1', '2', and '4'. For the other interpreter it might multiple interpreters to support both 'application/postscript'
be able to only support "number-up" with a value of '1'. (for PostScript) and 'text/plain' (for text) documents. However,
for only one of those interpreters might the Printer object be
able to support "number-up" with values of '1', '2', and '4'.
For the other interpreter it might be able to only support
"number-up" with a value of '1'.
If the client omits this attribute, the Printer object SHOULD If the Printer object does not distinguish between different
respond as if the attribute had been supplied with a value set to document formats when validating jobs in the create and Validate-
the Printer object's "document-format" default value attribute Job operations, it SHALL NOT distinguish between document formats
(if supported). It is recommended that the client always supply in the Get-Printer-Attributes operation. Thus a client can use
a value for "document-format", since the Printer object's the Get-Printer-Attributes operation to obtain the attributes and
values that will be used to accept/reject a create job operation.
Expires May 7, 1998 Expires June 19, 1998
"document-format" may be 'application/octet-stream', in which If the client omits this attribute, the Printer object SHALL
case the returned attributes and values are for the union of the respond as if the attribute had been supplied with a value equal
document formats that the Printer can automatically sense. For to the value of the Printer object's "document-format-default"
more details, see the description of the 'mimeMediaType' attribute. It is recommended that the client always supply a
attribute syntax in section 4.1.9. value for "document-format", since the Printer object's
"document-format-default" may be 'application/octet-stream', in
which case the returned attributes and values are for the union
of the document formats that the Printer can automatically sense.
For more details, see the description of the 'mimeMediaType'
attribute syntax in section 4.1.11.
Note: The "document-format" operation attribute is a fairly If the client supplies a value for the "document-format"
sophisticated filtering notion that is not supported by many Operation attribute that is not supported by the Printer, i.e.,
existing print systems or devices. is not among the values of the Printer object's "document-format-
supported" attribute, the Printer object SHALL reject the
operation and return the 'client-error-document-format-not-
supported' status code.
3.2.5.2 Get-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-Attributes Response: the Get-Printer-Attributes Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Status Code and Message: Status Code and Message:
The response includes the MANDATORY status code and an OPTIONAL The response includes the MANDATORY status code and an OPTIONAL
"status-message" (text) operation attribute as described in "status-message" (text) operation attribute as described in
section 3.1.4. section 3.1.4.
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.3.2. attributes as described in section 3.1.3.2.
Group 2: Requested Printer Object Attributes Group 2: Unsupported Attributes
This is a set of Operation attributes supplied by the client (in
the request) that are not supported by the Printer object or that
conflict with one another (see sections 3.2.1.2 and 15).
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
attribute which is not supported. attribute which is not supported. However, the Printer object
SHALL respond with the 'unknown' value for any supported
Expires June 19, 1998
attribute (including all MANDATORY attributes) for which the
Printer object does not know the value. Also the Printer object
SHALL respond with the 'no-value' for any supported attribute
(including all MANDATORY attributes) for which the system
administrator has not configured a value. See the description of
the 'out-of-band' values in the beginning of Section 4.1.
3.2.6 Get-Jobs Operation 3.2.6 Get-Jobs Operation
The Get-Jobs operation allows a client to retrieve the list of Job This MANDATORY 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 Get-Attributes for Job object, except that This operation is similar Get-Job-Attributes for a Job object, except
this Get-Jobs operation returns attributes from possibly more than one that this Get-Jobs operation returns attributes from possibly more
object (see the description of Job attribute group names in section than one object (see the description of Job attribute group names in
3.3.4). section 3.3.4).
Expires May 7, 1998
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: Target:
The "printer-uri" target for this operation as described in The "printer-uri" target for this operation as described in
section 3.1.2. section 3.1.2.
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.3.1. attributes as described in section 3.1.3.1.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2. client as described in section 8.3.
"limit" (integer): "limit" (integer(1:MAX)):
The client OPTIONALLY supplies this attribute. It is an integer The client OPTIONALLY supplies this attribute. The Printer
value that indicates a limit to the number of Job objects object MUST support this attribute. It is an integer value that
returned. The limit is a "stateless limit" in that if the value indicates a limit to the number of Job objects returned. The
supplied by the client is 'N', then only the first 'N' jobs are limit is a "stateless limit" in that if the value supplied by the
returned in the Get-Jobs Response. There is no mechanism to client is 'N', then only the first 'N' jobs are returned in the
allow for the next 'M' jobs after the first 'N' jobs. If the
client does not supply this attribute, the Printer object Expires June 19, 1998
responds will all applicable jobs. Get-Jobs Response. There is no mechanism to allow for the next
'M' jobs after the first 'N' jobs. If the client does not supply
this attribute, the Printer object responds with all applicable
jobs.
"requested-attributes" (1setOf keyword): "requested-attributes" (1setOf keyword):
The client OPTIONALLY supplies this attribute. It is a set of The client OPTIONALLY supplies this attribute. The Printer
Job attribute names and/or attribute groups names in whose values object MUST support this attribute. It is a set of Job attribute
the requester is interested. This set of attributes is returned names and/or attribute groups names in whose values the requester
for each Job object that is returned. The allowed attribute is interested. This set of attributes is returned for each Job
group names are the same as those defined in the Get-Attributes object that is returned. The allowed attribute group names are
operation for Job objects in section 3.3.4. If the client does the same as those defined in the Get-Job-Attributes operation in
not supply this attribute, the Printer SHALL respond as if the section 3.3.4. If the client does not supply this attribute, the
client had supplied this attribute with two values: 'job-uri' and Printer SHALL respond as if the client had supplied this
'job-id'. attribute with two values: 'job-uri' and 'job-id'.
"which-jobs" (keyword): "which-jobs" (keyword):
The client OPTIONALLY supplies this attribute. It indicates The client OPTIONALLY supplies this attribute. The Printer
which Job objects SHOULD be returned by the Printer object. The object MUST support this attribute. It indicates which Job
values for this attribute are: objects SHALL be returned by the Printer object. The values for
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'.
Expires May 7, 1998
'not-completed': This includes any Job object whose state is 'not-completed': This includes any Job object whose state is
'pending', 'processing', 'processing-stopped', 'pending- 'pending', 'processing', 'processing-stopped', 'pending-
held', 'unknown'. held', 'unknown'.
A Printer object SHALL support both values. However, if the
implementation does not keep jobs in the 'completed', 'canceled',
and 'aborted' states, then it returns no jobs when the
'completed' value is supplied.
If a client supplies some other value, the Printer object SHALL
copy the attribute and the unsupported value to the Unsupported
Attributes response group, reject the request, and return the
'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 SHALL respond as if the client had supplied the attribute with a
value of 'not-completed'. value of 'not-completed'.
"my-jobs" (boolean): "my-jobs" (boolean):
The client OPTIONALLY supplies this attribute. It indicates The client OPTIONALLY supplies this attribute. The Printer
whether all jobs or just the jobs submitted by the requesting object MUST support this attribute. It indicates whether all
user of this request SHALL be returned by the Printer object. jobs or just the jobs submitted by the requesting user of this
If the client does not supply this attribute, the Printer object request SHALL be returned by the Printer object. If the client
SHALL respond as if the client had supplied the attribute with a does not supply this attribute, the Printer object SHALL respond
value of 'false', i.e., all jobs not just my jobs. The means for
authenticating the requesting user and matching the jobs is Expires June 19, 1998
described in section 3.1.5. as if the client had supplied the attribute with a value of
'false', i.e., all jobs. The means for authenticating the
requesting user and matching the jobs is described in section 8.
3.2.6.2 Get-Jobs Response 3.2.6.2 Get-Jobs Response
The Printer object returns all of the Job objects 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.
skipping to change at page 39, line 45 skipping to change at page 44, line 31
Status Code and Message: Status Code and Message:
The response includes the MANDATORY status code and an OPTIONAL The response includes the MANDATORY status code and an OPTIONAL
"status-message" (text) operation attribute as described in "status-message" (text) operation attribute as described in
section 3.1.4. section 3.1.4.
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.3.2. attributes as described in section 3.1.3.2.
Groups 2 to N: Job Object Attributes Group 2: Unsupported Attributes
This is a set of Operation attributes supplied by the client (in
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).
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 which is not supported not respond with) any requested attribute which is not supported
or which is restricted by the security policy in force, including or which is restricted by the security policy in force, including
whether the requesting user is the user that submitted the job whether the requesting user is the user that submitted the job
(job originating user) or not (see section 3.1.5). (job originating user) or not (see section 8). However, the
Printer object SHALL respond with the 'unknown' value for any
supported attribute (including all MANDATORY attributes) for
which the Printer object does not know the value, unless it would
violate the security policy. See the description of the 'out-of-
band' values in the beginning of Section 4.1.
Expires May 7, 1998
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
Expires June 19, 1998
response, the Printer SHALL indicate the submitted natural response, the Printer SHALL 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 'text' attribute syntax (see Section 4.1.1), the Natural the sections 4.1.2 and 4.1.4, the Natural Language Override
Language Override overrides the Job object's "attributes-natural- overrides the Job object's "attributes-natural-language" value
language" value and/or the "attributes-natural-language" and/or the "attributes-natural-language" operation attribute
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 are 'completed', 'aborted', or 'canceled' states), then the Jobs
returned newest to oldest (with respect to actual completion are returned newest to oldest (with respect to actual
time) completion time)
- If the client requests all 'non-completed' Jobs (Jobs in the - If the client requests all 'not-completed' Jobs (Jobs in the
'pending', 'processing', 'pending-held', 'processing-stopped', 'pending', 'processing', 'pending-held', 'processing-
and 'unknown' states), then Jobs are returned in relative stopped', and 'unknown' states), then Jobs are returned in
chronological order of expected time to complete (based on relative chronological order of expected time to complete
whatever scheduling algorithm is configured for the Printer (based on whatever scheduling algorithm is configured for
object). the Printer object).
3.3 Job Operations 3.3 Job Operations
All Job operations are directed at Job objects. A client MUST always All Job operations are directed at Job objects. A client MUST always
supply some means of identifying the Job object in order to identify supply some means of identifying the Job object in order to identify
the correct target of the operation. Job objects can be identified the correct target of the operation. That job identification MAY
with either a single Job URI or a combination of a Printer URI with a either be a single Job URI or a combination of a Printer URI with a
Job ID. Job ID. The IPP object implementation MUST support both forms of
identification for every job.
Note: The following rules apply to all Job operation requests mapped
onto HTTP/1.1:
Expires May 7, 1998
- If the client chooses to identify Job objects with just the Job
URI, this "job-uri" attribute is not supplied in the body of the
operation as other operation attributes are. It is supplied in
the "request-URI" field in the HTTP header.
- If the client chooses to identify Job objects with both a Printer
URI and a local Job ID, the "printer-uri" attribute is not
supplied in the body of the operation, but it is supplied in the
"request-URI" field in the HTTP header. The "job-id" attribute
is included as an operation attribute.
Since the Get-Attributes operation can be both a Printer operation and
a Job operation, if a Printer object receives a Get-Attributes
request, the Printer object must check for the existence of the "job-
id" operation attribute. If present, the operation is intended to be
a Job operation on the corresponding Job object. If absent, the
operation is intended to be a Printer operation.
3.3.1 Send-Document Operation 3.3.1 Send-Document Operation
A client uses a Create-Job operation 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
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
Expires June 19, 1998
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
operation, the Printer object MAY decide on any of the following operation, the Printer object MAY decide on any of the following
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
'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').
Expires May 7, 1998
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
skipping to change at page 42, line 34 skipping to change at page 46, line 52
Target: Target:
Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri" Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
target for this operation as described in section 3.1.2. target for this operation as described in section 3.1.2.
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.3.1. attributes as described in section 3.1.3.1.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2. client as described in section 8.3.
"document-name" (name): Expires June 19, 1998
The client OPTIONALLY supplies this attribute, and it contains "document-name" (name(MAX)):
the client supplied document name. The document name MAY be The client OPTIONALLY supplies this attribute. The Printer
different than the Job name. It might be helpful, but NEED NOT object MUST support this attribute. It contains the client
be unique across multiple documents in the same Job. Typically, supplied document name. The document name MAY be different than
the client software automatically supplies the document name on the Job name. It might be helpful, but NEED NOT be unique across
behalf of the end user by using a file name or an application multiple documents in the same Job. Typically, the client
generated name. See the description of the "document-name" software automatically supplies the document name on behalf of
operation attribute in the Print-Job Request (section 3.2.1.1) the end user by using a file name or an application generated
for more information about this attribute. name. See the description of the "document-name" operation
attribute in the Print-Job Request (section 3.2.1.1) for more
information about this attribute.
"document-format" (mimeMediaType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. The value of this The client OPTIONALLY supplies this attribute. The Printer
attribute describes the format of the supplied document data. If object MUST support this attribute. The value of this attribute
the client does not supply this attribute, the Printer object identifies the format of the supplied document data. If the
assumes that the document data is in the format defined by the client does not supply this attribute, the Printer object assumes
Printer object's "document-format" attribute. that the document data is in the format defined by the Printer
object's "document-format-default" attribute. If the client
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's "document-format-supported" attribute, the
Printer object SHALL reject the request and return the 'client-
error-document-format-not-supported' status code.
Expires May 7, 1998
"document-natural-language" (naturalLanguage): "document-natural-language" (naturalLanguage):
This attribute is OPTIONALLY supplied by the client. There are The client OPTIONALLY supplies this attribute. The Printer
object OPTIONALLY supports this attribute. This attribute
specifies the natural language of the document for those
document-formats that require a specification of the natural
language in order to image the document Unambiguously. There are
no particular values required for the Printer object to support. no particular values required for the Printer object to support.
This attribute specifies the natural language of the document for
those document-formats that require a specification of the
natural language in order to image the document unambiguously.
"last-document" (boolean): "last-document" (boolean):
The client MUST supply this attribute. It is a boolean flag that The client MUST supply this attribute. The Printer object MUST
is set to 'true' if this is the last document for the Job, support this attribute. It is a boolean flag that is set to
'false' otherwise. 'true' if this is the last document for the Job, 'false'
otherwise.
Group 2: Document Content Group 2: Document Content
The client MUST supply the document data if the "last-document" The client MUST supply the document data if the "last-document"
flag is set to 'false'. However, since a client might not know flag is set to 'false'. However, since a client might not know
that the previous document sent with a Send-Document operation that the previous document sent with a Send-Document operation
was the last document (i.e., the "last-document" attribute was was the last document (i.e., the "last-document" attribute was
set to 'false'), it is legal to send a Send-Document request with set to 'false'), it is legal to send a Send-Document request with
no document data where the "last-document" flag is set to 'true'. no document data where the "last-document" flag is set to 'true'.
Such a request SHALL NOT increment the value of the Job object's
Expires June 19, 1998
"number-of-documents" attribute, since 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 Code and Message:
The response includes the MANDATORY status code and an OPTIONAL The response includes the MANDATORY status code and an OPTIONAL
"status-message" (text) operation attribute as described in "status-message" (text) operation attribute as described in
section 3.1.4. section 3.1.4.
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.3.2. attributes as described in section 3.1.3.2.
Group 2: Job Object Attributes Group 2: Unsupported Attributes
This is a set of Operation attributes supplied by the client (in
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).
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 operation is identical to the Send-Document operation (see This OPTIONAL operation is identical to the Send-Document operation
section 3.3.1) except that a client supplies a URI reference (see section 3.3.1) except that a client MUST supply a URI reference
Expires May 7, 1998
("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. existing multi-document Job object. If a Printer object supports this
operation, it MUST also support the Print-URI operation (see section
3.2.2).
The Printer object MUST validate the syntax of the supplied URI before The Printer object MUST validate the syntax and URI scheme of the
returning a response. If the Printer object supports this operation, supplied URI before returning a response, just as in the Print-URI
it MUST support the URI types defined under the Print-URI operation operation.
(see section 3.2.2)
Expires June 19, 1998
3.3.3 Cancel Job Operation 3.3.3 Cancel Job Operation
This operation allows a client to cancel a Print Job any time after a This MANDATORY operation allows a client to cancel a Print Job any
create job operation. Since a Job might already be printing by the time after a create job operation. Since a Job might already be
time a Cancel-Job is received, some media sheet pages might be printed printing by the time a Cancel-Job is received, some media sheet pages
before the job is actually terminated. might be 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: Target:
Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri" Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
target for this operation as described in section 3.1.2. target for this operation as described in section 3.1.2.
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.3.1. attributes as described in section 3.1.3.1.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2. client as described in section 8.3.
"message" (text): "message" (text(127)):
This attribute is OPTIONALLY supplied by the client. It is a The client OPTIONALLY supplies this attribute. The Printer
message to the operator. This "message" attribute is not the object OPTIONALLY supports this attribute. It is a message to the
same as the "job-message-from-operator" attribute. That operator. This "message" attribute is not the same as the "job-
attribute is used to report a message from the operator to the message-from-operator" attribute. That attribute is used to
end user that queries that attribute. This "message" operation report a message from the operator to the end user that queries
attribute is used to send a message from the client to the that attribute. This "message" operation attribute is used to
operator along with the operation request. It is an send a message from the client to the operator along with the
implementation decision of how or where to display this message operation request. It is an implementation decision of how or
to the operator (if at all). where to display this message to the operator (if at all).
Expires May 7, 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 Code and Message:
The response includes the MANDATORY status code and an OPTIONAL The response includes the MANDATORY status code and an OPTIONAL
"status-message" (text) operation attribute as described in "status-message" (text) operation attribute as described in
section 3.1.4. section 3.1.4.
Expires June 19, 1998
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 SHALL
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.3.2. attributes as described in section 3.1.3.2.
Group 2: Unsupported Attributes
This is a set of Operation attributes supplied by the client (in
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).
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.6), the when the job enters the 'canceled' job-state (see section 4.3.6), 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-Attributes Operation (for Job objects) 3.3.4 Get-Job-Attributes Operation
The Get-Attributes operation allows a client to request the values of This MANDATORY 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-
Attributes operation for a Printer object (see section 3.2.5). The Printer-Attributes operation (see section 3.2.5). The only
only differences are that the operation is directed at a Job object differences are that the operation is directed at a Job object rather
rather than a Printer object and there is no "document-format" than a Printer object, there is no "document-format" operation
operation attribute used when querying a Job object. 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
object attributes.
For Jobs, the attribute groups include: 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
attributes.
Expires May 7, 1998 Expires June 19, 1998
There is also the special group 'all' that includes all supported
attributes. Since a client MAY request specific attributes or named Since a client MAY request specific attributes or named groups, there
groups, there is a potential that there is some overlap. For example, is a potential that there is some overlap. For example, if a client
if a client requests, 'job-name' and 'job-description', the client is requests, 'job-name' and 'job-description', the client is actually
actually requesting the "job-name" attribute once by naming it requesting the "job-name" attribute once by naming it explicitly, and
explicitly, and once by inclusion in the 'job-description' group. In once by inclusion in the 'job-description' group. In such cases, the
such cases, the Printer object NEED NOT return the attribute only once Printer object NEED NOT return the attribute only once in the response
in the response even if it is requested multiple times. The client even if it is requested multiple times. The client SHOULD NOT request
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. MANDATORY that each Job object support all group names.
3.3.4.1 Get-Attributes Request 3.3.4.1 Get-Job-Attributes Request
The following groups of attributes are part of the Get-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: Target:
Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri" Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
target for this operation as described in section 3.1.2. target for this operation as described in section 3.1.2.
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.3.1. attributes as described in section 3.1.3.1.
Requesting User Name: Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2. client as described in section 8.3.
"requested-attributes" (1setOf keyword) : "requested-attributes" (1setOf keyword) :
The client OPTIONALLY supplies this attribute. It is a set of The client OPTIONALLY supplies this attribute. The IPP object
attribute names and/or attribute group names in whose values the MUST support this attribute. It is a set of attribute names
requester is interested. If the client omits this attribute, the and/or attribute group names in whose values the requester is
Printer object SHALL respond as if this attribute had been interested. If the client omits this attribute, the IPP object
supplied with a value of 'all'. SHALL respond as if this attribute had been supplied with a value
of 'all'.
3.3.4.2 Get-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-Attributes Response: the Get-Job-Attributes Response:
Group 1: Operation Attributes Group 1: Operation Attributes
Expires May 7, 1998 Expires June 19, 1998
Status Code and Message: Status Code and Message:
The response includes the MANDATORY status code and an OPTIONAL The response includes the MANDATORY status code and an OPTIONAL
"status-message" (text) operation attribute as described in "status-message" (text) operation attribute as described in
section 3.1.4. section 3.1.4.
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.3.2. The "attributes- attributes as described in section 3.1.3.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.
Group 2: Requested Job Object Attributes Group 2: Unsupported Attributes
This is a set of Operation attributes supplied by the client (in
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).
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 Printer object ignores (does not respond with) any requested The IPP object ignores (does not respond with) any requested
attribute which is not supported or which is restricted by the attribute which is not supported or which is restricted by the
security policy in force, including whether the requesting user security policy in force, including whether the requesting user
is the user that submitted the job (job originating user) or not is the user that submitted the job (job originating user) or not
(see section 3.1.5). (see section 8). However, the IPP object SHALL respond with the
'unknown' value for any supported attribute (including all
MANDATORY attributes) for which the IPP object does not know the
value, unless it would violate the security policy. See the
description of the 'out-of-band' values in the beginning of
Section 4.1.
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
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). The keyword is included in the "keyword" (see section 12.2.1) which is the name of the attribute.
section header describing that attribute. In addition, one of the
attribute syntaxes described below is "keyword". Therefore, some Expires June 19, 1998
attributes can be defined as having an attribute syntax that is a set
of keywords. The keyword is included in the section header describing that
attribute.
Note: Not only are keywords used to identify attributes, but one of
the attribute syntaxes described below is "keyword" so that some
attributes have keyword values. Therefore, these attributes are
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 SHALL be able to accept in responses and accept in
requests, respectively. Each attribute description in sections 3 and requests, respectively. Each attribute description in sections 3 and
4 includes the name of attribute syntax(es) in the heading (in 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 SHALL
include the semantics of the attribute syntax(es) so identified. include the semantics of the attribute syntax(es) so identified.
Expires May 7, 1998
Section 6 describes how the protocol can be extended with new Section 6 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 or be syntaxes specified in the sub-section heading for the attribute. In
one of the "out of band" values. Standard values are: addition, responses (but not requests) MAY be one of the "out of band"
values. Standard "out-of-band" values are:
'unknown': The attribute is supported, but the value is unknown for 'unknown': The attribute is supported by the IPP object, but the
some reason. value is unknown to the IPP object for some reason.
'unsupported': The attribute is unsupported. 'unsupported': The attribute is unsupported by the IPP object.
This value SHALL be returned only as the value of an attribute in
the Unsupported Attributes Group.
'no-value': The attribute is supported by the Printer object, but
the system administrator has not yet configured a value.
The protocol specification defines mechanisms for allowing passing The protocol specification defines mechanisms for allowing passing
"out of band" values. "out of band" values. All attributes in a request SHALL have one or
more values as defined in Sections 4.2 to 4.4. Thus clients SHALL not
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
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 "|"
Expires June 19, 1998
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 SHALL 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 The 'text' attribute syntax is a sequence of one or more characters
encoded in a maximum of 4095 octets. The Printer object SHALL support encoded in a maximum of 1023 octets which is indicated in sub-section
the UTF-8 charset [RFC2044] and MAY support additional charsets headers using the notation: text(MAX). If an attribute is specified
provided that they are registered with IANA [IANA-CS]. See Section to have a smaller maximum in its sub-section header description, the
4.1.7 for the specification of the 'charset' attribute syntax, explicit number of octets is indicated. For example: the "printer-
including restricted semantics and examples of charsets. location" attribute is specified as: printer-location (text(127)).
The Printer object SHALL support the UTF-8 charset [RFC2044] and MAY
support additional charsets provided that they are registered with
IANA [IANA-CS] to represent 'text' values. 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
'text' attribute syntax, also automatically have the
'textWithLanguage' attribute syntax. See section 4.1.2.
If the client needs to supply or the Printer object needs to return a If the client needs to supply or the Printer object needs to return a
'text' attribute in a different natural language from the rest of the 'text' attribute in a different natural language from the rest of the
'text' attributes in the request or response as indicated by the 'text' attributes in the request or response as indicated by the
"attributes-natural-language" operation attribute (see Section 3.1.3) "attributes-natural-language" operation attribute (see Section 3.1.3)
or job attribute (see Section 4.3.21), the client or Printer object or job attribute (see Section 4.3.25), the client or Printer object
SHALL identify the natural language for that attribute. This SHALL identify the natural language for that attribute. This
mechanism for identifying the natural language of a single attribute MANDATORY mechanism for identifying the natural language of a single
value is called the Natural Language Override mechanism. attribute value is called the Natural Language Override mechanism.
This mechanism uses an alternate attribute syntax, called
'textWithLanguage', which is described in section 4.1.2.
Expires May 7, 1998 4.1.2 'textWithLanguage'
If the attribute is multi-valued (1setOf text), then the Natural
Language Override must be explicitly specified with each attribute The 'textWithLanguage' attribute syntax is a compound attribute syntax
value whose natural language needs to be overriden. Other values in a consisting of two parts: a 'text' part plus an additional
multi-valued 'text' attribute in a request or a response revert to the 'naturalLanguage' (see section 4.1.10) part that overrides the natural
natural language of the operation attribute or to the "attributes- language in force. The 'naturalLanguage' part explicitly identifies
natural-language" Job attribute, if present, in the case of a Get-Jobs the natural language that applies to the text part of that value and
response. 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
Expires June 19, 1998
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
'text' attribute value in a different natural language from the rest
of the 'text' attribute values in the request or response as indicated
by the "attributes-natural-language" operation attribute (see Section
3.1.3) or to the "attributes-natural-language" Job attribute, if
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
Language Override mechanism for the 'text' attribute syntax and MUST
be supported by IPP objects.
If the attribute is multi-valued (1setOf text), then the
'textWithLanguage' attribute syntax MUST be used to explicitly specify
each attribute value whose natural language needs to be overridden.
Other values in a multi-valued 'text' attribute in a request or a
response revert to the natural language of the operation attribute or
to the "attributes-natural-language" Job attribute, if present, in the
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 languages in the "attributes-natural-language" Job object any natural languages 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 with each attribute value any Natural Language Override, whether store any 'textWithLanguage' attribute value, whether the Printer
the Printer object supports that natural language or not. These object supports that natural language or not. These requirements are
requirements are independent of the value of the "ipp-attribute- independent of the value of the "ipp-attribute-fidelity" operation
fidelity" operation attribute that the client supplies. 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 Natural Language Override mechanism as follows: the 'textWithLanguage' attribute syntax with the following two values:
'fr': Natural Language Override indicating French 'fr': Natural Language Override indicating French
Expires June 19, 1998
'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
Natural Language Override mechanism. 'textWithLanguage' attribute syntax.
4.1.2 'name' 4.1.3 'name'
The 'name' attribute syntax is the same as 'text', including the The 'name' attribute syntax is the same as 'text', including the
MANDATORY support of UTF-8 and the Natural Language Override MANDATORY support of UTF-8 and the Natural Language Override
mechanism, except that the sequence of characters is limited so that mechanism, except that the sequence of characters is limited so that
its encoded form is of length 1 to 255 octets. This syntax type is its encoded form is of length 1 to 255 octets which is indicated in
used for user-friendly strings, such as a Printer name, that, for sub-section headers using the notation: name(MAX). If an attribute is
humans, are more meaningful than identifiers. 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
'name' attribute syntax, also automatically have the
'nameWithLanguage' attribute syntax. See section 4.1.4.
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'
The 'nameWithLanguage' attribute syntax is the same as
'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" Example: If the client supplies the "attributes-natural-language"
operation attribute with the value: 'en' indicating English, but the operation attribute with the value: 'en' indicating English, but the
"printer-name" attribute is in German, the client MUST use Natural "printer-name" attribute is in German, the client MUST use the
Language Override 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
Expires May 7, 1998 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
Expires June 19, 1998
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 SHALL 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 SHALL NOT use the Natural Language Override mechanism, since
they SHALL always be US-ASCII and U.S. English. they SHALL always be US-ASCII and U.S. English.
skipping to change at page 50, line 46 skipping to change at page 57, line 43
keyword SHALL not be used for two different values within the same keyword SHALL 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 describes how
the protocol can be extended with new keyword values. Examples of the protocol can be extended with new keyword values. Examples of
attribute name keywords: attribute name keywords:
"job-name" "job-name"
"attributes-charset" "attributes-charset"
4.1.4 'enum' 4.1.6 '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 -2**31 (MIN) to 2**31 - 1 (MAX). Each value has an
associated 'keyword' name. In the definition for each attribute of associated 'keyword' name. In the definition for each attribute of
Expires May 7, 1998
this syntax type, the full set of possible values for that attribute this syntax type, the full set of possible values for that attribute
are listed. This syntax type is used for attributes for which there are listed. This syntax type is used for attributes for which there
are enum values assigned by other standards, such as SNMP MIBs. A are enum values assigned by other standards, such as SNMP MIBs. A
number of attribute enum values in this specification are also used number of attribute enum values in this specification are also used
for corresponding attributes in other standards [RFC1759]. This for corresponding attributes in other standards [RFC1759]. This
syntax type is not used for attributes to which the system syntax type is not used for attributes to which the system
Expires June 19, 1998
administrator may assign values. Section 6 describes how the protocol administrator may assign values. Section 6 describes how the protocol
can be extended with new enum values. can be extended 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 out Note: SNMP MIBs use '2' for 'unknown' which corresponds to the IPP out
of band value 'unknown'. Therefore, most attributes of type 'enum' of band value 'unknown'. See the description of the "out-of-band"
often start at '3'. values at the beginning of Section 4.1. Therefore, most attributes of
type 'enum' often start at '3'.
4.1.5 'uri' 4.1.7 '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]. or URLs [RFC1738] [RFC1808]. The maximum length of URIs used within
IPP is 1023 octets.
4.1.6 'uriScheme' 4.1.8 '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 HTTPS schemed URIs (e.g., "https://...")
'ftp': for FTP schemed URIs (e.g., "ftp://...") 'ftp': for FTP schemed URIs (e.g., "ftp://...")
'mailto': for SMTP schemed URIs (e.g., "mailto:...") 'mailto': for SMTP schemed URIs (e.g., "mailto:...")
'file': for file schemed URIs (e.g., "file:...") 'file': for file schemed URIs (e.g., "file:...")
A Printer object MAY support any URI scheme that has been registered A Printer object MAY support any URI scheme that has been registered
with IANA [IANA-MT] with IANA [IANA-MT]. The maximum length of URI schemes used within IPP
is 63 octets.
Expires May 7, 1998 4.1.9 'charset'
4.1.7 'charset'
The 'charset' attribute syntax is a standard identifier for a The 'charset' attribute syntax is a standard identifier for a charset.
"charset". A charset is a coded character set and encoding scheme. A charset is a coded character set and encoding scheme. Charsets are
Charsets are used for labeling certain document contents and 'text'
and 'name' attribute values. The syntax and semantics of this Expires June 19, 1998
attribute syntax are specified in RFC 2046 [RFC2046] and contained in
the IANA character-set Registry [IANA-CS] according to the IANA used for labeling certain document contents and 'text' and 'name'
procedures [IANA-CSa]. Though RFC 2046 requires that the values be attribute values. The syntax and semantics of this attribute syntax
case-insensitive US-ASCII, IPP requires all lower case to simplify are specified in RFC 2046 [RFC2046] and contained in the IANA
character-set Registry [IANA-CS] according to the IANA procedures
[IANA-CSa]. Though RFC 2046 requires that the values be case-
insensitive US-ASCII, IPP requires all lower case to simplify
comparing by IPP clients and Printer objects. When a character-set in 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, SHALL be used.
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 [RFC2044] transfer encoding scheme
in which US-ASCII is a subset charset. The 'utf-8' charset value in which US-ASCII is a subset charset. The 'utf-8' charset value
supplied in the "attributes-charset" operation attribute (see supplied in the "attributes-charset" operation attribute (see
Section 3.1.3), which is used to identify the charset of 'text' Section 3.1.3), which is used to identify the charset of 'text'
and 'name' attributes, SHALL be restricted to any characters and 'name' attributes, SHALL be restricted to any characters
defined by ISO 10646 [ISO10646-1]. 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
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
Character Set (UCS) represented as two octets (UCS-2), with the
high order octet of each pair coming first (so-called Big Endian
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 MANDATORY values that MUST be
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.8 'naturalLanguage' 4.1.10 '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 taken from 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:
Expires June 19, 1998
'en': for English 'en': for English
Expires May 7, 1998
'en-us': for US English 'en-us': for US English
'fr': for French 'fr': for French
'de': for German 'de': for German
4.1.9 'mimeMediaType' The maximum length of naturalLanguage values used within IPP is 63
octets.
4.1.11 '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]. Examples:
'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
skipping to change at page 53, line 39 skipping to change at page 60, line 43
'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
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 SHALL 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" 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 SHOULD rely on the supplied attribute, rather than value, the Printer SHALL rely on the supplied attribute, rather than
trust its auto-sensing algorithm. To summarize: trust its auto-sensing algorithm. To summarize:
Expires June 19, 1998
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 SHOULD trust format of the document data and the Printer object SHALL trust
Expires May 7, 1998
the client supplied value more than the outcome of applying an the 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 SHALL 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 SHALL 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-
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.
4.1.10 'octetString' The maximum length of a 'mimeMediaType' value in IPP is 63 octets.
4.1.12 '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 4095 octets. This syntax type is used for opaque data. a maximum of 1023 octets which is indicated in sub-section headers
using the notation: octetString(MAX). This syntax type is used for
opaque data.
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.12 'integer' 4.1.14 '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 if the range is different may specify the range constraint explicitly in sub-section headers if
from the full range of possible integer values (e.g., 0:100 for the the range is different from the full range of possible integer values.
"job-priority" attribute), however, the enforcement of that additional
constraint is up to the IPP objects, not the protocol.
4.1.13 'rangeOfInteger' Expires June 19, 1998
For example: job-priority (integer(1:100)) for the "job-priority"
attribute. However, the enforcement of that additional constraint is
up to the IPP objects, not the protocol.
4.1.15 '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
Expires May 7, 1998
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.14 'dateTime' 4.1.16 '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
[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. When accepting 'dateTime' values from users and representation. A user interface will provide a mapping between
displaying 'dateTime' values to users, clients SHOULD localize the protocol dateTime values and displayable user-friendly words or
values to the charset and natural language of the user. presentation values and phrases which are localized to the natural
language and date format of the user.
4.1.15 'resolution' 4.1.17 '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
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 dots per inch and dots per centimeter). All three Printer MIB (namely, '3' indicates dots per inch and '4' indicates
values MUST be present even if the first two values are the same. dots per centimeter). All three values MUST be present even if the
Example: '300', '600', '3' indicates a 300 dpi cross-feed direction first two values are the same. Example: '300', '600', '3' indicates
resolution, a 600 dpi feed direction resolution, since a '3' indicates a 300 dpi cross-feed direction resolution, a 600 dpi feed direction
dots per inch. resolution, since a '3' indicates dots per inch (dpi).
4.1.16 '1setOf X' Expires June 19, 1998
4.1.18 '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 SHALL NOT be empty (i.e., a set of
size 0). Sets are normally unordered, however each attribute size 0). Sets are normally unordered. However each attribute
description of this type may specify that the values MUST be in a description of this type may specify that the values MUST be in a
certain order for that attribute. certain order for that attribute.
Expires May 7, 1998
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, 12.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 1. If the Printer object supports "xxx" then it SHALL support both
a "xxx-default" default value attribute (unless there is a "No" a "xxx-default" attribute (unless there is a "No" in the table
in the table below) and a "xxx-supported" supported values below) and a "xxx-supported" attribute.
attribute.
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, the processing behavior for this Job. When "xxx" is not supplied,
client is indicating that the Printer object apply its default job the client is indicating that the Printer object apply its
processing behavior at job processing time if the document content default job processing behavior at job processing time if the
does not contain an embedded instruction indicating an xxx-related document content does not contain an embedded instruction
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.
The "xxx-supported" attribute is a Printer object attribute that 3. The "xxx-supported" attribute is a Printer object attribute that
describes which job processing behaviors are supported by that Printer describes which job processing behaviors are supported by that
object. A client can query the Printer object to find out what xxx- Printer object. A client can query the Printer object to find
related behaviors are supported by inspecting the returned values of out what xxx-related behaviors are supported by inspecting the
the "xxx-supported" attribute. The "xxx-default" default value returned values of the "xxx-supported" attribute.
attribute describes what will be done at job processing time when no
other job processing information is supplied by the client (either Note: The "xxx" in each "xxx-supported" attribute name is
explicitly as an IPP attribute in the create request or implicitly as singular, even though an "xxx-supported" attribute usually has
an embedded instruction within the document data). more than one value, such as "job-sheet-supported", unless the
Expires June 19, 1998
"xxx" Job Template attribute is plural, such as "finishings" or
"sides". In such cases the "xxx-supported" attribute names are:
"finishings-supported" and "sides-supported".
4. The "xxx-default" default value attribute describes what will be
done at job processing time when no other job processing
information is supplied by the client (either explicitly as an
IPP attribute in the create request or implicitly as an embedded
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
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-Attributes Request, or the enumerate each attribute by name in the Get-Printer-Attributes
Request, or the client MAY just name the "job-template" group in order
Expires May 7, 1998 to get the complete set of supported attributes (both supported and
client MAY just name the "job-template" group in order to get the default attributes).
complete set of supported attributes (both supported and default
attributes).
The "finishings" attribute is an example of a Job Template attribute. The "finishings" attribute is an example of a Job Template attribute.
It can take on a set of values such as 'staple', 'punch', and/or It can take on a set of values such as 'staple', 'punch', and/or
'cover'. A client can query the Printer object for the "finishings- 'cover'. A client can query the Printer object for the "finishings-
supported" attribute and the "finishings-default" attribute. The supported" attribute and the "finishings-default" attribute. The
supported attribute contains a set of supported values. The default supported attribute contains a set of supported values. The default
value attribute contains the finishing value(s) that will be used for value attribute contains the finishing value(s) that will be used for
a 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. If the client does supply the "finishings" the create request and the document data does not contain any
attribute in the create request, the Printer validates the value or corresponding finishing instructions. If the client does supply the
values to make sure that they are a subset of the supported values. "finishings" attribute in the create request, the IPP object validates
If the client-supplied values are all supported, the Job object is the value or values to make sure that they are a subset of the
created with a "finishings" attribute that is populated with the supported values identified in the Printer object's "finishings-
values supplied by the client. Subsequently, when the Job object is supported" attribute. See section 3.2.1.2.
queried, it returns the values supplied by the client. If the client
does not supply a "finishings" attribute in the create request, the
Job object is created, but no "finishings" attribute is associated
with the new Job object. A subsequent query of the Job object will
return no "finishings" attribute. In this case, the querying client
knows that there were was no client supplied "finishings" attribute.
If the client is interested to know what the default value is that the
Printer will use at job processing time for the missing attribute, the
client can query the Printer object's default value "finishings-
default" attribute to find out how the Job will be finished, unless
the document(s) contain embedded finishing instructions.
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
shows the name and syntax for each Job Template attribute in the Job Attribute") shows the name and syntax for each Job Template attribute
object. These are the attributes that can optionally be supplied by in the Job object. These are the attributes that can optionally be
the client in a create request. The last two columns (labeled supplied by the client in a create request. The last two columns
"Printer: Default Value" and "Printer: Supported Values") shows the (labeled "Printer: Default Value Attribute" and "Printer: Supported
name and syntax for each Job Template attribute in the Printer object Values Attribute") shows the name and syntax for each Job Template
(the default value attribute and the supported values attribute). A attribute in the Printer object (the default value attribute and the
"No" in the table means the Printer SHALL NOT support the attribute supported values attribute). A "No" in the table means the Printer
(that is the attribute is simply not applicable). SHALL NOT support the attribute (that is, the attribute is simply not
Expires May 7, 1998 Expires June 19, 1998
applicable). For brevity in the table, the 'text' and 'name' entries
do not show (MAX).
Expires June 19, 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 | | (type4 keyword | | default | supported |
| name) | (type4 keyword | |(1setOf | | name) | (type4 keyword | |(1setOf |
| | name) | type4 keyword | name)| | | name) | type4 keyword | name)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| job-sheets | job-sheets-default |job-sheets-supported | | job-sheets | job-sheets-default |job-sheets-supported |
| (type4 keyword | | (type4 keyword | |(1setOf | (type4 keyword | | (type4 keyword | |(1setOf |
| name) | name) | type4 keyword | name)| | name) | name) | type4 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)) | (integer (1:MAX)) |
| | | |
| | copies-collated- | copies-collated- |
| | default | supported |
| | (integer (1:MAX)) | (integer (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 |
skipping to change at page 59, line 4 skipping to change at page 66, line 50
| 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 (0:MAX)) | (integer (0:MAX)) |(1setOf integer |
| | | (0:MAX) | | | | | (0:MAX) | |
| | | rangeOfInteger | | | | rangeOfInteger |
| | | (0:MAX)) | | | | (0:MAX)) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| orientation | orientation-default | orientation- | | orientation | orientation-default | orientation- |
| (type2 enum) | (type2 enum) | supported | | (type2 enum) | (type2 enum) | supported |
| | | (1setOf type2 enum) | | | | (1setOf type2 enum) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
Expires May 7, 1998
| media | media-default | media-supported | | media | media-default | media-supported |
| (type4 keyword | | (type4 keyword | |(1setOf | | (type4 keyword | | (type4 keyword | |(1setOf |
| name) | name) | type4 keyword | name)| | name) | name) | type4 keyword | name)|
| | | | | | | |
Expires June 19, 1998
| | | media-ready | | | | media-ready |
| | |(1setOf | | | |(1setOf |
| | | type4 keyword | name)| | | | type4 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 |
skipping to change at page 60, line 4 skipping to change at page 67, line 48
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 SHALL
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 SHALL 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
Expires May 7, 1998
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 SHALL have priorities higher than
100, rather than restricting the range available to end-users. 100, rather than restricting the range available to end-users.
Expires June 19, 1998
If the client does not supply this attribute and this attribute is
supported by the Printer object, the Printer object SHALL use the
value of the Printer object's "job-priority-default" at job submission
time (unlike most Job Template attributes that are used if necessary
at job 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 SHALL 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)
where n is the value of "job-priority-supported" and x ranges from 0 where n is the value of "job-priority-supported" and x ranges from 0
through n-1. through n-1.
For example, if n=1 the sequence of values is 50; if n=2, the For example, if n=1 the sequence of values is 50; if n=2, the
sequence 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, 11 to 20, the Printer object maps them to 15, object maps them to 5, in the range 11 to 20, the Printer object maps
etc. them to 15, etc.
4.2.2 job-hold-until (type4 keyword | name) 4.2.2 job-hold-until (type4 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. SHALL 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)
Expires June 19, 1998
An administrator SHALL associate allowable print times with a named An administrator SHALL 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
Expires May 7, 1998
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 SHALL 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 SHALL 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 SHALL 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 job state reasons that keep the job in the 'pending-held' state, the
remain, the Printer SHALL consider the job as a candidate for Printer SHALL consider the job as a candidate for processing by moving
processing by moving the job to the 'pending' state. the job to the 'pending' state.
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 SHALL be a
candidate for processing immediately. candidate for processing immediately.
4.2.3 job-sheets (type4 keyword | name) If the client does not supply this attribute and this attribute is
supported by the Printer object, the Printer object SHALL use the
value of the Printer object's "job-hold-until-default" at job
submission time (unlike most Job Template attributes that are used if
necessary at job processing time).
4.2.3 job-sheets (type4 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, SHALL
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
'keyword' attribute syntax, depending on implementation. 'keyword' attribute syntax, depending on implementation.
Note: The effect of this attribute on jobs with multiple documents MAY Note: The effect of this attribute on jobs with multiple documents MAY
be affected by the "multiple-document-handling" job attribute (section be affected by the "multiple-document-handling" job attribute (section
4.2.4), depending on the job sheet semantics. 4.2.4), depending on the job sheet semantics.
Expires June 19, 1998
4.2.4 multiple-document-handling (type2 keyword) 4.2.4 multiple-document-handling (type2 keyword)
This attribute is relevant only if a job consists of two or more This attribute is relevant only if a job consists of two or more
documents. The attribute controls finishing operations and the documents. The attribute controls finishing operations and the
placement of one or more print-stream pages into impressions and onto placement of one or more print-stream pages into impressions and onto
media sheets. When the value of the "copies" attribute exceeds 1, it media sheets. When the value of the "copies" attribute exceeds 1, it
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
Expires May 7, 1998
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) SHALL be treated as a single
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
skipping to change at page 62, line 44 skipping to change at page 71, line 5
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 SHALL 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 SHALL 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 SHALL be a(*), b(*), a(*), b(*), ... .
Expires June 19, 1998
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-
collated-copies', documents a and b are stapled separately. uncollated-copies' and 'separate-documents-collated-copies', documents
a and b are stapled separately.
Note: None of these values provide means to produce uncollated sheets
within a document, i.e., where multiple copies of sheet n are produced
before sheet n+1 of the same document.
Expires May 7, 1998
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.4. control document processing is described in section 15.5.
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.
The "copies-supported" attribute is the limit on the number of
uncollated copies supported, i.e., the limit when the value of the
"multiple-document-handling" attribute is 'single-document' or
'separate-documents-uncollated-copies'. The " copies-collated-
supported" attribute is the limit on the number of collated copies
supported, i.e., the limit when the value of the "multiple-document-
handling" attribute is 'separate-documents-collated-copies'.
The "copies-default" attribute is the default for the number of
uncollated copies, i.e., the default when the value of the "multiple-
document-handling" attribute is 'single-document' or 'separate-
documents-uncollated-copies'. The " copies-collated-default"
attribute is the default for the number of collated copies, i.e., the
default when the value of the "multiple-document-handling" attribute
is 'separate-documents-collated-copies'.
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.4. that control document processing is described in section 15.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:
Value Symbolic Name and Description Value Symbolic Name and Description
'3' 'none': Perform no finishing '3' 'none': Perform no finishing
Expires May 7, 1998 Expires June 19, 1998
'4' 'staple': Bind the document(s) with one or more staples. '4' 'staple': Bind the document(s) with one or more staples.
The exact number and placement of the staples is site- The exact number and placement of the staples is site-
defined. defined.
'5' 'punch': This value indicates that holes are required in '5' 'punch': This value indicates that holes are required in
the finished document. The exact number and placement the finished document. The exact number and placement
of the holes is site-defined The punch specification of the holes is site-defined The punch specification
MAY be satisfied (in a site- and implementation- MAY be satisfied (in a site- and implementation-
specific manner) either by drilling/punching, or by specific manner) either by drilling/punching, or by
substituting pre-drilled media. substituting pre-drilled media.
'6' 'cover': This value is specified when it is desired to '6' 'cover': This value is specified when it is desired to
skipping to change at page 64, line 27 skipping to change at page 72, line 27
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
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.4. that control document processing is described in section 15.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). exist in the document(s). Ranges SHALL be in ascending order, for
example: 1-3, 5-7, 15-19 and SHALL NOT overlap, so that a non-spooling
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
request and return the 'client-error-bad-request' status code.
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 SHALL 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.
Expires June 19, 1998
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. SHALL 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
Expires May 7, 1998
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.
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.
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.4. that control document processing is described in section 15.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 (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.
'two-sided-long-edge': imposes each consecutive pair of print- 'two-sided-long-edge': imposes each consecutive pair of print-
stream pages upon front and back sides of consecutive media stream pages upon front and back sides of consecutive media
sheets, such that the orientation of each pair of print-stream sheets, such that the orientation of each pair of print-stream
pages on the medium would be correct for the reader as if for pages on the medium would be correct for the reader as if for
binding on the long edge. This imposition is sometimes called binding on the long edge. This imposition is sometimes called
'duplex' or 'head-to-head'. 'duplex' or 'head-to-head'.
'two-sided-short-edge': imposes each consecutive pair of print- 'two-sided-short-edge': imposes each consecutive pair of print-
stream pages upon front and back sides of consecutive media stream pages upon front and back sides of consecutive media
sheets, such that the orientation of each pair of print-stream sheets, such that the orientation of each pair of print-stream
pages on the medium would be correct for the reader as if for pages on the medium would be correct for the reader as if for
binding on the short edge. This imposition is sometimes called binding on the short edge. This imposition is sometimes called
'tumble' or 'head-to-toe'. 'tumble' or 'head-to-toe'.
Expires June 19, 1998
'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
Expires May 7, 1998
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.4. that control document processing is described in section 15.5.
4.2.9 number-up (integer(0: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
'0' The Printer SHALL place one print-stream page on a single
side of an instance of the selected medium and SHALL
NOT add any sort of translation, scaling, rotation or
other embellishment).
'1' The Printer SHALL 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 SHALL 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 SHALL 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, but a site may choose to add rotation of print-stream pages.
embellishments, such as borders, to any non-zero value.
Note: The '0' value is for the protocol. It is expected that a
client would chose some more user-friendly representation for
displaying the value '0' to the end-user, such as 'none', rather than
displaying a zero.
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.4. that control document processing is described in section 15.5.
Expires May 7, 1998
4.2.10 orientation (type2 enum) 4.2.10 orientation (type2 enum)
This attribute specifies the orientation of the content of the print- This attribute specifies the orientation of the content of the print-
stream pages to be printed. In most cases, the orientation of the stream pages to be printed. In most cases, the orientation of the
content is specified within the document format generated by the content is specified within the document format generated by the
device driver at print time. However, some document formats (such as device driver at print time. However, some document formats (such as
'text/plain') do not support the notion of page orientation, and it is 'text/plain') do not support the notion of page orientation, and it is
possible to bind the orientation after the document content has been possible to bind the orientation after the document content has been
Expires June 19, 1998
generated. This attribute provides an end user with the means to generated. This attribute provides an end user with the means to
specify orientation for such documents. specify orientation for such documents.
Standard values are: Standard values are:
Value Symbolic Name and Description Value Symbolic Name and Description
'1' 'portrait': The content will be imaged across the short '1' 'portrait': The content will be imaged across the short
edge of the medium. edge of the medium.
'2' 'landscape': The content will be imaged across the long '2' 'landscape': The content will be imaged across the long
skipping to change at page 67, line 43 skipping to change at page 75, line 36
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' value was added because some
applications rotate landscape -90 degrees from applications rotate landscape -90 degrees from
portrait, rather than +90 degrees. portrait, rather than +90 degrees.
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.4. that control document processing is described in section 15.5.
4.2.11 media (type4 keyword | name) 4.2.11 media (type4 keyword | name(MAX))
This attribute identifies the medium that the Printer uses for all This attribute identifies the medium that the Printer uses for all
impressions of the Job. impressions of the Job.
The values for "media" include medium-names, medium-sizes, input-trays The values for "media" include medium-names, medium-sizes, input-trays
and electronic forms so that one attribute specifies the media. If a and electronic forms so that one attribute specifies the media. If a
Printer object supports a medium name as a value of this attribute, Printer object supports a medium name as a value of this attribute,
Expires May 7, 1998
such a medium name implicitly selects an input-tray that contains the such a medium name implicitly selects an input-tray that contains the
specified medium. If a Printer object supports a medium size as a specified medium. If a Printer object supports a medium size as a
value of this attribute, such a medium size implicitly selects a value of this attribute, such a medium size implicitly selects a
medium name that in turn implicitly selects an input-tray that medium name that in turn implicitly selects an input-tray that
contains the medium with the specified size. If a Printer object contains the medium with the specified size. If a Printer object
supports an input-tray as the value of this attribute, such an input- supports an input-tray as the value of this attribute, such an input-
tray implicitly selects the medium that is in that input-tray at the tray implicitly selects the medium that is in that input-tray at the
time the job prints. This case includes manual-feed input-trays. If time the job prints. This case includes manual-feed input-trays. If
Expires June 19, 1998
a Printer object supports an electronic form as the value of this a Printer object supports an electronic form as the value of this
attribute, such an electronic form implicitly selects a medium-name attribute, such an electronic form implicitly selects a medium-name
that in turn implicitly selects an input-tray that contains the medium that in turn implicitly selects an input-tray that contains the medium
specified by the electronic form. The electronic form also implicitly specified by the electronic form. The electronic form also implicitly
selects an image that the Printer SHALL merge with the document data selects an image that the Printer SHALL merge with the document data
as its prints each page. as its prints each page.
Standard values are (taken from ISO DPA and the Printer MIB) and are Standard values are (taken from ISO DPA and the Printer MIB) and are
listed in section 14. An administrator MAY define additional values listed in section 14. An administrator MAY define additional values
using the 'name' or 'keyword' attribute syntax, depending on using the 'name' or 'keyword' attribute syntax, depending on
implementation. implementation.
There is also an additional Printer attribute named "media-ready" There is also an additional Printer attribute named "media-ready"
which differs from "media-supported" in that legal values only include which differs from "media-supported" in that legal values only include
the subset of "media-supported" values that are physically loaded and the subset of "media-supported" values that are physically loaded and
ready for printing with no operator intervention required. ready for printing with no operator intervention required. If an IPP
object supports "media-supported", it NEED NOT support "media-ready".
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.4. control document processing is described in section 15.5.
4.2.12 printer-resolution (resolution) 4.2.12 printer-resolution (resolution)
This attribute identifies the resolution that Printer uses for the This attribute identifies the resolution that Printer uses for the
Job. Job.
4.2.13 print-quality (type2 enum) 4.2.13 print-quality (type2 enum)
This attribute specifies the print quality that the Printer uses for This attribute specifies the print quality that the Printer uses for
the Job. the Job.
The standard values are: The standard values are:
Value Symbolic Name and Description Value Symbolic Name and Description
'3' 'draft': lowest quality available on the printer '3' 'draft': lowest quality available on the printer
'4' 'normal': normal or intermediate quality on the printer '4' 'normal': normal or intermediate quality on the printer
'5' 'high': highest quality available on the printer '5' 'high': highest quality available on the printer
Expires May 7, 1998
4.2.14 compression (type3 keyword)
This attribute identifies compression algorithms used on compressed
document data. The value of this attribute does not apply to the
encoding of the IPP operation itself.
Standard values are :
'none': no compression is used.
'deflate': ZIP public domain inflate/deflate) compression
technology
`gzip' GNU zip compression technology described in RFC 1952.
'compress': UNIX compression technology
4.2.15 job-k-octets (integer(0:MAX))
This attribute specifies the total size of the document data in K
octets, i.e., in units of 1024 octets requested to be processed in
the job. The value SHALL be rounded up, so that a job between 1 and
1024 octets SHALL be indicated as being 1, 1025 to 2048 SHALL be 2,
etc.
This value SHALL not include the multiplicative factors contributed by
the number of copies specified by the "copies" attribute, independent
of whether the device can process multiple copies without making
multiple passes over the document data and independent of whether the
output is collated or not. Thus the value is independent of the
implementation.
This value SHALL also not include the multiplicative factor due to a
copies instruction embedded in the document data. If the document
data actually includes replications of the document data, this value
will include such replication. In other words, this value is always
the size of the source document data, rather than a measure of the
hardcopy output to be produced.
Note: This attribute and the following two attributes ("job-
impressions" and "job-media-sheets") are not intended to be counters;
they are intended to be useful routing and scheduling information if
known. For these three attributes, the Printer object may try to
compute the value if it is not supplied in the create request. Even
if the client does supply a value for these three attributes in the
create request, the Printer object MAY choose to change the value if
the Printer object is able to compute a value which is more accurate
than the client supplied value. The Printer object may be able to
determine the correct value for these three attributes either right at
job submission time or at any later point in time. If the value of
Expires May 7, 1998
this attribute is unknown at the moment, the Printer object MAY choose
to respond with a special value of 'unknown' rather than not return
the attribute at all.
4.2.16 job-impressions (integer(0:MAX))
This attribute specifies the total number of impressions of the
document(s) being requested by this job to produce.
This value SHALL not include the multiplicative factors contributed by
the number of copies specified by the "copies" attribute, independent
of whether the device can process multiple copies without making
multiple passes over the document data and independent of whether the
output is collated or not. Thus the value is independent of the
implementation.
As with "job-k-octets", this value SHALL also not include the
multiplicative factor due to a copies instruction embedded in the
document data. If the document data actually includes replications of
the document data, this value will include such replication. In other
words, this value is always the number of impressions in the source
document data, rather than a measure of the number of impressions to
be produced.
See the Note in the "job-k-octets" attribute that also applies to this
attribute.
4.2.17 job-media-sheets (integer(0:MAX))
This attribute specifies the total number of media sheets to be
processed for this job.
Unlike the "job-k-octets" and the "job-impressions" attributes, this
value SHALL include the multiplicative factors contributed by the
number of copies specified by the "copies" attribute and number of
copies instructions embedded in the document data, if any.
See the Note in the "job-k-octets" attribute that also applies to this
attribute.
4.3 Job Description Attributes 4.3 Job Description Attributes
The attributes in this section form the attribute group called "job- The attributes in this section form the attribute group called "job-
description". The following table summarizes these attributes. The description". The following table summarizes these attributes. The
third column indicates whether the attribute is a MANDATORY attribute third column indicates whether the attribute is a MANDATORY attribute
Expires May 7, 1998 Expires June 19, 1998
that MUST be supported by Printer objects. If it is not MANDATORY,
then it is OPTIONAL. that MUST be supported by Printer objects. If it is not indicated as
MANDATORY, then it is OPTIONAL. The maximum size in octets for 'text'
and 'name' attributes is indicated in parenthesizes.
Expires June 19, 1998
Expires May 7, 1998
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| Attribute | Syntax | MANDATORY? | | Attribute | Syntax | MANDATORY? |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-uri | uri | MANDATORY | | job-uri | uri | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-id | integer(1:MAX) | MANDATORY | | job-id | integer(1:MAX) | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-more-info | uri | | | job-more-info | uri | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-name | name | MANDATORY | | job-name | name (MAX) | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-originating-user-name | name | MANDATORY | | job-originating-user-name | name (MAX) | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-state | type1 enum | MANDATORY | | job-state | type1 enum | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-state-reasons | 1setOf type2 keyword | | | job-state-reasons | 1setOf type2 keyword | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-state-message | text | | | job-state-message | text (MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| number-of-documents | integer (0-MAX) | | | number-of-documents | integer (0-MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| containing-printer-uri | uri | MANDATORY | | containing-printer-uri | uri | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| output-device-assigned | name | | | output-device-assigned | name (127) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-at-creation | integer (0:MAX) | | | time-at-creation | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-at-processing | integer (0:MAX) | | | time-at-processing | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-at-completed | integer (0:MAX) | | | time-at-completed | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| number-of-intervening-jobs | integer (0:MAX) | | | number-of-intervening-jobs | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-message-from-operator | text | | | job-message-from-operator | text (127) | |
+----------------------------+----------------------+----------------+
| compression | type3 keyword | |
+----------------------------+----------------------+----------------+
| job-k-octets | integer (0:MAX) | |
+----------------------------+----------------------+----------------+
| job-impressions | integer (0:MAX) | |
+----------------------------+----------------------+----------------+
| job-media-sheets | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-k-octets-processed | integer (0:MAX) | | | job-k-octets-processed | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-impressions-completed | integer (0:MAX) | | | job-impressions-completed | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-media-sheets-completed | integer (0:MAX) | | | job-media-sheets-completed | integer (0:MAX) | |
Expires June 19, 1998
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| attributes-charset | charset | MANDATORY | | attributes-charset | charset | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| attributes-natural-language| naturalLanguage | MANDATORY | | attributes-natural-language| naturalLanguage | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
Expires May 7, 1998
4.3.1 job-uri (uri) 4.3.1 job-uri (uri)
This MANDATORY attribute contains the URI for the job. The Printer This MANDATORY attribute contains the URI for the job. The Printer
object, on receipt of a new job, generates a URI which identifies the object, on receipt of a new job, generates a URI which identifies the
new Job on that Printer object. The Printer object returns the value new Job on that Printer object. The Printer object returns the value
of the "job-uri" attribute as part of the response to a create of the "job-uri" attribute as part of the response to a create
request. This MUST be an HTTP schemed URI, however the precise request. The precise format of a Job URI is implementation dependent.
format of a Job URI is implementation dependent.
For a description of this attribute and its relationship to the For a description of this attribute and its relationship to the
following "job-id" attribute, see the discussion in section 2.4 on following "job-id" attribute, see the discussion in section 2.4 on
"Object Identity". "Object Identity".
4.3.2 job-id (integer(1:MAX)) 4.3.2 job-id (integer(1:MAX))
This MANDATORY attribute contains the ID of the job. The Printer, on This MANDATORY attribute contains the ID of the job. The Printer, on
receipt of a new job, generates an ID which identifies the new Job on receipt of a new job, generates an ID which identifies the new Job on
that Printer. The Printer returns the value of the "job-id" attribute that Printer. The Printer returns the value of the "job-id" attribute
skipping to change at page 73, line 37 skipping to change at page 79, line 43
For a description of this attribute and its relationship to the For a description of this attribute and its relationship to the
previous "job-uri" attribute, see the discussion in section 2.4 on previous "job-uri" attribute, see the discussion in section 2.4 on
"Object Identity". "Object Identity".
4.3.3 job-more-info (uri) 4.3.3 job-more-info (uri)
Similar to "printer-more-info", this attribute contains the URI Similar to "printer-more-info", this attribute contains the URI
referencing some resource with more information about this Job object, referencing some resource with more information about this Job object,
perhaps an HTML page containing information about the Job. perhaps an HTML page containing information about the Job.
4.3.4 job-name (name) 4.3.4 job-name (name(MAX))
This MANDATORY attribute is the name of the job. It is a name that is This MANDATORY attribute is the name of the job. It is a name that is
more user friendly than the "job-uri" attribute value. It does not more user friendly than the "job-uri" attribute value. It does not
need to be unique between Jobs. The Job's "job-name" attribute is set need to be unique between Jobs. The Job's "job-name" attribute is set
to the value supplied by the client in the "job-name" operation to the value supplied by the client in the "job-name" operation
attribute in the create request (see Section 3.2.1.1). If, however, attribute in the create request (see Section 3.2.1.1). If, however,
Expires June 19, 1998
the "job-name" operation attribute is not supplied by the client in the "job-name" operation attribute is not supplied by the client in
the create request, the Printer object, on creation of the Job, SHALL the create request, the Printer object, on creation of the Job, SHALL
generate a name. The printer SHOULD generate the value of the Job's generate a name. The printer SHOULD generate the value of the Job's
"job-name" attribute from the first of the following sources that "job-name" attribute from the first of the following sources that
produces a value: 1) the "document-name" operation attribute of the produces a value: 1) the "document-name" operation attribute of the
first (or only) document, 2) the "document-URI" attribute of the first first (or only) document, 2) the "document-URI" attribute of the first
Expires May 7, 1998
(or only) document, or 3) any other piece of Job specific and/or (or only) document, or 3) any other piece of Job specific and/or
Document Content information. Document Content information.
4.3.5 job-originating-user-name (name) 4.3.5 job-originating-user-name (name(MAX))
This MANDATORY attribute contains the name of the end user that This MANDATORY attribute contains the name of the end user that
submitted the print job. The Printer object sets this attribute to submitted the print job. The Printer object sets this attribute to
the most authenticated printable name that it can obtain from the the most authenticated printable name that it can obtain from the
authentication service over which the IPP operation was received. authentication service over which the IPP operation was received.
Only if such is not available, does the Printer object use the value Only if such is not available, does the Printer object use the value
supplied by the client in the "requesting-user-name" operation supplied by the client in the "requesting-user-name" operation
attribute of the create operation. See Section 3.1.5. attribute of the create operation (see Section 8).
Note: The Printer object needs to keep an internal originating user Note: The Printer object needs to keep an internal originating user
id of some form, typically as a credential of a principal, with the id of some form, typically as a credential of a principal, with the
Job object. Since such an internal attribute is implementation- Job object. Since such an internal attribute is implementation-
dependent and not of interest to clients, it is not specified as a Job dependent and not of interest to clients, it is not specified as a Job
Description attribute. This originating user id is used for Description attribute. This originating user id is used for
authorization checks (if any) on all subsequent operation. authorization checks (if any) on all subsequent operation.
4.3.6 job-state (type1 enum) 4.3.6 job-state (type1 enum)
skipping to change at page 74, line 46 skipping to change at page 81, line 4
Values Symbolic Name and Description Values Symbolic Name and Description
'3' 'pending': The job is a candidate to start processing, but '3' 'pending': The job is a candidate to start processing, but
is not yet processing. is not yet processing.
'4' 'pending-held': The job is not a candidate for processing '4' 'pending-held': The job is not a candidate for processing
for any number of reasons but will return to the for any number of reasons but will return to the
'pending' state as soon as the reasons are no longer 'pending' state as soon as the reasons are no longer
present. The job's "job-state-reason" attribute SHALL present. The job's "job-state-reason" attribute SHALL
Expires June 19, 1998
indicate why the job is no longer a candidate for indicate why the job is no longer a candidate for
processing. processing.
'5' 'processing': One or more of: '5' 'processing': One or more of: