j4cups.op

Class Operation

java.lang.Object

j4cups.op.Operation

Direct Known Subclasses:

CancelJob, CreateJob, GetDefault, GetJobs, GetPrinterAttributes, GetPrinters, PrintJob

public class Operation
extends java.lang.Object

This is the common super class of all IPP operations.

Since:

0.5 (26.03.2018)

Author:

oboehm

Constructor Summary

Constructors

Modifier	Constructor and Description
	Operation(IppOperations id) Instantiates an operation with the given id.
protected	Operation(IppOperations id, IppRequest ippRequest) Instantiates an operation with the given id and the given IPP request.

Method Summary

Modifier and Type	Method and Description
protected static IppRequest	createIppRequest(IppOperations ippOp)
Attribute	getAttribute(java.lang.String name) Returns the attribute of the give name.
IppRequest	getIppRequest() Gets the IPP request which belongs to this operation.
IppResponse	getIppResponse() Gets the IPP response for the stored IPP request.
java.lang.String	getPrinterName() The printer name is the last part of the printer-uri.
java.net.URI	getPrinterURI() Gets printer uri.
protected void	initPrinterAttributes(AttributeGroup group) Initialiazes printer-attributes with default values.
void	setCupsURI(java.net.URI cupsURI) Sets the CUPS URI.
void	setIppRequestId(int id) Sets the ID of the IPP request.
void	setJobAttribute(Attribute attribute) Sets the given job attribute in the generated IPP request.
void	setJobId(int jobId) Sets job id.
void	setJobState(JobState state) Sets job state.
void	setJobStateReasons(JobStateReasons reason) Sets job state reason.
void	setOperationAttribute(Attribute attribute) Sets the given operation attribute in the generated IPP request.
void	setPrinterURI(java.net.URI printerURI) Sets the printer-uri.
protected static java.net.URI	toIPP(java.net.URI uri) Converts the given URI into an URI beginning with "ipp://...".
void	validateRequest() Looks if the stored request is valid.
void	validateRequest(byte[] bytes) Looks if the given bytes represents a valid request.
void	validateRequest(IppRequest request) Looks if the given request is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

Operation

public Operation(IppOperations id)

Instantiates an operation with the given id.

Parameters:

id - a positiv number between 0x0000 and 0x0031

Operation

protected Operation(IppOperations id,
                    IppRequest ippRequest)

Instantiates an operation with the given id and the given IPP request.

Parameters:

id - a positiv number between 0x0000 and 0x0031

ippRequest - the ipp request

Method Detail

createIppRequest

protected static IppRequest createIppRequest(IppOperations ippOp)

getIppRequest

public IppRequest getIppRequest()

Gets the IPP request which belongs to this operation.

Returns:

IPP request

getIppResponse

public IppResponse getIppResponse()

Gets the IPP response for the stored IPP request.

Returns:

IPP response

setIppRequestId

public void setIppRequestId(int id)

Sets the ID of the IPP request.

Parameters:

id - the new ID

getAttribute

public Attribute getAttribute(java.lang.String name)

Returns the attribute of the give name.

Parameters:

name - attribute name

Returns:

the attribute

setPrinterURI

public void setPrinterURI(java.net.URI printerURI)

Sets the printer-uri.

Parameters:

printerURI - the printer uri

getPrinterURI

public java.net.URI getPrinterURI()

Gets printer uri.

Returns:

printer uri

getPrinterName

public java.lang.String getPrinterName()

The printer name is the last part of the printer-uri.

Returns:

the printer name

setCupsURI

public void setCupsURI(java.net.URI cupsURI)

Sets the CUPS URI. This is needed e.g. to set the job-uri.

Parameters:

cupsURI - the printer uri

setJobId

public void setJobId(int jobId)

Sets job id.

Parameters:

jobId - the job id

setJobState

public void setJobState(JobState state)

Sets job state.

Parameters:

state - the state

setJobStateReasons

public void setJobStateReasons(JobStateReasons reason)

Sets job state reason.

Parameters:

reason - the job-state-reason

setOperationAttribute

public void setOperationAttribute(Attribute attribute)

Sets the given operation attribute in the generated IPP request.

Parameters:

attribute - operation attribute

setJobAttribute

public void setJobAttribute(Attribute attribute)

Sets the given job attribute in the generated IPP request.

Parameters:

attribute - operation attribute

initPrinterAttributes

protected void initPrinterAttributes(AttributeGroup group)

Initialiazes printer-attributes with default values. This method can be used by sub classes to do it.

Parameters:

group - attribute group where the printer attributes belong to

validateRequest

public void validateRequest(byte[] bytes)

Looks if the given bytes represents a valid request. If not an ValidationException will be thrown

Parameters:

bytes - which represents an request

validateRequest

public void validateRequest(IppRequest request)

Looks if the given request is valid. If not an ValidationException will be thrown

Parameters:

request - IPP reqeust

validateRequest

public void validateRequest()

Looks if the stored request is valid. If not an ValidationException will be thrown

Since:

0.5

toIPP

protected static java.net.URI toIPP(java.net.URI uri)

Converts the given URI into an URI beginning with "ipp://...".

Parameters:

uri - the uri

Returns:

the uri