public class AQjmsBytesMessage extends AQjmsMessage implements BytesMessage
javax.jms.BytesMessage
.DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
Modifier and Type | Method and Description |
---|---|
void |
clearBody()
Clears 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.
|
long |
getBodyLength()
Gets the number of bytes of the message body when the message is in read-only mode.
|
boolean |
readBoolean()
Reads a
boolean from the bytes message stream. |
byte |
readByte()
Reads a signed 8-bit value from the bytes message stream.
|
int |
readBytes(byte[] value)
Reads a byte array from the bytes message stream.
|
int |
readBytes(byte[] value, int length)
Reads a portion of the bytes message stream.
|
char |
readChar()
Reads a Unicode character value from the bytes message stream.
|
double |
readDouble()
Reads a
double from the bytes message stream. |
float |
readFloat()
Reads a
float from the bytes message stream. |
int |
readInt()
Reads a signed 32-bit integer from the bytes message stream.
|
long |
readLong()
Reads a signed 64-bit integer from the bytes message stream.
|
short |
readShort()
Reads a signed 16-bit number from the bytes message stream.
|
int |
readUnsignedByte()
Reads an unsigned 8-bit number from the bytes message stream.
|
int |
readUnsignedShort()
Reads an unsigned 16-bit number from the bytes message stream.
|
java.lang.String |
readUTF()
Reads a string that has been encoded using a modified UTF-8 format from the bytes message stream.
|
void |
reset()
Puts the message body in read-only mode and repositions the stream of bytes 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 bytes message stream as a 1-byte value. |
void |
writeByte(byte value)
Writes a
byte to the bytes message stream as a 1-byte value. |
void |
writeBytes(byte[] value)
Writes a byte array to the bytes message stream.
|
void |
writeBytes(byte[] value, int offset, int length)
Writes a portion of a byte array to the bytes message stream.
|
void |
writeChar(char value)
Writes a
char to the bytes message stream as a 2-byte value, high byte first. |
void |
writeDouble(double value)
Converts the
double argument to a long using the doubleToLongBits method in class Double , and then writes that long value to the bytes message stream as an 8-byte quantity, high byte first. |
void |
writeFloat(float value)
Converts the
float argument to an int using the floatToIntBits method in class Float , and then writes that int value to the bytes message stream as a 4-byte quantity, high byte first. |
void |
writeInt(int value)
Writes an
int to the bytes message stream as four bytes, high byte first. |
void |
writeLong(long value)
Writes a
long to the bytes message stream as eight bytes, high byte first. |
void |
writeObject(java.lang.Object value)
Writes an object to the bytes message stream.
|
void |
writeShort(short value)
Writes a
short to the bytes message stream as two bytes, high byte first. |
void |
writeUTF(java.lang.String value)
Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner.
|
acknowledge, clearProperties, getAttempts, 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 bytes message stream.readBoolean
in interface BytesMessage
boolean
value readJMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public byte readByte() throws JMSException
readByte
in interface BytesMessage
byte
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public int readUnsignedByte() throws JMSException
readUnsignedByte
in interface BytesMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public short readShort() throws JMSException
readShort
in interface BytesMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public int readUnsignedShort() throws JMSException
readUnsignedShort
in interface BytesMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public char readChar() throws JMSException
readChar
in interface BytesMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public int readInt() throws JMSException
readInt
in interface BytesMessage
int
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public long readLong() throws JMSException
readLong
in interface BytesMessage
long
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public float readFloat() throws JMSException
float
from the bytes message stream.readFloat
in interface BytesMessage
float
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public double readDouble() throws JMSException
double
from the bytes message stream.readDouble
in interface BytesMessage
double
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public java.lang.String readUTF() throws JMSException
For more information on the UTF-8 format, see "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, X/Open Company Ltd., Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.
readUTF
in interface BytesMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageEOFException
- if unexpected end of bytes stream has been reached.MessageNotReadableException
- if the message is in write-only mode.public int readBytes(byte[] value) throws JMSException
If the length of array value
is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.
If the number of bytes remaining in the stream is less than the length of array value
, the bytes should be read into the array. The return value of the total number of bytes read will be less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.
readBytes
in interface BytesMessage
value
- the buffer into which the data is readJMSException
- if the JMS provider fails to read the message due to some internal error.MessageNotReadableException
- if the message is in write-only mode.public int readBytes(byte[] value, int length) throws JMSException
If the length of array value
is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.
If the number of bytes remaining in the stream is less than the length of array value
, the bytes should be read into the array. The return value of the total number of bytes read will be less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.
If length
is negative, or length
is greater than the length of the array value
, then an IndexOutOfBoundsException
is thrown. No bytes will be read from the stream for this exception case.
readBytes
in interface BytesMessage
value
- the buffer into which the data is readlength
- the number of bytes to read; must be less than or equal to value.length
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageNotReadableException
- if the message is in write-only mode.public void writeBoolean(boolean value) throws JMSException
boolean
to the bytes message stream as a 1-byte value. The value true
is written as the value (byte)1
; the value false
is written as the value (byte)0
.writeBoolean
in interface BytesMessage
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 bytes message stream as a 1-byte value.writeByte
in interface BytesMessage
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 bytes message stream as two bytes, high byte first.writeShort
in interface BytesMessage
value
- the short
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 bytes message stream as a 2-byte value, high byte first.writeChar
in interface BytesMessage
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 bytes message stream as four bytes, high byte first.writeInt
in interface BytesMessage
value
- the int
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 bytes message stream as eight bytes, high byte first.writeLong
in interface BytesMessage
value
- the long
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
argument to an int
using the floatToIntBits
method in class Float
, and then writes that int
value to the bytes message stream as a 4-byte quantity, high byte first.writeFloat
in interface BytesMessage
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
argument to a long
using the doubleToLongBits
method in class Double
, and then writes that long
value to the bytes message stream as an 8-byte quantity, high byte first.writeDouble
in interface BytesMessage
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 writeUTF(java.lang.String value) throws JMSException
For more information on the UTF-8 format, see "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, X/Open Company Ltd., Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.
writeUTF
in interface BytesMessage
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
writeBytes
in interface BytesMessage
value
- the byte array 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
writeBytes
in interface BytesMessage
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 BytesMessage
value
- the object in the Java programming language ("Java object") to be written; it must not be nullJMSException
- if the JMS provider fails to write the message due to some internal error.MessageFormatException
- if the object is of an invalid type.MessageNotWriteableException
- if the message is in read-only mode.java.lang.NullPointerException
- if the parameter value
is null.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 BytesMessage
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
AQjmsMessage
clearBody
in interface Message
clearBody
in class AQjmsMessage
JMSException
- if the message body is not cleared due to some error.public long getBodyLength() throws JMSException
getBodyLength
in interface BytesMessage
getBodyLength
in class AQjmsMessage
JMSException
- if the JMS provider fails to read the message due to some internal error.MessageNotReadableException
- if the message is in write-only mode.