Changeset b3a56af for server/lib/gutenbach/server/requests.py

Timestamp:

Jan 22, 2012, 12:15:47 AM (12 years ago)

Author:

Jessica B. Hamrick <jhamrick@…>

Branches:

no-cups

Children:

97f20dd

Parents:

17eb586

git-author:

Jessica B. Hamrick <jhamrick@…> (01/22/12 00:15:47)

git-committer:

Jessica B. Hamrick <jhamrick@…> (01/22/12 00:15:47)

Message:

Some IPP documentation in printer.py

File:

• server/lib/gutenbach/server/requests.py (modified) (12 diffs)

server/lib/gutenbach/server/requests.py

@@ -229 +229 @@
     @handler_for(ipp.OperationCodes.VALIDATE_JOB)
     def validate_job(self, request, response):
-        """3.2.3 Validate-Job Operation
+        """RFC 2911: 3.2.3 Validate-Job Operation
 
         This REQUIRED operation is similar to the Print-Job operation
@@ -312 +312 @@
     @handler_for(ipp.OperationCodes.GET_JOBS)
     def get_jobs(self, request, response):
-        """3.2.6 Get-Jobs Operation
+        """RFC 2911: 3.2.6 Get-Jobs Operation
         
         This REQUIRED operation allows a client to retrieve the list
@@ -401 +401 @@
     @handler_for(ipp.OperationCodes.PRINT_URI)
     def print_uri(self, request, response):
-        """3.2.2 Print-URI Operation
+        """RFC 2911: 3.2.2 Print-URI Operation
 
         This OPTIONAL operation is identical to the Print-Job
@@ -415 +415 @@
         Printer object MUST reject the request and return the
         'client-error-uri- scheme-not-supported' status code.
-
-        The IPP Printer MAY validate the accessibility of the document
-        as part of the operation or subsequently.  If the Printer
-        determines an accessibility problem before returning an
-        operation response, it rejects the request and returns the
-        'client-error-document-access- error' status code.  The
-        Printer MAY also return a specific document access error code
-        using the 'document-access-error' operation attribute (see
-        section 3.1.6.4).
-
-        If the Printer determines this document accessibility problem
-        after accepting the request and returning an operation
-        response with one of the successful status codes, the Printer
-        adds the 'document-access- error' value to the job's
-        'job-state-reasons' attribute and MAY populate the job's
-        'job-document-access-errors' Job Description attribute (see
-        section 4.3.11).  See The Implementer's Guide [IPP- IIG] for
-        suggested additional checks.
                                                                               
         If the Printer object supports this operation, it MUST support
@@ -631 +613 @@
     @handler_for(ipp.OperationCodes.PAUSE_PRINTER)
     def pause_printer(self, request, response):
-        """3.2.7 Pause-Printer Operation
+        """RFC 2911: 3.2.7 Pause-Printer Operation
 
         This OPTIONAL operation allows a client to stop the Printer
@@ -694 +676 @@
     @handler_for(ipp.OperationCodes.RESUME_PRINTER)
     def resume_printer(self, request, response):
-        """3.2.8 Resume-Printer Operation
+        """RFC 2911: 3.2.8 Resume-Printer Operation
 
         This operation allows a client to resume the Printer object
@@ -838 +820 @@
     @handler_for(ipp.OperationCodes.CANCEL_JOB)
     def cancel_job(self, request, response):
-        """3.3.3 Cancel-Job Operation
+        """RFC 2911: 3.3.3 Cancel-Job Operation
 
         This REQUIRED operation allows a client to cancel a Print Job
@@ -877 +859 @@
         operation.
 
-        Access Rights: The authenticated user (see section 8.3)
-        performing this operation must either be the job owner or an
-        operator or administrator of the Printer object (see Sections
-        1 and 8.5).  Otherwise, the IPP object MUST reject the
-        operation and return: 'client-error-forbidden',
-        'client-error-not-authenticated', or
-        'client-error-not-authorized' as appropriate.
-
         Request
         -------
@@ -938 +912 @@
     @handler_for(ipp.OperationCodes.SEND_DOCUMENT)
     def send_document(self, request, response):
-        """3.3.1 Send-Document Operation
+        """RFC 2911: 3.3.1 Send-Document Operation
         
         This OPTIONAL operation allows a client to create a
@@ -976 +950 @@
         interval specified by the Printer object's
         'multiple-operation-time-out' attribute.
-
-        Access Rights: The authenticated user (see section 8.3)
-        performing this operation must either be the job owner (as
-        determined in the Create-Job operation) or an operator or
-        administrator of the Printer object (see Sections 1 and
-        8.5). Otherwise, the IPP object MUST reject the operation and
-        return: 'client-error-forbidden', 'client-
-        error-not-authenticated', or 'client-error-not-authorized' as
-        appropriate.
 
         Request
@@ -1090 +1055 @@
     @handler_for(ipp.OperationCodes.SEND_URI)
     def send_uri(self, request, response):
-
-        """3.2.2 Send URI
+        """RFC 2911: 3.2.2 Send URI
 
         This OPTIONAL operation is identical to the Send-Document
@@ -1222 +1186 @@
     @handler_for(ipp.OperationCodes.GET_JOB_ATTRIBUTES)
     def get_job_attributes(self, request, response):
-        """3.3.4 Get-Job-Attributes Operation
+        """RFC 2911: 3.3.4 Get-Job-Attributes Operation
 
         This REQUIRED operation allows a client to request the values