j4cups.client

Class CupsClient

java.lang.Object

j4cups.client.CupsClient

public class CupsClient
extends java.lang.Object

This is a very basic client to access CUPS. It was introduced to simplify the internal tests with a CUPS server.

Since:

0.5

Constructor Summary

Constructors

Constructor and Description
CupsClient() Generates a client for the access to a local CUPS on port 631.
CupsClient(java.net.URI cupsURI) Generates a client for the access to the given URI to CUPS.

Method Summary

Modifier and Type	Method and Description
IppResponse	cancelJob(int jobId, java.net.URI printerURI) Cancels a job.
IppResponse	createJob(java.net.URI printerURI) Creates a Job.
java.net.URI	getCupsURI() Gets the URI of the CUPS server.
IppResponse	print(java.net.URI printerURI, java.nio.file.Path... files) Sends a list of files as one job to the given printer.
IppResponse	print(java.net.URI printerURI, java.nio.file.Path path) Sends a print job to the printer.
void	replay(java.nio.file.Path dir) CupsServer allows you to record IPP requests.
IppResponse	send(IppRequest ippRequest) Sends the IPP request to CUPS.
IppResponse	send(Operation op) Sends an IPP operation to CUPS.
IppResponse	sendDocument(java.net.URI printerURI, java.nio.file.Path path, int jobId, boolean lastDocument)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CupsClient

public CupsClient()

Generates a client for the access to a local CUPS on port 631.

CupsClient

public CupsClient(java.net.URI cupsURI)

Generates a client for the access to the given URI to CUPS.

Parameters:

cupsURI - normally "http://localhost:631" on Linux and Mac

Method Detail

getCupsURI

public java.net.URI getCupsURI()

Gets the URI of the CUPS server.

Returns:

the CUPS URI

print

public IppResponse print(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

print

public IppResponse print(java.net.URI printerURI,
                         java.nio.file.Path... files)

Sends a list of files as one job to the given printer.

Parameters:

printerURI - where to send the files

files - the files to be printed

Returns:

the ipp response

sendDocument

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

createJob

public IppResponse createJob(java.net.URI printerURI)

Creates a Job. This is needed if you want to print several documents as one job.

Parameters:

printerURI - where to send the files after creation

Returns:

response from CUPS

cancelJob

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

Cancels a job.

Parameters:

jobId - the job id which should be cancelled

printerURI - the printer uri

Returns:

response from CUPS

send

public IppResponse send(Operation op)

Sends an IPP operation to CUPS.

Parameters:

op - IPP oeration

Returns:

response from CUPS

send

public IppResponse send(IppRequest ippRequest)

Sends the IPP request to CUPS.

Parameters:

ippRequest - IPP request

Returns:

response from CUPS

replay

public void replay(java.nio.file.Path dir)
            throws java.io.IOException

CupsServer allows you to record IPP requests. This method allows you to replay these recorded IPP requests.

Parameters:

dir - directory where the requests are recorded

Throws:

java.io.IOException - the io exception

Since:

0.6

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object