public class AQjmsStreamMessage extends AQjmsMessage implements StreamMessage
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
Modifier and Type | Method and Description |
---|---|
void |
clearBody()
Clear out the message body.
|
java.io.OutputStream |
getBody(java.io.OutputStream outputStream)
Writes the message body to the OutputStream specified.
|
java.io.OutputStream |
getBody(java.io.OutputStream outputStream, int chunkSize)
Writes the message body to the OutputStream specified, with chunkSize bytes written at a time.
|
java.io.OutputStream |
getBody(java.io.OutputStream outputStream, int chunkSize, long timeout)
Writes the message body to the OutputStream specified, chunkSize bytes at a time.
|
java.io.OutputStream |
getBody(java.io.OutputStream outputStream, long timeout)
Writes the message body to the OutputStream specified.
|
boolean |
readBoolean()
Reads a
boolean from the stream message. |
byte |
readByte()
Reads a
byte value from the stream message. |
int |
readBytes(byte[] value)
Reads a byte array field from the stream message into the specified
byte[] object (the read buffer). |
char |
readChar()
Reads a Unicode character value from the stream message.
|
double |
readDouble()
Reads a
double from the stream message. |
float |
readFloat()
Reads a
float from the stream message. |
int |
readInt()
Reads a 32-bit integer from the stream message.
|
long |
readLong()
Reads a 64-bit integer from the stream message.
|
java.lang.Object |
readObject()
Reads an object from the stream message.
|
short |
readShort()
Reads a 16-bit integer from the stream message.
|
java.lang.String |
readString()
Reads a
String from the stream message. |
void |
reset()
Puts the message body in read-only mode and repositions the stream to the beginning.
|
void |
setInputStream(java.io.InputStream inputStream)
Writes an InputStream to the bytes message stream
|
void |
writeBoolean(boolean value)
Writes a
boolean to the stream message. |
void |
writeByte(byte value)
Writes a
byte to the stream message. |
void |
writeBytes(byte[] value)
Writes a byte array field to the stream message.
|
void |
writeBytes(byte[] value, int offset, int length)
Writes a portion of a byte array as a byte array field to the stream message.
|
void |
writeChar(char value)
Writes a
char to the stream message. |
void |
writeDouble(double value)
Writes a
double to the stream message. |
void |
writeFloat(float value)
Writes a
float to the stream message. |
void |
writeInt(int value)
Writes an
int to the stream message. |
void |
writeLong(long value)
Writes a
long to the stream message. |
void |
writeObject(java.lang.Object value)
Writes an object to the stream message.
|
void |
writeShort(short value)
Writes a
short to the stream message. |
void |
writeString(java.lang.String value)
Writes a
String to the stream message. |
acknowledge, clearProperties, getAttempts, getBodyLength, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSMessageIDAsBytes, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getSenderID, getShortProperty, getStringProperty, getUserPropertyNames, isLargeBody, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setSenderID, setShortProperty, setStringProperty, test_getUserProperties
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
acknowledge, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty
public boolean readBoolean() throws JMSException
boolean
from the stream message.readBoolean
in interface StreamMessage
boolean
value readJMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.public byte readByte() throws JMSException
byte
value from the stream message.readByte
in interface StreamMessage
byte
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.public short readShort() throws JMSException
readShort
in interface StreamMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.public char readChar() throws JMSException
readChar
in interface StreamMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalidMessageNotReadableException
- if the message is in write-only mode.public int readInt() throws JMSException
readInt
in interface StreamMessage
int
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.public long readLong() throws JMSException
readLong
in interface StreamMessage
long
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.public float readFloat() throws JMSException
float
from the stream message.readFloat
in interface StreamMessage
float
value from the stream messageJMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.public double readDouble() throws JMSException
double
from the stream message.readDouble
in interface StreamMessage
double
value from the stream messageJMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.public java.lang.String readString() throws JMSException
String
from the stream message.readString
in interface StreamMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.public int readBytes(byte[] value) throws JMSException
byte[]
object (the read buffer).
To read the field value, readBytes
should be successively called until it returns a value less than the length of the read buffer. The value of the bytes in the buffer following the last byte read is undefined.
If readBytes
returns a value equal to the length of the buffer, a subsequent readBytes
call must be made. If there are no more bytes to be read, this call returns -1.
If the byte array field value is null, readBytes
returns -1.
If the byte array field value is empty, readBytes
returns 0.
Once the first readBytes
call on a byte[]
field value has been made, the full value of the field must be read before it is valid to read the next field. An attempt to read the next field before that has been done will throw a MessageFormatException
.
To read the byte field value into a new byte[]
object, use the readObject
method.
readBytes
in interface StreamMessage
value
- the buffer into which the data is readJMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.AQjmsStreamMessage.readObject()
public java.lang.Object readObject() throws JMSException
This method can be used to return, in objectified format, an object in the Java programming language ("Java object") that has been written to the stream with the equivalent writeObject
method call, or its equivalent primitive writetype
method.
Note that byte values are returned as byte[]
, not Byte[]
.
An attempt to call readObject
to read a byte field value into a new byte[]
object before the full value of the byte field has been read will throw a MessageFormatException
.
readObject
in interface StreamMessage
int
, an Integer
is returned)JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of message stream has been reached.MessageFormatException
- if this type conversion is invalid.MessageNotReadableException
- if the message is in write-only mode.AQjmsStreamMessage.readBytes(byte[] value)
public void writeBoolean(boolean value) throws JMSException
boolean
to the stream message. The value true
is written as the value (byte)1
; the value false
is written as the value (byte)0
.writeBoolean
in interface StreamMessage
value
- the boolean
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeByte(byte value) throws JMSException
byte
to the stream message.writeByte
in interface StreamMessage
value
- the byte
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeShort(short value) throws JMSException
short
to the stream message.writeShort
in interface StreamMessage
value
- the short
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeChar(char value) throws JMSException
char
to the stream message.writeChar
in interface StreamMessage
value
- the char
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeInt(int value) throws JMSException
int
to the stream message.writeInt
in interface StreamMessage
value
- the int
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeLong(long value) throws JMSException
long
to the stream message.writeLong
in interface StreamMessage
value
- the long
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeFloat(float value) throws JMSException
float
to the stream message.writeFloat
in interface StreamMessage
value
- the float
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeDouble(double value) throws JMSException
double
to the stream message.writeDouble
in interface StreamMessage
value
- the double
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeString(java.lang.String value) throws JMSException
String
to the stream message.writeString
in interface StreamMessage
value
- the String
value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeBytes(byte[] value) throws JMSException
The byte array value
is written to the message as a byte array field. Consecutively written byte array fields are treated as two distinct fields when the fields are read.
writeBytes
in interface StreamMessage
value
- the byte array value to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeBytes(byte[] value, int offset, int length) throws JMSException
The a portion of the byte array value
is written to the message as a byte array field. Consecutively written byte array fields are treated as two distinct fields when the fields are read.
writeBytes
in interface StreamMessage
value
- the byte array value to be writtenoffset
- the initial offset within the byte arraylength
- the number of bytes to useJMSException
- if the JMS provider fails to write the message due to some internal error.MessageNotWriteableException
- if the message is in read-only mode.public void writeObject(java.lang.Object value) throws JMSException
This method works only for the objectified primitive object types (Integer
, Double
, Long
...), String
objects, and byte arrays.
writeObject
in interface StreamMessage
value
- the Java object to be writtenJMSException
- if the JMS provider fails to write the message due to some internal error.MessageFormatException
- if the object is invalid.MessageNotWriteableException
- if the message is in read-only mode.public void setInputStream(java.io.InputStream inputStream) throws JMSException
inputStream
- - InputStream to read the message payloadJMSException
- - if the JMS provided fails to read the payload due to some internal errorpublic java.io.OutputStream getBody(java.io.OutputStream outputStream) throws JMSException
outputStream
- - the OutputStream to which message body can be writtenJMSException
- - if the JMS provided fails to receive the message body due to some internal errorpublic java.io.OutputStream getBody(java.io.OutputStream outputStream, int chunkSize) throws JMSException
outputStream
- - the OutputStream to which message body can be writtenchunkSize
- - the number of bytes to be written at a time, default value 8192 (ie. 8KB)JMSException
- - if the JMS provided fails to receive the message body due to some internal errorpublic java.io.OutputStream getBody(java.io.OutputStream outputStream, long timeout) throws JMSException
outputStream
- - the OutputStream to which message body can be writtentimeout
- - the timeout value (in milliseconds)JMSException
- - if the JMS provided fails to receive the message body due to some internal errorpublic java.io.OutputStream getBody(java.io.OutputStream outputStream, int chunkSize, long timeout) throws JMSException
outputStream
- - the OutputStream to which message body can be writtenchunkSize
- - the number of bytes to be written at a time, default value 8192 (ie. 8KB)timeout
- - the timeout value (in milliseconds)JMSException
- - if the JMS provided fails to receive the message body due to some internal errorpublic void reset() throws JMSException
reset
in interface StreamMessage
JMSException
- if the JMS provider fails to reset the message due to some internal error.MessageFormatException
- if the message has an invalid format.public void clearBody() throws JMSException
clearBody
in interface Message
clearBody
in class AQjmsMessage
JMSException
- if JMS fails to due to some internal JMS error.