Skip navigation links
A B C D E G H I J L M O P R S T V W X 

A

AbstractIpp - Class in j4cups.protocol
The class AbstractIpp is the common super class of IppRequest and IppResponse which encapsulates the common code of both classes.
AbstractIpp() - Constructor for class j4cups.protocol.AbstractIpp
This constructor is needed for the Externalizable interface.
AbstractIpp(byte[]) - Constructor for class j4cups.protocol.AbstractIpp
Instantiates a new IPP request or responsel from the given bytes.
AbstractIpp(ByteBuffer) - Constructor for class j4cups.protocol.AbstractIpp
Instantiates a new IPP request or response from the given bytes.
AbstractIpp(AbstractIpp.Version, short, int, List<AttributeGroup>) - Constructor for class j4cups.protocol.AbstractIpp
Instantiates a new IPP request or response with no data.
AbstractIpp(AbstractIpp.Version, short, int, List<AttributeGroup>, byte[]) - Constructor for class j4cups.protocol.AbstractIpp
Instantiates a new IPP request or response.
AbstractIpp.Version - Class in j4cups.protocol
Container for the version information.
AbstractIppRequestHandler - Class in j4cups.server.http
Class AbstractIppRequestHandler.
AbstractIppRequestHandler() - Constructor for class j4cups.server.http.AbstractIppRequestHandler
 
add(Attribute) - Method in class j4cups.protocol.attr.Attribute
For multi-value attributes you can use this method to add the single values to the attribute.
addAttribute(Attribute) - Method in class j4cups.protocol.attr.AttributeGroup
Adds an attribute to the given attributes.
addAttributeGroup(AttributeGroup) - Method in class j4cups.protocol.AbstractIpp
Adds the given group.
AdditionalValue(Attribute) - Constructor for class j4cups.protocol.attr.Attribute.AdditionalValue
 
AdditionalValue(Attribute.AttributeWithOneValue) - Constructor for class j4cups.protocol.attr.Attribute.AdditionalValue
 
AdditionalValue(byte[]) - Constructor for class j4cups.protocol.attr.Attribute.AdditionalValue
 
AdditionalValue(ByteBuffer) - Constructor for class j4cups.protocol.attr.Attribute.AdditionalValue
 
addPrinter(URI) - Method in class j4cups.op.GetPrinters
Adds a printer into the response.
Attribute - Class in j4cups.protocol.attr
An "attribute" field is encoded as attribute-with-one-value and (optional) several addtional-values.
Attribute(ByteBuffer) - Constructor for class j4cups.protocol.attr.Attribute
Instantiates a new (single valued or multi-valued) attribute from the given bytes.
Attribute.AdditionalValue - Class in j4cups.protocol.attr
An "additional-value" has four entries.
Attribute.AttributeWithOneValue - Class in j4cups.protocol.attr
An "attribute-with-one-value" field is encoded with five subfields.
AttributeGroup - Class in j4cups.protocol.attr
Each "attribute-group" field represents a single group of attributes, such as an Operation Attributes group or a Job Attributes group (see the Model document).
AttributeGroup(AttributeGroup) - Constructor for class j4cups.protocol.attr.AttributeGroup
This is the copy construtor.
AttributeGroup(DelimiterTags) - Constructor for class j4cups.protocol.attr.AttributeGroup
Instantiates a new empty attribute group from the given bytes.
AttributeGroup(ByteBuffer) - Constructor for class j4cups.protocol.attr.AttributeGroup
Instantiates a new attribute group from the given bytes.
AttributeWithOneValue(ByteBuffer) - Constructor for class j4cups.protocol.attr.Attribute.AttributeWithOneValue
Instantiates a new attribute-with-one-value from the given bytes.
AttributeWithOneValue(ValueTags, String, byte[]) - Constructor for class j4cups.protocol.attr.Attribute.AttributeWithOneValue
Instantiates a new attribute-with-one-value.

B

Binary - Interface in j4cups.protocol
The Interface Binary describes objects which supports a binary presentation of the object.

C

cancelJob(int, URI) - Method in class j4cups.client.CupsClient
Cancels a job.
CancelJob - Class in j4cups.op
Class CancelJob represents the cancel-job operation.
CancelJob() - Constructor for class j4cups.op.CancelJob
Instantiates an operation for 'cancel-job'.
cancelJob(URI, int) - Method in class j4cups.server.IppHandler
Cancels a (created) job.
cancelJob(URI, int) - Method in class j4cups.server.IppProxyHandler
Cancels a (created) job.
Config - Class in j4cups
Configuration stuff for J4Cups
Config() - Constructor for class j4cups.Config
Creates a new configuration for a standalone server.
Config(String) - Constructor for class j4cups.Config
Instantiates a new Configuration with the given resource
createIppRequest(IppOperations) - Static method in class j4cups.op.Operation
 
