[IPP] Descriptions of CUPS additions to the Cancel-Job and Purge-Jobs operations

[IPP] Descriptions of CUPS additions to the Cancel-Job and Purge-Jobs operations

Michael Sweet msweet at apple.com
Mon Sep 14 21:41:01 UTC 2009


All,

Here are the descriptions for the CUPS additions to the Cancel-Job and  
Purge-Jobs operations. These came up in today's conference call...

------------------------------------------------------

Cancel Job Operation

The Cancel-Job operation (0x0008) cancels the specified job. CUPS 1.4  
adds a new purge-job (boolean) attribute that allows you to purge both  
active and completed jobs, removing all history and document files for  
the job as well.

Cancel-Job Request

The following groups of attributes are supplied as part of the Cancel- 
Job request:

Group 1: Operation Attributes

Natural Language and Character Set:
     The "attributes-charset" and "attributes-natural-language"  
attributes as described in section 3.1.4.1 of the IPP Model and  
Semantics document.

"printer-uri" (uri) and "job-id" (integer)
OR
"job-uri":
     The client MUST supply a URI for the specified printer and a job  
ID number, or the job URI.

"purge-job" (boolean):
     The client OPTIONALLY supplies this attribute. When true, all job  
files (history and document) are purged. The default is false, leading  
to the standard IPP behavior.


Cancel-Job Response

The following groups of attributes are send as part of the Cancel-Job  
Response:

Group 1: Operation Attributes

Status Message:
     The standard response status message.

Natural Language and Character Set:
     The "attributes-charset" and "attributes-natural-language"  
attributes as described in section 3.1.4.2 of the IPP Model and  
Semantics document.


Purge-Jobs Operation

The Purge-Jobs operation (0x0012) cancels all of the jobs on a given  
destination and optionally removes all history and document files for  
the jobs as well.

Purge-Jobs Request

The following groups of attributes are supplied as part of the Purge- 
Jobs request:

Group 1: Operation Attributes

Natural Language and Character Set:
     The "attributes-charset" and "attributes-natural-language"  
attributes as described in section 3.1.4.1 of the IPP Model and  
Semantics document.

"printer-uri" (uri):
     The client MUST supply a URI for the specified printer or "ipp://.../printers 
" for all printers and classes.

"requesting-user-name" (name(MAX)):
     The client OPTIONALLY supplies this attribute to specify whose  
jobs jobs are purged or canceled.

"my-jobs" (boolean):
     The client OPTIONALLY supplies this attribute to specify that  
only the jobs owned by the requesting user are purged or canceled. The  
default is false.

"purge-jobs" (boolean):
     The client OPTIONALLY supplies this attribute to specify whether  
the jobs are purged (true) or just canceled (false). The default is  
true.


Purge-Jobs Response

The following groups of attributes are send as part of the Purge-Jobs  
Response:

Group 1: Operation Attributes

Status Message:
     The standard response status message.

Natural Language and Character Set:
     The "attributes-charset" and "attributes-natural-language"  
attributes as described in section 3.1.4.2 of the IPP Model and  
Semantics document.


___________________________________________________
Michael Sweet, Senior Printing System Engineer




-- 
This message has been scanned for viruses and
dangerous content by MailScanner, and is
believed to be clean.




More information about the ipp mailing list