org.cups4j.CupsPrinter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cups4j Show documentation
Show all versions of cups4j Show documentation
Java printing library for CUPS/IPP
package org.cups4j;
/**
* Copyright (C) 2009 Harald Weyhing
*
* This program is free software; you can redistribute it and/or modify it under the terms of the
* GNU Lesser General Public License as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* See the GNU Lesser General Public License for more details. You should have received a copy of
* the GNU Lesser General Public License along with this program; if not, see
* numberUpSupported = new ArrayList();
private List mediaSupported = new ArrayList();
private List resolutionSupported = new ArrayList();
private List colorModeSupported = new ArrayList();
private List mimeTypesSupported = new ArrayList();
private List sidesSupported = new ArrayList();
/**
* Constructor
*
* @param printerURL
* @param printerName
* @param isDefault
* true if this is the default printer on this IPP server
*/
public CupsPrinter(URL printerURL, String printerName, boolean isDefault) {
this.printerURL = printerURL;
this.name = printerName;
this.isDefault = isDefault;
}
/**
* Print method
*
* @param printJob
* @return PrintRequestResult
* @throws Exception
*/
public PrintRequestResult print(PrintJob printJob) throws Exception {
int ippJobID = -1;
InputStream document = printJob.getDocument();
String userName = printJob.getUserName();
String jobName = printJob.getJobName();
int copies = printJob.getCopies();
String pageRanges = printJob.getPageRanges();
String resolution = printJob.getResolution();
String pageFormat = printJob.getPageFormat();
boolean color = printJob.isColor();
boolean portrait = printJob.isPortrait();
Map attributes = printJob.getAttributes();
if (userName == null) {
userName = CupsClient.DEFAULT_USER;
}
if (attributes == null) {
attributes = new HashMap();
}
attributes.put("requesting-user-name", userName);
attributes.put("job-name", jobName);
String copiesString = null;
StringBuffer rangesString = new StringBuffer();
if (copies > 0) {// other values are considered bad value by CUPS
copiesString = "copies:integer:" + copies;
addAttribute(attributes, "job-attributes", copiesString);
}
if (portrait) {
addAttribute(attributes, "job-attributes", "orientation-requested:enum:3");
} else {
addAttribute(attributes, "job-attributes", "orientation-requested:enum:4");
}
if (color) {
addAttribute(attributes, "job-attributes", "output-mode:keyword:color");
} else {
addAttribute(attributes, "job-attributes", "output-mode:keyword:monochrome");
}
if (pageFormat != null && !"".equals(pageFormat)) {
addAttribute(attributes, "job-attributes", "media:keyword:" + pageFormat);
}
if (resolution != null && !"".equals(resolution)) {
addAttribute(attributes, "job-attributes", "printer-resolution:resolution:" + resolution);
}
if (pageRanges != null && !"".equals(pageRanges.trim()) && !"1-".equals(pageRanges.trim())) {
String[] ranges = pageRanges.split(",");
String delimeter = "";
rangesString.append("page-ranges:setOfRangeOfInteger:");
for (String range : ranges) {
range = range.trim();
String[] values = range.split("-");
if (values.length == 1) {
range = range + "-" + range;
}
rangesString.append(delimeter).append(range);
// following ranges need to be separated with ","
delimeter = ",";
}
addAttribute(attributes, "job-attributes", rangesString.toString());
}
if (printJob.isDuplex()) {
addAttribute(attributes, "job-attributes", "sides:keyword:two-sided-long-edge");
}
IppPrintJobOperation command = new IppPrintJobOperation(printerURL.getPort());
IppResult ippResult = command.request(printerURL, attributes, document);
PrintRequestResult result = new PrintRequestResult(ippResult);
// IppResultPrinter.print(result);
for (AttributeGroup group : ippResult.getAttributeGroupList()) {
if (group.getTagName().equals("job-attributes-tag")) {
for (Attribute attr : group.getAttribute()) {
if (attr.getName().equals("job-id")) {
ippJobID = Integer.parseInt(attr.getAttributeValue().get(0).getValue());
}
}
}
}
result.setJobId(ippJobID);
return result;
}
/**
* Print method for several print jobs which should be not interrupted by
* another print job. The printer must support
* 'multiple-document-jobs-supported' which is a recommended option.
*
* ATTENTION: Don't use different users for the different print jobs. You
* will get probably error 401 (forbidden) from CUPS. To avoid error 401
* you'll get now an {@link IllegalStateException}.
*
*
* @param job1 first print job
* @param moreJobs more print jobs
* @return PrintRequestResult
* @since 0.7.2
* @author oboehm
*/
public PrintRequestResult print(PrintJob job1, PrintJob... moreJobs) {
verifyUser(job1.getUserName(), moreJobs);
int jobId = createJob(job1);
List printJobs = new ArrayList();
printJobs.add(job1);
printJobs.addAll(Arrays.asList(moreJobs));
for (int i = 0; i < printJobs.size() - 1; i++) {
print(printJobs.get(i), jobId, false);
}
return print(printJobs.get(printJobs.size()-1), jobId, true);
}
private static void verifyUser(String userName, PrintJob[] printJobs) {
for (PrintJob job : printJobs) {
String jobUserName = job.getUserName();
if (!userName.equals(jobUserName)) {
throw new IllegalStateException(
"different users (" + userName + ", " + jobUserName + ", ...) in print jobs are forbidden");
}
}
}
/**
* If you want to print serveral print jobs as one job you must first tell
* CUPS that you want to start. This is the method to create a job. The
* returned job-id must be used for the following print calls.
*
* @param jobName the name of a job
* @return the job-id
* @since 0.7.2
* @author oboehm
* @deprecated use {@link #createJob(PrintJob)} or {@link #createJob(String, String)}
*/
@Deprecated
public int createJob(String jobName) {
return createJob(jobName, CupsClient.DEFAULT_USER);
}
/**
* If you want to print serveral print jobs as one job you must first tell
* CUPS that you want to start. This is the method to create a job. The
* returned job-id must be used for the following print calls.
*
* @param jobName the name of a job
* @param userName the name of a user
* @return the job-id
* @since 0.7.4
* @author oboehm
*/
public int createJob(String jobName, String userName) {
return createJob(new PrintJob.Builder(new byte[0]).jobName(jobName).userName(userName).build());
}
/**
* If you want to print serveral print jobs as one job you must first tell
* CUPS that you want to start. This is the method to create a job. The
* returned job-id must be used for the following print calls.
*
* @param job the print-job with job-name and user-name
* @return the job-id
* @since 0.7.4
* @author oboehm
*/
public int createJob(PrintJob job) {
Map attributes = new HashMap();
attributes.put("job-name", job.getJobName());
attributes.put("requesting-user-name", job.getUserName());
IppCreateJobOperation command = new IppCreateJobOperation(printerURL.getPort());
IppResult ippResult = command.request(printerURL, attributes);
AttributeGroup attrGroup = ippResult.getAttributeGroup("job-attributes-tag");
return Integer.parseInt(attrGroup.getAttribute("job-id").getValue());
}
/**
* Call this method if you want to print several print jobs as one print job.
* Call {@link #createJob(String)} to the get the correct job-id.
*
* @param job the job
* @param jobId the job id from {@link #createJob(String)}
* @param lastDocument set it to true if it is the last document
* @return the print request result
* @since 0.7.2
* @author oboehm
*/
public PrintRequestResult print(PrintJob job, int jobId, boolean lastDocument) {
IppSendDocumentOperation op = new IppSendDocumentOperation(printerURL.getPort(), jobId, lastDocument);
IppResult ippResult = op.request(printerURL, job);
PrintRequestResult result = new PrintRequestResult(ippResult);
result.setJobId(jobId);
return result;
}
/**
*
* @param map
* @param name
* @param value
*/
private void addAttribute(Map map, String name, String value) {
if (value != null && name != null) {
String attribute = map.get(name);
if (attribute == null) {
attribute = value;
} else {
attribute += "#" + value;
}
map.put(name, attribute);
}
}
/**
* Get a list of jobs
*
* @param whichJobs
* completed, not completed or all
* @param user
* requesting user (null will be translated to anonymous)
* @param myJobs
* boolean only jobs for requesting user or all jobs for this
* printer?
* @return job list
* @throws Exception
*/
public List getJobs(WhichJobsEnum whichJobs, String user, boolean myJobs) throws Exception {
IppGetJobsOperation command = new IppGetJobsOperation(printerURL.getPort());
return command.getPrintJobs(this, whichJobs, user, myJobs);
}
/**
* Get current status for the print job with the given ID.
*
* @param jobID
* @return job status
* @throws Exception
*/
public JobStateEnum getJobStatus(int jobID) throws Exception {
return getJobStatus(CupsClient.DEFAULT_USER, jobID);
}
/**
* Get current status for the print job with the given ID
*
* @param userName
* @param jobID
* @return job status
* @throws Exception
*/
public JobStateEnum getJobStatus(String userName, int jobID) throws Exception {
IppGetJobAttributesOperation command = new IppGetJobAttributesOperation(printerURL.getPort());
PrintJobAttributes job = command.getPrintJobAttributes(printerURL.getHost(), userName, printerURL.getPort(), jobID);
return job.getJobState();
}
/**
* Get the URL for this printer
*
* @return printer URL
*/
public URL getPrinterURL() {
return printerURL;
}
/**
* Is this the default printer
*
* @return true if this is the default printer false otherwise
*/
public boolean isDefault() {
return isDefault;
}
protected void setDefault(boolean isDefault) {
this.isDefault = isDefault;
}
/**
* Get a String representation of this printer consisting of the printer URL
* and the name
*
* @return String
*/
public String toString() {
return name;
}
/**
* Get name of this printer.
*
* For a printer http://localhost:631/printers/printername 'printername' will
* be returned.
*
*
* @return printer name
*/
public String getName() {
return name;
}
/**
* Get location attribute for this printer
*
* @return location
*/
public String getLocation() {
return location;
}
public void setLocation(String location) {
this.location = location;
}
/**
* Get description attribute for this printer
*
* @return description
*/
public String getDescription() {
return description;
}
public List getMediaSupported() {
return mediaSupported;
}
public String getMediaDefault() {
return mediaDefault;
}
public String getResolutionDefault() {
return resolutionDefault;
}
public String getColorModeDefault() {
return colorModeDefault;
}
public List getResolutionSupported() {
return resolutionSupported;
}
public List getColorModeSupported() {
return colorModeSupported;
}
public List getMimeTypesSupported() {
return mimeTypesSupported;
}
public void setPrinterURL(URL printerURL) {
this.printerURL = printerURL;
}
public void setName(String name) {
this.name = name;
}
public void setDescription(String description) {
this.description = description;
}
public void setMediaDefault(String mediaDefault) {
this.mediaDefault = mediaDefault;
}
public void setMediaSupported(List mediaSupportedList) {
this.mediaSupported = mediaSupportedList;
}
public void setResolutionDefault(String resolutionDefault) {
this.resolutionDefault = resolutionDefault;
}
public void setColorModeDefault(String colorModeDefault) {
this.colorModeDefault = colorModeDefault;
}
public void setResolutionSupported(List resolutionSupported) {
this.resolutionSupported = resolutionSupported;
}
public void setColorModeSupported(List colorModeSupported) {
this.colorModeSupported = colorModeSupported;
}
public void setMimeTypesSupported(List mimeTypesSupported) {
this.mimeTypesSupported = mimeTypesSupported;
}
public String getSidesDefault() {
return sidesDefault;
}
public void setSidesDefault(String sidesDefault) {
this.sidesDefault = sidesDefault;
}
public List getSidesSupported() {
return sidesSupported;
}
public void setSidesSupported(List sidesSupported) {
this.sidesSupported = sidesSupported;
}
public String getNumberUpDefault() {
return numberUpDefault;
}
public void setNumberUpDefault(String numberUpDefault) {
this.numberUpDefault = numberUpDefault;
}
public List getNumberUpSupported() {
return numberUpSupported;
}
public void setNumberUpSupported(List numberUpSupported) {
this.numberUpSupported = numberUpSupported;
}
}