createJob(URI) - Method in class j4cups.client.CupsClient
Creates a Job.
CreateJob - Class in j4cups.op
Class CreateJob.
CreateJob() - Constructor for class j4cups.op.CreateJob
Instantiates an operation for 'create-job'.
CreateJob(IppRequest) - Constructor for class j4cups.op.CreateJob
Instantiates an operation with the given IPP request.
createJob(URI) - Method in class j4cups.server.IppHandler
Creates a new job.
createJob(URI) - Method in class j4cups.server.IppProxyHandler
Creates a new job.
CupsClient - Class in j4cups.client
This is a very basic client to access CUPS.
CupsClient() - Constructor for class j4cups.client.CupsClient
Generates a client for the access to a local CUPS on port 631.
CupsClient(URI) - Constructor for class j4cups.client.CupsClient
Generates a client for the access to the given URI to CUPS.
CupsServer - Class in j4cups.server
The CupsServer is a little embedded HTTP server based on Apache's HTTP components.
CupsServer() - Constructor for class j4cups.server.CupsServer
Instantiates a CUPS server with the IPP standard port (631).
CupsServer(int) - Constructor for class j4cups.server.CupsServer
Instantiates a CUPS server with the given IPP port.
CupsServer(int, URI) - Constructor for class j4cups.server.CupsServer
Instantiates a CUPS server with the given IPP port.

D

DEFAULT_VERSION - Static variable in class j4cups.protocol.AbstractIpp
The actual supported version is 2.
DelimiterTags - Enum in j4cups.protocol.tags
The DelimiterTags delimit major sections of the protocol, namely attributes and data.

E

equals(Object) - Method in class j4cups.protocol.AbstractIpp
The binary representation of this class is used to compare to request or respone objects.
equals(Object) - Method in class j4cups.protocol.AbstractIpp.Version
 

G

getAdditionalValues() - Method in class j4cups.protocol.attr.Attribute
Gets the different values for a multi-value attribute.
getAttribute(String) - Method in class j4cups.op.Operation
Returns the attribute of the give name.
getAttribute(String) - Method in class j4cups.protocol.AbstractIpp
Gets the attribute with the given name.
getAttribute(String) - Method in class j4cups.protocol.attr.AttributeGroup
Looks for the attribute with the given name and returns it.
getAttributeGroup(DelimiterTags) - Method in class j4cups.protocol.AbstractIpp
Returns all attributes of the given delimiter-tag.
getAttributeGroups() - Method in class j4cups.protocol.AbstractIpp
The fourth field is the "attribute-group" field, and it occurs 0 or more times.
getAttributes() - Method in class j4cups.protocol.AbstractIpp
Gets a collected list of all attributes of the attribute-groups.
getAttributes() - Method in class j4cups.protocol.attr.AttributeGroup
An "attribute-group" field contains zero or more "attribute" fields.
getBeginTag() - Method in class j4cups.protocol.attr.AttributeGroup
The "begin-attribute-group-tag" field marks the beginning of an "attribute-group" field and its value identifies the type of attribute group, e.g.
getBooleanValue() - Method in class j4cups.protocol.attr.Attribute
The "value" field contains the value of a boolean attribute.
getCode() - Method in enum j4cups.protocol.IppOperations
Gets the operation id or op-code of the operation.
getCode() - Method in enum j4cups.protocol.StatusCode
Gets the value of the statuscode.
getCrossFeedDirection() - Method in class j4cups.protocol.attr.PrinterResolution
Gets cross feed direction.
getCupsURI() - Method in class j4cups.client.CupsClient
Gets the URI of the CUPS server.
getData() - Method in class j4cups.protocol.AbstractIpp
Returns the data part of the request.
GetDefault - Class in j4cups.op
The class GetPrinters is called if you want to get the default printer from CUPS.
GetDefault() - Constructor for class j4cups.op.GetDefault
Instantiates a new Get printers.
getFeedDirection() - Method in class j4cups.protocol.attr.PrinterResolution
Gets feed direction.
getForwardURI() - Method in class j4cups.server.HttpProxyHandler
 
