CupsServer represents a host running a cups
* compatible server. It mainly consists of its URI and optional
* user and password combination if access is restricted.
* * It provides methods for retrival of valid CUPS printer uris * that are used to construct IppPrintService objects. *
* * @author Wolfgang Baer (WBaer@gmx.de) */ public class CupsServer { /** * The URI of the CUPS server. * This is something like: http://localhost:631 */ private transient URI uri; /** * The optional username. */ private transient String username; /** * The optional password for the user. */ private transient String password; /** * Creates aCupsServer object which
* tries to connect to a cups server.
*
* If gnu.javax.print.server is explicitly set, then
* that hostname will be used. Otherwise it will default to localhost.
*
* @param username the username
* @param password the password for the username.
*/
public CupsServer(String username, String password)
{
this.username = username;
this.password = password;
this.uri = null;
try
{
String serv = System.getProperty("gnu.javax.print.server");
if( serv != null )
this.uri = new URI("http://"+serv+":631");
}
catch(URISyntaxException use)
{
throw new RuntimeException("gnu.javax.print.CupsServer value is not a valid hostname.");
}
catch(SecurityException se)
{
}
try
{
if( this.uri == null )
this.uri = new URI("http://localhost:631");
}
catch (URISyntaxException e)
{
// does not happen
}
}
/**
* Creates a CupsServer object which
* tries to connect to a running cups server on the
* given URI.
*
* @param uri the URI of the server.
* @param username the username
* @param password the password for the username.
*/
public CupsServer(URI uri, String username, String password)
{
this.uri = uri;
this.username = username;
this.password = password;
}
/**
* Requests the default printer from this CUPS server.
* This is always returned as IppPrintService.
*
* @return The default printer.
* @throws IppException if problems during request/response processing occur.
*/
public IppPrintService getDefaultPrinter() throws IppException
{
IppResponse response = null;
try
{
IppRequest request = new IppRequest(uri, username, password);
request.setOperationID((short)CupsIppOperation.CUPS_GET_DEFAULT);
request.setOperationAttributeDefaults();
RequestedAttributes requestedAttrs
= new RequestedAttributes("printer-uri-supported");
request.addOperationAttribute(requestedAttrs);
response = request.send();
}
catch (IOException e)
{
throw new IppException("IOException in IPP request/response.", e);
}
Map printerAttributes = (Map) response.getPrinterAttributes().get(0);
Set uris = (Set) printerAttributes.get(PrinterUriSupported.class);
PrinterUriSupported uri = (PrinterUriSupported) uris.toArray()[0];
IppPrintService service
= new CupsPrintService(uri.getURI(), username, password);
return service;
}
/**
* Requests all printers from this CUPS server.
*
* @return The list of available printers.
* @throws IppException if problems during request/response processing occur.
*/
public List getAllPrinters() throws IppException
{
IppResponse response = null;
try
{
IppRequest request = new IppRequest(uri, username, password);
request.setOperationID((short)CupsIppOperation.CUPS_GET_PRINTERS);
request.setOperationAttributeDefaults();
RequestedAttributes requestedAttrs
= new RequestedAttributes("printer-uri-supported");
request.addOperationAttribute(requestedAttrs);
response = request.send();
}
catch (IOException e)
{
throw new IppException("IOException in IPP request/response.", e);
}
List prAttr = response.getPrinterAttributes();
List services = new ArrayList();
for (int i=0; i < prAttr.size(); i++)
{
Map printerAttributes = (Map) prAttr.get(i);
Set uris = (Set) printerAttributes.get(PrinterUriSupported.class);
PrinterUriSupported uri = (PrinterUriSupported) uris.toArray()[0];
try
{
CupsPrintService cups = new CupsPrintService(uri.getURI(),
username, password);
services.add(cups);
}
catch (IppException e)
{
// do nothing, we only catch the IppException which could be
// thrown during instantiation as single printers may be discovered
// correctly but not usable due to other security restrictions
}
}
return services;
}
/**
* Requests all classes from this CUPS server. Classes in cups are
* collections of printers. This means jobs directed to a class
* are forwarded to the first available printer of the collection.
*
* @return The list of available classes.
* @throws IppException if problems during request/response processing occur.
*/
public List getAllClasses() throws IppException
{
IppResponse response = null;
try
{
IppRequest request = new IppRequest(uri, username, password);
request.setOperationID((short)CupsIppOperation.CUPS_GET_CLASSES);
request.setOperationAttributeDefaults();
RequestedAttributes requestedAttrs
= new RequestedAttributes("printer-uri-supported");
request.addOperationAttribute(requestedAttrs);
response = request.send();
}
catch (IOException e)
{
throw new IppException("IOException in IPP request/response.", e);
}
List prAttr = response.getPrinterAttributes();
List services = new ArrayList();
for (int i=0; i < prAttr.size(); i++)
{
Map printerAttributes = (Map) prAttr.get(i);
Set uris = (Set) printerAttributes.get(PrinterUriSupported.class);
PrinterUriSupported uri = (PrinterUriSupported) uris.toArray()[0];
try
{
CupsPrintService cups = new CupsPrintService(uri.getURI(),
username, password);
services.add(cups);
}
catch (IppException e)
{
// do nothing, we only catch the IppException which could be
// thrown during instantiation as single printers may be discovered
// correctly but not usable due to other security restrictions
}
}
return services;
}
}