j4cups.protocol

Class AbstractIpp

java.lang.Object

j4cups.protocol.AbstractIpp

Direct Known Subclasses:

IppRequest, IppResponse

public abstract class AbstractIpp
extends Object

The class AbstractIpp is the common super class of IppRequest and IppResponse which encapsulates the common code of both classes. An operation request or response is defined in RFC-2910:

  -----------------------------------------------
  |                  version-number             |   2 bytes  - required
  -----------------------------------------------
  |               operation-id (request)        |
  |                      or                     |   2 bytes  - required
  |               status-code (response)        |
  -----------------------------------------------
  |                   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.2 (16.02.2018)

Author:

oboehm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractIpp.Version Container for the version information.

Field Summary

Fields

Modifier and Type	Field and Description
protected static AbstractIpp.Version	DEFAULT_VERSION The actual supported version is 2.

Constructor Summary

Constructors

Modifier	Constructor and Description
	AbstractIpp(AbstractIpp.Version version, short opCode, int requestId, List<AttributeGroup> groups) Instantiates a new IPP request or response with no data.
	AbstractIpp(AbstractIpp.Version version, short opCode, int requestId, List<AttributeGroup> groups, byte[] data) Instantiates a new IPP request or response.
protected	AbstractIpp(byte[] bytes) Instantiates a new IPP request or responsel from the given bytes.
	AbstractIpp(ByteBuffer bytes) Instantiates a new IPP request or response from the given bytes.

Method Summary

Modifier and Type	Method and Description
Attribute	getAttribute(String name) Gets the attribute with the given name.
List<AttributeGroup>	getAttributeGroups() The fourth field is the "attribute-group" field, and it occurs 0 or more times.
List<Attribute>	getAttributeGroups(DelimiterTags tag) Returns all attributes of the given delimiter-tag.
List<Attribute>	getAttributes() Gets a collected list of all attributes of the attribute-groups.
byte[]	getData() Returns the data part of the request.
short	getOpCode() Returns the 2nd part (byte 2-3) with the operation-id or status-code.
protected abstract String	getOpCodeAsString() Returns the 2nd part (byte 2-3) with the operation-id or status-code as string.
int	getRequestId() Retunns the 3rd part (byte 4-7) of the request which contains the request-id.
AbstractIpp.Version	getVersion() Gets the first part (byte 0-1) with the supported IPP version.
boolean	hasData() The data part of the request can be empty.
byte[]	toByteArray() Converts the IppResponse to a byte array as described in RFC-2910.
String	toLongString() Puts all attribute information into the resulting string.
String	toString() With this toString() implementation we want to provide the most important values which are useful for logging and debugging.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VERSION

protected static final AbstractIpp.Version DEFAULT_VERSION

The actual supported version is 2.

Constructor Detail

AbstractIpp

protected AbstractIpp(byte[] bytes)

Instantiates a new IPP request or responsel from the given bytes.

Parameters:

bytes - the bytes of the IPP request

AbstractIpp

public AbstractIpp(ByteBuffer bytes)

Instantiates a new IPP request or response from the given bytes.

Parameters:

bytes - the bytes of the IPP request

AbstractIpp

public AbstractIpp(AbstractIpp.Version version,
                   short opCode,
                   int requestId,
                   List<AttributeGroup> groups)

Instantiates a new IPP request or response with no data.

Parameters:

version - the version

opCode - the code for operation-id or status-code

requestId - the request id

groups - the attribute groups

AbstractIpp

public AbstractIpp(AbstractIpp.Version version,
                   short opCode,
                   int requestId,
                   List<AttributeGroup> groups,
                   byte[] data)

Instantiates a new IPP request or response.

Parameters:

version - the version

opCode - the code for operation-id or status-code

requestId - the request id

groups - the attribute groups

data - the data

Method Detail

getVersion

public AbstractIpp.Version getVersion()

Gets the first part (byte 0-1) with the supported IPP version. This is a number from 1.0 till 1.4 for version 1 or 2.0 for version 2.

Returns:

e.g. "2.0"

getOpCode

public short getOpCode()

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

Returns:

e.g. 0x0005 for 'Create-Job'

getOpCodeAsString

protected abstract String getOpCodeAsString()

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

Returns:

e.g. "Create-Job"

getRequestId

public int getRequestId()

Retunns the 3rd part (byte 4-7) of the request which contains the request-id.

Returns:

the request-id

getAttributeGroups

public List<AttributeGroup> getAttributeGroups()

The fourth field is the "attribute-group" field, and it occurs 0 or more times.

Returns:

a list of attribute-groups

getAttributeGroups

public List<Attribute> getAttributeGroups(DelimiterTags tag)

Returns all attributes of the given delimiter-tag.

Parameters:

tag - the delimiter-tag

Returns:

list of attributes

getAttributes

public List<Attribute> getAttributes()

Gets a collected list of all attributes of the attribute-groups.

Returns:

list of all attibutes

getAttribute

public Attribute getAttribute(String name)

Gets the attribute with the given name. If not attribute with the given name is found an IllegalArgumentException will be thrown.

Parameters:

name - name of the attribute

Returns:

attribute with given name

getData

public byte[] getData()

Returns the data part of the request. If no data part is present a 0-length byte array is returned.

Returns:

data part

hasData

public boolean hasData()

The data part of the request can be empty.

Returns:

false if data part is empty, true otherwise

toString

public String toString()

With this toString() implementation we want to provide the most important values which are useful for logging and debugging.

Overrides:

toString in class Object

Returns:

a String with operation, request-id and other stuff

toLongString

public String toLongString()

Puts all attribute information into the resulting string. The data value may be abbreviated if it is too long. But you can set the log level to TRACE if you want to record the full request.

Returns:

string with all attribute values

toByteArray

public byte[] toByteArray()

Converts the IppResponse to a byte array as described in RFC-2910.

  -----------------------------------------------
  |                  version-number             |   2 bytes  - required
  -----------------------------------------------
  |          operation-id or status-code        |   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
  -----------------------------------------------
 

Returns:

at least 9 bytes