getForwardURI() - Method in class j4cups.server.IppProxyHandler
Gets the URI to which the requests are forwared to..
getIntValue() - Method in class j4cups.protocol.attr.Attribute
The "value" field contains the value of a integer attribute.
getIppRequest() - Method in class j4cups.op.GetPrinterAttributes
Gets the IPP request which belongs to this operation.
getIppRequest() - Method in class j4cups.op.Operation
Gets the IPP request which belongs to this operation.
getIppResponse() - Method in class j4cups.op.GetDefault
Gets the IPP response for the stored IPP request.
getIppResponse() - Method in class j4cups.op.GetPrinterAttributes
Gets the IPP response for the stored IPP request.
getIppResponse() - Method in class j4cups.op.Operation
Gets the IPP response for the stored IPP request.
getIppResponse() - Method in class j4cups.op.PrintJob
Gets the IPP response for the stored IPP request.
getJobId() - Method in class j4cups.protocol.AbstractIpp
Returns the job-id of the request or response.
GetJobs - Class in j4cups.op
Class GetJobs.
GetJobs() - Constructor for class j4cups.op.GetJobs
Instantiates an operation for 'get-jobs'.
getJobs(URI) - Method in class j4cups.server.IppHandler
Gets all jobs of a printer.
getJobs(URI) - Method in class j4cups.server.IppProxyHandler
Gets all jobs of a printer.
getJobState() - Method in class j4cups.protocol.AbstractIpp
Returns the job-state of the request or response.
getJobStateMessage() - Method in class j4cups.protocol.AbstractIpp
Returns the job-state-message of the request or response.
getJobStateReasons() - Method in class j4cups.protocol.AbstractIpp
Returns the job-state-reason of the request or response.
getJobURI() - Method in class j4cups.protocol.AbstractIpp
Returns the job-uri of the request or response.
getLength() - Method in class j4cups.protocol.AbstractIpp
Calculates the size of the request or response.
getName() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
The "name" field contains the textual name of the attribute.
getName() - Method in class j4cups.protocol.attr.Attribute
The "name" field contains the textual name of the attribute.
getOpCode() - Method in class j4cups.protocol.AbstractIpp
Returns the 2nd part (byte 2-3) with the operation-id or status-code.
getOpCodeAsString() - Method in class j4cups.protocol.AbstractIpp
Returns the 2nd part (byte 2-3) with the operation-id or status-code as string.
getOpCodeAsString() - Method in class j4cups.protocol.IppRequest
Returns the 2nd part (byte 2-3) with the operation-id as string.
getOpCodeAsString() - Method in class j4cups.protocol.IppResponse
Returns the 2nd part (byte 2-3) with the status-code as string.
getOperation() - Method in class j4cups.protocol.IppRequest
Returns the 2nd part (byte 2-3) with the operation-id.
getOperationAttributes() - Method in class j4cups.protocol.AbstractIpp
Gets a collected list of all operation attributes.
getPort() - Method in class j4cups.server.CupsServer
Gives the port where the server is running.
GetPrinterAttributes - Class in j4cups.op
 
GetPrinterAttributes() - Constructor for class j4cups.op.GetPrinterAttributes
Instantiates an operation with the get-printer-attributes id.
GetPrinterAttributes(IppRequest) - Constructor for class j4cups.op.GetPrinterAttributes
Instantiates an operation with the get-printer-attributes id and the given IPP request.
getPrinterAttributes(URI) - Method in class j4cups.server.IppHandler
Sends a get-printer-attributes to CUPS.
getPrinterAttributes(URI) - Method in class j4cups.server.IppProxyHandler
Sends a get-printer-attributes to CUPS.
getPrinterName() - Method in class j4cups.op.Operation
The printer name is the last part of the printer-uri.
GetPrinters - Class in j4cups.op
The class GetPrinters is called if you want to get a list of printers from CUPS.
GetPrinters() - Constructor for class j4cups.op.GetPrinters
Instantiates a new Get printers.
getPrinterURI() - Method in class j4cups.op.Operation
Gets printer uri.
getPrinterURI() - Method in class j4cups.protocol.AbstractIpp
Gets the URI of the printer from the attributes.
getPrintQuality() - Method in class j4cups.protocol.attr.PrinterResolution
Gets print quality.
getProperty(String) - Method in class j4cups.util.XProperties
If the property is unset the value of the system property will be taken as default.
getRequestId() - Method in class j4cups.protocol.AbstractIpp
Returns the 3rd part (byte 4-7) of the request which contains the request-id.
getResponse() - Method in exception j4cups.protocol.IppRequestException
Gets the error response of the request
getServerForwardURI() - Method in class j4cups.Config
Gets server forward URI.
getServerInfo() - Method in class j4cups.Config
 
getServerPort() - Method in class j4cups.Config
Gets server port.
getStatusCode() - Method in class j4cups.protocol.IppResponse
Returns the 2nd part (byte 2-3) with the status-code.
getStatusMessage() - Method in class j4cups.protocol.IppResponse
Gets the content of the attribute 'status-message'.
getStringValue() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
The "value" field contains the value of the attribute.
getStringValue() - Method in class j4cups.protocol.attr.Attribute
The "value" field contains the value of a charset attribute.
getUriValue() - Method in class j4cups.protocol.attr.Attribute
The "value" field contains the value of a URI attribute.
getValue() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
The "value" field contains the value of the attribute.
getValue() - Method in class j4cups.protocol.attr.Attribute
The "value" field contains the value of the attribute.
getValue() - Method in enum j4cups.protocol.enums.JobState
Gets the represenation of the value as 32 bit integer.
getValue() - Method in enum j4cups.protocol.enums.PrintQuality
Gets value.
getValue() - Method in enum j4cups.protocol.tags.DelimiterTags
Gets the byte value of the tag.
getValue() - Method in enum j4cups.protocol.tags.ValueTags
Gets the byte value of the tag.
getValueTag() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
The "value-tag" field specifies the attribute syntax, e.g. 0x44 for the attribute syntax 'keyword'.
getValueTag() - Method in class j4cups.protocol.attr.Attribute
The "value-tag" field specifies the attribute syntax, e.g. 0x44 for the attribute syntax 'keyword'.
getVersion() - Method in class j4cups.protocol.AbstractIpp
Gets the first part (byte 0-1) with the supported IPP version.

