j4cups.server

Class IppHandler

java.lang.Object

j4cups.server.IppHandler

Direct Known Subclasses:

IppProxyHandler

public class IppHandler
extends java.lang.Object

The IppHandler is reponsible for handling IPP requests. He can do it by forwarding the request to a real CUPS server. Or it can handle the IPP requests itself and acts like a (more ore less) real CUPS server. This may be useful if you want to do some tests with a CUPS server but do not want to waste paper.

Since:

0.5 (26.04.2018)

Author:

oboehm

Constructor Summary

Constructors

Constructor and Description
IppHandler(java.nio.file.Path recordDir) Instantiates a new IPP handler.
IppHandler(java.net.URI forwardURI) Instantiates a new IPP handler.

Method Summary

Modifier and Type	Method and Description
IppResponse	cancelJob(java.net.URI printerURI, int jobId) Cancels a (created) job.
IppResponse	createJob(java.net.URI printerURI) Creates a new job.
IppResponse	getJobs(java.net.URI printerURI) Gets all jobs of a printer.
IppResponse	getPrinterAttributes(java.net.URI printerURI) Sends a get-printer-attributes to CUPS.
IppResponse	printJob(java.net.URI printerURI, java.nio.file.Path path) Sends a print job to the printer.
IppResponse	send(IppRequest ippRequest) Sends an IPP request to a CUPS server.
IppResponse	sendDocument(java.net.URI printerURI, java.nio.file.Path path, int jobId, boolean lastDocument) Sends one print job of a multiple document to the printer
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IppHandler

public IppHandler(java.net.URI forwardURI)

Instantiates a new IPP handler.

Parameters:

forwardURI - the forward uri where to store the requests/responses

IppHandler

public IppHandler(java.nio.file.Path recordDir)

Instantiates a new IPP handler.

Parameters:

recordDir - directory where requests and responses are recorded

Method Detail

printJob

public IppResponse printJob(java.net.URI printerURI,
                            java.nio.file.Path path)

Sends a print job to the printer.

Parameters:

printerURI - printer URI

path - file to be printed

Returns:

answer from CUPS

getJobs

public IppResponse getJobs(java.net.URI printerURI)

Gets all jobs of a printer.

Parameters:

printerURI - printer URI

Returns:

answer from CUPS

createJob

public IppResponse createJob(java.net.URI printerURI)

Creates a new job. This is needed if you want to send multiple documents.

Parameters:

printerURI - printer URI

Returns:

answer from CUPS

sendDocument

public IppResponse sendDocument(java.net.URI printerURI,
                                java.nio.file.Path path,
                                int jobId,
                                boolean lastDocument)

Sends one print job of a multiple document to the printer

Parameters:

printerURI - printer URI

path - file to be printed

jobId - the job id

lastDocument - if it is the last document

Returns:

answer from CUPS

cancelJob

public IppResponse cancelJob(java.net.URI printerURI,
                             int jobId)

Cancels a (created) job.

Parameters:

printerURI - printer URI

jobId - the job id

Returns:

answer from CUPS

getPrinterAttributes

public IppResponse getPrinterAttributes(java.net.URI printerURI)

Sends a get-printer-attributes to CUPS.

Parameters:

printerURI - printer URI

Returns:

answer from CUPS

send

public IppResponse send(IppRequest ippRequest)

Sends an IPP request to a CUPS server. Normally the resonse from CUPS is an IppResponse. But in some case (like the get-printers operation the answer is returned as HTML page.

Parameters:

ippRequest - the ipp request

Returns:

response from CUPS

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object