j4cups.protocol

Class IppResponse

java.lang.Object

j4cups.protocol.AbstractIpp

j4cups.protocol.IppResponse

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class IppResponse
extends AbstractIpp

The IppResponse represents an IPP response as 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.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
IppResponse() This constructor is needed for the Externalizable interface.
IppResponse(byte[] bytes) Instantiates a new IPP response from the given bytes.
IppResponse(IppRequest request) The IppResponse is the response to a IppRequest.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getOpCodeAsString() Returns the 2nd part (byte 2-3) with the status-code as string.
StatusCode	getStatusCode() Returns the 2nd part (byte 2-3) with the status-code.
java.lang.String	getStatusMessage() Gets the content of the attribute 'status-message'.
void	setStatusCode(StatusCode code) Set the 2nd part (byte 2-3) with the new status-code.
void	setStatusMessage(java.lang.String message) In case of a bad request or other error status you can set the message for this status with this function.

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

IppResponse

public IppResponse()

This constructor is needed for the Externalizable interface.

IppResponse

public IppResponse(byte[] bytes)

Instantiates a new IPP response from the given bytes.

Parameters:

bytes - the bytes of the IPP request

IppResponse

public IppResponse(IppRequest request)

The IppResponse is the response to a IppRequest. So you need the id of the IppRequest to create a response.

Parameters:

request - the request for this response

Method Detail

setStatusCode

public void setStatusCode(StatusCode code)

Set the 2nd part (byte 2-3) with the new status-code.

Parameters:

code - the new status code

getStatusCode

public StatusCode getStatusCode()

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

Returns:

e.g. StatusCode.SUCCESSFUL_OK

setStatusMessage

public void setStatusMessage(java.lang.String message)

In case of a bad request or other error status you can set the message for this status with this function.

Parameters:

message - the status message

Since:

0.5

getStatusMessage

public java.lang.String getStatusMessage()

Gets the content of the attribute 'status-message'.

Returns:

string with the status message

Since:

0.5

getOpCodeAsString

protected java.lang.String getOpCodeAsString()

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

Specified by:

getOpCodeAsString in class AbstractIpp

Returns:

e.g. "successful-ok"