H

handle(HttpRequest, HttpResponse, HttpContext) - Method in class j4cups.server.http.AbstractIppRequestHandler
Handles the incoming HTTP request and converts it to a HttpEntityEnclosingRequest (if possible).
handle(HttpEntityEnclosingRequest, HttpResponse) - Method in class j4cups.server.http.AbstractIppRequestHandler
Handles the incomming HTTP request.
handle(HttpEntityEnclosingRequest, HttpResponse) - Method in class j4cups.server.http.IppPrinterRequestHandler
Handles the request and produces a response to be sent back to the client.
handle(HttpRequest, HttpResponse, HttpContext) - Method in class j4cups.server.http.IppServerRequestHandler
Handles the incomming HTTP request.
handle(HttpEntityEnclosingRequest, HttpResponse) - Method in class j4cups.server.http.IppServerRequestHandler
Handles the incomming IPP request and sends it to the real CUPS server (given by the forwardURI or the inserted printer-uri).
handle(BasicHttpRequest, HttpResponse) - Method in class j4cups.server.HttpHandler
 
handle(BasicHttpRequest, HttpResponse) - Method in class j4cups.server.HttpProxyHandler
 
handleException(IppRequest, HttpResponse, ValidationException) - Static method in class j4cups.server.http.AbstractIppRequestHandler
If a ValidationException happens the response is filled with the error message.
hasAttribute(String) - Method in class j4cups.protocol.AbstractIpp
Checks the attribute with the given name.
hasAttribute(String) - Method in class j4cups.protocol.attr.AttributeGroup
Checks if the given attribute is available.
hasData() - Method in class j4cups.protocol.AbstractIpp
The data part of the request can be empty.
hashCode() - Method in class j4cups.protocol.AbstractIpp
 
hashCode() - Method in class j4cups.protocol.AbstractIpp.Version
 
HttpHandler - Class in j4cups.server
The HttpHandler is reponsible for handling HTTP requests.
HttpHandler() - Constructor for class j4cups.server.HttpHandler
 
HttpProxyHandler - Class in j4cups.server
The class HttpProxyHandler forwards HTTP requests to a real CUPS server and acts like a proxy.
HttpProxyHandler(URI) - Constructor for class j4cups.server.HttpProxyHandler
 

I

