|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mqe.jms.MQeMessage | +--com.ibm.mqe.jms.MQeBytesMessage
A BytesMessage
is used to send a message containing a stream of
uninterpreted bytes. It inherits from MQeMessage
and adds a bytes message body. The receiver of the message must interpret
these bytes. This message type is intended for client encoding of existing
message formats, and, if possible, one of the other self-defining message
types should be used instead.
The primitive types can be written explicitly using methods
for each type. They may also be written generically as objects.
For instance, a call to BytesMessage.writeInt(6)
is
equivalent to BytesMessage.writeObject(new Integer(6))
.
Both forms are provided because the explicit form is convenient for
static programming and the object form is needed when types are not known
at compile time.
When the message is first created, and when MQeMessage.clearBody()
is called, the body of the message is in write-only mode. After the
first call to reset()
has been made, the message is in
read-only mode. When a message has been sent, by definition, the
provider calls reset()
in order to read it's content, and
when a message has been received, the provider has called
reset()
so that the message is in read-only mode for the client.
If MQeMessage.clearBody()
is called on a message in read-only mode,
the message body is cleared and the message is in write-only mode.
If a client attempts to read a message in write-only mode a
MessageNotReadableException
is thrown, and similarly
if a client attempts to write a message in read-only mode a
MessageNotWriteableException
is thrown.
Session.createBytesMessage()
,
MapMessage
,
Message
,
ObjectMessage
,
StreamMessage
,
TextMessage
Field Summary |
Fields inherited from class com.ibm.mqe.jms.MQeMessage |
DEFAULT_DELIVERY_MODE |
Fields inherited from interface javax.jms.Message |
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE |
Constructor Summary | |
MQeBytesMessage()
|
Method Summary | |
long |
getBodyLength()
Gets the number of bytes of the message body when the message is in read-only mode. |
boolean |
readBoolean()
Read a boolean from the bytes message. |
byte |
readByte()
Read a signed 8-bit value from the bytes message. |
int |
readBytes(byte[] value)
Read a byte array from the bytes message. |
int |
readBytes(byte[] value,
int length)
Read a portion of the bytes message. |
char |
readChar()
Read a Unicode character value from the bytes message. |
double |
readDouble()
Read a double from the bytes message. |
float |
readFloat()
Read a float from the bytes message. |
int |
readInt()
Read a signed 32-bit integer from the bytes message. |
long |
readLong()
Read a signed 64-bit integer from the bytes message. |
short |
readShort()
Read a signed 16-bit number from the bytes message. |
int |
readUnsignedByte()
Read an unsigned 8-bit number from the bytes message. |
int |
readUnsignedShort()
Read an unsigned 16-bit number from the bytes message. |
java.lang.String |
readUTF()
Read in a string that has been encoded using a modified UTF-8 format from the bytes message. |
void |
reset()
Put the message in read-only mode, and reposition the stream of bytes to the beginning. |
void |
writeBoolean(boolean value)
Write a boolean to the bytes message as a 1-byte value. |
void |
writeByte(byte value)
Write out a byte to the bytes message as a 1-byte value. |
void |
writeBytes(byte[] value)
Write a byte array to the byte message. |
void |
writeBytes(byte[] value,
int offset,
int length)
Write a portion of a byte array to the byte message. |
void |
writeChar(char value)
Write a char to the bytes message as a 2-byte value,
high byte first. |
void |
writeDouble(double value)
Convert the double argument to a long using the
doubleToLongBits method in class Double ,
and then writes that long value to the stream
message as an 8-byte quantity, high byte first. |
void |
writeFloat(float value)
Convert the float argument to an int using the
floatToIntBits method in class Float ,
and then writes that int value to the stream
message as a 4-byte quantity, high byte first. |
void |
writeInt(int value)
Write an int to the bytes message as four bytes,
high byte first. |
void |
writeLong(long value)
Write a long to the bytes message as eight bytes,
high byte first. |
void |
writeObject(java.lang.Object value)
Write a Java object to the bytes message. |
void |
writeShort(short value)
Write a short to the bytes message as two bytes, high
byte first. |
void |
writeUTF(java.lang.String value)
Write a string to the bytes message using UTF-8 encoding in a machine-independent manner. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.jms.Message |
acknowledge, clearBody, 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 |
Constructor Detail |
public MQeBytesMessage()
Method Detail |
public long getBodyLength() throws javax.jms.JMSException
javax.jms.JMSException
- if the JMS provider fails to read the message
due to some internal error.
javax.jms.MessageNotReadableException
- if the message is in write-only
mode.public boolean readBoolean() throws javax.jms.JMSException
boolean
from the bytes message.
readBoolean
in interface javax.jms.BytesMessage
boolean
value read.
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
javax.jms.MessageEOFException
- if end of message streampublic byte readByte() throws javax.jms.JMSException
readByte
in interface javax.jms.BytesMessage
byte
.
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public int readUnsignedByte() throws javax.jms.JMSException
readUnsignedByte
in interface javax.jms.BytesMessage
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public short readShort() throws javax.jms.JMSException
readShort
in interface javax.jms.BytesMessage
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public int readUnsignedShort() throws javax.jms.JMSException
readUnsignedShort
in interface javax.jms.BytesMessage
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public char readChar() throws javax.jms.JMSException
readChar
in interface javax.jms.BytesMessage
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public int readInt() throws javax.jms.JMSException
readInt
in interface javax.jms.BytesMessage
int
.
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public long readLong() throws javax.jms.JMSException
readLong
in interface javax.jms.BytesMessage
long
.
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public float readFloat() throws javax.jms.JMSException
float
from the bytes message.
readFloat
in interface javax.jms.BytesMessage
float
.
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public double readDouble() throws javax.jms.JMSException
double
from the bytes message.
readDouble
in interface javax.jms.BytesMessage
double
.
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public java.lang.String readUTF() throws javax.jms.JMSException
readUTF
in interface javax.jms.BytesMessage
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public int readBytes(byte[] value) throws javax.jms.JMSException
readBytes
in interface javax.jms.BytesMessage
value
- the buffer into which the data is read.
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.public int readBytes(byte[] value, int length) throws javax.jms.JMSException
readBytes
in interface javax.jms.BytesMessage
value
- the buffer into which the data is read.length
- the number of bytes to read.
javax.jms.MessageNotReadableException
- if message in write-only mode.
javax.jms.MessageEOFException
- if end of message stream
javax.jms.JMSException
- if JMS fails to read message due to
some internal JMS error.
java.lang.IndexOutOfBoundsException
- if length is negative or greater than the length
of the supplied byte arraypublic void writeBoolean(boolean value) throws javax.jms.JMSException
boolean
to the bytes message as a 1-byte value.
The value true
is written out as the value
(byte)1
; the value false
is written out as
the value (byte)0
.
writeBoolean
in interface javax.jms.BytesMessage
value
- the boolean
value to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeByte(byte value) throws javax.jms.JMSException
byte
to the bytes message as a 1-byte value.
writeByte
in interface javax.jms.BytesMessage
value
- the byte
value to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeShort(short value) throws javax.jms.JMSException
short
to the bytes message as two bytes, high
byte first.
writeShort
in interface javax.jms.BytesMessage
value
- the short
to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeChar(char value) throws javax.jms.JMSException
char
to the bytes message as a 2-byte value,
high byte first.
writeChar
in interface javax.jms.BytesMessage
value
- the char
value to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeInt(int value) throws javax.jms.JMSException
int
to the bytes message as four bytes,
high byte first.
writeInt
in interface javax.jms.BytesMessage
value
- the int
to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeLong(long value) throws javax.jms.JMSException
long
to the bytes message as eight bytes,
high byte first.
writeLong
in interface javax.jms.BytesMessage
value
- the long
to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeFloat(float value) throws javax.jms.JMSException
int
using the
floatToIntBits
method in class Float
,
and then writes that int
value to the stream
message as a 4-byte quantity, high byte first.
writeFloat
in interface javax.jms.BytesMessage
value
- the float
value to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeDouble(double value) throws javax.jms.JMSException
long
using the
doubleToLongBits
method in class Double
,
and then writes that long
value to the stream
message as an 8-byte quantity, high byte first.
writeDouble
in interface javax.jms.BytesMessage
value
- the double
value to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeUTF(java.lang.String value) throws javax.jms.JMSException
writeUTF
in interface javax.jms.BytesMessage
value
- the String
value to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeBytes(byte[] value) throws javax.jms.JMSException
writeBytes
in interface javax.jms.BytesMessage
value
- the byte array to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeBytes(byte[] value, int offset, int length) throws javax.jms.JMSException
writeBytes
in interface javax.jms.BytesMessage
value
- the byte array value to be written.offset
- the initial offset within the byte array.length
- the number of bytes to use.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void writeObject(java.lang.Object value) throws javax.jms.JMSException
Note that this method only works for the objectified primitive object types (Integer, Double, Long ...), String's and byte arrays.
writeObject
in interface javax.jms.BytesMessage
value
- the Java object to be written.
javax.jms.MessageNotWriteableException
- if message in read-only mode.
javax.jms.MessageFormatException
- if object is invalid type.
javax.jms.JMSException
- if JMS fails to write message due to
some internal JMS error.public void reset() throws javax.jms.JMSException
reset
in interface javax.jms.BytesMessage
javax.jms.JMSException
- if JMS fails to reset the message due to
some internal JMS error.
javax.jms.MessageFormatException
- if message has an invalid
format
|
Websphere MQ Everyplace | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |