Previous | Next

Frontpage | Contents | Keywords

Internet Printing Protocol/1.1: Model and Semantics

1. Introduction

1.1. Simplified Printing Model

2. IPP Objects

2.1. Printer Object

2.2. Job Object

2.3. Object Relationships

2.4. Object Identity

3. IPP Operations

3.1. Common Semantics

3.1.1. Required Parameters

3.1.2. Operation IDs and Request IDs

3.1.3. Attributes

3.1.4. Character Set and Natural Language Operation Attributes

3.1.4.1. Request Operation Attributes

3.1.4.2. Response Operation Attributes

3.1.5. Operation Targets

3.1.6. Operation Response Status Codes and Status Messages

3.1.6.1. "status-code" (type2 enum)

3.1.6.2. "status-message" (text(255))

3.1.6.3. "detailed-status-message" (text(MAX))

3.1.6.4. "document-access-error" (text(MAX))

3.1.7. Unsupported Attributes

3.1.8. Versions

3.1.9. Job Creation Operations

3.2. Printer Operations

3.2.1. Print-Job Operation

3.2.1.1. Print-Job Request

3.2.1.2. Print-Job Response

3.2.2. Print-URI Operation

3.2.3. Validate-Job Operation

3.2.4. Create-Job Operation

3.2.5. Get-Printer-Attributes Operation

3.2.5.1. Get-Printer-Attributes Request

3.2.5.2. Get-Printer-Attributes Response

3.2.6. Get-Jobs Operation

3.2.6.1. Get-Jobs Request

3.2.6.2. Get-Jobs Response

3.2.7. Pause-Printer Operation

3.2.7.1. Pause-Printer Request

3.2.7.2. Pause-Printer Response

3.2.8. Resume-Printer Operation

3.2.9. Purge-Jobs Operation

3.3. Job Operations

3.3.1. Send-Document Operation

3.3.1.1. Send-Document Request

3.3.1.2. Send-Document Response

3.3.2. Send-URI Operation

3.3.3. Cancel-Job Operation

3.3.3.1. Cancel-Job Request

3.3.3.2. Cancel-Job Response

3.3.4. Get-Job-Attributes Operation

3.3.4.1. Get-Job-Attributes Request

3.3.4.2. Get-Job-Attributes Response

3.3.5. Hold-Job Operation

3.3.5.1. Hold-Job Request

3.3.5.2. Hold-Job Response

3.3.6. Release-Job Operation

3.3.7. Restart-Job Operation

3.3.7.1. Restart-Job Request

3.3.7.2. Restart-Job Response

4. Object Attributes

4.1. Attribute Syntaxes

4.1.1. 'text'

4.1.1.1. 'textWithoutLanguage'

4.1.1.2. 'textWithLanguage'

4.1.2. 'name'

4.1.2.1. 'nameWithoutLanguage'

4.1.2.2. 'nameWithLanguage'

4.1.2.3. Matching 'name' attribute values

4.1.8. 'naturalLanguage'

4.1.9. 'mimeMediaType'

4.1.9.1. Application/octet-stream -- Auto-Sensing the document format

4.1.10. 'octetString'

4.1.11. 'boolean'

4.1.12. 'integer'

4.1.13. 'rangeOfInteger'

4.1.14. 'dateTime'

4.1.15. 'resolution'

4.1.16. '1setOf X'

4.2. Job Template Attributes

4.2.1. job-priority (integer(1:100))

4.2.2. job-hold-until (type3 keyword | name (MAX))

4.2.3. job-sheets (type3 keyword | name(MAX))

4.2.4. multiple-document-handling (type2 keyword)

4.2.5. copies (integer(1:MAX))

4.2.6. finishings (1setOf type2 enum)

4.2.7. page-ranges (1setOf rangeOfInteger (1:MAX))

4.2.8. sides (type2 keyword)

4.2.9. number-up (integer(1:MAX))

4.2.10. orientation-requested (type2 enum)

4.2.11. media (type3 keyword | name(MAX))

4.2.12. printer-resolution (resolution)

4.2.13. print-quality (type2 enum)

4.3. Job Description Attributes

4.3.1. job-uri (uri)

4.3.2. job-id (integer(1:MAX))

4.3.3. job-printer-uri (uri)

4.3.4. job-more-info (uri)

4.3.5. job-name (name(MAX))

4.3.6. job-originating-user-name (name(MAX))

4.3.7. job-state (type1 enum)

4.3.7.1. Forwarding Servers