initPrinterAttributes(AttributeGroup) - Method in class j4cups.op.Operation
Initialiazes printer-attributes with default values.
IppEntity - Class in j4cups.server.http
Class IppEntity.
IppEntity(AbstractIpp) - Constructor for class j4cups.server.http.IppEntity
Instantiates a new entity.
IppEntity(byte[]) - Constructor for class j4cups.server.http.IppEntity
Instantiates a new entity.
IppHandler - Class in j4cups.server
The IppHandler is reponsible for handling IPP requests.
IppHandler(URI) - Constructor for class j4cups.server.IppHandler
Instantiates a new IPP handler.
IppHandler(Path) - Constructor for class j4cups.server.IppHandler
Instantiates a new IPP handler.
IppOperations - Enum in j4cups.protocol
The enum IppOperations represents the IPP operations which are described in RFC-8011.
IppPrinterRequestHandler - Class in j4cups.server.http
The IppPrinterRequestHandler emulates an IPP printer and handles the request you would normally send to an IPP printer.
IppPrinterRequestHandler() - Constructor for class j4cups.server.http.IppPrinterRequestHandler
Instantiates the request handler for the printer emulation.
IppPrinterRequestHandler(Path) - Constructor for class j4cups.server.http.IppPrinterRequestHandler
Instantiates the request handler for the printer emulation.
IppProxyHandler - Class in j4cups.server
The class IppProxyHandler forwards IPP requests to a real CUPS server and acts like a proxy.
IppProxyHandler(URI) - Constructor for class j4cups.server.IppProxyHandler
Instantiates a new Cups client.
IppRequest - Class in j4cups.protocol
The IppRequest represents an IPP request as is defined in RFC-2910.
IppRequest() - Constructor for class j4cups.protocol.IppRequest
This constructor is needed for the Externalizable interface.
IppRequest(byte[]) - Constructor for class j4cups.protocol.IppRequest
Instantiates a new IPP request from the given bytes.
IppRequest(ByteBuffer) - Constructor for class j4cups.protocol.IppRequest
Instantiates a new IPP request from the given bytes.
IppRequestException - Exception in j4cups.protocol
The class IppRequestException can be thrown if there is a problem with an IppRequest.
IppRequestException(IppResponse) - Constructor for exception j4cups.protocol.IppRequestException
Constructs a new runtime exception with the specified IPP response.
IppRequestException(IppResponse, Throwable) - Constructor for exception j4cups.protocol.IppRequestException
Constructs a new runtime exception with the specified IPP response and cause.
IppResponse - Class in j4cups.protocol
The IppResponse represents an IPP response as is defined in RFC-2910.
IppResponse() - Constructor for class j4cups.protocol.IppResponse
This constructor is needed for the Externalizable interface.
IppResponse(byte[]) - Constructor for class j4cups.protocol.IppResponse
Instantiates a new IPP response from the given bytes.
IppResponse(IppRequest) - Constructor for class j4cups.protocol.IppResponse
The IppResponse is the response to a IppRequest.
IppServerRequestHandler - Class in j4cups.server.http
The class IppServerRequestHandler handles the IPP requests.
IppServerRequestHandler() - Constructor for class j4cups.server.http.IppServerRequestHandler
The default ctor is mainly intented for testing.
IppServerRequestHandler(URI) - Constructor for class j4cups.server.http.IppServerRequestHandler
If the request handler acts as a proxy qe need to know the URI where the request should be forwarded.
IppServerRequestHandler(IppHandler, HttpHandler) - Constructor for class j4cups.server.http.IppServerRequestHandler
If the request handler acts as a proxy we need to know the URI where the request should be forwarded.
isCharacterStringValue() - Method in enum j4cups.protocol.tags.ValueTags
One kind of value tags are character-string values, which are the values from 0x40 - 0x4f.
isIntegerValue() - Method in enum j4cups.protocol.tags.ValueTags
One kind of value tags are integer values, which are the values from 0x20 - 0x2f.
isLastDocument() - Method in class j4cups.op.SendDocument
Returns true if the operation belongs to the last document.
isMultiValue() - Method in class j4cups.protocol.attr.Attribute
When the attribte value is multi-valued this method returns true.
isStarted() - Method in class j4cups.server.CupsServer
Looks, if the server is running.
isSuccessful() - Method in enum j4cups.protocol.StatusCode
For the constants which represents an succesful state this method returns true.
isValid(int) - Static method in enum j4cups.protocol.tags.DelimiterTags
The range for a delimiter-tag is between 0 and 0x0f.
isValid(int) - Static method in enum j4cups.protocol.tags.ValueTags
The range for a value-tag is between 0x10 and 0x0f.

J

j4cups - package j4cups
 
j4cups.client - package j4cups.client
 
j4cups.op - package j4cups.op
This is the package for the IPP operations like 'print-job' or 'send-document'.
j4cups.protocol - package j4cups.protocol
This package supports the data types which are described in RFC-2910 and RFC-8011.
j4cups.protocol.attr - package j4cups.protocol.attr
In this package are the building blocks for attribute and attribute-groups.
j4cups.protocol.enums - package j4cups.protocol.enums
This package is the container for enum values.
j4cups.protocol.tags - package j4cups.protocol.tags
This package represents the which are described in section 3.5 of RFC-2910.
j4cups.server - package j4cups.server
If you want to build up your own little CUPS server you find in this package some lightweight components for this task.
j4cups.server.http - package j4cups.server.http
 
j4cups.util - package j4cups.util
 
JobState - Enum in j4cups.protocol.enums
The JobState describes the IPP Job Life Cycle.
JobStateReasons - Enum in j4cups.protocol.enums
This REQUIRED attribute provides additional information about the Job's current state.

L

LogRequestInterceptor - Class in j4cups.server.http
Class LogRequestInterceptor.
LogRequestInterceptor(String) - Constructor for class j4cups.server.http.LogRequestInterceptor
Instantiates a new interceptor.
LogResponseInterceptor - Class in j4cups.server.http
Class LogRequestInterceptor.
LogResponseInterceptor(String) - Constructor for class j4cups.server.http.LogResponseInterceptor
Instantiates a new interceptor.

M

main(String...) - Static method in class j4cups.server.CupsServer
This is the CLI interface to start the CupsServer.

O

