j4cups.server

Class IppProxyHandler

java.lang.Object

j4cups.server.IppHandler

j4cups.server.IppProxyHandler

public class IppProxyHandler
extends IppHandler

The class IppProxyHandler forwards IPP requests to a real CUPS server and acts like a proxy. It can be used as template for additional tasks like filtering, accounting, logging or other things which are not part of a normal CUPS server.

Since:

0.5 (01.06.2018)

Author:

oboehm

Constructor Summary

Constructors

Constructor and Description
IppProxyHandler(java.net.URI cupsURI) Instantiates a new Cups client.

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.
java.net.URI	getForwardURI() Gets the URI to which the requests are forwared to..
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

IppProxyHandler

public IppProxyHandler(java.net.URI cupsURI)

Instantiates a new Cups client.

Parameters:

cupsURI - the CUPS URI

Method Detail

getForwardURI

public java.net.URI getForwardURI()

Gets the URI to which the requests are forwared to..

Returns:

the forward URI

printJob

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

Sends a print job to the printer.

Overrides:

printJob in class IppHandler

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.

Overrides:

getJobs in class IppHandler

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.

Overrides:

createJob in class IppHandler

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

Overrides:

sendDocument in class IppHandler

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.

Overrides:

cancelJob in class IppHandler

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.

Overrides:

getPrinterAttributes in class IppHandler

Parameters:

printerURI - printer URI

Returns:

answer from CUPS

send

public IppResponse send(IppRequest ippRequest)

Description copied from class: IppHandler

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.

Overrides:

send in class IppHandler

Parameters:

ippRequest - the ipp request

Returns:

response from CUPS

toString

public java.lang.String toString()

Overrides:

toString in class IppHandler