j4cups.protocol

Class IppRequest

java.lang.Object

j4cups.protocol.AbstractIpp

j4cups.protocol.IppRequest

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class IppRequest
extends AbstractIpp

The IppRequest represents an IPP request as is defined in RFC-2910.

  -----------------------------------------------
  |                  version-number             |   2 bytes  - required
  -----------------------------------------------
  |               operation-id (request)        |   2 bytes  - required
  -----------------------------------------------
  |                   request-id                |   4 bytes  - required
  -----------------------------------------------
  |                 attribute-group             |   n bytes - 0 or more
  -----------------------------------------------
  |              end-of-attributes-tag          |   1 byte   - required
  -----------------------------------------------
  |                     data                    |   q bytes  - optional
  -----------------------------------------------
 

Since:

0.0.1 (09.02.2018)

Author:

oboehm

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class j4cups.protocol.AbstractIpp

AbstractIpp.Version

Field Summary

Fields inherited from class j4cups.protocol.AbstractIpp

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
IppRequest() This constructor is needed for the Externalizable interface.
IppRequest(byte[] bytes) Instantiates a new IPP request from the given bytes.
IppRequest(java.nio.ByteBuffer bytes) Instantiates a new IPP request from the given bytes.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getOpCodeAsString() Returns the 2nd part (byte 2-3) with the operation-id as string.
IppOperations	getOperation() Returns the 2nd part (byte 2-3) with the operation-id.

Methods inherited from class j4cups.protocol.AbstractIpp

addAttributeGroup, equals, getAttribute, getAttributeGroup, getAttributeGroups, getAttributes, getData, getJobId, getJobState, getJobStateMessage, getJobStateReasons, getJobURI, getLength, getOpCode, getOperationAttributes, getPrinterURI, getRequestId, getVersion, hasAttribute, hasData, hashCode, readExternal, recordTo, recordTo, setAttribute, setAttribute, setAttributesCharset, setAttributesNaturalLanguage, setData, setJobAttribute, setJobId, setJobState, setJobStateMessage, setJobStateReasons, setJobURI, setOpCode, setOperationAttribute, setPrinterURI, setRequestId, setRequestingUserName, toByteArray, toLongString, toShortString, toString, validate, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

IppRequest

public IppRequest()

This constructor is needed for the Externalizable interface.

IppRequest

public IppRequest(byte[] bytes)

Instantiates a new IPP request from the given bytes.

Parameters:

bytes - the bytes of the IPP request

IppRequest

public IppRequest(java.nio.ByteBuffer bytes)

Instantiates a new IPP request from the given bytes.

Parameters:

bytes - the bytes of the IPP request

Method Detail

getOperation

public IppOperations getOperation()

Returns the 2nd part (byte 2-3) with the operation-id.

Returns:

e.g. IppOperations.CREATE_JOB

getOpCodeAsString

protected java.lang.String getOpCodeAsString()

Returns the 2nd part (byte 2-3) with the operation-id as string.

Specified by:

getOpCodeAsString in class AbstractIpp

Returns:

e.g. "Create-Job"