4.3.7.2. Partitioning of Job States

4.3.8. job-state-reasons (1setOf type2 keyword)

4.3.9. job-state-message (text(MAX))

4.3.10. job-detailed-status-messages (1setOf text(MAX))

4.3.11. job-document-access-errors (1setOf text(MAX))

4.3.12. number-of-documents (integer(0:MAX))

4.3.13. output-device-assigned (name(127))

4.3.14. Event Time Job Description Attributes

4.3.14.1. time-at-creation (integer(MIN:MAX))

4.3.14.2. time-at-processing (integer(MIN:MAX))

4.3.14.3. time-at-completed (integer(MIN:MAX))

4.3.14.4. job-printer-up-time (integer(1:MAX))

4.3.14.5. date-time-at-creation (dateTime)

4.3.14.6. date-time-at-processing (dateTime)

4.3.14.7. date-time-at-completed (dateTime)

4.3.15. number-of-intervening-jobs (integer(0:MAX))

4.3.16. job-message-from-operator (text(127))

4.3.17. Job Size Attributes

4.3.17.1. job-k-octets (integer(0:MAX))

4.3.17.2. job-impressions (integer(0:MAX))

4.3.17.3. job-media-sheets (integer(0:MAX))

4.3.18. Job Progress Attributes

4.3.18.1. job-k-octets-processed (integer(0:MAX))

4.3.18.2. job-impressions-completed (integer(0:MAX))

4.3.18.3. job-media-sheets-completed (integer(0:MAX))

4.3.19. attributes-charset (charset)

4.3.20. attributes-natural-language (naturalLanguage)

4.4. Printer Description Attributes

4.4.1. printer-uri-supported (1setOf uri)

4.4.2. uri-authentication-supported (1setOf type2 keyword)

4.4.3. uri-security-supported (1setOf type2 keyword)

4.4.4. printer-name (name(127))

4.4.5. printer-location (text(127))

4.4.6. printer-info (text(127))

4.4.7. printer-more-info (uri)

4.4.8. printer-driver-installer (uri)

4.4.9. printer-make-and-model (text(127))

4.4.10. printer-more-info-manufacturer (uri)

4.4.11. printer-state (type1 enum)

4.4.12. printer-state-reasons (1setOf type2 keyword)

4.4.13. printer-state-message (text(MAX))

4.4.14. ipp-versions-supported (1setOf type2 keyword)

4.4.15. operations-supported (1setOf type2 enum)

4.4.16. multiple-document-jobs-supported (boolean)

4.4.17. charset-configured (charset)

4.4.18. charset-supported (1setOf charset)

4.4.19. natural-language-configured (naturalLanguage)

4.4.20. generated-natural-language-supported (1setOf naturalLanguage)

4.4.21. document-format-default (mimeMediaType)

4.4.22. document-format-supported (1setOf mimeMediaType)

4.4.23. printer-is-accepting-jobs (boolean)

4.4.24. queued-job-count (integer(0:MAX))

4.4.25. printer-message-from-operator (text(127))

4.4.26. color-supported (boolean)

4.4.27. reference-uri-schemes-supported (1setOf uriScheme)

4.4.28. pdl-override-supported (type2 keyword)

4.4.29. printer-up-time (integer(1:MAX))

4.4.30. printer-current-time (dateTime)

4.4.31. multiple-operation-time-out (integer(1:MAX))

4.4.32. compression-supported (1setOf type3 keyword)

4.4.33. job-k-octets-supported (rangeOfInteger(0:MAX))

4.4.34. job-impressions-supported (rangeOfInteger(0:MAX))

4.4.35. job-media-sheets-supported (rangeOfInteger(0:MAX))

4.4.36. pages-per-minute (integer(0:MAX))

4.4.37. pages-per-minute-color (integer(0:MAX))

5. Conformance

5.1. Client Conformance Requirements

5.2. IPP Object Conformance Requirements

5.2.1. Objects

5.2.2. Operations

5.2.3. IPP Object Attributes

5.2.4. Versions

5.2.5. Extensions

5.2.6. Attribute Syntaxes

5.2.7. Security

5.3. Charset and Natural Language Requirements

6. IANA Considerations

6.1. Typed 'keyword' and 'enum' Extensions

6.2. Attribute Extensibility

6.3. Attribute Syntax Extensibility

6.4. Operation Extensibility

6.5. Attribute Group Extensibility

6.6. Status Code Extensibility

6.7. Out-of-band Attribute Value Extensibility

