draft-ietf-ipp-model-06.txt   draft-ietf-ipp-model-07.txt 
INTERNET-DRAFT INTERNET-DRAFT
draft-ietf-ipp-model-06.txt draft-ietf-ipp-model-07.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
October 14, 1997 November 7, 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.
Status of this Memo Status of this Memo
This document is an Internet-Draft. Internet-Drafts are working This document is an Internet-Draft. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas, documents of the Internet Engineering Task Force (IETF), its areas,
and its working groups. Note that other groups may also distribute and its working groups. Note that other groups may also distribute
working documents as Internet-Drafts. working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
skipping to change at page 1, line 42 skipping to change at page 1, line 43
"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).
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 technology. 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 is focused only end user and administrative features, IPP version 1.0 (IPP/1.0)
on end user functionality. focuses only on end user functionality.
Expires April 14, 1998 Expires May 7, 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 Internet Printing Protocol/1.0: Model and Semantics (this document)
Internet Printing Protocol/1.0: Protocol Specification [IPP-PRO] 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]
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 the out a subset of end user requirements that MUST be satisfied in
first version of IPP. Operator and administrator requirements are out IPP/1.0. Operator and administrator requirements are out of scope for
of scope for v1.0. This document, "Internet Printing Protocol/1.0: version 1.0. This document, ''Internet Printing Protocol/1.0: Model and
Model and Semantics", describes a simplified model with abstract Semantics'', describes a simplified model with abstract objects, their
objects, their attributes, and their operations. The model introduces attributes, and their operations. The model introduces a Printer and
a Printer object and a Job object. The Job object supports multiple a Job. The Job supports multiple documents per Job. The model
documents per job. The model document also addresses how security, document also addresses how security, internationalization, and
internationalization, and directory issues are addressed. The protocol directory issues are addressed. The protocol specification, ''
specification, " Internet Printing Protocol/1.0: Protocol Internet Printing Protocol/1.0: Protocol Specification'', is a formal
Specification", is a formal mapping of the abstract operations and mapping of the abstract operations and attributes defined in the model
attributes defined in the model document onto HTTP/1.1. The protocol document onto HTTP/1.1. The protocol specification defines the
specification defines the encoding rules for a new Internet media type encoding rules for a new Internet media type called ''application/ipp''.
called "application/ipp".
Expires April 14, 1998 Expires May 7, 1998
Table of Contents Table of Contents
1. Simplified Printing Model .......................................8 1. Simplified Printing Model ......................................8
2. IPP Objects ....................................................10 2. IPP Objects ...................................................10
2.1 Printer Object................................................10 2.1 Printer Object................................................11
2.2 Job Object....................................................13 2.2 Job Object....................................................12
2.3 Object Relationships..........................................14 2.3 Object Relationships..........................................13
2.4 Object Identity...............................................14 2.4 Object Identity...............................................14
3. IPP Operations .................................................15 3. IPP Operations ................................................15
3.1 General Semantics.............................................16 3.1 General Semantics.............................................16
3.1.1 Operation Characteristics................................16 3.1.1 Operation Characteristics................................16
3.1.2 Operation Targets........................................18 3.1.2 Operation Targets........................................18
3.1.3 Character Set and Natural Language Operation Attributes..19 3.1.3 Character Set and Natural Language Operation Attributes..19
3.1.3.1 Request Operation Attributes ..........................19 3.1.3.1 Request Operation Attributes ..........................19
3.1.3.2 Response Operation Attributes .........................20 3.1.3.2 Response Operation Attributes .........................22
3.1.4 Operation Status Codes and Messages......................21 3.1.4 Operation Status Codes and Messages......................23
3.1.5 Security Concerns for IPP Operations.....................22 3.1.5 Security Concerns for IPP Operations.....................23
3.1.5.1 Authenticated Requester Identity ......................22 3.1.5.1 Authenticated Requester Identity ......................23
3.1.5.2 Restricted Queries ....................................23 3.1.5.2 The "requesting-user-name" Operation Attribute ........24
3.1.6 Versions.................................................23 3.1.5.3 Restricted Queries ....................................25
3.1.7 Job Creation Operations..................................24 3.1.6 Versions.................................................25
3.2 Printer Operations............................................26 3.1.7 Job Creation Operations..................................26
3.2.1 Print-Job Operation......................................26 3.2 Printer Operations............................................28
3.2.1.1 Print-Job Request .....................................26 3.2.1 Print-Job Operation......................................29
3.2.1.2 Print-Job Response ....................................28 3.2.1.1 Print-Job Request .....................................29
3.2.2 Print-URI Operation......................................30 3.2.1.2 Print-Job Response ....................................31
3.2.3 Validate-Job Operation...................................31 3.2.2 Print-URI Operation......................................34
3.2.4 Create-Job Operation.....................................31 3.2.3 Validate-Job Operation...................................34
3.2.5 Get-Attributes Operation.................................31 3.2.4 Create-Job Operation.....................................35
3.2.5.1 Get-Attributes Request ................................32 3.2.5 Get-Attributes Operation (for Printer objects)...........35
3.2.5.2 Get-Attributes Response ...............................33 3.2.5.1 Get-Attributes Request ................................36
3.2.6 Get-Jobs Operation.......................................34 3.2.5.2 Get-Attributes Response ...............................37
3.2.6.1 Get-Jobs Request ......................................34 3.2.6 Get-Jobs Operation.......................................37
3.2.6.2 Get-Jobs Response .....................................35 3.2.6.1 Get-Jobs Request ......................................38
3.3 Job Operations................................................36 3.2.6.2 Get-Jobs Response .....................................39
3.3.1 Send-Document Operation..................................37 3.3 Job Operations................................................40
3.3.1.1 Send-Document Request .................................37 3.3.1 Send-Document Operation..................................41
3.3.1.2 Send-Document Response ................................39 3.3.1.1 Send-Document Request .................................42
3.3.2 Send-URI Operation.......................................39 3.3.1.2 Send-Document Response ................................43
3.3.3 Cancel Job Operation.....................................39 3.3.2 Send-URI Operation.......................................43
3.3.3.1 Cancel-Job Request ....................................40 3.3.3 Cancel Job Operation.....................................44
3.3.3.2 Cancel-Job Response ...................................40 3.3.3.1 Cancel-Job Request ....................................44
3.3.4 Get-Attributes Operation.................................41 3.3.3.2 Cancel-Job Response ...................................45
3.3.4.1 Get-Attributes Request ................................41 3.3.4 Get-Attributes Operation (for Job objects)...............45
3.3.4.2 Get-Attributes Response ...............................41 3.3.4.1 Get-Attributes Request ................................46
4. Object Attributes ..............................................42 3.3.4.2 Get-Attributes Response ...............................46
4.1 Attribute Syntaxes............................................42 4. Object Attributes .............................................47
4.1.1 'text'...................................................43 4.1 Attribute Syntaxes............................................47
Expires April 14, 1998 Expires May 7, 1998
4.1.2 'name'...................................................44 4.1.1 'text'...................................................48
4.1.3 'keyword'................................................44 4.1.2 'name'...................................................49
4.1.4 'enum'...................................................45 4.1.3 'keyword'................................................50
4.1.5 'uri'....................................................45 4.1.4 'enum'...................................................50
4.1.6 'uriScheme'..............................................45 4.1.5 'uri'....................................................51
4.1.7 'charSet'................................................46 4.1.6 'uriScheme'..............................................51
4.1.8 'naturalLanguage'........................................46 4.1.7 'charset'................................................52
4.1.9 'mimeType'...............................................47 4.1.8 'naturalLanguage'........................................52
4.1.10 'octetString'............................................48 4.1.9 'mimeMediaType'..........................................53
4.1.11 'boolean'................................................48 4.1.10 'octetString'............................................54
4.1.12 'integer'................................................48 4.1.11 'boolean'................................................54
4.1.13 'rangeOfInteger'.........................................48 4.1.12 'integer'................................................54
4.1.14 'dateTime'...............................................48 4.1.13 'rangeOfInteger'.........................................54
4.1.15 'resolution'.............................................48 4.1.14 'dateTime'...............................................55
4.1.16 '1setOf X'..............................................49 4.1.15 'resolution'.............................................55
4.2 Job Template Attributes.......................................49 4.1.16 '1setOf X'..............................................55
4.2.1 job-sheets (type4 keyword, name).........................53 4.2 Job Template Attributes.......................................56
4.2.2 job-priority (integer(1:100))............................54 4.2.1 job-priority (integer(1:100))............................59
4.2.3 job-hold-until (type4 keyword, name).....................55 4.2.2 job-hold-until (type4 keyword | name)....................60
4.2.4 multiple-document-handling (type2 keyword)...............56 4.2.3 job-sheets (type4 keyword | name)........................61
4.2.5 media (type4 keyword, name)..............................57 4.2.4 multiple-document-handling (type2 keyword)...............61
4.2.6 number-up (integer)......................................57 4.2.5 copies (integer(1:MAX))..................................63
4.2.7 sides (type2 keyword)....................................58 4.2.6 finishings (1setOf type2 enum)...........................63
4.2.8 printer-resolution (resolution)..........................59 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))..............64
4.2.9 print-quality (type2 enum)...............................59 4.2.8 sides (type2 keyword)....................................65
4.2.10 finishings (1setOf type2 enum)...........................59 4.2.9 number-up (integer(0:MAX))...............................66
4.2.11 copies (integer(1:2**31 - 1))............................60 4.2.10 orientation (type2 enum).................................67
4.2.12 page-ranges (1setOf rangeOfInteger)......................60 4.2.11 media (type4 keyword | name).............................67
4.2.13 orientation (type2 enum).................................61 4.2.12 printer-resolution (resolution)..........................68
4.2.14 document-format (mimeType)...............................61 4.2.13 print-quality (type2 enum)...............................68
4.2.15 compression (type3 keyword)..............................62 4.2.14 compression (type3 keyword)..............................69
4.2.16 job-k-octets (integer(0:2**31 - 1))......................62 4.2.15 job-k-octets (integer(0:MAX))............................69
4.2.17 job-impressions (integer(0:2**31 - 1))...................62 4.2.16 job-impressions (integer(0:MAX)).........................70
4.2.18 job-media-sheets (integer(0:2**31 - 1))..................63 4.2.17 job-media-sheets (integer(0:MAX))........................70
4.3 Job Description Attributes....................................63 4.3 Job Description Attributes....................................70
4.3.1 job-uri (uri)............................................64 4.3.1 job-uri (uri)............................................73
4.3.2 job-id (integer(1:MAX))..................................65 4.3.2 job-id (integer(1:MAX))..................................73
4.3.3 job-more-info (uri)......................................65 4.3.3 job-more-info (uri)......................................73
4.3.4 job-name (name)..........................................65 4.3.4 job-name (name)..........................................73
4.3.5 job-originating-user (octetString).......................65 4.3.5 job-originating-user-name (name).........................74
4.3.6 job-state (type1 enum)...................................66 4.3.6 job-state (type1 enum)...................................74
4.3.7 job-state-reasons (1setOf type2 keyword)................68 4.3.7 job-state-reasons (1setOf type2 keyword)................77
4.3.8 job-state-message (text).................................70 4.3.8 job-state-message (text).................................79
4.3.9 number-of-documents (integer(0:2**31 - 1))...............70 4.3.9 number-of-documents (integer(0:MAX)).....................80
4.3.10 output-device-assigned (name)............................71 4.3.10 containing-printer-uri (uri).............................80
4.3.11 time-of-creation (integer)...............................71 4.3.11 output-device-assigned (name)............................80
4.3.12 time-at-processing (integer).............................71 4.3.12 time-at-creation (integer(0:MAX))........................80
4.3.13 time-at-completed (integer)..............................71 4.3.13 time-at-processing (integer(0:MAX))......................80
Expires April 14, 1998 Expires May 7, 1998
4.3.14 number-of-intervening-jobs (integer(0:2**31 - 1))........71 4.3.14 time-at-completed (integer(0:MAX)).......................81
4.3.15 job-message-from-operator (text).........................71 4.3.15 number-of-intervening-jobs (integer(0:MAX))..............81
4.3.16 job-k-octets-processed (integer(0:2**31 - 1))............72 4.3.16 job-message-from-operator (text).........................81
4.3.17 job-impressions-completed (integer(0:2**31 - 1))........72 4.3.17 job-k-octets-processed (integer(0:MAX))..................81
4.3.18 job-media-sheets-completed (integer(0:2**31 - 1))........72 4.3.18 job-impressions-completed (integer(0:MAX))..............82
4.3.19 attributes-charset (charSet).............................72 4.3.19 job-media-sheets-completed (integer(0:MAX))..............82
4.3.20 attributes-natural-language (naturalLanguage)............73 4.3.20 attributes-charset (charset).............................82
4.4 Printer Description Attributes................................73 4.3.21 attributes-natural-language (naturalLanguage)............83
4.4.1 printer-uri (uri)........................................75 4.4 Printer Description Attributes................................83
4.4.2 printer-name (name)......................................75 4.4.1 printer-uri (uri)........................................85
4.4.3 printer-location (text)..................................75 4.4.2 printer-name (name)......................................85
4.4.4 printer-info (text)......................................75 4.4.3 printer-location (text)..................................85
4.4.5 printer-more-info (uri)..................................75 4.4.4 printer-info (text)......................................85
4.4.6 printer-driver-installer (uri)...........................76 4.4.5 printer-more-info (uri)..................................86
4.4.7 printer-make-and-model (text)............................76 4.4.6 printer-driver-installer (uri)...........................86
4.4.8 printer-more-info-manufacturer (uri).....................76 4.4.7 printer-make-and-model (text)............................86
4.4.9 printer-state (type1 enum)...............................76 4.4.8 printer-more-info-manufacturer (uri).....................86
4.4.10 printer-state-reasons (1setOf type2 keyword).............77 4.4.9 printer-state (type1 enum)...............................86
4.4.11 printer-state-message (text).............................80 4.4.10 printer-state-reasons (1setOf type2 keyword).............88
4.4.12 operations-supported (1setOf operation)..................80 4.4.11 printer-state-message (text).............................90
4.4.13 printer-charset (charSet)................................81 4.4.12 operations-supported (1setOf type2 enum).................90
4.4.14 charsets-supported (1setOf charSet)......................81 4.4.13 charset (charset)........................................91
4.4.15 printer-natural-language (naturalLanguage)...............81 4.4.14 charset-supported (1setOf charset).......................91
4.4.16 natural-languages-supported (1setOf naturalLanguage).....81 4.4.15 natural-language (naturalLanguage).......................92
4.4.17 printer-is-accepting-jobs (boolean)......................82 4.4.16 natural-language-supported (1setOf naturalLanguage)......92
4.4.18 queued-job-count (integer(0:2**31 - 1))..................82 4.4.17 document-format (mimeMediaType)..........................93
4.4.19 printer-message-from-operator (text).....................82 4.4.18 document format-supported (1setOf mimeMediaType).........93
4.4.20 color-supported (boolean)................................82 4.4.19 printer-is-accepting-jobs (boolean)......................93
4.4.21 reference-uri-schemes-supported (1setOf uriScheme).......83 4.4.20 queued-job-count (integer(0:MAX))........................93
4.4.22 pdl-override (type2 keyword).............................83 4.4.21 printer-message-from-operator (text).....................93
4.4.23 security-mechanisms-supported (1setOf keyword)...........83 4.4.22 color-supported (boolean)................................94
4.4.24 printer-up-time (integer(1:MAX)).........................84 4.4.23 reference-uri-schemes-supported (1setOf uriScheme).......94
4.4.25 printer-current-time (dateTime)..........................84 4.4.24 pdl-override (type2 keyword).............................94
4.4.26 multiple-operation-time-out (integer)....................84 4.4.25 printer-up-time (integer(1:MAX)).........................95
5. Conformance ....................................................84 4.4.26 printer-current-time (dateTime)..........................95
5.1 Client Conformance Requirements...............................85 4.4.27 multiple-operation-time-out (integer(1:MAX)).............95
5.2 Printer Object Conformance Requirements.......................85 5. Conformance ...................................................96
5.2.1 Objects..................................................86 5.1 Client Conformance Requirements...............................96
5.2.2 Operations...............................................86 5.2 IPP Object Conformance Requirements...........................97
5.2.3 Attributes...............................................86 5.2.1 Objects..................................................97
5.2.4 Printer extensions.......................................87 5.2.2 Operations...............................................97
5.2.5 Attribute Syntaxes.......................................87 5.2.3 IPP Object Attributes....................................97
5.3 Security Conformance Requirements.............................87 5.2.4 Extensions...............................................98
6. IANA Considerations (registered and private extensions) ........87 5.2.5 Attribute Syntaxes.......................................98
6.1 Typed Extensions..............................................88 5.3 charset and Natural Language Requirements.....................98
6.2 Registration of MIME types/sub-types for document-formats.....89 5.4 Security Conformance Requirements.............................99
6.3 Attribute Extensibility.......................................89 6. IANA Considerations (registered and private extensions) .......99
6.4 Attribute Syntax Extensibility................................89 6.1 Typed Extensions..............................................99
Expires April 14, 1998 Expires May 7, 1998
7. Internationalization Considerations ............................89 6.2 Registration of MIME types/sub-types for document-formats....101
8. Security Considerations ........................................91 6.3 Attribute Extensibility......................................101
8.1 Client and Printer in the Same Security Domain................92 6.4 Attribute Syntax Extensibility...............................101
8.2 Client and Printer in Different Security Domains..............92 7. Internationalization Considerations ..........................101
8.3 Print by Reference............................................93 8. Security Considerations ......................................102
8.3.1 Unprotected Documents....................................93 8.1 Client and Printer in the Same Security Domain...............104
8.3.2 Protected Documents......................................93 8.2 Client and Printer in Different Security Domains.............104
8.4 Common Security Scenarios.....................................93 8.3 Print by Reference...........................................104
8.4.1 No Security..............................................93 8.3.1 Unprotected Documents...................................104
8.4.2 Message Protection During Transmission...................94 8.3.2 Protected Documents.....................................105
8.4.3 Client Authentication and Authorization..................94 8.4 Common Security Scenarios....................................105
8.4.4 Mutual Authentication, Authorization and Message Protection 8.4.1 No Security.............................................105
94 8.4.2 Message Protection During Transmission..................105
8.5 Recommended Security Mechanisms...............................94 8.4.3 Client Authentication and Authorization.................106
9. References .....................................................95 8.4.4 Mutual Authentication, Authorization and Message
10.Copyright Notice ...............................................99 Protection.........................................106
11.Author's Address ...............................................99 8.5 Recommended Security Mechanisms..............................106
12.APPENDIX A: Terminology .......................................102 9. References ...................................................107
12.1 Conformance Terminology......................................102 10. Copyright Notice .............................................110
12.1.1 MUST....................................................102 11. Author's Address .............................................110
12.1.2 MUST NOT................................................102 12. APPENDIX A: Terminology ......................................113
12.1.3 SHOULD..................................................102 12.1 Conformance Terminology......................................113
12.1.4 SHOULD NOT..............................................102 12.1.1 MUST....................................................113
12.1.5 MAY.....................................................102 12.1.2 MUST NOT................................................113
12.1.6 NEED NOT................................................103 12.1.3 SHOULD..................................................113
12.2 Model Terminology............................................103 12.1.4 SHOULD NOT..............................................113
12.2.1 Keyword.................................................103 12.1.5 MAY.....................................................114
12.2.2 Attributes..............................................103 12.1.6 NEED NOT................................................114
12.2.2.1 Attribute Name .......................................103 12.2 Model Terminology............................................114
12.2.2.2 Attribute Group Name .................................104 12.2.1 Keyword.................................................114
12.2.2.3 Attribute Value ......................................104 12.2.2 Attributes..............................................114
12.2.2.4 Attribute Syntax .....................................104 12.2.2.1 Attribute Name .......................................115
12.2.3 Supports................................................104 12.2.2.2 Attribute Group Name .................................115
12.2.4 print-stream page.......................................106 12.2.2.3 Attribute Value ......................................115
12.2.5 imposed page............................................106 12.2.2.4 Attribute Syntax .....................................115
13.APPENDIX B: Status Codes .....................................106 12.2.3 Supports................................................115
13.1 Status Codes.................................................107 12.2.4 print-stream page.......................................117
13.1.1 Informational...........................................107 12.2.5 impression..............................................118
13.1.2 Successful Status Codes.................................107 13. APPENDIX B: Status Codes and Suggested Status Code Messages .118
13.1.2.1 successful-ok (0x0000) ...............................107 13.1 Status Codes.................................................119
13.1.2.2 successful-ok-ignored-or-substituted-attributes (0x0001) 13.1.1 Informational...........................................119
108 13.1.2 Successful Status Codes.................................119
13.1.3 Redirection Status Codes................................108 13.1.2.1 successful-ok (0x0000) ...............................119
13.1.4 Client Error Status Codes...............................108 13.1.2.2 successful-ok-ignored-or-substituted-
13.1.4.1 client-error-bad-request (0x0400) ....................108 attributes (0x0001) .............................120
13.1.4.2 client-error-forbidden (0x0401) ......................108 13.1.2.3 successful-ok-conflicting-attributes (0x0002) ........120
13.1.4.3 client-error-not-authenticated (0x0402) ..............108 13.1.3 Redirection Status Codes................................120
13.1.4.4 client-error-not-authorized (0x0403) .................109 13.1.4 Client Error Status Codes...............................120
Expires April 14, 1998 Expires May 7, 1998
13.1.4.5 client-error-not-possible (0x0404) ...................109 13.1.4.1 client-error-bad-request (0x0400) ....................120
13.1.4.6 client-error-timeout (0x0405) ........................109 13.1.4.2 client-error-forbidden (0x0401) ......................120
13.1.4.7 client-error-not-found (0x0406) ......................109 13.1.4.3 client-error-not-authenticated (0x0402) ..............121
13.1.4.8 client-error-gone (0x0407) ...........................110 13.1.4.4 client-error-not-authorized (0x0403) .................121
13.1.4.9 client-error-request-entity-too-large (0x0408) .......110 13.1.4.5 client-error-not-possible (0x0404) ...................121
13.1.4.10 client-error-request-URI-too-long (0x0409) ...........110 13.1.4.6 client-error-timeout (0x0405) ........................121
13.1.4.11 client-error-unsupported-document-format (0x040A) ....110 13.1.4.7 client-error-not-found (0x0406) ......................122
13.1.4.12 client-error-attribute-not-supported (0x040B) ........111 13.1.4.8 client-error-gone (0x0407) ...........................122
13.1.4.13 client-error-uri-scheme-not-supported (0x040C) .......111 13.1.4.9 client-error-request-entity-too-large (0x0408) .......122
13.1.4.14 client-error-charset-not-supported (0x040D) ..........111 13.1.4.10 client-error-request-uri-too-long (0x0409) ...........123
13.1.4.15 client-error-natural-language-not-supported (0x040E) .111 13.1.4.11 client-error-document-format-not-supported (0x040A) ..123
13.1.5 Server Error Status Codes...............................111 13.1.4.12 client-error-attribute-not-supported (0x040B) ........123
13.1.5.1 server-error-internal- error (0x0500) ................112 13.1.4.13 client-error-uri-scheme-not-supported (0x040C) .......124
13.1.5.2 server-error-operation-not-supported (0x0501) ........112 13.1.4.14 client-error-charset-not-supported (0x040D) ..........124
13.1.5.3 server-error-service-unavailable (0x0502) ............112 13.1.4.15 client-error-conflicting-attributes (0x040E) .........124
13.1.5.4 server-error-version-not-supported (0x0503) ..........112 13.1.5 Server Error Status Codes...............................124
13.1.5.5 server-error-device-error (0x0504) ...................112 13.1.5.1 server-error-internal-error (0x0500) .................124
13.1.5.6 server-error-temporary-error (0x0505) ................113 13.1.5.2 server-error-operation-not-supported (0x0501) ........124
13.2 Status Codes for IPP Operations..............................114 13.1.5.3 server-error-service-unavailable (0x0502) ............125
14.APPENDIX C: "media" keyword values ...........................114 13.1.5.4 server-error-version-not-supported (0x0503) ..........125
15.APPENDIX D: Processing IPP Attributes .........................119 13.1.5.5 server-error-device-error (0x0504) ...................125
15.1 Fidelity.....................................................119 13.1.5.6 server-error-temporary-error (0x0505) ................126
15.2 Page Description Language (PDL) Override.....................121 13.2 Status Codes for IPP Operations..............................127
15.3 Suggested Operation Processing Algorithm.....................122 14. APPENDIX C: "media" keyword values ..........................127
15.4 Using Job Template Attributes During Document Processing.....126 15. APPENDIX D: Processing IPP Attributes ........................132
16.APPENDIX E: Generic Directory Schema ..........................127 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 April 14, 1998 Expires May 7, 1998
1. Simplified Printing Model 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, environment where requesters of print services (clients, applications,
applications, printer drivers, etc.) cooperate and interact with print printer drivers, etc.) cooperate and interact with print service
service providers. This model and semantics document describes a providers. This model and semantics document describes a simple,
simple, abstract model for IPP even though the underlying abstract model for IPP even though the underlying configurations may
configurations may be complex "n-tier" client/server systems. An be complex "n-tier" client/server systems. An important simplifying
important simplifying step in the IPP model is to expose only the key step in the IPP model is to expose only the key objects and interfaces
objects and interfaces required for printing. The model does not required for printing. The model described in this model document
include features, interfaces, and relationships that are beyond the does not include features, interfaces, and relationships that are
scope of IPP/1.0. IPP incorporates many of the relevant ideas and beyond the scope of the first version of IPP (IPP/1.0). IPP/1.0
lessons learned from other specification and development efforts incorporates many of the relevant ideas and lessons learned from other
[HTPP] [LDPA] [P1387.4] [PSIS] [RFC1179] [SWP]. specification and development efforts [HTPP] [ISO10175] [LDPA]
[P1387.4] [PSIS] [RFC1179] [SWP].
The IPP 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
(section 12). In the remainder of this document, terms such as section 12. In the remainder of this document, terms such as
"attributes", "keywords", and "supports" have special meaning and are "attributes", "keywords", and "support" have special meaning and are
defined in the model terminology section. Capitalized terms such as defined in the model terminology section. Capitalized terms such as
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 model), there implementations (which lie underneath the abstracted IPP/1.0 model),
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 model. The following figure illustrates where IPP defined in the IPP/1.0 model. The following figure illustrates where
fits with respect to these other components. IPP/1.0 fits with respect to these other components.
Expires April 14, 1998 Expires May 7, 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 9, line 36 skipping to change at page 9, line 36
I +--------+--------+ | I +--------+--------+ |
O | | O | |
N +-----------------+ | IPP Printer N +-----------------+ | IPP Printer
| Print Service | | | Print Service | |
+-----------------+ | +-----------------+ |
| --+ | --+
+-----------------+ +-----------------+
| Output Device(s)| | Output Device(s)|
+-----------------+ +-----------------+
An IPP Printer encapsulates the functions normally associated with An IPP Printer object encapsulates the functions normally associated
physical output devices along with the spooling, scheduling and with physical output devices along with the spooling, scheduling and
multiple device management functions often associated with a print multiple device management functions often associated with a print
server. IPP Printers are optionally registered as entries in a server. Printer objects are optionally registered as entries in a
directory where end users find and select them based on some sort of directory where end users find and select them based on some sort of
filtered and context based searching mechanism. The directory is used filtered and context based searching mechanism (see section 16). The
to store relatively static information about the Printer, allowing end directory is used to store relatively static information about the
users to search for and find Printers that match their search Printer, allowing end users to search for and find Printers that match
criteria, for example: name, context, printer capabilities, etc. (see their search criteria, for example: name, context, printer
section 16). The more dynamic information is directly associated with capabilities, etc.. The more dynamic information is directly
the IPP Printer itself. This information includes state, currently associated with the Printer object itself (as compared to the entry in
loaded and ready media, number of jobs at the Printer, errors, the directory which only represents the Printer object). This more
warnings, and so forth. dynamic information includes state, currently loaded and ready media,
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) the ability to query an IPP Printer and submit end users (or programs running on behalf of end users) the ability to
and manage print jobs. An IPP server is just that part of the IPP
Expires April 14, 1998 Expires May 7, 1998
Printer that implements the server-side protocol. The rest of the IPP query Printer objects and submit and manage print jobs. An IPP server
Printer implements the application semantics of the print service is just that part of the Printer object that implements the server-
itself. The IPP Printer may be embedded in an output device or may be side protocol. The rest of the Printer object implements (or gateways
into) the application semantics of the print service itself. The
Printer objects may be embedded in an output device or may be
implemented on a host on the network that communicates with 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 print job by using the Job object's Cancel- End users may also cancel the print job by using the Job object's
Job operation. The end user is able to register to receive certain Cancel-Job operation. The notification service(s) are out of scope
events that are then routed using the specified notification for IPP/1.0, but using such a notification service, the end user is
service(s). able to register for and receive Printer specific and Job specific
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
and Get-Jobs operations.
2. IPP Objects 2. IPP Objects
The IPP model introduces objects of type Printer and Job. Each type The IPP/1.0 model introduces objects of type Printer and Job. Each
of object models relevant aspects of a real-world entity such as a type of object models relevant aspects of a real-world entity such as
real printer or print job. Each object type is defined as a set of a real printer or real print job. Each object type is defined as a
possible attributes that may be supported by instances of that object set of possible attributes that may be supported by instances of that
type. For each object, the actual set of supported attributes and object type. For each object (instance), the actual set of supported
values describe a specific implementation. The object's attributes attributes and values describe a specific implementation. The
and values describe its state, capabilities, realizable features, job object's attributes and values describe its state, capabilities,
processing functions, and default behaviors and characteristics. For realizable features, job processing functions, and default behaviors
example, the object type Printer is defined as a set of attributes and characteristics. For example, the Printer object type is defined
that each Printer object potentially supports. In the same manner, as a set of attributes that each Printer object potentially supports.
the object type Job is defined as a set of attributes that are In the same manner, the Job object type is defined as a set of
potentially supported by each Job object. attributes that are potentially supported by each Job object.
Each attribute included in the set of attributes defining an object Each attribute included in the set of attributes defining an object
type is labeled as: type is labeled as:
- "MANDATORY": each object SHALL support the attribute. - "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
2.1 Printer Object 2.1 Printer Object
A major component of the IPP model is the Printer object (also called A major component of the IPP/1.0 model is the Printer object. A
the IPP Printer). A Printer object implements the IPP protocol. Printer object implements the IPP/1.0 protocol. Using the protocol,
Using the protocol, end users may query the attributes of the Printer end users may query the attributes of the Printer object and submit
and submit Jobs to the Printer. The actual implementation components print jobs to the Printer object. The actual implementation
components behind the Printer abstraction may take on different forms
Expires April 14, 1998 and different configurations. However, the model abstraction allows
behind the Printer abstraction may take on different forms and the details of the configuration of real components to remain opaque
different configurations. However, the model abstraction allows the to the end user. Section 3 describes each of the Printer operations
details of the configuration of real components to remain opaque to in detail.
the end user. Section 3 describes each of the Printer operations in
detail.
The capabilities and state of a Printer object are described by its The capabilities and state of a Printer object are described by its
attributes. Printer attributes are grouped into two groups: attributes. Printer attributes are divided into two groups:
- "job-template" attributes: These attributes the describe job - "job-template" attributes: These attributes describe supported
processing capabilities and defaults for the Printer object. (See job processing capabilities and defaults for the Printer object.
section 4.2) (See section 4.2)
- "printer-description" attributes: These attributes describe the - "printer-description" attributes: These attributes describe the
Printer object's identification, state, location, references to Printer object's identification, state, location, references to
other sources of information about the Printer object, etc. (see other sources of information about the Printer object, etc. (see
section 4.4) section 4.4)
Since a Printer object is an abstraction of a generic document output Since a Printer object is an abstraction of a generic document output
device and print service provider, a Printer object could be used to device and print service provider, a Printer object could be used to
represent any real or virtual device with semantics consistent with represent any real or virtual device with semantics consistent with
the Printer object, such as a fax device, an imager, or even a CD the Printer object, such as a fax device, an imager, or even a CD
writer. writer.
Some examples of configurations supporting a Printer object include: Some examples of configurations supporting a Printer object include:
1) An output device, with no spooling capabilities 1) An output device, with no spooling capabilities
2) An output device, with a built-in spooler 2) An output device, with a built-in spooler
skipping to change at page 12, line 5 skipping to change at page 12, 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 April 14, 1998 Expires May 7, 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 implementation hosted in a server. The Printer object
might or might not be capable of queuing/spooling. might or might not be capable of queuing/spooling.
any indicates any network protocol or direct any indicates any network protocol or direct
connect, including IPP connect, including IPP
embedded printer: embedded printer:
output device output device
+---------------+ +---------------+
O +--------+ | ########### | O +--------+ | ########### |
/|\ | client |------------IPP------------># Printer # | /|\ | client |------------IPP------------># Printer # |
skipping to change at page 12, line 44 skipping to change at page 12, line 44
+-->| output device | +-->| output device |
any/ | | any/ | |
O +--------+ ########### / +---------------+ O +--------+ ########### / +---------------+
/|\ | client |-IPP-># Printer #--* /|\ | client |-IPP-># Printer #--*
/ \ +--------+ # Object # \ +---------------+ / \ +--------+ # Object # \ +---------------+
########### any\ | | ########### any\ | |
+-->| output device | +-->| output device |
| | | |
+---------------+ +---------------+
A Printer object is identified with a Uniform Resource Identifier
(URI) [RFC1630]. Often, the URI is a Uniform Resource Locator (URL)
[RFC1738] [RFC1808]..
Expires April 14, 1998
Note: The IPP protocol specification [IPP-PRO] defines a mapping of
IPP onto HTTP/1.1. Therefore, all conforming Printer 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 does not specify how the URI is obtained, but it is RECOMMENDED
that a Printer object is registered in a directory service which end
users and programs can interrogate. Section 16 defines a generic
schema for Printer object entries in the directory service.
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
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
defaults and/or instructions embedded within the document data. defaults and/or instructions embedded within the document data.
(See section 4.2) (See section 4.2)
- "job-description" attributes: These attributes describe the Job - "job-description" attributes: These attributes describe the Job
object's identification, state, size, etc. The client does not object's identification, state, size, etc. Except for "job-name",
supply values for these attributes, they are set by the Printer the client does not supply values for these attributes, they are
object. (See section 4.3) set by the Printer object. (See section 4.3)
A Job object contains at least one document, but may contain multiple A Job object contains at least one document, but may contain multiple
documents. A document consists of either: documents. A document consists of either:
- a stream of data in a format supported by the Printer object, or - a stream of document data in a format supported by the Printer
- a URI reference to a stream of data in a format supported by the object (typically a Page Description Language - PDL), or
Printer - a reference to such a stream of document data
A document is not modeled as an IPP object, therefore it has no object In IPP/1.0, a document is not modeled as an IPP object, therefore it
identifier or associated attributes. All job processing instructions has no object identifier or associated attributes. All job processing
are modeled as Job object attributes. These attributes are called Job instructions are modeled as Job object attributes. These attributes
Template attributes and they apply equally to all documents within a are called Job Template attributes and they apply equally to all
Job. documents within a Job object.
Expires April 14, 1998
2.3 Object Relationships 2.3 Object Relationships
IPP objects have relationships that MUST be maintained persistently IPP objects have relationships that MUST be maintained persistently
along with the persistent storage of the object attributes. A Printer along with the persistent storage of the object attributes.
object may represent one or more output devices. A Printer object may
represent a logical device which "processes" jobs but never actually A Printer object MAY represent one or more output devices. A Printer
uses a physical output device to put marks on paper (for example a Web object MAY represent a logical device which "processes" jobs but never
page publisher or an interface into an online document archive or actually uses a physical output device to put marks on paper (for
repository). A Printer object contains zero or more Job objects. A example a Web page publisher or an interface into an online document
Job object is contained by exactly one Printer object, however the archive or repository). A Printer object contains zero or more Job
objects.
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
existing Job object, however it would have a new (different) Job
object identifier. A Job object contains one or more documents. If Expires May 7, 1998
the contained document is a stream of printer-ready data, that stream existing Job object, however it would have new (different) Job object
can be contained in only one document. However, there can be copies identifiers (see section 2.4).
of the stream in other documents in the same or different Job objects.
If the contained document is a reference to a stream of printer-ready A Job object contains one or more documents. If the contained
data, other documents (in the same or different Job object(s)) may document is a stream of document data, that stream can be contained in
reference the same stream. only one document. However, there can be copies of the stream in
other documents in the same or different Job objects. If the
contained document is a reference to a stream of document data, other
documents (in the same or different Job object(s)) may reference the
same stream.
2.4 Object Identity 2.4 Object Identity
All Printer and Job objects have an identifier so that they can be All Printer and Job objects be identified by an identifier so that
persistently and unambiguously referenced. The IPP model requires they can be persistently and unambiguously referenced. The IPP/1.0
that these identifiers be URIs. Often, the URI is a URL [RFC1738] model requires that these identifiers be Uniform Resource Identifiers
[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
RECOMMENDED that a Printer object is registered in a directory service
which end users and programs can interrogate. Section 16 defines a
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. In of the Printer's URI and some unique component for the Job object,
other implementations, the Printer object might be a central clearing- such as the unique 32-bit positive integer mentioned later in this
house for validating all Job object creation requests, and the Job paragraph. In other implementations, the Printer object might be a
object itself might be created in some environment that is remote from central clearing-house for validating all Job object creation
the Printer object. In this case, the Job object's URI may have no requests, and the Job object itself might be created in some
relationship at all to the Printer object's URI. 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
However, many existing printing systems have local models or interface object's URI. However, many existing printing systems have local
constraints that force Job objects to be identified using only a 32- models or interface constraints that force Job objects to be
bit positive integer rather than a URI. This numeric Job ID is only identified using only a 32-bit positive integer rather than a URI.
unique within the context of the Printer object to which the create This numeric Job ID is only unique within the context of the Printer
request was originally submitted. In order to allow both types of object to which the create request was originally submitted. In order
client access to Jobs (either Job URI or numeric Job ID), when the to allow both types of client access to Jobs (either by Job URI or by
Printer object successfully processes a create request and creates a
Expires April 14, 1998 Expires May 7, 1998
new Job, the Printer object SHALL generate both a Job URI and a Job ID numeric Job ID), when the Printer object successfully processes a
for the new Job object. This requirement allows all clients to access create request and creates a new Job, the Printer object SHALL
Printer objects and Job objects no matter the local constraints generate both a Job URI and a Job ID for the new Job object. This
imposed on the client implementation. requirement allows all clients to access Printer objects and Job
objects no matter the local constraints imposed on the client
implementation.
In addition to a unique identifier, Printer objects and Job objects In addition to a unique identifier, Printer objects and Job objects
may have names. An object name need not be unique across all have names. An object name need not be unique across all instances of
instances of all objects. A Printer object's name is chosen and set by all objects. A Printer object's name is chosen and set by an
an administrator through some mechanism outside the scope of IPP. 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, and it 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. number) that is unique within the context of that Printer object.
The Printer object's "printer-uri" contains the Printer URI. The The Printer object's "printer-uri" contains the Printer URI. The
Job object's "job-id" attribute contains the numeric Job ID. 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 itself. The Printer object's mechanism outside the scope of IPP/1.0 itself. The Printer
"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 have associated operations. An operation consists of a IPP objects support operations. An operation consists of a request
request and a response. When a client communicates with an IPP and a response. When a client communicates with an IPP object, the
object, it 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
to object attributes such as Printer attributes or Job attributes).
Each request carries along with it any operation attributes and/or
document data required by the object to perform the operation. Each
Expires April 14, 1998 Expires May 7, 1998
request requires a response from the object. Each response indicates to object attributes such as Printer object attributes or Job object
success or failure of the operation with a status code. The response attributes). Each request carries along with it any operation
contains any operation attributes, object attributes, and/or status attributes, object attributes, and/or document data required by the
messages generated by the execution of the operation request. object to perform the operation. Each request requires a response
from the object. Each response indicates success or failure of the
operation with a status code. The response contains any operation
attributes, object attributes, and/or status messages generated by the
execution of the operation request.
This section describes the semantics of the IPP operations, both This section describes the semantics of the IPP operations, both
requests and responses, in terms of the attributes and other data requests and responses, in terms of the attributes and other data
associated with each operation. associated with each operation.
Note: The IPP protocol specification [IPP-PRO] describes a mapping and Note: The IPP/1.0 protocol specification [IPP-PRO] describes a mapping
encoding of IPP operations onto HTTP/1.1 POST commands. Other and encoding of IPP/1.0 operations onto HTTP/1.1 POST commands. Other
mappings for IPP operations to additional transport mechanisms are mappings for IPP/1.0 operations to additional transport mechanisms are
possible. possible.
The 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-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:
skipping to change at page 16, line 46 skipping to change at page 16, line 50
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 General Semantics
3.1.1 Operation Characteristics 3.1.1 Operation Characteristics
Each IPP operation is defined as both a request and a response. Both Each IPP operation is defined as both a request and a response. Both
requests and responses are composed of groups of attributes and/or requests and responses are composed of groups of attributes and/or
document data. Attributes are grouped into the following groups: document data. The attributes groups are:
- Operation Attributes: These are attributes that are only passed
in the operation itself, and usually do not persist beyond the
life of the operation. Operation attributes may also affect
other attributes or groups of attributes since values in the
operation attributes usually affect the behavior of the object
Expires April 14, 1998 Expires May 7, 1998
that processes the operation. All IPP objects that accept IPP - Operation Attributes: These attributes are passed in the
operation request MUST support all operation attributes. Some operation, and usually do not persist beyond the life of the
operation attributes are OPTIONAL for the client to supply, but operation. Operation attributes may also affect other attributes
the IPP object MUST support the attribute by being prepare to or groups of attributes since values in the operation attributes
handle the client supplied operation attribute by realizing the usually affect the behavior of the object that processes the
corresponding feature or function. operation. All IPP objects that accept IPP operation requests
MUST support all operation attributes. Some operation attributes
are OPTIONAL for the client to supply, but the IPP object MUST
support the attribute by being prepared to handle the client
supplied operation attribute by realizing the corresponding
feature or function. The addition of new operation attributes
(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. They are OPTIONALLY supplied by a client in a create of a job. A client OPTIONALLY supplies Job Template Attributes
request, and the receiving object MUST be prepared to received in a create request, and the receiving object MUST be prepared to
all supported attributes. The Job object can later be queried to receive all supported attributes. The Job object can later be
find out what was originally requested in the create request. queried to find out what Job Template attributes were originally
The Printer object can be queried to find out what type of job requested in the create request, and such attributes are returned
processing capabilities are supported and/or what the default job in the response as Job Object Attributes. The Printer object can
processing behaviors are. be queried about its Job Template attributes to find out what
type of job processing capabilities are supported and/or what the
default job processing behaviors are, though such attributes are
returned in the response as Printer Object Attributes..
- Job Object Attributes: These attributes are returned in response - Job Object Attributes: These attributes are returned in response
to query operation directed at a Job object. to a query operation directed at a Job object.
- Printer Object Attributes: These attributes are returned in - Printer Object Attributes: These attributes are returned in
response to a query operation directed at a Printer object. response to a query operation directed at a Printer object.
- Unsupported Attributes: In a create request, the client supplies - Unsupported Attributes: In a create request, the client
an optional set of Job Template attributes. If any of these are OPTIONALLY supplies a set of Job Template attributes. If any of
unsupported by the Printer object, the Printer object returns these are unsupported by the Printer object, the Printer object
them in the response. Section 15 gives a full description of how returns the set of unsupported attributes in the response.
Job Template attributes supplied by the client in a create Section 15 gives a full description of how Job Template
request are processed by the Printer object and how unsupported attributes supplied by the client in a create request are
attributes are returned to the client. processed by the Printer object and how unsupported attributes
are returned to the client.
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 request identifying the allowed and expected groups of attributes for each
and response. The model identifies a specific order for each group in request and response. The model identifies a specific order for each
each request or response, but the attributes within each group may be group in each request or response, but the attributes within each
in any order. group may be in any order. 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
Expires May 7, 1998
syntax(es) defined for that attribute (see section 3 for operation
attributes and section 4 for IPP object attributes).
Note: Document data included in the operation is not strictly an Note: Document data included in the operation is not strictly an
attribute, but it is treated as a special attribute group for ordering attribute, but it is treated as a special attribute group for ordering
purposes. The only operations that support supplying the document purposes. The only operations that support supplying the document
data within an operation request are Print-Job and Send-Document. data within an operation request are Print-Job and Send-Document.
There are no operations responses that include document data. There are no operation responses that include document data.
Since some operations are MANDATORY and some are OPTIONAL, a client Note: Some operations are MANDATORY for IPP objects to support; the
SHOULD first use the MANDATORY Get-Attributes operation to query the others are OPTIONAL (see section 5.2.2). Therefore, before using an
Printer's "operations-supported" attribute before using any OPTIONAL operation, a client SHOULD first use the MANDATORY Get-
unsupported operation. A client SHOULD NOT attempt to use an Attributes operation to query the Printer's "operations-supported"
unsupported operation. When a Printer object receives a request to attribute in order to determine which OPTIONAL Printer and Job
perform an operation it does not support, it returns the error code operations are actually supported. The client SHOULD NOT use an
'server-error-operation-not-supported' (see section 13.1.5.2). OPTIONAL operation that is not supported. When an IPP object
receives a request to perform an operation it does not support, it
returns the 'server-error-operation-not-supported' status code (see
section 13.1.5.2). It is non-conformance when an object does not
support a MANDATORY operation.
Expires April 14, 1998
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). its URI (the "printer-uri" attribute). For Job operations, the
operation is directed at either:
For Job operations, the operation is directed at either:
- the Job object itself using the Job object's URI ("job-uri") - the Job object itself using the Job object's URI (the "job-uri"
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
and the 32-bit numeric Job ID ("job-id") assigned by the Printer the 32-bit numeric Job ID (the "job-id" attribute assigned by the
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 SHOULD 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 over HTTP/1.1, the object's URI is Note: In the mapping of IPP/1.0 over HTTP/1.1, the object's URI is
actually encoded as the "request-URI" field of the HTTP POST actually encoded as the "request-URI" field of the HTTP POST
operation. In the case of Printer operations directed at a Printer operation. In the case of Printer operations directed at a Printer
object, the Printer object's "printer-uri" attribute is mapped to the object, the Printer object's "printer-uri" attribute is mapped to the
"request-URI" attribute in the HTTP header. In the case of Job "request-URI" attribute in the HTTP header. In the case of Job
operations directed at the Job object, the Job object's "job-uri" operations directed at the Job object, the Job object's "job-uri"
attribute is mapped to the "request-URI" attribute in the HTTP header. attribute is mapped to the "request-URI" attribute in the HTTP header.
In the case of Job operations directed at the Printer object that 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 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 in the HTTP header, and the "job-id" attribute is sent as an operation
operational attribute in the request body. In other mappings of IPP attribute in the request body. In other mappings of IPP operations
operations onto some other transport mechanism, the target URI is onto other transport mechanisms, the target URI is encoded using some
encoded using some other transport specific addressing mechanism. 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 in the published URI, then that port number number is specified within the syntax of the URI, then that port
MUST be used by the client to contact the IPP server. 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
port number specification, then the default port number for the port number specification, then the default port number for the
protocol should be used. protocol MUST be used.
3. Consult the appropriate IPP protocol mapping document to
determine alternate port numbers for the protocol specified in
the server URI.
Expires April 14, 1998
3.1.3 Character Set and Natural Language Operation Attributes 3.1.3 Character Set and Natural Language Operation Attributes
Some Job and Printer attributes have values that are text strings and Some Job and Printer attributes have values that are text strings and
names intended for human understanding rather than machine names intended for human understanding rather than machine
understanding (see the 'text' and 'name' attribute syntax descriptions understanding (see the 'text' and 'name' attribute syntax descriptions
in section 4.1). The following sections describe two MANDATORY in section 4.1). The following sections describe two MANDATORY
attributes for every IPP operation request and response. These operation attributes for every IPP request and response. These
attributes are "attributes-charset" and "attributes-natural-language". attributes are "attributes-charset" and "attributes-natural-language"
For the sake of brevity in this document, these operation attribute which SHALL be stored as Job Description attributes. For the sake of
descriptions are not repeated with every operation request and brevity in this document, these operation attribute descriptions are
response, but have a reference back to this section instead. not repeated with every operation request and response, but have a
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 operation following MANDATORY operation attributes in every IPP/1.0 operation
request: request:
"attributes-charset" (charSet): "attributes-charset" (charset):
This operation attribute identifies the charset (coded character This operation attribute identifies the charset (coded character
set and encoding method) used by any 'text' and 'name' attributes set and encoding method) used by any 'text' and 'name' attributes
that the client is supplying in this request and that the Printer that the client is supplying in this request. It also identifies
object SHALL return in this operation response. See Sections the charset that the Printer object SHALL use (if supported) for
4.1.1 and 4.1.2 for the specification of the 'text' and 'name' all 'text' and 'name' attributes and status messages that the
attribute syntaxes. Printer object returns in the response to this request. See
Sections 4.1.1 and 4.1.2 for the specification of the 'text' and
'name' attribute syntaxes.
The Printer object SHALL support the 'utf-8' charset [RFC2044] Expires May 7, 1998
and MAY support additional charsets provided that they are All IPP objects SHALL support the 'utf-8' charset [RFC2044] and
registered with IANA [IANA-CS]. If the Printer object does not MAY support additional charsets provided that they are registered
support the supplied charset value, the Printer object SHALL with IANA [IANA-CS]. If the Printer object does not support the
reject the request and return status code 'client-error-charset- client supplied charset value, the Printer object SHALL reject
not-supported'. The Printer object SHALL indicate the charset(s) the request and return the 'client-error-charset-not-supported'
supported as the values of the "charsets-supported" Printer status code. The Printer object SHALL indicate the charset(s)
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.14), so that the client MAY query
which charset(s) are supported. which charset(s) are supported.
See the 'charSet' attribute syntax description in Section 4.1.7 Note to client implementers: Since IPP objects are only required
to support the 'utf-8' charset, in order to maximize
interoperability with multiple IPP object implementations, a
client may want to supply 'utf-8' in the "attributes-charset"
operation attribute, even though the client is only passing and
able to present a simpler charset, such as US-ASCII or ISO-8859-
1. Then the client will have to filter out (or charset convert)
those characters that are returned in the response that it cannot
present to its user. On the other hand, if both the client and
the IPP objects also support a charset in common besides utf-8,
the client MAY want to use that charset in order to avoid charset
conversion or data loss.
See the 'charset' attribute syntax description in Section 4.1.7
for 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. A Printer SHOULD do its best to respond in the this request. This attribute also identifies the natural
same natural language. language that the Printer object SHOULD use for all 'text' and
'name' attributes and status messages that the Printer object
returns in the response to this request.
Expires April 14, 1998
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's "natural-language- object to support. However, the Printer object's "natural-
supported" attribute SHALL list the natural languages supported, language-supported" attribute SHALL list the natural languages
so that the client MAY query which natural language(s) are supported by the Printer object and any contained Job objects, so
supported. For any of the attributes for which the Printer that the client MAY query which natural language(s) are
generates messages, i.e., for the "job-state-message", "printer- supported.
state-message" attributes ", and Status Messages (see Section For any of the attributes for which the Printer object generates
3.1.4) in operation responses, the Printer object SHALL be able text, i.e., for the "job-state-message", "printer-state-message",
to generate messages in any of its supported natural languages. and status messages (see Section 3.1.4), the Printer object SHALL
If the client requests a natural language that is not supported, be able to generate these text strings in any of its supported
the Printer object SHALL return these generated messages in the natural languages. If the client requests a natural language
Printer's configured natural language as specified by the that is not supported, the Printer object SHALL return these
Printer's "printer-natural-language " attribute" (see Section
4.4.15).
For other Printer 'text' and 'name' attributes supplied by the Expires May 7, 1998
operator, system administrator, or manufacturer, i.e., for generated messages in the Printer's configured natural language
"printer-name" (name), "printer-location" (text), "printer-info" as specified by the Printer's "natural-language" attribute" (see
(text), and "printer-make-and-model" (text), the Printer object Section 4.4.15).
is only required to support the configured natural language of
the Printer identified by the Printer's "printer-natural-language
" attribute, though support of additional natural languages for
these attributes is permitted
If the Printer object does not support the natural language value For other 'text' and 'name' attributes supplied by the client,
supplied by the client, the Printer object SHALL either (1) authentication system, operator, system administrator, or
reject the request and return status code ' client-error-natural- manufacturer, i.e., for "job-originating-user-name", "printer-
language-not-supported' or (2) accept the natural language rather name" (name), "printer-location" (text), "printer-info" (text),
than returning an error, depending on implementation. In the and "printer-make-and-model" (text), the Printer object is only
latter case, the Printer object SHALL use the method for required to support the configured natural language of the
representing exception natural languages in attribute values as Printer identified by the Printer object's "natural-language"
described for the 'text' attribute syntax in Section 4.1.1 for attribute, though support of additional natural languages for
any such 'text' or 'name' attributes that the Printer (1) accepts these attributes is permitted.
from or (2) returns to a client.
For any 'text' or 'name' attribute in the request that is in a
different natural language than the value supplied in the
"attributes-natural-language", the client SHALL use the Natural
Language Override mechanism (see section 4.1.1 on the 'text'
attribute syntax) on each attribute value supplied.
The IPP object SHALL accept any natural language and any Natural
Language Override, whether the IPP object supports that natural
language or not (and independent of the value of the "ipp-
attribute-fidelity" Operation attribute), i.e., whether the
Printer object's "natural-language-supported" contains the value
supplied by the client in the "attributes-natural-language"
Operation attribute or in a Natural Language Override. In some
cases, the client supplies an attribute with a natural language
that is not supported. In these cases, the IPP object SHALL
remember that natural language for that attribute, and SHALL
indicate that natural language when returning the attribute in
response to a query. For example, the "job-name" attribute is
supplied by the client in a create request, and its value, if
supplied, is used to populate the Job objects "job-name"
attribute. If the client supplies a Job name in an unsupported
natural language, Printer object SHALL accept the create request
and remember the client supplied natural language. There is no
need for the Printer object to reject the create request just
because the client choose to pick some unsupported natural
language for the Job name. Whenever a client queries the "job-
name" attribute, the IPP object returns the attribute and
indicates the natural language of the attribute as a Natural
Language Override if it is different than the natural language of
the other attributes in the response.
See the 'naturalLanguage' attribute syntax description in Section See the 'naturalLanguage' attribute syntax description in Section
4.1.8 for the syntax and semantic interpretation of the values of 4.1.8 for the syntax and semantic interpretation of the values of
this attribute and for example values. this attribute and for example values.
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 operation following MANDATORY operation attributes in every IPP/1.0 operation
response: response:
"attributescharset" (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
Expires April 14, 1998
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. See "attributes-charset" described in
Section 3.1.3.1 above. 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
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
charset stores the data in the charset supplied by the client or
code converts to one of the other supported charsets, depends on
implementation. The strategy SHOULD try to minimize loss of
information during code conversion. In any case, responses SHALL
always be in the charset requested. If this is not possible
(i.e., the charset requested is not supported), the request SHALL
be rejected.
"attributes-natural-language" (naturalLanguage): "attributes-natural-language" (naturalLanguage):
This is a MANDATORY Job Template attribute for the Printer object This operation attribute identifies the natural language used by
to return. This attribute specifies the natural language used by any 'text' and 'name' attributes that the IPP object is returning
'text' and 'name' attributes with empty tags in this response and in this response. Unlike the "attributes-charset" operation
SHALL be the same value as supplied by the client in the request, attribute, the IPP object NEED NOT return the same value as that
whether the Printer object supports that value or not. Any supplied by the client in the request. The IPP object MAY return
'text' or 'name' values in this response that have a different the natural language of the Job object or the Printer's default,
natural language SHALL have a fully specified natural language rather than the natural language supplied by the client. For any
tag pre-pended to each such attribute value. 'text' or 'name' attribute or status message in the response that
In a subsequent query request (Get-Attributes or Get-Jobs), the Expires May 7, 1998
Printer object NEED NOT convert any 'text' or 'name' attribute is in a different natural language than the value returned in the
values to the natural language of the requester when it is "attributes-natural-language" operation attribute, the IPP object
different from that specified (and subsequently stored) in the SHALL use the Natural Language Override mechanism (see section
original create request.. In such cases, the Printer object 4.1.1 on the 'text' attribute syntax) on each attribute value
SHALL return an explicit natural language indicator for each such returned.
attribute value. See the 'text' attribute syntax description in
Section 4.1.1.
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. A status code provides information on the
processing of a request. A status message provides a short textual processing of a request. A status message provides a short textual
description of the status of the operation. The status code is description of the status of the operation. The status code is
intended for use by automata and the status message is intended for intended for use by automata, and the status message is intended for
the human user. If a response does include a status message, an IPP the human end user. If a response does include a status message, an
client is not required to examine or display the status message, IPP client NEED NOT examine or display the status message, however it
however it SHOULD do so in some implementation specific manner. SHOULD do so in some implementation specific manner.
Expires April 14, 1998
Section 13 describes the status codes and suggests a corresponding
status message for each status code. In some cases, if the status
code indicates an error, there may be additional attributes in the
response that are not returned in the successful case. One such
example is the set of unsupported attributes in the Print-Job response
(see section 3.2.1.2).
The status code is a numeric value that has semantic meaning. The The status code is a numeric value that has semantic meaning. The
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
0xFFFF. 0x7FFF. Section 13 describes the status codes, assigns the numeric
values, and suggests a corresponding status message for each status
code.
A client implementation of IPP could convert status code values into A client implementation of IPP SHOULD convert status code values into
any localized string that has semantic meaning to the end user. The any localized message that has semantic meaning to the end user. If
Printer object SHALL be able to generate this message in any of the the Printer object supports the status message, the Printer object
natural languages identified by the Printer's "natural-language- MUST be able to generate this message in any of the natural languages
supported" attribute (see the "attributes-natural-language" operation identified by the Printer object's "natural-language-supported"
attribute specified in Section 3.1.3.1). If the charset requested by attribute (see the "attributes-natural-language" operation attribute
the client in the "attributes-charset" operation attribute is not specified in Section 3.1.3.1). As described in Section 3.1.3.1 for
supported by the Printer object, the Printer object SHALL represent any returned 'text' attribute, if there is a choice for generating
the status message, if returned, in the charset specified by the this message, the Printer object uses the natural language indicated
Printer's "printer-charset" attribute (which the client MAY not be by the value of the "attributes-natural-language" in the client
able to interpret). request if supported, otherwise the Printer object uses the value in
the Printer object's own "natural-language" attribute.
3.1.5 Security Concerns for IPP Operations 3.1.5 Security Concerns for IPP Operations
3.1.5.1 Authenticated Requester Identity 3.1.5.1 Authenticated Requester Identity
IPP is layered on top of security services that supply the requester's IPP is layered on top of security services that supply the requester's
identity. It is assumed that the identity supplied by the identity. It is assumed that the identity supplied by the
authentication service is the most authenticated identity required by authentication service is the most authenticated identity required by
a given site's configuration and current policy. It is also assumed a given site's configuration and current policy. It is also assumed
that the layering allows for a single IPP implementation to be run 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. over a consistent interface that supplies the authenticated identity.
The authentication interface should allow for various modular and The authentication interface SHOULD allow for various modular and
extensible authentication service implementations without requiring extensible authentication service implementations without requiring
changes to the IPP implementation. changes to the IPP implementation.
Once the authenticated identity of the requester has been supplied to Once the authenticated identity of the requester has been supplied to
the IPP implementation, the implementation uses that identity to the IPP implementation, the implementation uses that identity to
enforce any authorization policy(ies) that might be in place. When a enforce any authorization policy(ies) that might be in place. When a
Job is created, the identity of the requester from the create request Job object is created, the identity of the requester from the create
is persistently stored in the Job's "job-originating-user" attribute. request is persistently stored in the Job object in an internal
This attribute can be used to match the requester's identity of implementation-dependent attribute. This attribute can be used to
subsequent operations on that Job in order to enforce the local match the requester's identity of subsequent operations on that Job
authorization policy(ies), if any. For example, a one site's policy object in order to enforce the local authorization policy(ies), if
might be that only the job owner is allowed to cancel a job. There any. For example, one site's policy might be that only the job owner
are operation status codes that allow an implementation to return 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.
Expires April 14, 1998 3.1.5.2 The "requesting-user-name" Operation Attribute
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,
and must be established via some mechanism outside the scope of IPP.
3.1.5.2 Restricted Queries 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.
3.1.5.3 Restricted Queries
In many of these IPP operations, a client supplies a list of In many of these IPP operations, a client supplies a list of
attributes to be returned in the response. A Printer may be attributes to be returned in the response. An IPP object may be
configured, for security reasons, not to return all attributes that a configured, for security reasons, not to return all attributes that a
client requests. It may even return none of the requested attributes. client requests. The job attributes returned MAY depend on whether
In such cases, the status returned is the same as if the Printer had 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 returned all requested attributes. The client cannot tell by such a
response whether the requested attribute was present or absent on the response whether the requested attribute was present or absent on the
Printer or Job. object.
3.1.6 Versions 3.1.6 Versions
Each operation request carries with it a version number. Each version Each operation request carries with it a version number. Each version
number is in the form "X.Y" where X is the major version number and Y number is in the form "X.Y" where X is the major version number and Y
is the minor version number. By including a version number in the is the minor version number. By including a version number in the
client request, it allows the client (the requester) to identify which client request, it allows the client (the requester) to identify which
version of IPP it is interested in using. If the Printer does not version of IPP it is interested in using. If the IPP object does not
support that version, the Printer responds with a status code of support that version, the object responds with a status code of
'server-error-version-not-supported'. '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
version not supported status code from the Printer, there is nothing 'server-error-version-not-supported' status code from the Printer,
that prevents a client from trying again with a different version there is nothing that prevents a client from trying again with a
number. For example, a client might be configured to support IPP different version number. In order to conform to IPP/1.0, an
version 3.0, 2.5, 2.0 and 1.0 (hypothetically speaking). A client implementation MUST support at least version '1.0'.
might first try to speak version 3.0. If after receiving a version not
supported, it might successively try version 2.5, then 2.0, and then
1.0. All implementations MUST support version 1.0.
There is only one version number that covers both IPP Model and the There is only one notion of version that covers both IPP Model and IPP
IPP Protocol changes. Thus the version number MUST change when Protocol changes. Thus the version number MUST change when introducing
introducing a new version of the Model document or a new version of a new version of the Model document or a new version of the Protocol
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 IPP processors to changes that make it impossible for older version of IPP clients and
correctly parse and interpret the new or changed attributes, Printer objects to correctly parse and interpret the new or changed
operations and responses. If the major version number changes, the attributes, operations and responses. If the major version number
minor version numbers is set to zero. One example that would have changes, the minor version numbers is set to zero. As an example,
required a change to the major version number would have been adding adding the "ipp-attribute-fidelity" attribute (if it had not been part
the "ipp-attribute-fidelity" attribute if it had not been part of of version '1.0'), would have required a change to the major version
version 1.0. Items that might affect the changing of the major version number. . Items that might affect the changing of the major version
Expires April 14, 1998
number include any changes to the protocol specification itself such number include any changes to the protocol specification itself such
as: as:
- reordering of ordered attributes or attribute sets - reordering of ordered attributes or attribute sets
- changes to the syntax of existing attributes - changes to the syntax of existing attributes
- changing OPTIONAL to MANDATORY and vice versa - changing OPTIONAL to MANDATORY and vice versa
- adding new operation attributes
- adding values to existing operation attributes
- 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 processors, but which can be ignored if not understood. by all IPP objects, but which can be ignored if not understood. Items
Items that might affect the changing of the minor version number that might affect the changing of the minor version number include any
include any changes to the model objects and attributes but not the changes to the model objects and attributes but not the protocol
protocol specification itself, 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
- formally adding in new attribute values - adding new attribute values
- changing any of the type1 attributes - changing any of the type1 attributes
- adding new object attributes
- adding new attribute syntaxes
- adding OPTIONAL operations
3.1.7 Job Creation Operations 3.1.7 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 by including the document data in the request itself. the Printer object by including the document data in the request
itself.
- The Print-URI Request: A client that wants to submit a print job - The Print-URI Request: A client that wants to submit a print job
with only a single document where the Printer "pulls" the with only a single document (where the Printer object "pulls" the
document data uses the Print-URI operation. In this case, the
client includes only a URI reference to the document data (not Expires May 7, 1998
the document data itself). document data instead of the client "pushing" the data to the
Printer object) uses the Print-URI operation. In this case, the
client includes in the request only a URI reference to the
document data (not the document data itself).
- The Create-Job Request: A client that wants to submit a print job - The 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 or operation is followed by an arbitrary number of Send-Document
Send-URI operations (each creating another document for the newly and/or Send-URI operations (each creating another document for
create Job object). The Send-Document operation includes the the newly create Job object). The Send-Document operation
document data in the request (the client "pushes" the document includes the document data in the request (the client "pushes"
data to the printer), and the Send-URI operation includes only a the document data to the printer), and the Send-URI operation
URI reference to the document data in the request (the Printer includes only a URI reference to the document data in the request
"pulls" the document data from the referenced location). The (the Printer "pulls" the document data from the referenced
last Send-Document or Send-URI request for a given Job object location). The last Send-Document or Send-URI request for a
includes a "last-document" operation attribute set to 'true' given Job object includes a "last-document" operation attribute
indicating that this is the last document. set to 'true' indicating that this is the last document.
Expires April 14, 1998
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 Section 15 describes the rules and issues surrounding the processing
and either the acceptance or rejection of a create request. 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
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 using the rules supplied
in section 15 and either accept or reject the request in section 15 and either accept or 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
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
100% accurate, and must yet be done again at job processing time. 100% accurate, and MUST yet be done again at job processing time.
Also, in the case of a URI, checking for availability at job Also, in the case of a URI, checking for availability at job
submission time does not guarantee availability at job processing submission time does not guarantee availability at job processing
time. In addition, at job processing time, the Printer object might time. In addition, at job processing time, the Printer object might
discover any of the following conditions that were not detectable at discover any of the following conditions that were not detectable at
job submission time: job submission time:
- runtime errors in the document data, - runtime errors in the document data,
Expires April 14, 1998
- 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 has already responded with a At job processing time, since the Printer object has already responded
successful status code in the response to the create request, if the with a successful status code in the response to the create request,
Printer object detects an error, the Printer object in unable to if the Printer object detects an error, the Printer object is unable
inform the end user of the error with an operational status code. In to inform the end user of the error with an operation status code.
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
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. In HTTP/1.1 mapping of IPP, this correct target of the operation.
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.
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 When an end user desires to submit a print job with only one document
and the client supplies the document data (rather than just a and the client supplies the document data (rather than just a
reference to the data), the client uses a Print-Job operation. reference to the data), the client uses a Print-Job operation. See
Section 15 for a suggested processing algorithm for the create
operations and their Operation and Job Template attributes.
3.2.1.1 Print-Job Request 3.2.1.1 Print-Job Request
The following groups of attributes are supplied as part of the Print- The following groups of attributes are supplied as part of the Print-
Job Request: Job Request:
Group1: Operation Attributes Group1: 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. The Printer object
SHALL copy these values to the corresponding Job Description
attributes described in sections 4.3.20 and 4.3.21.
Requesting User Name:
The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2.
"job-name" (name): "job-name" (name):
This attribute is OPTIONALLY supplied by the client, and it This attribute is OPTIONALLY supplied by the client, and it
contains the client supplied Job name. If this attribute is contains the client supplied Job name. If this attribute is
supplied by the client, its value is used for the "job-name"
Expires April 14, 1998 attribute of the newly created Job object. The client MAY
supplied, its value it used for the "job-name" attribute of the automatically include any information that will help the end-user
newly created Job object. If this attribute is not supplied by distinguish amongst his/her jobs, such as the name of the
the client, the Printer generates a name to use in the "job-name" application program along with information from the document,
attribute of the newly created Job object (see Section 4.3.4). such as the document name, document subject, or source file name.
If this attribute is not 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): "document-name" (name):
This attribute is OPTIONALLY supplied by the client, and it This attribute is OPTIONALLY supplied by the client, and it
contains the client supplied document name. The document name contains the client supplied document name. The document name
MAY be different than the Job name. Typically, the client MAY be different than the Job name. Typically, the client
software automatically supplies the document name on behalf of software automatically supplies the document name on behalf of
Expires May 7, 1998
the end user by using a file name or an application generated the end user by using a file name or an application generated
name. If this attribute is supplied, its value can be used in a name. If this attribute is supplied, its value can be used in a
manner defined by each implementation. Examples include: printed manner defined by each implementation. Examples include: printed
along with the Job (banner page, page adornments, etc.), used by along with the Job (job start sheet, page adornments, etc.), used
accounting or resource tracking management tools, or even stored by accounting or resource tracking management tools, or even
along with the document as a document level attribute. IPP/1.0 stored along with the document as a document level attribute.
does not support the concept of document level attributes, IPP/1.0 does not support the concept of document level
however, a vendor specific extension to IPP/1.0 might support the attributes.
document level attributes. In this case, the "document-name"
attribute could be persistently stored along with the document "document-format" (mimeMediaType) :
and queried using a Get-Attributes operation on the Job object The client OPTIONALLY supplies this attribute. The value of this
that includes a request for document level attributes or some attribute describes the format of the supplied document data. If
other private extension mechanism. the client does not supply this attribute, the Printer object
assumes that the document data is in the format defined by the
Printer object's "document-format" attribute.
"ipp-attribute-fidelity" (boolean): "ipp-attribute-fidelity" (boolean):
This attribute is OPTIONALLY supplied by the client. If not This attribute is OPTIONALLY supplied by the client. If not
supplied, the Printer object assumes the value is 'false'. The supplied, the Printer object assumes the value is 'false'. The
value 'true' indicates that total fidelity to client supplied value 'true' indicates that total fidelity to client supplied
attributes and values is required. The value 'false' indicates attributes and values is required, else the Printer object SHALL
that a reasonable attempt to print the Job is acceptable. All reject the Print-Job request. The value 'false' indicates that a
Printer objects MUST support both types of job processing. See reasonable attempt to print the Job object is acceptable and the
section 15 for a full description of "ipp-attribute-fidelity" Printer object SHALL accept the Print-job request. All Printer
and its relationship to other attributes, especially the Printer objects MUST support both types of job processing. See section
object's "pdl-override" attribute. 15 for a full description of "ipp-attribute-fidelity" and its
relationship to other attributes, especially the Printer object's
"document-charset" (charSet): "pdl-override" attribute.
This attribute is OPTIONALLY supplied by the client. A Printer
object SHALL support this attribute if it supports a document-
format that requires a character set to be identified in order to
unambiguously interpret the document, such as 'text/plain'.
There are no particular values required for the Printer object to
support. This attribute specifies the charset of the document
for those document-formats that require a specification of the
charset in order to image the document unambiguously. If the
value of the "document-format" attribute contains a charset
parameter (see 'mimeType' attribute syntax in Section 4.1.9), the
client SHALL also supply the "document-charset" attribute and its
value SHALL be the same.
Expires April 14, 1998
"document-natural-language" (naturalLanguage): "document-natural-language" (naturalLanguage):
This attribute is OPTIONALLY supplied by the client. There are This attribute is OPTIONALLY supplied by the client. There are
no particular values are required for the Printer object to no particular values required for the Printer object to support.
support. This attribute specifies the natural language of the This attribute specifies the natural language of the document for
document for those document-formats that require a specification those document-formats that require a specification of the
of the natural language in order to image the document natural language in order to image the document unambiguously.
unambiguously.
Group2: Job Template Attributes Group2: 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. See section 15 for a full description as defined in section 4.2.
of Job Template attributes.
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 and nothing else. In this case, the Printer object: Content, the "attributes-charset" and "attributes-natural-language"
Expires May 7, 1998
operation attributes, and nothing else. In this case, the Printer
object:
- creates a new Job object (the Job object contains a single - creates a new Job object (the Job object contains a single
document), document),
- stores a generated Job name in the "job-name" attribute, - stores a generated Job name in the "job-name" attribute in the
- assumes that the document data is in a supported format, and natural language and charset requested (see Section 3.1.3.1) (if
- uses its corresponding default value attributes for missing Job those are supported, otherwise using the Printer object's default
Template attributes and embedded instructions in the document natural language and charset), and
data. - at job processing time, uses its corresponding default value
attributes for the supported Job Template attributes that were
not supplied by the client as IPP attribute or embedded
instructions in the document data.
3.2.1.2 Print-Job Response 3.2.1.2 Print-Job Response
The Printer 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. section 3.1.4. If the client supplies unsupported or conflicting
attributes or values, the Printer object SHALL reject or accept
the Print-Job request depending on the whether the client
supplied a 'true' or 'false' value for the "ipp-attribute-
fidelity" operation attribute. See section 15 for a complete
description of the processing algorithm.
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.
Expires April 14, 1998
Group 2: Job Object Attributes Group 2: 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
"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 attribute then it MUST be returned in the response. If this
this attribute is not returned in the response, the client can attribute is not returned in the response, the client can assume
assume that the "job-state-reasons" attribute is not supported that the "job-state-reasons" attribute is not supported and will
and will not be returned in a subsequent Job object query. not be returned in a subsequent Job object query.
"job-state-message": "job-state-message":
The Printer object OPTIONALLY returns the Job object's OPTIONAL The Printer object OPTIONALLY returns the Job object's OPTIONAL
"job-state-message" attribute. If the Printer object supports "job-state-message" attribute. If the Printer object supports
this attribute then it MUST be returned in the response. If this this attribute then it MUST be returned in the response. If this
attribute is not returned in the response, the client can assume attribute is not returned in the response, the client can assume
that the "job-state-message" attribute is not supported and will that the "job-state-message" attribute is not supported and will
not be returned in a subsequent Job object query. not be returned in a subsequent Job object query.
"number-of-intervening-jobs": "number-of-intervening-jobs":
skipping to change at page 30, line 5 skipping to change at page 32, line 45
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.
Expires April 14, 1998
Group 3: Unsupported Attributes Group 3: Unsupported Attributes
This is an OPTIONAL set of attributes. It is a set of Job This is a set of Job Template attributes supplied by the client
Template attributes supplied by the client (in the request) that (in the request) that are not supported by the Printer object or
are not supported by the Printer object. When the Printer object that conflict with one another (see section 15).
rejects the request because of more than one unsupported
attribute (see section 15), it SHOULD return all of the
unsupported attributes. Some implementations may choose to only
return the first unsupported attribute that is encountered during
the processing of the attributes, but that may lead to additional
requests with only one "fixed" attribute from the set of problem
attributes. In the case where the Printer object accepts the
request and creates a Job object, the Printer MUST return the set
of unsupported attributes where substitutions were made or the
attribute was completely ignored.
Unsupported attributes fall into two categories: Unsupported attributes fall into three categories:
Expires May 7, 1998
1. The Printer object does not support the named attribute (no 1. The Printer object does not support the named attribute (no
matter what the value), or matter what the value), or
2. The Printer object does supports the attribute, but not the 2. The Printer object does support the attribute, but does not
particular value supplied by the client (i.e., the Printer does support some or all of the particular values supplied by the
not have that value in the corresponding supported values client (i.e., the Printer object does not have those values in
attribute). 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 In the case of an unsupported attribute name, the Printer object
returns the client supplied attribute with a substituted special returns the client-supplied attribute with a substituted special
value of 'unsupported' indicating no support for the attribute value of 'unsupported' indicating no support for the attribute
itself. In the case of a supported attribute with an unsupported itself.
value, the Printer object simply returns the client-supplied
attribute. This indicates support for the attribute, but no In the case of a supported attribute with one or more unsupported
support for that particular value. 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 and a status code of "successful-ok". Attributes, the MANDATORY "attributes-charset" and "attributes-
natural-language" operation attributes, and a status code of
"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 operation is identical to the Print-Job operation (section 3.2.1)
except that a client supplies a URI reference to the document data except that a client supplies a URI reference to the document data
using the "document-uri" (uri) operation attribute rather than using the "document-uri" (uri) operation attribute rather than
including the document data itself. It is up to the IPP server to including the document data itself. Before returning the response,
interpret the URI and subsequently "pull" the document from the source the Printer MUST validate that the Printer supports the retrieval
referenced by the URI string. At job submission time, the Printer method (e.g., http, ftp, etc.) implied by the URI, and SHOULD check
MUST validate the fact that it supports the retrieval method (e.g., for valid URI syntax. The Printer NEED NOT follow the reference and
http, ftp, etc.) implied by the URI. If the Printer object supports validate the contents of the reference.
Expires April 14, 1998 If the Printer object supports this operation, it MUST support the
this operation, it MUST support the "reference-uri-schemes-supported" "reference-uri-schemes-supported" attribute (see section 4.4.23).
attribute (see section 4.4.21).
It is up to the IPP object to interpret the URI and subsequently
"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 operation is similar to the Print-Job operation (section 3.2.1)
except that a client supplies no document data and the Printer except that a client supplies no document data and the Printer
allocates no resources (i.e., it does not create a new Job object). allocates no resources (i.e., it does not create a new Job object).
This operation is used only to verify capabilities of a printer object This operation is used only to verify capabilities of a printer object
against whatever attributes are supplied by the client in the against whatever attributes are supplied by the client in the
Validate-Job request. There are no Job Object Attributes returned in Validate-Job request. By using the Validate-Job operation a client
the Validate-Job Response. If the Printer supports either the Print- can check that the same Print-Job operation will be accepted without
URI or Send-URI operations, the client MAY include a "document-uri" having to send the document data. The Validate-Job operation also
attribute in the request. In this case, the Printer MUST validate performs the same security negotiation as the Print-Job operation (see
that the Printer supports the retrieval method implied by the URI, and section 8), so that a client can check that the client and Printer
SHOULD check for validate URI syntax. The Printer NEED NOT follow the object security requirements can be met before performing a Print-Job
reference and validate the contents of the reference. If all is well, operation.
the Printer returns the status code "successful-ok". Otherwise, the
Printer returns a set of unsupported attributes and/or the appropriate
error status code. If the client supplies the "ipp-attribute-
fidelity" attribute set to false (or does not supply the attribute at
all) and if the Printer object returns a "successful-ok-ignored-or-
substituted-attributes", the Printer object SHOULD return all ignored
or substituted in the Unsupported Attributes group. In such a case,
the Printer object MUST return at least one attribute indicating an
unsupported attribute value or an ignored attribute.
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
operation will be accepted, since the client doesn't send the data
with the Print-URI operation. The client SHOULD just issue the Print-
URI request.
The Printer object returns the same status codes, Operation Attributes
(Group 1) and Unsupported Attributes (Group 3) as the Print-Job
operation. However, no Job Object Attributes (Group 2) are returned,
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 operation is similar to the Print-Job operation (section 3.2.1)
except that in the Create-Job request , a client does not supply except that in the Create-Job request , a client does not supply
document data (or any reference to document data). Also, the client document data (or any reference to document data). Also, the client
does not supply any of the "document-name", "content-charset", or does not supply either of the "document-name" or "document-natural-
"content-natural-language" attributes. This operation is followed by language" attributes. This operation is followed by one or more Send-
one or more Send-Document or Send-URI operations. In each of these Document or Send-URI operations. In each of those operation requests,
operation requests, the client OPTIONALLY supplies the "document- the client OPTIONALLY supplies the "document-name" and "document-
name", "content-charset", or "content-natural-language" attributes for natural-language" attributes for each document in the multi-document
each document in the multi-document Job. If a Printer object supports Job object. If a Printer object supports the Create-Job operation, it
the Create-Job operation, it MUST also support the Send-Document MUST also support the Send-Document operation and also MAY support the
operation and also MAY support the Send-URI operation. Send-URI operation.
3.2.5 Get-Attributes Operation
The Printer Get-Attributes operation allows a client to obtain 3.2.5 Get-Attributes Operation (for Printer objects)
information from a Printer object. In the operations attributes in a
request, the client supplies the set of attribute names and/or
attribute group names in which the requester is interested. In the
operation attribute in the response, the Printer returns a
Expires April 14, 1998 The Get-Attributes operation allows a client to request the values of
corresponding attribute set with the appropriate attribute values the attributes of a Printer or Job object. This section describes the
filled in. former and section 3.3.4 describes the latter. In the request, the
client supplies the set of Printer attribute names and/or attribute
group names in which the requester is interested. In the response,
the Printer object returns a corresponding attribute set with the
appropriate attribute values filled in.
For Printers, 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.
There is also the special group 'all' that includes all supported There is also the special group 'all' that includes all supported
attributes. Since a client MAY request specific attributes or named attributes. Since a client MAY request specific attributes or named
groups, there is a potential that there is some overlap. For example, groups, there is a potential that there is some overlap. For example,
if a client requests, 'printer-name', 'printer-description', and if a client requests, 'printer-name' and 'all', the client is actually
'all', client is actually requesting the "printer-group, and once by requesting the "printer-name" attribute twice: once by naming it
inclusion in the 'all' group. In all cases, the Printer SHALL only explicitly, and once by inclusion in the 'all' group. In such cases,
return the attribute once in the response. the Printer object NEED NOT return each attribute only once in the
response even if it is requested multiple times. The client SHOULD
NOT request the same attribute in multiple ways.
It is NOT REQUIRED that a Printer support all attributes belonging to It is NOT REQUIRED that a Printer object support all attributes
a group, however it is MANDATORY that each Printer implementation belonging to a group (since some attributes are OPTIONAL), however, it
understand all group names. is MANDATORY that each Printer object support all group names.
Expires May 7, 1998
3.2.5.1 Get-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-Attributes
Request when the request is directed to a Printer object: Request when the request is directed to a Printer object:
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:
The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2.
"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. If the client omits this attribute, the Printer
SHALL respond as if this attribute had been supplied with a value SHALL respond as if this attribute had been supplied with a value
of 'all'. of 'all'.
"document-format" (mimeType) : "document-format" (mimeMediaType) :
The client OPTIONALLY supplies this attribute. This attribute is The client OPTIONALLY supplies this attribute. This attribute is
useful for a Printer to determine the set of supported attribute useful for a Printer object to determine the set of supported
values that relate to the requested document format. The Printer attribute values that relate to the requested document format.
The Printer object SHOULD return only (1) those attributes that
are supported for that format and (2) the attribute values that
are supported for the specified document format. By specifying
the document format, the client can get the Printer object to
eliminate the attributes and values that are not supported for a
specific document format. For example, a Printer object might
have multiple interpreters to support both
'application/postscript' (for PostScript) and 'text/plain' (for
text) documents. However, for only one of those interpreters
might the Printer object be able to support "number-up" with
values of '1', '2', and '4'. For the other interpreter it might
be able to only support "number-up" with a value of '1'.
Expires April 14, 1998 If the client omits this attribute, the Printer object SHOULD
SHOULD return only (1) those attributes that are supported for respond as if the attribute had been supplied with a value set to
that format and (2) the attribute values that are supported for the Printer object's "document-format" default value attribute
the specified document format. By specifying the document (if supported). It is recommended that the client always supply
format, the client can get the Printer to eliminate the a value for "document-format", since the Printer object's
attributes and values that are not supported for a specific
document format. For example, a Printer might have multiple
interpreters to support both 'application/postscript' (for
PostScript) and 'text/plain' (for text) documents. However, for
only one of those interpreters might the Printer 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 SHALL respond as Expires May 7, 1998
if the attribute had been supplied with a value set to the "document-format" may be 'application/octet-stream', in which
Printer object's "document-format-default" default value case the returned attributes and values are for the union of the
attribute. It is recommended that the client always supply a document formats that the Printer can automatically sense. For
value for "document-format", since the Printer object's more details, see the description of the 'mimeMediaType'
"document-format-default" may be 'application/octet-stream', in attribute syntax in section 4.1.9.
which case the returned attributes and values are for the union
of the document formats that the Printer can automatically sense.
For more details, see the description of the 'mimeType' attribute
syntax in section 4.1.9.
NOTE: The "document-format" operation attribute is a fairly Note: The "document-format" operation attribute is a fairly
sophisticated filtering notion that is not supported by many sophisticated filtering notion that is not supported by many
existing print systems or devices. existing print systems or devices.
3.2.5.2 Get-Attributes Response 3.2.5.2 Get-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-Attributes Response:
Group 1: Operation Attributes Group 1: Operation Attributes
skipping to change at page 34, line 5 skipping to change at page 37, line 34
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: Requested Printer Object Attributes
Expires April 14, 1998
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.
3.2.6 Get-Jobs Operation 3.2.6 Get-Jobs Operation
The Get-Jobs operation allows a client to retrieve the list of Jobs The Get-Jobs operation allows a client to retrieve the list of Job
belonging to the target Printer object. The client may also supply a objects belonging to the target Printer object. The client may also
list of Job attribute names or attribute group names. These Job supply a list of Job attribute names and/or attribute group names. A
attributes will be returned for each Job that is returned. group of Job object attributes will be returned for each Job object
that is returned.
This operation is similar Get-Attributes, except that this Get-Jobs This operation is similar Get-Attributes for Job object, except that
operation returns attributes from possibly more than one object (see this Get-Jobs operation returns attributes from possibly more than one
the description of attribute group names in section 3.3.4). object (see the description of Job attribute group names in 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 groupsof attributes are part of the Get-Jobs Request: The following groupsof 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:
The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2.
"limit" (integer): "limit" (integer):
The client OPTIONALLY supplies this attribute. It is an integer The client OPTIONALLY supplies this attribute. It is an integer
value that indicates a limit to the number of Job objects value that indicates a limit to the number of Job objects
returned. The limit is a "stateless limit" in that if the value returned. The limit is a "stateless limit" in that if the value
supplied by the client is 'n', then only the first 'n' jobs are supplied by the client is 'N', then only the first 'N' jobs are
returned in the Get-Jobs Response. There is no mechanism to returned in the Get-Jobs Response. There is no mechanism to
allow for the next 'm' jobs after the first 'n' jobs. If the allow for the next 'M' jobs after the first 'N' jobs. If the
client does not supply this attribute, the Printer object client does not supply this attribute, the Printer object
responds will all applicable jobs. responds will all applicable jobs.
"requested-attributes" (1setOf keyword): "requested-attributes" (1setOf keyword):
The client OPTIONALLY supplies this attribute. It is a set of Job The client OPTIONALLY supplies this attribute. It is a set of
attribute names or attribute groups names in whose values the Job attribute names and/or attribute groups names in whose values
requester is interested. This set of attributes is returned for the requester is interested. This set of attributes is returned
each Job that is returned. The allowed attribute group names are for each Job object that is returned. The allowed attribute
the same as those defined in the Get-Attributes operation for Job group names are the same as those defined in the Get-Attributes
objects. If the client does not supply this attribute, the operation for Job objects in section 3.3.4. If the client does
not supply this attribute, the Printer SHALL respond as if the
Expires April 14, 1998 client had supplied this attribute with two values: 'job-uri' and
Printer SHALL respond as if the client had supplied values of 'job-id'.
'job-uri' and 'job-id'.
"which-jobs" (keyword): "which-jobs" (keyword):
The client OPTIONALLY supplies this attribute. It indicates which The client OPTIONALLY supplies this attribute. It indicates
Jobs should be returned by the Printer object. The values for which Job objects SHOULD be returned by the Printer object. The
this attribute are: values for this attribute are:
'completed': This includes any Job object whose state is 'completed': This includes any Job object whose state is
'completed', 'cancelled', 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'.
If the client does not supply the attribute, the Printer object If the client does not supply this attribute, the Printer object
SHALL respond as if the client had supplied the value of 'not- SHALL respond as if the client had supplied the attribute with a
completed'. value of 'not-completed'.
"my-jobs" (boolean):
The client OPTIONALLY supplies this attribute. It indicates
whether all jobs or just the jobs submitted by the requesting
user of this request SHALL be returned by 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
value of 'false', i.e., all jobs not just my jobs. The means for
authenticating the requesting user and matching the jobs is
described in section 3.1.5.
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 35, line 48 skipping to change at page 39, line 48
"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 Groups 2 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. for each returned Job object. The Printer object ignores (does
not respond with) any requested attribute which is not supported
or which is restricted by the security policy in force, including
whether the requesting user is the user that submitted the job
(job originating user) or not (see section 3.1.5).
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 client is requesting in the Get-Jobs natural language that the Printer object is returning in the
request, the Printer SHALL indicate the submitted natural "attributes-natural-language" operation attribute in the Get-Jobs
language by returning the "job-natural-language" as the first Job response, the Printer SHALL indicate the submitted natural
language by returning the Job object's "attributes-natural-
Expires April 14, 1998 language" as the first Job object attribute, which overrides the
object attribute, which overrides the "attributes-natural- "attributes-natural-language" operation attribute value being
language" operation attribute value being returned by the returned by the Printer object. If any returned 'text' or 'name'
Printer. If any returned 'text' or 'name' attribute includes an attribute includes a Natural Language Override as described in
exception natural language as described in the 'text' attribute the 'text' attribute syntax (see Section 4.1.1), the Natural
syntax (see Section 4.1.1), the exception natural language Language Override overrides the Job object's "attributes-natural-
overrides the "job-natural-language" value (for the immediately language" value and/or the "attributes-natural-language"
following attribute value only). operation attribute value.
Jobs are returned in the following order: Jobs are returned in the following order:
- If the client requests all 'completed' Jobs (Jobs in the - If the client requests all 'completed' Jobs (Jobs in the
'completed', 'aborted', or 'cancelled' states), then the Jobs are 'completed', 'aborted', or 'canceled' states), then the Jobs are
returned newest to oldest (with respect to actual completion returned newest to oldest (with respect to actual completion
time) time)
- If the client requests all 'non-completed' Jobs (Jobs in the - If the client requests all 'non-completed' Jobs (Jobs in the
'pending', 'processing', 'pending-held', 'processing-stopped', 'pending', 'processing', 'pending-held', 'processing-stopped',
and 'unknown' states), then Jobs are returned in relative and 'unknown' states), then Jobs are returned in relative
chronological order of expected time to complete (based on chronological order of expected time to complete (based on
whatever scheduling algorithm is configured for the Printer whatever scheduling algorithm is configured for the Printer
object). object).
3.3 Job Operations 3.3 Job Operations
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. Since Job objects can be the correct target of the operation. Job objects can be identified
identified with either a single Job URI or a combination of a Printer with either a single Job URI or a combination of a Printer URI with a
URI with a local Job ID, the following rules apply to all Job Job ID.
operation requests mapped onto HTTP/1.1:
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 - 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 URI, this "job-uri" attribute is not supplied in the body of the
operation as other operation attributes are. It is supplied in operation as other operation attributes are. It is supplied in
the "request-URI" field in the HTTP header. - If the client the "request-URI" field in the HTTP header.
chooses to identify Job objects with both a Printer URI and a - If the client chooses to identify Job objects with both a Printer
local Job ID, the "printer-uri" attribute is not supplied in the URI and a local Job ID, the "printer-uri" attribute is not
body of the operation, but it is supplied in the "request-URI" supplied in the body of the operation, but it is supplied in the
field in the HTTP header. The "job-id" attribute is included as "request-URI" field in the HTTP header. The "job-id" attribute
an operation attribute. is included as an operation attribute.
Since the Get-Attributes operation can be both a Printer operation and Since the Get-Attributes operation can be both a Printer operation and
a Job operation, if a Printer object receives a Get-Attributes a Job operation, if a Printer object receives a Get-Attributes
request, the Printer object must check for the existence of the "job- request, the Printer object must check for the existence of the "job-
id" operation attribute. If present, the operation is intended to be id" operation attribute. If present, the operation is intended to be
a Job operation on the corresponding Job object. If absent, the a Job operation on the corresponding Job object. If absent, the
operation is intended to be a Printer operation. operation is intended to be a Printer operation.
Expires April 14, 1998
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 A client uses a Create-Job operation 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-Documents that follow can occur over Since the Create-Job and the send operations (Send-Document or Send-
arbitrarily long periods of time, each Printer object must decide how URI operations) that follow can occur over arbitrarily long periods of
long to "wait" for the next Send-Document operation. The Printer time, each Printer object must decide how long to "wait" for the next
object OPTIONALLY supports the "multiple-operation-timeout" attribute. send operation. The Printer object OPTIONALLY supports the "multiple-
This attribute indicates the maximum number of seconds the Printer operation-timeout" attribute. This attribute indicates the maximum
object will wait for the next Send-Document operation. If the Printer number of seconds the Printer object will wait for the next send
object times-out waiting for the next Send-Document operation, the operation. If the Printer object times-out waiting for the next send
Printer object MAY decide on any of the following semantic actions: operation, the Printer object MAY decide on any of the following
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-Document associated with the Job. In this case, if another send operation
operation is finally received, the Printer responds with an is finally received, the Printer responds with an "client-error-
"client-error-not-possible" or "client-error-not-found" depending not-possible" or "client-error-not-found" depending on whether or
on whether or not the Job object is still around when it finally not the Job object is still around when it finally arrives.
arrives. 2. Assume that the last send operation received was in fact the
2. Assume that the last Send-Document received was in fact the last last document (as if the "last-document" flag had been set to
document (as if the "last-document" flag had been set to 'true'), 'true'), close the Job object, and proceed to process it (i.e.,
close the Job, and proceed to process it (i.e., move the Job's move the Job's state to 'pending').
state to 'pending').
3. Assume that the last Send-Document received was in fact the last Expires May 7, 1998
document, close the Job, but move it to the 'pending-held' to 3. Assume that the last send operation received was in fact the
allow an operator to determine whether or not to continue last document, close the Job, but move it to the 'pending-held'
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, it is possible that the Job may already have been is to abort the Job object, it is possible that the Job object may
processed to the point that some pages have been printed. already have been processed to the point that some media sheet pages
have been printed.
3.3.1.1 Send-Document Request 3.3.1.1 Send-Document Request
The following attribute sets are part of the Send-Document Request: The following attribute sets are part of the Send-Document Request:
Group 1: Operation Attributes Group 1: Operation Attributes
Expires April 14, 1998
Target: Target:
Either the "printer-uri" plus "job-id" or "job-uri" target for Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
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:
The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2.
"document-name" (name): "document-name" (name):
The client OPTIONALLY supplies this attribute, and it contains The client OPTIONALLY supplies this attribute, and it contains
the client supplied document name. The document name MAY be the client supplied document name. The document name MAY be
different than the Job name. It might be helpful, but NEED NOT different than the Job name. It might be helpful, but NEED NOT
be unique across multiple documents in the same Job. Typically, be unique across multiple documents in the same Job. Typically,
the client software automatically supplies the document name on the client software automatically supplies the document name on
behalf of the end user by using a file name or an application behalf of the end user by using a file name or an application
generated name. See the description of the "document-name" generated name. See the description of the "document-name"
operation attribute in the Print-Job Request (section 3.2.1.1) operation attribute in the Print-Job Request (section 3.2.1.1)
for more information about this attribute. for more information about this attribute.
"last-document" (boolean): "document-format" (mimeMediaType) :
The client MUST supply this attribute. It is a boolean flag that The client OPTIONALLY supplies this attribute. The value of this
is set to 'true' if this is the last document for the Job, attribute describes the format of the supplied document data. If
'false' otherwise. the client does not supply this attribute, the Printer object
assumes that the document data is in the format defined by the
"document-charset" (charSet): Printer object's "document-format" attribute.
This attribute is OPTIONALLY supplied by the client. A Printer
object SHALL support this attribute if it supports a document-
format that requires a character set to be identified in order to
unambiguously interpret the document, such as 'text/plain'.
There are no particular values required for the Printer object to
support. This attribute specifies the charset of the document
for those document-formats that require a specification of the
charset in order to image the document unambiguously. If the
value of the "document-format" attribute contains a charset
parameter (see 'mimeType' attribute syntax in Section 4.1.9), the
client SHALL also supply the "document-charset" attribute and its
value SHALL be the same.
Expires May 7, 1998
"document-natural-language" (naturalLanguage): "document-natural-language" (naturalLanguage):
This attribute is OPTIONALLY supplied by the client. There are This attribute is OPTIONALLY supplied by the client. 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 This attribute specifies the natural language of the document for
those document-formats that require a specification of the those document-formats that require a specification of the
natural language in order to image the document unambiguously, natural language in order to image the document unambiguously.
such as proper glyph selection..
"last-document" (boolean):
The client MUST supply this attribute. It is a boolean flag that
is set to 'true' if this is the last document for the Job,
'false' otherwise.
Group 2: Document Content Group 2: Document Content
Expires April 14, 1998
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'.
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
skipping to change at page 39, line 38 skipping to change at page 44, line 4
Group 2: Job Object Attributes Group 2: 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 operation is identical to the Send-Document operation (see
section 3.3.1) except that a client supplies a URI reference section 3.3.1) except that a client supplies 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.
The Printer object MUST validate the syntax of the supplied URI before The Printer object MUST validate the syntax of the supplied URI before
returning a response. If the Printer object supports this operation, returning a response. If the Printer object supports this operation,
it MUST support the URI types defined under the Print-URI operation it MUST support the URI types defined under the Print-URI operation
(see section 3.2.2) (see section 3.2.2)
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 operation allows a client to cancel a Print Job any time after a
create job operation.. Since a Job might already be printing by the create job operation. Since a Job might already be printing by the
time a Cancel-Job is received, some media sheet pages might be printed
Expires April 14, 1998 before the job is actually terminated.
time a Cancel-Job is received, some pages may 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 the "printer-uri" plus "job-id" or "job-uri" target for Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
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:
The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2.
"message" (text): "message" (text):
OPTIONAL message to the operator. This is not the same as the This attribute is OPTIONALLY supplied by the client. It is a
"job-message-from-operator" attribute. This attribute is used to message to the operator. This "message" attribute is not the
send a message along with the operation request. It is an same as the "job-message-from-operator" attribute. That
attribute is used to report a message from the operator to the
end user that queries that attribute. This "message" operation
attribute is used to send a message from the client to the
operator along with the operation request. It is an
implementation decision of how or where to display this message implementation decision of how or where to display this message
(if at all). 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.
If the job is already in the 'completed', 'aborted', or
'canceled' state, or the 'process-to-stop-point' value is set in
the Job's "job-state-reasons" attribute, the Printer object SHALL
reject the request and return the 'client-error-not-possible'
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.
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 'cancelled' guarantees that the Job will eventually end up in the 'canceled'
state. If the implementation is forced to leave the job in the some state. Between the time of the Cancel-Job operation is accepted and
other state, the "job-state-reasons" SHOULD contain the ' processing- when the job enters the 'canceled' job-state (see section 4.3.6), the
to-stop-point ' value which indicates to later queries that although "job-state-reasons" attribute SHOULD contain the ' processing-to-stop-
the Job may still be 'processing', it will eventually end up in the point ' value which indicates to later queries that although the Job
'cancelled' state, not the 'completed' state. might still be 'processing', it will eventually end up in the
'canceled' state, not the 'completed' state.
Expires April 14, 1998 3.3.4 Get-Attributes Operation (for Job objects)
3.3.4 Get-Attributes Operation
The Job Get-Attributes operation allows a client to obtain information The Get-Attributes operation allows a client to request the values of
from a Job object and it is almost identical to the Get-Attributes attributes of a Job object and it is almost identical to the Get-
operation for a Printer object (see section 3.2.5). The only Attributes operation for a Printer object (see section 3.2.5). The
differences are that the operation is directed at a Job rather than a only differences are that the operation is directed at a Job object
Printer and there is no "document-format" operation attribute used rather than a Printer object and there is no "document-format"
when querying a Job object. operation attribute used when querying a Job object.
For Jobs, the attribute groups include: For Jobs, the attribute groups include:
- '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': the attributes specified in Section 4.3. - 'job-description': all of the Job Description attributes
specified in Section 4.3.
Expires May 7, 1998
There is also the special group 'all' that includes all supported There is also the special group 'all' that includes all supported
attributes. If for some reason, the client includes an attribute two attributes. Since a client MAY request specific attributes or named
or more times in the request (e.g., the client supplies values of groups, there is a potential that there is some overlap. For example,
'all', 'job-template', and 'sides' in the "requested-attributes" if a client requests, 'job-name' and 'job-description', the client is
attribute), the Printer SHALL only return one occurrence of the actually requesting the "job-name" attribute once by naming it
attribute in the response. explicitly, and once by inclusion in the 'job-description' group. In
such cases, the Printer object NEED NOT return the attribute only once
in the response even if it is requested multiple times. The client
SHOULD NOT request the same attribute in multiple ways.
It is NOT REQUIRED that a Job object support all attributes belonging
to a group (since some attributes are OPTIONAL), however it is
MANDATORY that each Job object support all group names.
3.3.4.1 Get-Attributes Request 3.3.4.1 Get-Attributes Request
The following groups of attributes are part of the Get-Attributes The following groups of attributes are part of the Get-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 the "printer-uri" plus "job-id" or "job-uri" target for Either (1) the "printer-uri" plus "job-id" or (2) the "job-uri"
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:
The "requesting-user-name" attribute SHOULD be supplied by the
client as described in section 3.1.5.2.
"requested-attributes" (1setOf keyword) : "requested-attributes" (1setOf keyword) :
An OPTIONAL set of attribute names and/or attribute group names The client OPTIONALLY supplies this attribute. It is a set of
in whose values the requester is interested. If the client omits attribute names and/or attribute group names in whose values the
this attribute, the Printer SHALL respond as if this attribute requester is interested. If the client omits this attribute, the
had been supplied with a value of 'all'. Printer object 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-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-Attributes Response:
Expires April 14, 1998
Group 1: Operation Attributes Group 1: Operation Attributes
Expires May 7, 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. attributes as described in section 3.1.3.2. The "attributes-
natural-language" MAY be the natural language of the Job object,
rather than the one requested.
Group 2: Requested Job Object Attributes Group 2: Requested 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 Printer object ignores (does not respond with) any requested
attribute which is not supported. attribute which is not supported or which is restricted by the
security policy in force, including whether the requesting user
is the user that submitted the job (job originating user) or not
(see section 3.1.5).
4. Object Attributes 4. Object Attributes
This section describes the attributes with their corresponding This section describes the attributes with their corresponding
syntaxes and values that are part of the IPP model. The sections below attribute syntaxes and values that are part of the IPP model. The
show the objects and their associated attributes which are included sections below show the objects and their associated attributes which
within the scope of this protocol. Many of these attributes are are included within the scope of this protocol. Many of these
derived from other relevant specifications: attributes are derived from other relevant specifications:
- Document Printing Application (DPA) [ISODPA] - 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). The keyword is included in the
section header describing that attribute. All attributes are uniquely section header describing that attribute. In addition, one of the
identified with a keyword as its name. In addition, some attributes attribute syntaxes described below is "keyword". Therefore, some
are defined having a syntax that is a set of keywords. attributes can be 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 a client This section defines the basic attribute syntax types that all clients
and server SHALL be able to handle. Each attribute description in and IPP objects SHALL be able to accept in responses and accept in
sections 3 and 4 includes the name of attribute syntax(es) in the requests, respectively. Each attribute description in sections 3 and
heading (in parentheses). A conforming implementation of an attribute 4 includes the name of attribute syntax(es) in the heading (in
SHALL include the semantics of the attribute syntax(es) so identified. parentheses). A conforming implementation of an attribute SHALL
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,
where the sub-section heading is the keyword name of the attribute
syntax inside the single quotes. In operation requests and responses
each attribute value MUST be represented as one of the attribute
syntaxes specified in the sub-section heading for the attribute or be
one of the "out of band" values. Standard values are:
'unknown': The attribute is supported, but the value is unknown for
some reason.
'unsupported': The attribute is unsupported.
The protocol specification defines mechanisms for allowing passing
"out of band" values.
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 "|"
Expires April 14, 1998 character in the sub-section heading to indicate the choice. Since
the value. Since each value SHALL be tagged as to its attribute each value SHALL be tagged as to its attribute syntax in the protocol,
syntax in the protocol, a single-valued attribute instance may have a single-valued attribute instance may have any one of its attribute
any one of its attribute syntaxes and a multi-valued attribute syntaxes and a multi-valued attribute instance may have a mixture of
instance may have a mixture of its defined attribute syntaxes. its defined attribute syntaxes.
The attribute syntaxes are specified in the following sub-sections,
where the sub-section heading is the name of the attribute syntax
inside the single quotes:
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
with a limit of 1 to 4095 octets. The Printer object SHALL support encoded in a maximum of 4095 octets. The Printer object SHALL support
UTF-8 [RFC2044] and MAY support additional charsets provided that they the UTF-8 charset [RFC2044] and MAY support additional charsets
are registered with IANA [IANA-CS]. See Section 4.1.7 for the provided that they are registered with IANA [IANA-CS]. See Section
specification of the 'charSet' attribute syntax, including restricted 4.1.7 for the specification of the 'charset' attribute syntax,
semantics and examples of charsets. including restricted semantics and examples of charsets.
If the client needs to pass 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 than 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)
the client or Printer object SHALL immediately precede that attribute or job attribute (see Section 4.3.21), the client or Printer object
value with a 'naturalLanguage' attribute value that indicates the SHALL identify the natural language for that attribute. This
differing natural language. Thus the attribute becomes multi-valued mechanism for identifying the natural language of a single attribute
with two values. This additional values is called an "exception" value is called the Natural Language Override mechanism.
natural language value. In a create operation, the Printer object
SHOULD accept and store an exception natural language value. If the
Printer object does not store an exception natural language value, the
Printer SHALL ignore it and SHALL store the immediately following
'text' value only. The Printer SHALL not reject the request no matter
what value the client supplies as an exception natural language.
If the attribute is multi-valued (1setOf text), then the exception Expires May 7, 1998
natural language value applies only to the next 'text' value. If the attribute is multi-valued (1setOf text), then the Natural
Subsequent values in a multi-valued 'text' attribute in a request or a Language Override must be explicitly specified with each attribute
response revert to the natural language of the operation attribute or value whose natural language needs to be overriden. Other values in a
the "job-natural-language" job attribute, if present, in the case of a multi-valued 'text' attribute in a request or a response revert to the
Get-Jobs response. natural language of the operation attribute or to the "attributes-
natural-language" Job attribute, if present, in the case of a Get-Jobs
response.
In a create request, the Printer object MUST accept and store with the
Job object any natural languages in the "attributes-natural-language"
operation attribute, whether the Printer object supports that natural
language or not. Furthermore, the Printer object MUST accept and
store with each attribute value any Natural Language Override, whether
the Printer object supports that natural language or not. These
requirements are independent of the value of the "ipp-attribute-
fidelity" operation attribute that the client supplies.
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
values of the "job-name" attribute is in French, the values of the value of the "job-name" attribute is in French, the client MUST use
normally single-valued "job-name" attribute supplied by the client in the Natural Language Override mechanism as follows:
any request or returned by the Printer object in any response would be
the following two values, each tagged with the appropriate attribute
syntax ('naturalLanguage' and 'text') in the protocol:
Expires April 14, 1998 'fr': Natural Language Override indicating French
'fr': exception natural language indicating French with attribute 'Rapport Mensuel': the job name in French
syntax 'naturalLanguage'
'Rapport Mensuel': the job name in French with attribute syntax See the Protocol document [IPP-PRO] for a detailed example of the
'name'. Natural Language Override mechanism.
4.1.2 'name' 4.1.2 '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 exception natural language 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. This syntax type is
used for user-friendly strings, such as a Printer name, that, for used for user-friendly strings, such as a Printer name, that, for
humans, are more meaningful than identifiers. humans, are more meaningful than identifiers.
Note: Only the 'text' and 'name attribute syntaxes permit the Note: Only the 'text' and 'name' attribute syntaxes permit the
exception natural language mechanism. Natural Language Override mechanism.
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 values of the normally "printer-name" attribute is in German, the client MUST use Natural
single-valued "printer-name" attribute returned by the Printer in any Language Override as follows:
operation response would be the following two values, each tagged with
the appropriate attribute syntax ('naturalLanguage' and 'name') in the
protocol:
'de': exception natural language indicating German with the 'de': Natural Language Override indicating German
attribute syntax 'naturalLanguage' 'Farbdrucker': the Printer name in German
'Farbdrucker': the Printer name in German with attribute syntax
'name'
Expires May 7, 1998
4.1.3 'keyword' 4.1.3 'keyword'
The 'keyword' attribute syntax is a sequence of characters, length: 1 The 'keyword' attribute syntax is a sequence of characters, length: 1
to 255, containing only the US-ASCII [ASCII] encoded values for to 255, containing only the US-ASCII [ASCII] encoded values for
lowercase letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot lowercase letters ("a" - "z"), digits ("0" - "9"), hyphen ("-"), dot
("."), and underscore ("_"). The first character MUST be a lowercase ("."), and underscore ("_"). The first character MUST be a lowercase
letter. Furthermore, keywords SHALL be in U.S. English. letter. Furthermore, keywords 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 exception natural language mechanism, since values SHALL NOT use the Natural Language Override mechanism, since
they SHALL always be US-ASCII and U.S. English. When accepting they SHALL always be US-ASCII and U.S. English.
keywords from users and displaying keywords to users, clients SHOULD
localize the keywords to the charset and natural language of the user. Keywords are for use in the protocol. A user interface will likely
provide a mapping between protocol keywords and displayable user-
friendly words and phrases which are localized to the natural language
of the user. While the keywords specified in this document MAY be
displayed to users whose natural language is U.S. English, they MAY be
mapped to other U.S. English words for U.S. English users, since the
user interface is outside the scope of this document.
Expires April 14, 1998
In the definition for each attribute of this syntax type, the full set In the definition for each attribute of this syntax type, the full set
of defined keyword values for that attribute are listed. of defined keyword values for that attribute are listed.
When a keyword is used to represent an attribute (its name), it MUST When a keyword is used to represent an attribute (its name), it MUST
be unique within the full scope of all IPP objects and attributes. be unique within the full scope of all IPP objects and attributes.
When a keyword is used to represent a value of an attribute, it MUST When a keyword is used to represent a value of an attribute, it MUST
be unique just within the scope of that attribute. That is, the same be unique just within the scope of that attribute. That is, the same
keyword SHALL not be used for two different values within the same keyword 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.4 'enum'
The 'enum' attribute syntax is an enumerated integer value that is in The 'enum' attribute syntax is an enumerated integer value that is in
the range from -2**31 to 2**31 - 1. Each value has an associated the range from -2**31 (MIN) to 2**31 - 1 (MAX). Each value has an
'keyword' name. In the definition for each attribute of this syntax associated 'keyword' name. In the definition for each attribute of
type, the full set of possible values for that attribute are listed..
This syntax type is used for attributes for which there are enum Expires May 7, 1998
values assigned by other standards, such as SNMP MIBs. A number of this syntax type, the full set of possible values for that attribute
attribute enum values in this specification are also used for are listed. This syntax type is used for attributes for which there
corresponding attributes in other standards [RFC1759].. This syntax are enum values assigned by other standards, such as SNMP MIBs. A
type is not used for attributes to which the system administrator may number of attribute enum values in this specification are also used
assign values. Section 6 describes how the protocol can be extended for corresponding attributes in other standards [RFC1759]. This
with new enum values. Though this document includes a symbolic name syntax type is not used for attributes to which the system
for each enum value (in U.S. English), when accepting enum names from administrator may assign values. Section 6 describes how the protocol
users and displaying enum names to users, clients SHOULD localize the can be extended with new enum values.
names to the charset and natural language of the user.
Enum values are for use in the protocol. A user interface will
provide a mapping between protocol enum values and displayable user-
friendly words and phrases which are localized to the natural language
of the user. While the enum symbols specified in this document MAY be
displayed to users whose natural language is U.S. English, they MAY be
mapped to other U.S. English words for U.S. English users, since the
user interface is outside the scope of this document.
Note: SNMP MIBs use '2' for 'unknown' which corresponds to the IPP out
of band value 'unknown'. Therefore, most attributes of type 'enum'
often start at '3'.
4.1.5 'uri' 4.1.5 'uri'
The 'uri' attribute syntax is any valid Uniform Resource Identifier or The 'uri' attribute syntax is any valid Uniform Resource Identifier or
URI [RFC1630]. Most often, URIs are simply Uniform Resource Locators URI [RFC1630]. Most often, URIs are simply Uniform Resource Locators
or URLs [RFC1738] [RFC1808]. or URLs [RFC1738] [RFC1808].
4.1.6 'uriScheme' 4.1.6 'uriScheme'
The 'uriScheme' attribute syntax is a sequence of characters The 'uriScheme' attribute syntax is a sequence of characters
representing a URI scheme according to RFC 1738 [RFC1738]. Standard representing a URI scheme according to RFC 1738 [RFC1738]. Though RFC
values for this syntax type are the following keywords: 1736 requires that the values be case-insensitive, IPP requires all
lower case to simplify comparing by IPP clients and Printer objects.
Standard values for this syntax type are the following keywords:
'http': for HTTP schemed URIs (e.g., "http://...") 'http': for HTTP schemed URIs (e.g., "http://...")
'https': for HTTPS schemed URIs (e.g., https://...)
'ftp': for FTP schemed URIs (e.g., "ftp://...") 'ftp': for FTP schemed URIs (e.g., "ftp://...")
Expires April 14, 1998
'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:...")
4.1.7 'charSet' A Printer object MAY support any URI scheme that has been registered
with IANA [IANA-MT]
The 'charSet' attribute syntax is a standard identifier of a coded Expires May 7, 1998
character set and encoding scheme for labeling certain document 4.1.7 'charset'
contents and 'text' and 'name' attribute values. The syntax and
semantics of this attribute syntax are specified in RFC 2046 [RFC2046] The 'charset' attribute syntax is a standard identifier for a
and contained in the IANA character-set Registry [IANA-CS] according "charset". A charset is a coded character set and encoding scheme.
to the IANA procedures [IANA-CSa]. As specified in RFC 2046, the Charsets are used for labeling certain document contents and 'text'
values SHALL be case-insensitive and SHALL be in US-ASCII. When a and 'name' attribute values. The syntax and semantics of this
character-set in the IANA registry has more than one name (alias), the attribute syntax are specified in RFC 2046 [RFC2046] and contained in
name labeled as "(preferred MIME name)" SHALL be used. 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
the IANA registry has more than one name (alias), the name labeled as
"(preferred MIME name)", if present, SHALL be used.
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 conformance level 2 and 'name' attributes, SHALL be restricted to any characters
of ISO 10646 [ISO10646-1], so that accented letters SHALL NOT be defined by ISO 10646 [ISO10646-1].
represented with non-spacing accents. This same 'utf-8' value 'us-ascii': 7-bit American Standard Code for Information
supplied in the "document-format" operation attribute (see Interchange (ASCII), ANSI X3.4-1986 [ASCII]. That standard
Sections 3.2.1.1 and 3.3.1.1), MAY include level 3 of ISO 10646.
'US-ASCII': 7-bit American Standard Code for Information
Interchange (ASCII), ANSI X3.4-1986 [ASCII]. This 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]. This defines a coded character set that is Nr 1 [ISO8859-1]. That standard defines a coded character set
used by Latin languages in the Western Hemisphere and Western that is used by Latin languages in the Western Hemisphere and
Europe. US-ASCII is a subset charset. Western Europe. US-ASCII is a subset charset.
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 the 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.8 'naturalLanguage'
The 'naturalLanguage' attribute syntax is a standard identifier for a The 'naturalLanguage' attribute syntax is a standard identifier for a
natural language and optionally a country. The values for this syntax natural language and optionally a country. The values for this syntax
type are taken from RFC 1766 [RFC1766]. As specified in RFC 1766, the type are taken from RFC 1766 [RFC1766]. Though RFC 1766 requires that
values SHALL be case-insensitive and SHALL be in US-ASCII. Examples the values be case-insensitive US-ASCII, IPP requires all lower case
to simplify comparing by IPP clients and Printer objects. Examples
include: include:
Expires April 14, 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 'mimeType' 4.1.9 'mimeMediaType'
The 'mimeType' attribute syntax is the standard defined Internet Media The 'mimeMediaType' attribute syntax is the Internet Media Type
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
that in the absence of the charset parameter SHALL mean US-ASCII that in the absence of the charset parameter SHALL mean US-ASCII
rather than simply unspecified) [RFC2046]. rather than simply unspecified) [RFC2046].
'text/plain; charset=US-ASCII': A plain text document in US-ASCII 'text/plain; charset=US-ASCII': A plain text document in US-ASCII
skipping to change at page 47, line 37 skipping to change at page 53, line 36
8859-1 (Latin 1) [ISO8859-1]. 8859-1 (Latin 1) [ISO8859-1].
'text/plain; charset=utf-8': A plain text document in ISO 10646 'text/plain; charset=utf-8': A plain text document in ISO 10646
represented as UTF-8 [RFC2044] represented as UTF-8 [RFC2044]
'text/plain, charset=iso-10646-ucs-2': A plain text document in 'text/plain, charset=iso-10646-ucs-2': A plain text document in
ISO 10646 represented in two octets (UCS-2) [ISO10646-1] ISO 10646 represented in two octets (UCS-2) [ISO10646-1]
'application/postscript': A PostScript document [RFC2046] 'application/postscript': A PostScript document [RFC2046]
'application/vnd.hp-PCL': A PCL document [IANA-MT] (charset escape 'application/vnd.hp-PCL': A PCL document [IANA-MT] (charset escape
sequence embedded in the document data) sequence embedded in the document data)
'application/octet-stream': Auto-sense - see below 'application/octet-stream': Auto-sense - see below
One special type is 'application/octet-stream'. If the Printer One special type is 'application/octet-stream'. If the Printer object
object supports this value, the Printer object or the device SHALL be supports this value, the Printer object SHALL be capable of auto-
capable of auto-sensing the format of the document data. If the sensing the format of the document data. If the Printer object's
Printer object's default value attribute is set to 'application/octet- default value attribute "document-format" is set to
stream' the Printer object not only supports auto-sensing of the 'application/octet-stream', the Printer object not only supports auto-
document format, but will depend on the result of applying its auto- sensing of the document format, but will depend on the result of
sensing algorithm in the case of missing information not supplied by applying its auto-sensing when the client does not supply the
the client. If the client supplies a document format value, the "document-format" attribute. If the client supplies a document format
Printer SHOULD rely on the supplied attribute, rather than trust its value, the Printer SHOULD rely on the supplied attribute, rather than
auto-sensing algorithm. To summarize: trust its auto-sensing algorithm. To summarize:
1. If the client does not supply a document format value, the 1. If the client does not supply a document format value, the
Printer MUST rely on its default value setting (which may be Printer MUST rely on its default value setting (which may be
'application/octet-stream' indicating an auto-sensing mechanism). 'application/octet-stream' indicating an auto-sensing mechanism).
2. If the client supplies a value other than 'application/octet- 2. If the client supplies a value other than 'application/octet-
stream', the client is supplying valid information about the stream', the client is supplying valid information about the
format of the document data and the Printer object SHOULD trust format of the document data and the Printer object SHOULD trust
Expires April 14, 1998 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 SHOULD 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 SHOULD use its the client is indicating that the Printer object SHALL use its
auto-sensing mechanism whether auto-sensing is the Printer auto-sensing mechanism on the client supplied document data
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
client requests both auto-sensing ("document-format" set to
'application/octet-stream') and true fidelity ("ipp-attribute-
fidelity" set to 'true'), the Printer object might not be able to
guarantee exactly what the end user intended (the auto-sensing
algorithm might mistake one document format for another ), but it is
able to guarantee that its auto-sensing mechanism be used.
4.1.10 'octetString' 4.1.10 'octetString'
The 'octetString' attribute syntax is a sequence of octets. This The 'octetString' attribute syntax is a sequence of octets encoded in
syntax type is used for opaque data a maximum of 4095 octets. This syntax type is used for opaque data.
4.1.11 'boolean' 4.1.11 'boolean'
The 'boolean' attribute syntax is like a keyword with only two values The 'boolean' attribute syntax is similar to an enum with only two
'true' and 'false'. values: 'true' and 'false'.
4.1.12 'integer' 4.1.12 'integer'
The 'integer' attribute syntax is an integer value that is in the The 'integer' attribute syntax is an integer value that is in the
range from -2**31 to 2**31 - 1. Each individual attribute may specify range from -2**31 (MIN) to 2**31 - 1 (MAX). Each individual attribute
the range constraint explicitly if the range is different from the may specify the range constraint explicitly if the range is different
full range of possible integer values (e.g., 0 - 100 for the "job- from the full range of possible integer values (e.g., 0:100 for the
priority" attribute), however, the enforcement of that additional "job-priority" attribute), however, the enforcement of that additional
constraint is up to the IPP objects, not the protocol. constraint is up to the IPP objects, not the protocol.
4.1.13 'rangeOfInteger' 4.1.13 'rangeOfInteger'
The 'rangeOfInteger' attribute syntax is an ordered set of two The 'rangeOfInteger' attribute syntax is an ordered pair of integers
integers, the smallest first, followed by the largest. The pair of that defines an inclusive range of integer values. The first integer
integers identifies an inclusive range of integer values. specifies the lower bound and the second specifies the upper bound.
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'
(i.e., 'X:Y' indicating X as a minimum value and Y as a maximum
value), then the constraint applies to both integers.
4.1.14 'dateTime' 4.1.14 'dateTime'
The 'dateTime' attribute syntax is a standard, fixed length The 'dateTime' attribute syntax is a standard, fixed length, 11 octet
representation of the "DateAndTime" syntax as defined in RFC 1514 representation of the "DateAndTime" syntax as defined in RFC 1903
[RFC1514] and RFC 1903 [RFC1903]. When accepting 'dateTime' values [RFC1903]. RFC 1903 also identifies an 8 octet representation of a
from users and displaying 'dateTime' values to users, clients SHOULD "DateAndTime" value, but IPP objects MUST use the 11 octet
localize the values to the charset and natural language of the user. representation. When accepting 'dateTime' values from users and
displaying 'dateTime' values to users, clients SHOULD localize the
values to the charset and natural language of the user.
4.1.15 'resolution' 4.1.15 'resolution'
The 'resolution' attribute syntax specifies a two-dimensional The 'resolution' attribute syntax specifies a two-dimensional
resolution in the indicated units. It consists of 3 integers: a cross resolution in the indicated units. It consists of 3 integers: a cross
Expires April 14, 1998
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 dots per inch and dots per centimeter). All three
skipping to change at page 49, line 31 skipping to change at page 56, line 5
4.1.16 '1setOf X' 4.1.16 '1setOf X'
The '1setOf X' attribute syntax is 1 or more values of attribute The '1setOf X' attribute syntax is 1 or more values of attribute
syntax 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 "foo": Template attribute called "xxx":
1. The Printer object OPTIOINALLY supports a "foo-supported"
attribute that describes which job processing behaviors are
supported by that Printer object. A client can query the Printer
object to find out what foo-related behaviors are supported by
inspecting the returned values of the "foo-supported" attribute.
2. The Printer also OPTIONALLY supports a default value attribute
named "foo-default". This default value attribute describes what
will be done 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 the Printer supports either the "foo-
Expires April 14, 1998 1. If the Printer object supports "xxx" then it SHALL support both
default" default value attribute or the "foo-supported" a "xxx-default" default value attribute (unless there is a "No"
attribute, the Printer MUST support both. in the table below) and a "xxx-supported" supported values
attribute.
3. "foo" is OPTIOINALLY supplied by the client in a create request. 2. "xxx" is OPTIONALLY supplied by the client in a create request.
If "foo" is supplied, the client is specifying that the Printer If "xxx" is supplied, the client is indicating a desired job
SHALL apply the corresponding job processing behavior to this Job processing behavior for this Job. When "xxx" is not supplied, the
while processing the Job. When "foo" is not supplied, the client client is indicating that the Printer object apply its default job
is specifying that the Printer apply the default job processing processing behavior at job processing time if the document content
does not contain an embedded instruction indicating an xxx-related
behavior. behavior.
NOTE: Since an administrator MAY change the default value Note: Since an administrator MAY change the default value
attribute after a Job has been submitted but before it has been attribute after a Job object has been submitted but before it has
processed, the default value used by the Printer object at job been processed, the default value used by the Printer object at
processing time may be different that the default value in effect job processing time may be different that the default value in
at job submission time. effect at job submission time.
The "xxx-supported" attribute is a Printer object attribute that
describes which job processing behaviors are supported by that Printer
object. A client can query the Printer object to find out what xxx-
related behaviors are supported by inspecting the returned values of
the "xxx-supported" attribute. 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 for the supported values. The application SHOULD also the Printer object for its supported value attributes. The
query the default value attributes. If the application then limits application SHOULD also query the default value attributes. If the
selectable values to only those value that are supported, the application then limits selectable values to only those value that are
application can guarantee that the values supplied by the client in supported, the application can guarantee that the values supplied by
the create request all fall within the set of supported values at the the client in the create request all fall within the set of supported
Printer. When querying the Printer, the client MAY enumerate each values at the Printer. When querying the Printer, the client MAY
attribute by name in the Get-Attributes Request, or the client MAY enumerate each attribute by name in the Get-Attributes Request, or the
just name the "job-template" group in order to get the complete set of
supported attributes (both supported and default attributes). Expires May 7, 1998
client MAY just name the "job-template" group in order to get the
complete set of supported attributes (both supported and default
attributes).
The "finishings" attribute is an example of a Job Template attribute. The "finishings" attribute is an example of a Job Template attribute.
It can take on a set of values such as 'staple', 'punch', and/or It can take on a set of values such as 'staple', 'punch', and/or
'cover'. A client can query the Printer object for the "finishings- 'cover'. A client can query the Printer object for the "finishings-
supported" attribute and the "finishings-default" attribute. The supported" attribute and the "finishings-default" attribute. The
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. If the client does supply the "finishings"
attribute in the create request, the Printer validates the value or attribute in the create request, the Printer validates the value or
skipping to change at page 51, line 4 skipping to change at page 57, line 30
If the client-supplied values are all supported, the Job object is If the client-supplied values are all supported, the Job object is
created with a "finishings" attribute that is populated with the created with a "finishings" attribute that is populated with the
values supplied by the client. Subsequently, when the Job object is values supplied by the client. Subsequently, when the Job object is
queried, it returns the values supplied by the client. If the client queried, it returns the values supplied by the client. If the client
does not supply a "finishings" attribute in the create request, the does not supply a "finishings" attribute in the create request, the
Job object is created, but no "finishings" attribute is associated Job object is created, but no "finishings" attribute is associated
with the new Job object. A subsequent query of the Job object will with the new Job object. A subsequent query of the Job object will
return no "finishings" attribute. In this case, the querying client return no "finishings" attribute. In this case, the querying client
knows that there were was no client supplied "finishings" attribute. knows that there were was no client supplied "finishings" attribute.
If the client is interested to know what the default value is that the 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
Expires April 14, 1998 client can query the Printer object's default value "finishings-
Printer will use for the missing attribute, the client can query the default" attribute to find out how the Job will be finished, unless
Printer object's default value "finishings-default" attribute to find the document(s) contain embedded finishing instructions.
out how the Job will be finished.
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 shows the name and syntax for each Job Template attribute in the Job
object. These are the attributes that can optionally be supplied by object. These are the attributes that can optionally be supplied by
the client in a create request. The last two columns (labeled the client in a create request. The last two columns (labeled
"Printer: Default Value" and "Printer: Supported Values") shows the "Printer: Default Value" and "Printer: Supported Values") shows the
name and syntax for each Job Template attribute in the Printer object name and syntax for each Job Template attribute in the Printer object
(the default value attribute and the supported values attribute). A (the default value attribute and the supported values attribute). A
"No" in the table means the Printer SHALL NOT support the attribute "No" in the table means the Printer SHALL NOT support the attribute
(that is the attribute is simply not applicable). (that is the attribute is simply not applicable).
Expires April 14, 1998 Expires May 7, 1998
+===================+======================+======================+ +===================+======================+======================+
| Job Attribute |Printer: Default Value| Printer: Supported | | Job Attribute |Printer: Default Value| Printer: Supported |
| | Attribute | Values Attribute | | | Attribute | Values Attribute |
+===================+======================+======================+ +===================+======================+======================+
| job-sheets | job-sheets-default |job-sheets-supported |
| (type4 keyword, | (type4 keyword, |(1setOf type4 keyword,|
| name) | name) | name) |
| | | |
+-------------------+----------------------+----------------------+
| 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 type4 keyword,| | name) | (type4 keyword | |(1setOf |
| name) | name) | name) | | | name) | type4 keyword | name)|
+-------------------+----------------------+----------------------+
| job-sheets | job-sheets-default |job-sheets-supported |
| (type4 keyword | | (type4 keyword | |(1setOf
| 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)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| media | media-default | media-supported | | copies | copies-default | copies-supported |
| (type4 keyword, | (type4 keyword, |(1setOf type4 keyword,| | (integer (1:MAX)) | (integer (1:MAX)) | (integer (1:MAX)) |
| name) | name) | name) |
| | | |
| | | media-ready |
| | |(1setOf type4 keyword,|
| | | name) |
| | | | | | | |
| | copies-collated- | copies-collated- |
| | default | supported |
| | (integer (1:MAX)) | (integer (1:MAX)) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| number-up | number-up-default | number-up-supported | | finishings | finishings-default | finishings-supported |
| (integer) | (integer) |(1setOf integer) | |(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) |
| | | | +-------------------+----------------------+----------------------+
| page-ranges | No | page-ranges- |
| (1setOf | | supported (boolean) |
| rangeOfInteger | | |
| (1:MAX)) | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| sides | sides-default | sides-supported | | sides | sides-default | sides-supported |
| (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)| | (type2 keyword) | (type2 keyword) |(1setOf type2 keyword)|
| | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| printer-resolution| printer-resolution- | printer-resolution- | | number-up | number-up-default | number-up-supported |
| (resolution) | default | supported | | (integer (0:MAX)) | (integer (0:MAX)) |(1setOf integer |
| | (resolution) |(1setOf resolution) | | | | (0:MAX) | |
| | | rangeOfInteger |
| | | (0:MAX)) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| print-quality | print-quality-default| print-quality- | | orientation | orientation-default | orientation- |
| (type2 enum) | (type2 enum) | supported | | (type2 enum) | (type2 enum) | supported |
| | |(1setOf type2 enum) | | | |(1setOf type2 enum) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| finishings | finishings-default | finishings-supported |
Expires April 14, 1998 Expires May 7, 1998
|(1setOf type2 enum)|(1setOf type2 enum) |(1setOf type2 enum) | | media | media-default | media-supported |
| | | | | (type4 keyword | | (type4 keyword | |(1setOf |
+-------------------+----------------------+----------------------+ | name) | name) | type4 keyword | name)|
| copies | copies-default | copies-supported |
| (integer: 1:MAX) | (integer: 1:MAX) | (integer: 1:MAX) |
| | | |
| | | collated-copies- |
| | | supported |
| | | (integer: 1:MAX) |
| | | | | | | |
| | | media-ready |
| | |(1setOf |
| | | type4 keyword | name)|
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| page-ranges | No | page-ranges- | | printer-resolution| printer-resolution- | printer-resolution- |
| (1setOf | | supported (boolean) | | (resolution) | default | supported |
| rangeOfInteger) | | | | | (resolution) |(1setOf resolution) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| orientation | orientation-default | orientation- | | print-quality | print-quality-default| print-quality- |
| (type2 enum) | (type2 enum) | supported | | (type2 enum) | (type2 enum) | supported |
| | | (1setOf type2 enum) | | | | (1setOf type2 enum) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| document-format | document-format- | document-format- |
| (mimeType) | default | supported |
| | (mimeType) |(1setOf mimeType) |
+-------------------+----------------------+----------------------+
| compression | No | compression-supported| | compression | No | compression-supported|
| (type3 keyword) | |(1setOf type3 keyword)| | (type3 keyword) | |(1setOf type3 keyword)|
| | | |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| job-k-octets | No |job-k-octets-supported| | job-k-octets | No |job-k-octets-supported|
| (integer) | | (rangeOf integer) | | (integer (0:MAX)) | | (rangeOfInteger |
| | | | | | | (0:MAX)) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| job- | No | job-impressions- | | job- | No | job-impressions- |
| impressions | | supported | | impressions | | supported |
| (integer) | | (rangeOf integer) | | (integer (0:MAX)) | | (rangeOfInteger |
| | | (0:MAX)) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
| job-media- | No | job-media-sheets- | | job-media- | No | job-media-sheets- |
| sheets | | supported | | sheets | | supported |
| (integer) | | (rangeOf integer) | | (integer (0:MAX)) | | (rangeOfInteger) |
| | | (0:MAX)) |
+-------------------+----------------------+----------------------+ +-------------------+----------------------+----------------------+
4.2.1 job-sheets (type4 keyword, name) 4.2.1 job-priority (integer(1:100))
This attribute determines which if any banner page(s) SHALL be printed
with a job.
Standard values are:
Expires April 14, 1998
'none': no job sheet is printed
'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
An administrator MAY define additional values using the 'name' or
'keyword' attribute syntax, depending on implementation.
Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section
4.2.4).
4.2.2 job-priority (integer(1:100))
This attribute specifies a priority for scheduling the Job. A higher This attribute specifies a priority for scheduling the Job. A higher
value specifies a higher priority. The value 1 indicates the lowest value specifies a higher priority. The value 1 indicates the lowest
possible priority. The value 100 indicates the highest possible possible priority. The value 100 indicates the highest possible
priority. Among those jobs that are ready to print, a Printer SHALL priority. Among those jobs that are ready to print, a Printer 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.
The syntax for the "job-priority-supported" is an integer(1:100). If the Printer object supports this attribute, it SHALL always support
the full range from 1 to 100. No administrative restrictions are
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
implemented outside IPP/1.0, they SHALL have priorities higher than
100, rather than restricting the range available to end-users.
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. For example, if the value of "job-priority-supported" is supported. The Printer object SHALL take the value supplied by the
'3', then the Printer object supports 3 levels of job priorities client and map it to the closest integer in a sequence of n integers
(let's call them 'high', 'medium', and 'low'). In this case, a client values that are evenly distributed over the range from 1 to 100 using
MUST assume the following: the formula:
A client supplied value in the range 1-33 is the same as any other roundToNearestInt((100x+50)/n)
value in the range 1-33 and any one of those values corresponds
to the 'low' priority.
A client supplied value in the range 34-66 is the same as any other
value in the range 34-66 and any one of those values corresponds
to the 'medium' priority.
A client supplied value in the range 67-100 is the same as any
other value in the range 67-100 and any one of those values
corresponds to the 'high' priority.
For another example, if the value of "job-priority-supported" is '10', where n is the value of "job-priority-supported" and x ranges from 0
then the Printer object supports 3 levels of job priorities, (let's through n-1.
call them 'one', 'two', ..., and 'ten' with 'one' being the lowest
priority and 'ten' being the highest). In this case, a client MUST
assume the following:
A client supplied value in the range 1-10 is the same as any other For example, if n=1 the sequence of values is 50; if n=2, the
value in the range 1-10 and any one of those values corresponds sequence of values is: 25 and 75; if n = 3, the sequence of values
to the 'one' priority. 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
is: 1, 2, 3, _ 100.
Expires April 14, 1998 If the value of the Printer object's "job-priority-supported" is 10
A client supplied value in the range 11-20 is the same as any other and the client supplies values in the range 1 to 10, the Printer
value in the range 11-20 and any one of those values corresponds object maps them to 5, 11 to 20, the Printer object maps them to 15,
to the 'two' priority. etc.
...
A client supplied value in the range 91-100 is the same as any
other value in the range 91-100 and any one of those values
corresponds to the 'ten' priority.
4.2.3 job-hold-until (type4 keyword, name) 4.2.2 job-hold-until (type4 keyword | name)
This job attribute specifies the named time period during which the This attribute specifies the named time period during which the Job
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 'second-shift': second-shift (after close of business)
'third-shift': third-shift (after midnight) 'third-shift': third-shift (after midnight)
An administrator SHALL associate allowable print times with a named An administrator 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 no other job from the job's "job-state-reason" attribute and, if there are no other
reasons that keep it in the 'pending-held' state remain, the Printer job state reasons that keep the job in the 'pending-held' state
SHALL consider the job as a candidate for processing by moving the job remain, the Printer SHALL consider the job as a candidate for
to the 'pending' state. processing by moving the job to the 'pending' state.
If this job attribute value is the named value 'no-hold', or specified If this job attribute value is the named value 'no-hold', or the
time period is in effect 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.
Expires April 14, 1998 4.2.3 job-sheets (type4 keyword | name)
This attribute determines which job start/end sheet(s), if any, SHALL
be printed with a job.
Standard values are:
'none': no job sheet is printed
'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
An administrator MAY define additional values using the 'name' or
'keyword' attribute syntax, depending on implementation.
Note: The effect of this attribute on jobs with multiple documents MAY
be affected by the "multiple-document-handling" job attribute (section
4.2.4), depending on the job sheet semantics.
4.2.4 multiple-document-handling (type2 keyword) 4.2.4 multiple-document-handling (type2 keyword)
This job 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 print-stream pages into imposed pages and onto media placement of one or more print-stream pages into impressions and onto
sheets. When the value of the "copies" attribute exceeds 1, it also media sheets. When the value of the "copies" attribute exceeds 1, it
controls the order in which the copies that result from processing the also controls the order in which the copies that result from
documents are produced. For the purposes of this explanations, if "a" processing the documents are produced. For the purposes of this
represents an instance of document data, then the result of processing explanations, if "a" represents an instance of document data, then the
the data in document "a" is a sequence of media sheets represented by
"a(*)". Expires May 7, 1998
result of processing the data in document "a" is a sequence of media
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
seqeunces a(*),b(*). The Printer SHALL NOT force the data in sequences a(*),b(*). The Printer object SHALL NOT force the data
each document instance to be formatted onto a new print-stream in each document instance to be formatted onto a new print-stream
page, nor to start a new imposed page or a new media sheet. If page, nor to start a new impression on a new media sheet. If more
more than one copy is made, the ordering of the sets of media than one copy is made, the ordering of the sets of media sheets
sheets resulting from processing the document data SHALL be a(*), resulting from processing the document data SHALL be a(*), b(*),
b(*), a(*), b(*),...., and the Printer SHALL force each copy to a(*), b(*), ..., and the Printer object SHALL force each copy
start on a new media sheet. (a(*),b(*)) to start on a new media sheet.
'separate-documents-uncollated-copies': If a Job object has 'separate-documents-uncollated-copies': If a Job object has
multiple documents, say the document data is called a and b, then multiple documents, say, the document data is called a and b,
the result of processing the data in each document instance SHALL then the result of processing the data in each document instance
be treated as a single sequence of media sheets for finishing SHALL be treated as a single sequence of media sheets for
operations; that is, the sets a(*) and b(*) would each be finishing operations; that is, the sets a(*) and b(*) would each
finished separately. The Printer SHALL force each copy of the be finished separately. The Printer object SHALL force each copy
result of process the data in a single document to start on a new of the result of processing the data in a single document to
media sheet. If more than one copy is made, the ordering of the start on a new media sheet. If more than one copy is made, the
sets of media sheets resulting from processing the document data ordering of the sets of media sheets resulting from processing
SHALL be a(*), a(*), b(*), b(*) .... the document data SHALL be a(*), a(*), ..., b(*), b(*) ... .
'separate-documents-collated-copies': If a Job object has multiple 'separate-documents-collated-copies': If a Job object has multiple
documents, say the document data is called a and b, then the documents, say, the document data is called a and b, then the
result of processing the data in each document instance SHALL be result of processing the data in each document instance 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. If more than one copy is made, the ordering finished separately. The Printer object SHALL force each copy of
of the sets of media sheets resulting from processing the the result of processing the data in a single document to start
document data SHALL be a(*), b(*), a(*), b(*), ...., and the on a new media sheet. If more than one copy is made, the
Printer SHALL force each document copy to start on a new sheet . ordering of the sets of media sheets resulting from processing
the document data SHALL be a(*), b(*), a(*), b(*), ... .
'separate-documents-collated-copies' is the same as 'single-document'
with respect to ordering of pages, but not media sheet generation,
Expires April 14, 1998
since the latter will put the first 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 the former case always force the next document
or document copy on to a new sheet.
4.2.5 media (type4 keyword, name)
This job attribute identifies the medium that the Printer uses for all
pages of the Job.
The values for "media" include medium-names, medium-sizes, input-trays
and electronic forms so that one attribute specifies the media. If a
printer allows a client to specify a medium name as the value of this
attribute, such a medium name implicitly selects an input-tray that
contains the specified medium. If a printer allows a client to
specify a medium size as the value of this attribute, such a medium
size implicitly selects a medium name that in turn implicitly selects
an input-tray that contains the medium with the specified size. If a
printer allows a client to specify 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 time the job prints. This case includes manual-
feed input-trays. If a printer allows a client to specify an
electronic form as the value of this attribute, such an electronic
form implicitly selects a medium-name that in turn implicitly selects
an input-tray that contains the medium specified by the electronic
form. The electronic form also implicitly selects an image that the
Printer SHALL merge with the document data as its prints each page.
Standard values are (taken from ISO DPA and the Printer MIB) and are
listed in section 14. An administrator MAY define additional values
using the 'name' or 'keyword' attribute syntax, depending on
implementation.
There is also an additional attribute named "media-ready" which The 'single-document' value is the same as 'separate-documents-
differs from "media-supported" in that legal values only include the collated-copies' with respect to ordering of print-stream pages, but
subset of "media-supported" values that are physically loaded and not media sheet generation, since 'single-document' will put the first
ready for printing with no operator intervention required. 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-
documents-collated-copies' always forces the next document or document
copy on to a new sheet. In addition, if the _finishings_ attribute
specifies `staple', then with 'single-document', documents a and b are
stapled together as a single document, but with 'separate-documents-
collated-copies', documents a and b are stapled separately.
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.4.
4.2.6 number-up (integer) 4.2.5 copies (integer(1:MAX))
This job attribute specifies the number of source page-images to
impose upon a single side of an instance of a selected medium. For
example, if the value is
Expires April 14, 1998
'1': The Printer SHALL place one logical page on a single side of
an instance of the selected medium (MAY add some sort of
translation, scaling, or rotation).
'2': The Printer SHALL place two logical pages on a single side of
an instance of the selected medium (MAY add some sort of
translation, scaling, or rotation).
'4': The Printer SHALL place four logical pages on a single side of
an instance of the selected medium (MAY add some sort of
translation, scaling, or rotation).
This attribute primarily controls the translation, scaling and
rotation of page images, but a site may choose to add embellishments,
such as borders to each logical page.
Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section
4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
ISSUE: Steve Z.: should this section be changed to include "print-
stream page" and "layout page"?? rather than "source page" and
"logical page"?
4.2.7 sides (type2 keyword)
This attribute specifies how source page-images are to be imposed upon
the sides of an instance of a selected medium.
The standard values are: This attribute specifies the number of copies to be printed.
'one-sided': imposes each consecutive source page-image upon the On many devices the supported number of collated copies will be
same side of consecutive media sheets. limited by the number of physical output bins on the device, and may
'two-sided-long-edge': imposes each consecutive pair of source be different from the number of uncollated copies which can be
page-image upon front and back sides of consecutive media sheets, supported.
such that the orientation of each pair of source-pages on the
medium would be correct for the reader as if for binding on the
long edge. This imposition is sometimes called 'duplex' or
'head-to-head'.
'two-sided-short-edge': imposes each consecutive pair of source
page-image upon front and back sides of consecutive media sheets,
such that the orientation of each pair of source-pages on the
medium would be correct for the reader as if for binding on the
short edge. This imposition is sometimes called 'tumble' or
'head-to-toe'.
'two-sided-long-edge', 'two-sided-short-edge', 'tumble', and 'duplex' The "copies-supported" attribute is the limit on the number of
all work the same for portrait or landscape. However 'head-to-toe' is uncollated copies supported, i.e., the limit when the value of the
'tumble' in portrait but 'duplex' in landscape. 'head-to-head' also "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'.
Expires April 14, 1998 The "copies-default" attribute is the default for the number of
switches between 'duplex' and 'tumble' when using portrait and uncollated copies, i.e., the default when the value of the "multiple-
landscape modes. 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.4.
4.2.8 printer-resolution (resolution) 4.2.6 finishings (1setOf type2 enum)
This attribute identifies the resolution that Printer uses for a
certain Job.
4.2.9 print-quality (type2 enum)
This attribute specifies the print quality that the Printer SHALL use
for a certain Job.
The standard values are:
'3' 'draft': lowest quality available on the printer
'4' 'normal': normal or intermediate quality on the printer
'5' 'high': highest quality available on the printer
4.2.10 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 a particular Job. For uses for each copy of each printed document in the Job. For Jobs with
Jobs with multiple documents, the "multiple-document-handling" multiple documents, the "multiple-document-handling" attribute
attribute determines what constitutes a _copy_ for purposes of determines what constitutes a "copy" for purposes of finishing.
finishing.
Standard values are: Standard values are:
Value Symbolic Name and Description
'3' 'none': Perform no finishing '3' 'none': Perform no finishing
Expires May 7, 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
select a non-printed (or pre-printed) cover for the select a non-printed (or pre-printed) cover for the
document. This does not supplant the specification of a document. This does not supplant the specification of a
Expires April 14, 1998
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). 4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
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.11 copies (integer(1:2**31 - 1)) 4.2.7 page-ranges (1setOf rangeOfInteger (1:MAX))
This attribute specifies the number of copies to be printed. On many This attribute identifies the range(s) of print-stream pages that the
devices the supported number of collated copies will be limited by the Printer object uses for each copy of each document which are to be
number of physical output bins on the device, and may be different printed. Nothing is printed for any pages identified that do not
from the number of uncollated copies which can be supported. The exist in the document(s).
"copies-supported" attribute is the limit on the number of uncollated
copies supported. The "collated-copies-supported" attribute is the
limit on the number of collated copies supported. The value in the
"copies-default" default value attribute applies to either collated or
uncollated as determined by the value in the "multiple-document-
handling-default" attribute.
Note: The effect of this attribute on jobs with multiple documents is For Jobs with multiple documents, the "multiple-document-handling"
controlled by the "multiple-document-handling" job attribute (section attribute determines what constitutes a "copy" for purposes of the
4.2.4) and the relationship of this attribute and the other attributes specified page range(s). When "multiple-document-handling" is
that control document processing is described in section 15.4. 'single-document', the Printer object SHALL apply each supplied page
range once to the concatenation of the print-stream pages. For
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
document and none of the pages of the other documents are printed.
When "multiple-document-handling" is 'separate-document-uncollated-
copies' or 'separate-document-collated-copies', the Printer object
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
4.2.12 page-ranges (1setOf rangeOfInteger) Expires May 7, 1998
pages and the 10th page of each of the 8 documents in the Job, as 8
separate documents.
This attribute specifies the pages of a document which are to be In most cases, the exact pages to be printed will be generated by a
printed. In most cases, the exact pages to be printed will be device driver and this attribute would not be required. However, when
generated by a device driver and this attribute would not be required. printing an archived document which has already been formatted, the
However, when printing an archived document which has already been end user may elect to print just a subset of the pages contained in
formatted, the end user may elect to print just a subset of the pages the document. In this case, if page-range = n.m is specified, the
contained in the document. In this case, if page-range = n.m is first page to be printed will be page n. All subsequent pages of the
specified, the first page to be printed will be page n. All subsequent document will be printed through and including page m.
pages of the 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-
Expires April 14, 1998
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.
4.2.13 orientation (type2 enum) Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section
4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
This attribute specifies the orientation of the content on the output 4.2.8 sides (type2 keyword)
pages to be printed. In most cases, the orientation of the content is
specified within the document format generated by the device driver at This attribute specifies how print-stream pages are to be imposed upon
print time. However, some document formats (such as 'text/plain') do the sides of an instance of a selected medium (an impression).
not support the notion of page orientation, and it is possible to bind
the orientation after the document content has been generated. This The standard values are:
attribute provides an end user with the means to specify orientation
for such documents. 'one-sided': imposes each consecutive print-stream page upon the
same side of consecutive media sheets.
'two-sided-long-edge': imposes each consecutive pair of print-
stream pages upon front and back sides of consecutive media
sheets, such that the orientation of each pair of print-stream
pages on the medium would be correct for the reader as if for
binding on the long edge. This imposition is sometimes called
'duplex' or 'head-to-head'.
'two-sided-short-edge': imposes each consecutive pair of print-
stream pages upon front and back sides of consecutive media
sheets, such that the orientation of each pair of print-stream
pages on the medium would be correct for the reader as if for
binding on the short edge. This imposition is sometimes called
'tumble' or 'head-to-toe'.
'two-sided-long-edge', 'two-sided-short-edge', 'tumble', and 'duplex'
all work the same for portrait or landscape. However 'head-to-toe' is
'tumble' in portrait but 'duplex' in landscape. 'head-to-head' also
Expires May 7, 1998
switches between 'duplex' and 'tumble' when using portrait and
landscape modes.
Note: The effect of this attribute on jobs with multiple documents is
controlled by the "multiple-document-handling" job attribute (section
4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
4.2.9 number-up (integer(0:MAX))
This attribute specifies the number of print-stream pages to impose
upon a single side of an instance of a selected medium. For example,
if the value is
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
side of an instance of the selected medium (MAY add
some sort of translation, scaling, or rotation).
'2' The Printer SHALL place two print-stream pages on a single
side of an instance of the selected medium (MAY add
some sort of translation, scaling, or rotation).
'4' The Printer SHALL place four print-stream pages on a single
side of an instance of the selected medium (MAY add
some sort of translation, scaling, or rotation).
This attribute primarily controls the translation, scaling and
rotation of print-stream pages, but a site may choose to add
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
controlled by the "multiple-document-handling" job attribute (section
4.2.4) and the relationship of this attribute and the other attributes
that control document processing is described in section 15.4.
Expires May 7, 1998
4.2.10 orientation (type2 enum)
This attribute specifies the orientation of the content of the print-
stream pages to be printed. In most cases, the orientation of the
content is specified within the document format generated by the
device driver at print time. However, some document formats (such as
'text/plain') do not support the notion of page orientation, and it is
possible to bind the orientation after the document content has been
generated. This attribute provides an end user with the means to
specify orientation for such documents.
Standard values are: Standard values are:
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
edge of the medium. Landscape is defined to be a edge of the medium. Landscape is defined to be a
rotation of the logical page to be imaged by +90 rotation of the print-stream page to be imaged by +90
degrees with respect to the medium (i.e. anti- degrees with respect to the medium (i.e. anti-
clockwise) from the portrait orientation. Note: The clockwise) from the portrait orientation. Note: The
+90 direction was chosen because simple finishing on +90 direction was chosen because simple finishing on
the long edge is the same edge whether portrait or the long edge is the same edge whether portrait or
landscape landscape
'3' 'reverse-landscape': The content will be imaged across the '3' 'reverse-landscape': The content will be imaged across the
long edge of the medium. Reverse-landscape is defined long edge of the medium. Reverse-landscape is defined
to be a rotation of the logical page to be imaged by - to be a rotation of the print-stream page to be imaged
90 degrees with respect to the medium (i.e. clockwise) by -90 degrees with respect to the medium (i.e.
from the portrait orientation. Note: The 'reverse- clockwise) from the portrait orientation. Note: The
landscape' value was added because some applications 'reverse-landscape' value was added because some
rotate landscape -90 degrees from portrait, rather than applications rotate landscape -90 degrees from
+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.4.
4.2.14 document-format (mimeType) 4.2.11 media (type4 keyword | name)
This attribute identifies the document format of the data to be This attribute identifies the medium that the Printer uses for all
printed. The standard values for this attribute are Internet Media impressions of the Job.
types which are sometimes called MIME types. See the description of
the 'mimeType' attribute syntax in Section 4.1.9.
Expires April 14, 1998 The values for "media" include medium-names, medium-sizes, input-trays
4.2.15 compression (type3 keyword) and electronic forms so that one attribute specifies the media. If a
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
specified medium. If a Printer object supports a medium size as a
value of this attribute, such a medium size implicitly selects a
medium name that in turn implicitly selects an input-tray that
contains the medium with the specified size. If a Printer object
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
time the job prints. This case includes manual-feed input-trays. If
a Printer object supports an electronic form as the value of this
attribute, such an electronic form implicitly selects a medium-name
that in turn implicitly selects an input-tray that contains the medium
specified by the electronic form. The electronic form also implicitly
selects an image that the Printer SHALL merge with the document data
as its prints each page.
Standard values are (taken from ISO DPA and the Printer MIB) and are
listed in section 14. An administrator MAY define additional values
using the 'name' or 'keyword' attribute syntax, depending on
implementation.
There is also an additional Printer attribute named "media-ready"
which differs from "media-supported" in that legal values only include
the subset of "media-supported" values that are physically loaded and
ready for printing with no operator intervention required.
The relationship of this attribute and the other attributes that
control document processing is described in section 15.4.
4.2.12 printer-resolution (resolution)
This attribute identifies the resolution that Printer uses for the
Job.
4.2.13 print-quality (type2 enum)
This attribute specifies the print quality that the Printer uses for
the Job.
The standard values are:
Value Symbolic Name and Description
'3' 'draft': lowest quality available on the printer
'4' 'normal': normal or intermediate quality 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 This attribute identifies compression algorithms used on compressed
document data. The value of this attribute does not apply the document data. The value of this attribute does not apply to the
encoding of the IPP operation itself. encoding of the IPP operation itself.
Standard values are : Standard values are :
'none': no compression is used. 'none': no compression is used.
'deflate': ZIP public domain inflate/deflate) compression 'deflate': ZIP public domain inflate/deflate) compression
technology technology
`gzip' GNU zip compression technology described in RFC 1952. `gzip' GNU zip compression technology described in RFC 1952.
'compress': UNIX compression technology 'compress': UNIX compression technology
4.2.16 job-k-octets (integer(0:2**31 - 1)) 4.2.15 job-k-octets (integer(0:MAX))
This attribute specifies the total size of the document data in K 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 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 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, 1024 octets SHALL be indicated as being 1, 1025 to 2048 SHALL be 2,
etc. etc.
This value SHALL not include the multiplicative factors contributed by This value SHALL not include the multiplicative factors contributed by
the number of copies specified by the "copies" attribute, independent the number of copies specified by the "copies" attribute, independent
of whether the device can process multiple copies without making of whether the device can process multiple copies without making
multiple passes over the document data and independent of whether the multiple passes over the document data and independent of whether the
output is collated or not. Thus the value is independent of the output is collated or not. Thus the value is independent of the
implementation. 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- Note: This attribute and the following two attributes ("job-
impressions" and "job-media-sheets") are not intended to be counters; impressions" and "job-media-sheets") are not intended to be counters;
they are intended to be useful routing and scheduling information if they are intended to be useful routing and scheduling information if
known. For these three attributes, the Printer may try to compute the known. For these three attributes, the Printer object may try to
value if it is not supplied in the create request. Even if the client compute the value if it is not supplied in the create request. Even
does supply a value for this attribute in the create request, the if the client does supply a value for these three attributes in the
Printer may choose to change the value if the Printer is able to create request, the Printer object MAY choose to change the value if
compute a value which is more accurate than the client supplied value. the Printer object is able to compute a value which is more accurate
The Printer may be able to determine the correct value for this than the client supplied value. The Printer object may be able to
attribute either right at job submission time or at any later point in determine the correct value for these three attributes either right at
time. If the value of this attribute is unknown, the Printer may job submission time or at any later point in time. If the value of
choose to respond with a value of '-2' (which signifies "unknown")
rather than choose to not support the attribute at all.
4.2.17 job-impressions (integer(0:2**31 - 1)) 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 This attribute specifies the total number of impressions of the
document(s) being requested by this job to produce. document(s) being requested by this job to produce.
Expires April 14, 1998
This value SHALL not include the multiplicative factors contributed by This value SHALL not include the multiplicative factors contributed by
the number of copies specified by the "copies" attribute, independent the number of copies specified by the "copies" attribute, independent
of whether the device can process multiple copies without making of whether the device can process multiple copies without making
multiple passes over the document data and independent of whether the multiple passes over the document data and independent of whether the
output is collated or not. Thus the value is independent of the output is collated or not. Thus the value is independent of the
implementation. implementation.
4.2.18 job-media-sheets (integer(0:2**31 - 1)) 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 This attribute specifies the total number of media sheets to be
processed for this job. processed for this job.
Unlike the "job-k-octets" and the "job-impressions" attributes, this Unlike the "job-k-octets" and the "job-impressions" attributes, this
value SHALL include the multiplicative factors contributes by the value SHALL include the multiplicative factors contributed by the
number of copies specified by the "copies" attribute 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
that MUST be supported by Printer objects. If it is not MANDATORY, that MUST be supported by Printer objects. If it is not MANDATORY,
then it is OPTIONAL. then it is OPTIONAL.
Expires April 14, 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 | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-originating-user | octetString | MANDATORY | | job-originating-user-name | name | 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 | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| number-of-documents | integer | | | number-of-documents | integer (0-MAX) | |
+----------------------------+----------------------+----------------+
| containing-printer-uri | uri | MANDATORY |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| output-device-assigned | name | | | output-device-assigned | name | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-of-creation | integer | | | time-at-creation | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-at-processing | integer | | | time-at-processing | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| time-at-completed | integer | | | time-at-completed | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| number-of-intervening-jobs | integer | | | number-of-intervening-jobs | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-message-from-operator | text | | | job-message-from-operator | text | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-k-octets-processed | integer | | | job-k-octets-processed | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-impressions-completed | integer | | | job-impressions-completed | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| job-media-sheets-completed | integer | | | job-media-sheets-completed | integer (0:MAX) | |
+----------------------------+----------------------+----------------+ +----------------------------+----------------------+----------------+
| 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)
Expires April 14, 1998 This MANDATORY attribute contains the URI for the job. The Printer
This attribute contains the URI for the job. The Printer, on receipt object, on receipt of a new job, generates a URI which identifies the
of a new job, generates a URI which identifies the new Job on that new Job on that Printer object. The Printer object returns the value
Printer. The Printer returns the value of the "job-uri" attribute as of the "job-uri" attribute as part of the response to a create
part of the response to a create request. This MUST be an HTTP request. This MUST be an HTTP schemed URI, however the precise
schemed URI, however the precise format of a Job URI is implementation format of a Job URI is implementation dependent.
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 attribute contains the ID of the job. The Printer, on receipt of This MANDATORY attribute contains the ID of the job. The Printer, on
a new job, generates an ID which identifies the new Job on that receipt of a new job, generates an ID which identifies the new Job on
Printer. The Printer returns the value of the "job-id" attribute as that Printer. The Printer returns the value of the "job-id" attribute
part of the response to a create request. as part of the response to a create request. The 0 value is not used
for compatibility with SNMP index values which cannot be 0.
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)
This attribute is the name of the job. It is a name that is more user This MANDATORY attribute is the name of the job. It is a name that is
friendly than the "job-uri" attribute value. It does not need to be more user friendly than the "job-uri" attribute value. It does not
unique between Jobs. The Job's "job-name" attribute is set to the need to be unique between Jobs. The Job's "job-name" attribute is set
value supplied by the client in the "job-name" operation attribute in to the value supplied by the client in the "job-name" operation
the create request. If, however, if the "job-name" operation attribute in the create request (see Section 3.2.1.1). If, however,
attribute is not supplied by the client in the create request, the the "job-name" operation attribute is not supplied by the client in
Printer, on creation of the Job, SHALL generate a name. The printer the create request, the Printer object, on creation of the Job, SHALL
SHOULD generate the value of the Job's "job-name" attribute from the generate a name. The printer SHOULD generate the value of the Job's
first of the following sources that produces a value: 1) the "job-name" attribute from the first of the following sources that
"document-URI" attribute of the first (or only) document, 2) the produces a value: 1) the "document-name" operation attribute of the
"document-name" operation attribute of the first (or only) document, first (or only) document, 2) the "document-URI" attribute of the first
or 3) any other piece of Job specific information.
4.3.5 job-originating-user (octetString) Expires May 7, 1998
(or only) document, or 3) any other piece of Job specific and/or
Document Content information.
This attribute contains the identity of the end user that submitted 4.3.5 job-originating-user-name (name)
the print job. The Printer object sets this attribute to the most
Expires April 14, 1998 This MANDATORY attribute contains the name of the end user that
authenticated name that it can obtain from the authentication service submitted the print job. The Printer object sets this attribute to
over which the IPP operation was received. the most authenticated printable name that it can obtain from the
authentication service over which the IPP operation was received.
Only if such is not available, does the Printer object use the value
supplied by the client in the "requesting-user-name" operation
attribute of the create operation. See Section 3.1.5.
Note: The Printer object needs to keep an internal originating user
id of some form, typically as a credential of a principal, with the
Job object. Since such an internal attribute is implementation-
dependent and not of interest to clients, it is not specified as a Job
Description attribute. This originating user id is used for
authorization checks (if any) on all subsequent operation.
4.3.6 job-state (type1 enum) 4.3.6 job-state (type1 enum)
This attribute identifies the current state of the job. Even though This MANDATORY attribute identifies the current state of the job.
the IPP protocol defines eight values for job states, implementations Even though the IPP protocol defines eight values for job states,
only need to support those states which are appropriate for the implementations only need to support those states which are
particular implementation. In other words, a Printer supports only appropriate for the particular implementation. In other words, a
those job states implemented by the output device and available to the Printer supports only those job states implemented by the output
Printer object implementation. device and available to the Printer object implementation.
Standard values are: Standard values are:
'unknown'(2): The job state is not known, or its state is Values Symbolic Name and Description
indeterminate.
'pending'(3): The job is a candidate to start processing, but is
not yet processing.
'pending-held'(4): The job is not a candidate for processing for
any number of reasons but will return to the 'pending' state as
soon as the reasons are no longer present. The job's "job-state-
reason" attribute SHALL indicate why the job is no longer a
candidate for processing.
'processing'(5): One or more of:
1. the job is using, or is attempting to use, one or more purely
software processes that are analyzing, creating, or
interpreting a PDL, etc.,
2. the job is using, or is attempting to use, one or more
hardware devices that are interpreting a PDL, making marks on
a medium, and/or performing finishing, such as stapling, etc.,
3. the server has made the job ready for printing, but the output
device is not yet printing it, either because the job hasn't
reached the output device or because the job is queued in the
output device or some other spooler, awaiting the output
device to print it.
Implementations MAY, though they NEED NOT, include additional '3' 'pending': The job is a candidate to start processing, but
values in the job's "job-state-reasons" attribute to indicate the is not yet processing.
progress of the job, such as adding the 'job-printing' value to
indicate when the device is actually making marks on a medium.
When the job is in the 'processing' state, the entire job state
includes the detailed status represented in the printer's
"printer-state", "printer-state-reasons", and "printer-state-
message" attributes.
Implementations MAY include additional values in the job's "job-
state-reasons" attribute to indicate the progress of the job,
such as adding the 'job-printing' value to indicate when the
output device is actually making marks on paper and/or the
Expires April 14, 1998 '4' 'pending-held': The job is not a candidate for processing
'processing-to-stop-point' value to indicate that the server or for any number of reasons but will return to the
device is in the process of canceling or aborting the job. Most 'pending' state as soon as the reasons are no longer
implementations won't bother with this nuance. present. The job's "job-state-reason" attribute SHALL
'processing-stopped'(6): The job has stopped while processing for indicate why the job is no longer a candidate for
any number of reasons and will return to the 'processing' state processing.
as soon as the reasons are no longer present.
The job's "job-state-reason" attribute MAY indicate why the job '5' 'processing': One or more of:
has stopped processing. For example, if the output device is
stopped, the 'printer-stopped' value MAY be included in the job's
"job-state-reasons" attribute.
Note: When an output device is stopped, the device usually Expires May 7, 1998
indicates its condition in human readable form locally at the 1. the job is using, or is attempting to use, one or
device. A client can obtain more complete device status remotely more purely software processes that are analyzing,
by querying the printer's "printer-state", "printer-state- creating, or interpreting a PDL, etc.,
reasons" and "printer-state-message" attributes. 2. the job is using, or is attempting to use, one or
more hardware devices that are interpreting a PDL,
making marks on a medium, and/or performing finishing,
such as stapling, etc.,
3. the Printer object has made the job ready for
printing, but the output device is not yet printing it,
either because the job hasn't reached the output device
or because the job is queued in the output device or
some other spooler, awaiting the output device to print
it.
'canceled'(7): The job has been canceled by a Cancel-Job operation When the job is in the 'processing' state, the entire
and the Printer has completed canceling the job and all job job state includes the detailed status represented in
status attributes have reached their final values for the job. the printer's "printer-state", "printer-state-reasons",
While the Printer is canceling the job, the job's "job-state- and "printer-state-message" attributes.
reasons" attribute SHOULD contain the 'processing-to-stop-point' Implementations MAY, though they NEED NOT, include
value and one of the 'canceled-by-user', 'canceled-by-operator', additional values in the job's "job-state-reasons"
or 'canceled-at-device' value. attribute to indicate the progress of the job, such as
'aborted'(8): The job has been aborted by the system, usually adding the 'job-printing' value to indicate when the
while the job was in the 'processing' or 'processing-stopped' output device is actually making marks on paper and/or
state and the Printer has completed aborting the job and all job