public class ActiveMQBytesMessage extends ActiveMQMessage implements BytesMessage
BytesMessage
.Modifier and Type | Field and Description |
---|---|
static byte |
TYPE |
message, propertiesReadOnly, readOnly
DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
Modifier | Constructor and Description |
---|---|
|
ActiveMQBytesMessage(BytesMessage foreign,
ClientSession session)
Foreign message constructor
|
protected |
ActiveMQBytesMessage(ClientMessage message,
ClientSession session)
Constructor on receipt at client side
|
protected |
ActiveMQBytesMessage(ClientSession session)
This constructor is used to construct messages prior to sending
|
Modifier and Type | Method and Description |
---|---|
void |
clearBody()
Clears out the message body.
|
void |
doBeforeReceive() |
void |
doBeforeSend() |
protected <T> T |
getBodyInternal(Class<T> c) |
long |
getBodyLength()
Gets the number of bytes of the message body when the message
is in read-only mode.
|
byte |
getType() |
boolean |
isBodyAssignableTo(Class c)
Returns whether the message body is capable of being assigned to the
specified type.
|
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.
|
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 |
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(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(String value)
Writes a string to the bytes message stream using UTF-8 encoding in a
machine-independent manner.
|
acknowledge, checkBuffer, checkRead, checkWrite, clearProperties, coreCompositeTypeToJMSCompositeType, coreMaptoJMSMap, createMessage, createMessage, getBody, getBooleanProperty, getByteProperty, getCoreMessage, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, hasNoBody, propertyExists, resetMessageID, saveToOutputStream, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIndividualAcknowledge, setInputStream, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setOutputStream, setShortProperty, setStringProperty, toString, waitCompletionOnStream
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
acknowledge, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty
public static final byte TYPE
protected ActiveMQBytesMessage(ClientSession session)
protected ActiveMQBytesMessage(ClientMessage message, ClientSession session)
public ActiveMQBytesMessage(BytesMessage foreign, ClientSession session) throws JMSException
JMSException
public boolean readBoolean() throws JMSException
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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 String readUTF() throws JMSException
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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
BytesMessage
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(String value) throws JMSException
BytesMessage
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
BytesMessage
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
BytesMessage
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(Object value) throws JMSException
BytesMessage
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.public void reset() throws JMSException
BytesMessage
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 doBeforeReceive() throws ActiveMQException
doBeforeReceive
in class ActiveMQMessage
ActiveMQException
public void clearBody() throws JMSException
Message
If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.
clearBody
in interface Message
clearBody
in class ActiveMQMessage
JMSException
- if the JMS provider fails to clear the message
body due to some internal error.public long getBodyLength() throws JMSException
BytesMessage
getBodyLength
in interface BytesMessage
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 doBeforeSend() throws Exception
doBeforeSend
in class ActiveMQMessage
Exception
public byte getType()
getType
in class ActiveMQMessage
public boolean isBodyAssignableTo(Class c)
Message
getBody
on the same message with the same type argument would not throw a
MessageFormatException.
If the message is a StreamMessage
then false is always returned.
If the message is a ObjectMessage
and object deserialization
fails then false is returned. If the message has no body then any type may be specified and true is
returned.
isBodyAssignableTo
in interface Message
isBodyAssignableTo
in class ActiveMQMessage
c
- The specified type TextMessage
then this method will
only return true if this parameter is set to
String.class
or another type to which a String
is assignable. ObjectMessage
then this
method will only return true if this parameter is set to
java.io.Serializable.class
or another class to
which the body is assignable. MapMessage
then this method
will only return true if this parameter is set to
java.util.Map.class
(or java.lang.Object.class
). BytesMessage
then this this
method will only return true if this parameter is set to
byte[].class
(or java.lang.Object.class
). TextMessage
, ObjectMessage
, MapMessage
or BytesMessage
and the message has no body,
then the above does not apply and this method will return true
irrespective of the value of this parameter.Message
(but not one of its subtypes)
then this method will return true
irrespective of the value of this parameter.protected <T> T getBodyInternal(Class<T> c)
getBodyInternal
in class ActiveMQMessage
Copyright © 2017 JBoss by Red Hat. All rights reserved.