de.spqrinfo.cups4j

Class CupsClient

java.lang.Object

de.spqrinfo.cups4j.CupsClient

public class CupsClient
extends Object

Main Client for accessing CUPS features like

- get printers

- print documents

- get job attributes

- ...

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOST
static int	DEFAULT_PORT
static String	DEFAULT_USER

Constructor Summary

Constructors

Constructor and Description
CupsClient() Creates a CupsClient for localhost port 631 with user anonymous
CupsClient(String host, int port) Creates a CupsClient for provided host and port with user anonymous
CupsClient(String host, int port, String userName) Creates a CupsClient for provided host, port and user

Method Summary

Modifier and Type	Method and Description
boolean	cancelJob(int jobID) Cancel the job with the provided jobID on the current host wit current user
boolean	cancelJob(String hostname, String userName, int jobID) Cancel the job with the provided jobID, hostname for provided userName
CupsPrinter	getDefaultPrinter() Returns default printer
PrintJobAttributes	getJobAttributes(int jobID) Returns job attributes for the job associated with the provided jobID
PrintJobAttributes	getJobAttributes(String userName, int jobID) Returns job attributes for the job associated with the provided jobID and user name
List<PrintJobAttributes>	getJobs(CupsPrinter printer, WhichJobsEnum whichJobs, String userName, boolean myJobs) Returns all jobs for given printer and user Name
CupsPrinter	getPrinter(String printerURL) Returns the printer for the provided URL
List<CupsPrinter>	getPrinters() Returns all available printers
boolean	holdJob(int jobID) Hold the job with the provided jobID on the current host wit current set user
boolean	holdJob(String hostname, String userName, int jobID) Hold the job with the provided jobID, hostname for provided userName
boolean	moveJob(int jobID, String userName, CupsPrinter currentPrinter, CupsPrinter targetPrinter) Moves the print job with job ID jobID from currentPrinter to targetPrinter
boolean	releaseJob(int jobID) Release the held job with the provided jobID on the current host wit current set user
boolean	releaseJob(String hostname, String userName, int jobID) Release the job with the provided jobID, hostname for provided userName

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_USER

public static final String DEFAULT_USER

See Also:

Constant Field Values

Constructor Detail

CupsClient

public CupsClient()
           throws Exception

Creates a CupsClient for localhost port 631 with user anonymous

Throws:

Exception

CupsClient

public CupsClient(String host,
                  int port)
           throws Exception

Creates a CupsClient for provided host and port with user anonymous

Parameters:

host -

port -

Throws:

Exception

CupsClient

public CupsClient(String host,
                  int port,
                  String userName)
           throws Exception

Creates a CupsClient for provided host, port and user

Parameters:

host -

port -

userName -

Throws:

Exception

Method Detail

getPrinters

public List<CupsPrinter> getPrinters()
                              throws Exception

Returns all available printers

Returns:

List of Printers

Throws:

Exception

getDefaultPrinter

public CupsPrinter getDefaultPrinter()
                              throws Exception

Returns default printer

Returns:

default printer

Throws:

Exception

getPrinter

public CupsPrinter getPrinter(String printerURL)
                       throws Exception

Returns the printer for the provided URL

Parameters:

printerURL - an URL like http://localhost:631/printers/printername

Returns:

printer

Throws:

Exception

getJobAttributes

public PrintJobAttributes getJobAttributes(int jobID)
                                    throws Exception

Returns job attributes for the job associated with the provided jobID

Parameters:

jobID -

Returns:

Job attributes

Throws:

Exception

getJobAttributes

public PrintJobAttributes getJobAttributes(String userName,
                                           int jobID)
                                    throws Exception

Returns job attributes for the job associated with the provided jobID and user name

Parameters:

userName -

jobID -

Returns:

Job attributes

Throws:

Exception

getJobs

public List<PrintJobAttributes> getJobs(CupsPrinter printer,
                                        WhichJobsEnum whichJobs,
                                        String userName,
                                        boolean myJobs)
                                 throws Exception

Returns all jobs for given printer and user Name

Currently all Jobs on the server are returned by this method.

user and printer names are provided in the resulting PrintJobAttributes

Parameters:

printer -

userName -

Returns:

List of job attributes

Throws:

Exception

cancelJob

public boolean cancelJob(int jobID)
                  throws Exception

Cancel the job with the provided jobID on the current host wit current user

Parameters:

jobID -

Returns:

boolean success

Throws:

Exception

cancelJob

public boolean cancelJob(String hostname,
                         String userName,
                         int jobID)
                  throws Exception

Cancel the job with the provided jobID, hostname for provided userName

Parameters:

hostname -

userName -

jobID -

Returns:

boolean success

Throws:

Exception

holdJob

public boolean holdJob(int jobID)
                throws Exception

Hold the job with the provided jobID on the current host wit current set user

Parameters:

jobID -

Returns:

boolean success

Throws:

Exception

holdJob

public boolean holdJob(String hostname,
                       String userName,
                       int jobID)
                throws Exception

Hold the job with the provided jobID, hostname for provided userName

Parameters:

hostname -

userName -

jobID -

Returns:

boolean success

Throws:

Exception

releaseJob

public boolean releaseJob(int jobID)
                   throws Exception

Release the held job with the provided jobID on the current host wit current set user

Parameters:

jobID -

Returns:

boolean success

Throws:

Exception

releaseJob

public boolean releaseJob(String hostname,
                          String userName,
                          int jobID)
                   throws Exception

Release the job with the provided jobID, hostname for provided userName

Parameters:

hostname -

userName -

jobID -

Returns:

boolean success

Throws:

Exception

moveJob

public boolean moveJob(int jobID,
                       String userName,
                       CupsPrinter currentPrinter,
                       CupsPrinter targetPrinter)
                throws Exception

Moves the print job with job ID jobID from currentPrinter to targetPrinter

Parameters:

jobID -

userName -

currentPrinter -

targetPrinter -

Returns:

boolean successs

Throws:

Exception