of(String, int) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for integer values.
of(String, int, int) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for a range of integer values.
of(String, boolean) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for boolean values.
of(String, URI) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for URI values.
of(String, Charset) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for charset values.
of(String, Locale) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for the given language.
of(ValueTags, String, int) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute for integer based values.
of(ValueTags, String, byte[]) - Static method in class j4cups.protocol.attr.Attribute
Creates a singe-value attribute.
of(ValueTags, String, byte[]...) - Static method in class j4cups.protocol.attr.Attribute
Creates a multi-value attribute for the given value-tag.
of(ValueTags, String, String...) - Static method in class j4cups.protocol.attr.Attribute
Creates a multi-value attribute for character-string values.
of(ValueTags, String, String) - Static method in class j4cups.protocol.attr.Attribute
Creates a single-value attribute for character-string values.
of(String, PrinterResolution...) - Static method in class j4cups.protocol.attr.Attribute
Creates a multi-value attribute with the different printer resolutions.
of(int, int, PrintQuality) - Static method in class j4cups.protocol.attr.PrinterResolution
Returns a PrinterResolution with the given value
of(int) - Static method in enum j4cups.protocol.enums.JobState
Allows you to map a int value to the corresponding value.
of(String) - Static method in enum j4cups.protocol.enums.JobStateReasons
Maps the given string to the corresponding element.
of(int) - Static method in enum j4cups.protocol.IppOperations
Allows you to map an id (or op-code) to the corresponding operation.
of(int) - Static method in enum j4cups.protocol.StatusCode
Allows you to map a value to the corresponding statuscode
of(int) - Static method in enum j4cups.protocol.tags.DelimiterTags
Allows you to map a byte value to the corresponding tag.
of(int) - Static method in enum j4cups.protocol.tags.ValueTags
Allows you to map a byte value to the corresponding tag.
Operation - Class in j4cups.op
This is the common super class of all IPP operations.
Operation(IppOperations) - Constructor for class j4cups.op.Operation
Instantiates an operation with the given id.
Operation(IppOperations, IppRequest) - Constructor for class j4cups.op.Operation
Instantiates an operation with the given id and the given IPP request.

P

print(URI, Path) - Method in class j4cups.client.CupsClient
Sends a print job to the printer.
print(URI, Path...) - Method in class j4cups.client.CupsClient
Sends a list of files as one job to the given printer.
PrinterResolution - Class in j4cups.protocol.attr
This RECOMMENDED attribute identifies the output resolution that the Printer uses for the Job.
PrinterResolution(int, int, PrintQuality) - Constructor for class j4cups.protocol.attr.PrinterResolution
Instantiates a new Printer resolution.
PrintJob - Class in j4cups.op
Class PrintJob represents the print-job operation.
PrintJob() - Constructor for class j4cups.op.PrintJob
Instantiates an operation for 'print-job'.
PrintJob(IppOperations) - Constructor for class j4cups.op.PrintJob
This constructor is foreseen for subclasses.
printJob(URI, Path) - Method in class j4cups.server.IppHandler
Sends a print job to the printer.
printJob(URI, Path) - Method in class j4cups.server.IppProxyHandler
Sends a print job to the printer.
PrintQuality - Enum in j4cups.protocol.enums
This RECOMMENDED attribute specifies the print quality that the Printer uses for the Job.
process(HttpRequest, HttpContext) - Method in class j4cups.server.http.LogRequestInterceptor
Processes a request.
process(HttpResponse, HttpContext) - Method in class j4cups.server.http.LogResponseInterceptor
Processes a response.
put(Object, Object) - Method in class j4cups.util.XProperties
If there is a reference to another value the value will replaced accordingly.

R

readExternal(ObjectInput) - Method in class j4cups.protocol.AbstractIpp
The object implements the readExternal method to restore its contents by reading the byte array and use this array to build up an IPP request or response.
recordTo(Path) - Method in class j4cups.protocol.AbstractIpp
This method allows you to record a IPP package into a file.
recordTo(Path, byte[], String) - Static method in class j4cups.protocol.AbstractIpp
This method is public because it is used also by other methods.
replay(Path) - Method in class j4cups.client.CupsClient
CupsServer allows you to record IPP requests.
run() - Method in class j4cups.server.CupsServer
This is the method to run the server directly.

S

send(Operation) - Method in class j4cups.client.CupsClient
Sends an IPP operation to CUPS.
send(IppRequest) - Method in class j4cups.client.CupsClient
Sends the IPP request to CUPS.
send(IppRequest) - Method in class j4cups.server.IppHandler
Sends an IPP request to a CUPS server.
send(IppRequest) - Method in class j4cups.server.IppProxyHandler
 
sendDocument(URI, Path, int, boolean) - Method in class j4cups.client.CupsClient
 