6.8. Registration of MIME types/sub-types for document-formats

6.9. Registration of charsets for use in 'charset' attribute values

7. Internationalization Considerations

8. Security Considerations

8.1. Security Scenarios

8.1.1. Client and Server in the Same Security Domain

8.1.2. Client and Server in Different Security Domains

8.1.3. Print by Reference

8.2. URIs in Operation, Job, and Printer attributes

8.3. URIs for each authentication mechanisms

8.4. Restricted Queries

8.5. Operations performed by operators and system administrators

8.6. Queries on jobs submitted using non-IPP protocols

9. References

10. Authors' Addresses

11. Formats for IPP Registration Proposals

11.1. Type2 keyword attribute values registration,

11.2. Type3 keyword attribute values registration

11.3. Type2 enum attribute values registration

11.4. Type3 enum attribute values registration

11.5. Attribute registration

11.6. Attribute Syntax registration

11.7. Operation registration

11.8. Attribute Group registration

11.9. Status code registration

11.10. Out-of-band Attribute Value registration

12. APPENDIX A: Terminology

12.1. Conformance Terminology

12.1.1. NEED NOT

12.2. Model Terminology

12.2.1. Keyword

12.2.2. Attributes

12.2.2.1. Attribute Name

12.2.2.2. Attribute Group Name

12.2.2.3. Attribute Value

12.2.2.4. Attribute Syntax

12.2.3. Supports

12.2.4. print-stream page

12.2.5. impression

13. APPENDIX B: Status Codes and Suggested Status Code Messages

13.1. Status Codes

13.1.1. Informational

13.1.2. Successful Status Codes

13.1.2.1. successful-ok (0x0000)

13.1.2.2. successful-ok-ignored-or-substituted-attributes (0x0001)

13.1.2.3. successful-ok-conflicting-attributes (0x0002)

13.1.3. Redirection Status Codes

13.1.4. Client Error Status Codes

13.1.4.1. client-error-bad-request (0x0400)

13.1.4.2. client-error-forbidden (0x0401)

13.1.4.3. client-error-not-authenticated (0x0402)

13.1.4.4. client-error-not-authorized (0x0403)

13.1.4.5. client-error-not-possible (0x0404)

13.1.4.6. client-error-timeout (0x0405)

13.1.4.7. client-error-not-found (0x0406)

13.1.4.8. client-error-gone (0x0407)

13.1.4.9. client-error-request-entity-too-large (0x0408)

13.1.4.10. client-error-request-value-too-long (0x0409)

13.1.4.11. client-error-document-format-not-supported (0x040A)

13.1.4.12. client-error-attributes-or-values-not-supported (0x040B)

13.1.4.13. client-error-uri-scheme-not-supported (0x040C)

13.1.4.14. client-error-charset-not-supported (0x040D)

13.1.4.15. client-error-conflicting-attributes (0x040E)

13.1.4.16. client-error-compression-not-supported (0x040F)

13.1.4.17. client-error-compression-error (0x0410)

13.1.4.18. client-error-document-format-error (0x0411)

13.1.4.19. client-error-document-access-error (0x0412)

13.1.5. Server Error Status Codes

13.1.5.1. server-error-internal-error (0x0500)

13.1.5.2. server-error-operation-not-supported (0x0501)

13.1.5.3. server-error-service-unavailable (0x0502)

13.1.5.4. server-error-version-not-supported (0x0503)

13.1.5.5. server-error-device-error (0x0504)

13.1.5.6. server-error-temporary-error (0x0505)

13.1.5.7. server-error-not-accepting-jobs (0x0506)

13.1.5.8. server-error-busy (0x0507)

13.1.5.9. server-error-job-canceled (0x0508)

13.1.5.10. server-error-multiple-document-jobs-not-supported (0x0509)

13.2. Status Codes for IPP Operations

14. APPENDIX C: "media" keyword values

14.1. Examples

15. APPENDIX D: Processing IPP Attributes

15.1. Fidelity

15.2. Page Description Language (PDL) Override

15.3. Using Job Template Attributes During Document Processing.

16. APPENDIX E: Generic Directory Schema

17. APPENDIX F: Differences between the IPP/1.0 and IPP/1.1 "Model and Semantics" Documents

18. Full Copyright Statement

19. Acknowledgement

Previous | Next

Frontpage | Contents | Keywords

RFC-Ref.org

Sister Sites

Chess-Ref.org
Law-Ref.org
InChI.info
Zvon.org