SendDocument - Class in j4cups.op
Class SendDocument represents the Send-Document operation if IPP.
SendDocument() - Constructor for class j4cups.op.SendDocument
Instantiates an operation for 'send-document'.
sendDocument(URI, Path, int, boolean) - Method in class j4cups.server.IppHandler
Sends one print job of a multiple document to the printer
sendDocument(URI, Path, int, boolean) - Method in class j4cups.server.IppProxyHandler
Sends one print job of a multiple document to the printer
setAttribute(String, byte[]) - Method in class j4cups.protocol.AbstractIpp
Sets the attribute with the given name.
setAttribute(Attribute, DelimiterTags) - Method in class j4cups.protocol.AbstractIpp
Sets the attribute into the group defined by the groupTag.
setAttributesCharset(Charset) - Method in class j4cups.protocol.AbstractIpp
Sets the attributes-charset attribute.
setAttributesNaturalLanguage(Locale) - Method in class j4cups.protocol.AbstractIpp
Sets the attributes-natural-language attribute.
setCupsURI(URI) - Method in class j4cups.op.Operation
Sets the CUPS URI.
setData(byte[]) - Method in class j4cups.op.PrintJob
Sets the data to be printed.
setData(byte[]) - Method in class j4cups.protocol.AbstractIpp
Sets the data part of the request or response.
setDocumentName(String) - Method in class j4cups.op.PrintJob
Sets the document-name.
setIppRequestId(int) - Method in class j4cups.op.Operation
Sets the ID of the IPP request.
setJobAttribute(Attribute) - Method in class j4cups.op.Operation
Sets the given job attribute in the generated IPP request.
setJobAttribute(Attribute) - Method in class j4cups.protocol.AbstractIpp
Sets the job attribute.
setJobId(int) - Method in class j4cups.op.Operation
Sets job id.
setJobId(int) - Method in class j4cups.protocol.AbstractIpp
Sets the job-id.
setJobName(String) - Method in class j4cups.op.PrintJob
Sets the job-name.
setJobState(JobState) - Method in class j4cups.op.Operation
Sets job state.
setJobState(JobState) - Method in class j4cups.protocol.AbstractIpp
Sets the job-state.
setJobStateMessage(String) - Method in class j4cups.protocol.AbstractIpp
Sets the job-state-message.
setJobStateReasons(JobStateReasons) - Method in class j4cups.op.Operation
Sets job state reason.
setJobStateReasons(JobStateReasons) - Method in class j4cups.protocol.AbstractIpp
Sets the job-state-rease.
setJobURI(URI) - Method in class j4cups.protocol.AbstractIpp
Sets the job-uri.
setLastDocument(boolean) - Method in class j4cups.op.SendDocument
To print multiple documents the last document must be marked as "last-document".
setOpCode(short) - Method in class j4cups.protocol.AbstractIpp
Sets the 2nd part (byte 2-3) with the new operation-id or status-code.
setOperationAttribute(Attribute) - Method in class j4cups.op.Operation
Sets the given operation attribute in the generated IPP request.
setOperationAttribute(Attribute) - Method in class j4cups.protocol.AbstractIpp
Sets the operation attribute.
setPrinterName(String) - Method in class j4cups.op.GetDefault
Sets the default printer.
setPrinterURI(URI) - Method in class j4cups.op.Operation
Sets the printer-uri.
setPrinterURI(URI) - Method in class j4cups.protocol.AbstractIpp
Sets the printer-uri attribute.
setRequestId(int) - Method in class j4cups.protocol.AbstractIpp
Sets the request-id.
setRequestingUserName(String) - Method in class j4cups.protocol.AbstractIpp
Sets the requesting-user-name attribute.
setStatusCode(StatusCode) - Method in class j4cups.protocol.IppResponse
Set the 2nd part (byte 2-3) with the new status-code.
setStatusMessage(String) - Method in class j4cups.protocol.IppResponse
In case of a bad request or other error status you can set the message for this status with this function.
setValue(byte[]) - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
Sets the value of the attribute.
setValue(byte[]) - Method in class j4cups.protocol.attr.Attribute
Sets the value of the attribute.
shutdown() - Method in class j4cups.server.CupsServer
This is the command to shut down the server.
start() - Method in class j4cups.server.CupsServer
This is the method to start the server in the background.
StatusCode - Enum in j4cups.protocol
The status-code values range from 0x0000 to 0x7fff.

T

toByteArray() - Method in class j4cups.protocol.AbstractIpp
Converts the IppResponse to a byte array as described in RFC-2910.
toByteArray() - Method in class j4cups.protocol.AbstractIpp.Version
 
toByteArray() - Method in class j4cups.protocol.attr.Attribute.AttributeWithOneValue
Converts an attribute-with-one-value to a byte array.
toByteArray() - Method in class j4cups.protocol.attr.PrinterResolution
Creates a byte array of 9 bytes with the resolutions and quality as described in RFC-2910 (chapter 3.9).
toByteArray() - Method in interface j4cups.protocol.Binary
Converts the object to its binary presentation
toIPP(URI) - Static method in class j4cups.op.Operation
Converts the given URI into an URI beginning with "ipp://...".
toIppRequest(HttpEntityEnclosingRequest) - Static method in class j4cups.server.http.IppEntity
This is a utility method to convert an HttpEntityEnclosingRequest to an IppRequest.
toIppResponse(HttpResponse) - Static method in class j4cups.server.http.IppEntity
This is a utility method to convert an HttpResponse to an IppResponse.
toLongString() - Method in class j4cups.protocol.AbstractIpp
Puts all attribute information into the resulting string.
toLongString() - Method in class j4cups.protocol.attr.Attribute
This method shows a short representation of an attribute.
toLongString() - Method in class j4cups.protocol.attr.AttributeGroup
All attribute values are put into the resulting string.
toShortString() - Method in class j4cups.protocol.AbstractIpp
Provides a shorter version with only the main elements and attributes.
toString() - Method in class j4cups.client.CupsClient
 
toString() - Method in class j4cups.protocol.AbstractIpp
With this toString() implementation we want to provide the most important values which are useful for logging and debugging.
toString() - Method in class j4cups.protocol.AbstractIpp.Version
Prints the two bytes as string.
toString() - Method in class j4cups.protocol.attr.Attribute
This method shows a short representation of an attribute.
toString() - Method in class j4cups.protocol.attr.AttributeGroup
With this toString() implementation we want to provide the most important values which are useful for logging and debugging.
toString() - Method in class j4cups.protocol.attr.PrinterResolution
 
toString() - Method in enum j4cups.protocol.enums.JobStateReasons
This implementation generates the same representation as described in section RFC-8011 (section 5.3.8).
toString() - Method in enum j4cups.protocol.IppOperations
This implementation generates the same representation as described in section RFC-8011 (section 5.4.15).
toString() - Method in enum j4cups.protocol.StatusCode
This implementation generates the same representation as described in section RFC-8011 (section 5.4.15).
toString() - Method in enum j4cups.protocol.tags.DelimiterTags
This implementation generates the same representation as in the corresponding RFCs.
toString() - Method in class j4cups.server.CupsServer
For a useful toString implementation we put the port into it.
toString() - Method in class j4cups.server.IppHandler
 
toString() - Method in class j4cups.server.IppProxyHandler
 

V

validate() - Method in class j4cups.protocol.AbstractIpp
Validates an request.
validateRequest(byte[]) - Method in class j4cups.op.Operation
Looks if the given bytes represents a valid request.
validateRequest(IppRequest) - Method in class j4cups.op.Operation
Looks if the given request is valid.
validateRequest() - Method in class j4cups.op.Operation
Looks if the stored request is valid.
validateRequest(IppRequest) - Method in class j4cups.op.PrintJob
Looks if the given request is valid.
valueOf(String) - Static method in enum j4cups.protocol.enums.JobState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.enums.JobStateReasons
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.enums.PrintQuality
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.IppOperations
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.StatusCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.tags.DelimiterTags
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum j4cups.protocol.tags.ValueTags
Returns the enum constant of this type with the specified name.
values() - Static method in enum j4cups.protocol.enums.JobState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.enums.JobStateReasons
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.enums.PrintQuality
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.IppOperations
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.StatusCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.tags.DelimiterTags
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum j4cups.protocol.tags.ValueTags
Returns an array containing the constants of this enum type, in the order they are declared.
ValueTags - Enum in j4cups.protocol.tags
The ValueTags specify the type of each attribute value.
Version(byte, byte) - Constructor for class j4cups.protocol.AbstractIpp.Version
Expects the first two bytes of an IPP request or response.

W

withProperty(String, String) - Method in class j4cups.Config
Fluent API for setting a property.
withServerForwardURI(String) - Method in class j4cups.Config
If the server acts like a proxy you set the URI to the forwardded CUPS server here.
withServerPort(int) - Method in class j4cups.Config
Fluent API for setting the server port.
writeBinaryTo(OutputStream) - Method in class j4cups.protocol.attr.Attribute
Converts the attribute to a byte array as described in RFC-2910 and writes it to the given output-stream.
writeBinaryTo(OutputStream) - Method in class j4cups.protocol.attr.AttributeGroup
Converts the attribute-group to a byte array as described in RFC-2910 and writes it to the given output-stream.
writeBinaryTo(OutputStream) - Method in interface j4cups.protocol.Binary
Writes the binary presentation to an output stream.
writeExternal(ObjectOutput) - Method in class j4cups.protocol.AbstractIpp
The object implements the writeExternal method to save its contents by storing it as byte array.

X

XProperties - Class in j4cups.util
The eXtended Properties (or XProperties) is a extension of the normal properties and allows variable substitution.
XProperties() - Constructor for class j4cups.util.XProperties
 
A B C D E G H I J L M O P R S T V W X 
Skip navigation links

Copyright © 2018–2020. All rights reserved.