public class ActiveMQBytesMessage extends ActiveMQMessage implements BytesMessage
BytesMessage
object is used to send a message containing a
stream of uninterpreted bytes. It inherits from the Message
interface and adds a bytes message body. The receiver of the message supplies
the interpretation of the bytes.
The BytesMessage
methods are based largely on those found in
java.io.DataInputStream
and
java.io.DataOutputStream
.
This message type is for client encoding of existing message formats. If possible, one of the other self-defining message types should be used instead.
Although the JMS API allows the use of message properties with byte messages, they are typically not used, since the inclusion of properties may affect the format.
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 clearBody
is
called, the body of the message is in write-only mode. After the first call
to reset
has been made, the message body is in read-only mode.
After a message has been sent, the client that sent it can retain and modify
it without affecting the message that has been sent. The same message object
can be sent multiple times. When a message has been received, the provider
has called reset
so that the message body is in read-only mode
for the client.
If 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.
If a client attempts to write a message in read-only mode, a
MessageNotWriteableException
is thrown.
Message.MessageDestination
Modifier and Type | Field and Description |
---|---|
protected ByteArrayOutputStream |
bytesOut |
static byte |
DATA_STRUCTURE_TYPE |
protected DataInputStream |
dataIn |
protected DataOutputStream |
dataOut |
protected int |
length |
acknowledgeCallback, BROKER_PATH_PROPERTY, DLQ_DELIVERY_FAILURE_CAUSE_PROPERTY
arrival, brokerInTime, brokerOutTime, compressed, content, correlationId, dataStructure, DEFAULT_MINIMUM_MESSAGE_SIZE, destination, droppable, expiration, groupID, groupSequence, jmsXGroupFirstForConsumer, marshalledProperties, messageId, ORIGINAL_EXPIRATION, originalDestination, originalTransactionId, persistent, priority, producerId, properties, readOnlyBody, readOnlyProperties, recievedByDFBridge, redeliveryCounter, replyTo, size, targetConsumerId, timestamp, transactionId, type, userID
commandId, responseRequired
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
AMQ_SCHEDULED_CRON, AMQ_SCHEDULED_DELAY, AMQ_SCHEDULED_ID, AMQ_SCHEDULED_PERIOD, AMQ_SCHEDULED_REPEAT, AMQ_SCHEDULER_ACTION, AMQ_SCHEDULER_ACTION_BROWSE, AMQ_SCHEDULER_ACTION_END_TIME, AMQ_SCHEDULER_ACTION_REMOVE, AMQ_SCHEDULER_ACTION_REMOVEALL, AMQ_SCHEDULER_ACTION_START_TIME, AMQ_SCHEDULER_MANAGEMENT_DESTINATION
Constructor and Description |
---|
ActiveMQBytesMessage() |
Modifier and Type | Method and Description |
---|---|
protected void |
checkWriteOnlyBody() |
void |
clearBody()
Clears out the message body.
|
Message |
copy() |
protected byte[] |
decompress(ByteSequence dataSequence) |
protected void |
doCompress() |
long |
getBodyLength()
Gets the number of bytes of the message body when the message is in
read-only mode.
|
byte |
getDataStructureType() |
String |
getJMSXMimeType()
Returns the MIME type of this mesage.
|
void |
onSend()
Send operation event listener.
|
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 |
setObjectProperty(String name,
Object value) |
void |
storeContent() |
String |
toString() |
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, checkReadOnlyBody, checkValidObject, checkValidScheduled, clearProperties, convertScheduled, copy, decodeString, encodeString, equals, getAcknowledgeCallback, getAllPropertyNames, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, hashCode, propertyExists, setAcknowledgeCallback, setBooleanProperty, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setProperties, setShortProperty, setStringProperty, storeContentAndClear, visit
afterMarshall, afterUnmarshall, beforeMarshall, beforeUnmarshall, canProcessAsExpired, clearMarshalledState, compress, copy, decrementReferenceCount, getArrival, getBrokerInTime, getBrokerOutTime, getBrokerPath, getCluster, getConnection, getContent, getCorrelationId, getDataStructure, getDestination, getExpiration, getGroupID, getGroupSequence, getMarshalledProperties, getMemoryUsage, getMessage, getMessageHardRef, getMessageId, getMinimumMessageSize, getOriginalDestination, getOriginalTransactionId, getPriority, getProducerId, getProperties, getProperty, getRedeliveryCounter, getReferenceCount, getRegionDestination, getReplyTo, getSize, getTargetConsumerId, getTimestamp, getTransactionId, getType, getUserID, incrementRedeliveryCounter, incrementReferenceCount, isAdvisory, isCompressed, isDroppable, isDropped, isExpired, isInTransaction, isJMSXGroupFirstForConsumer, isMarshallAware, isMessage, isPersistent, isReadOnlyBody, isReadOnlyProperties, isRecievedByDFBridge, isRedelivered, lazyCreateProperties, onMessageRolledBack, removeProperty, setArrival, setBrokerInTime, setBrokerOutTime, setBrokerPath, setCluster, setCompressed, setConnection, setContent, setCorrelationId, setDataStructure, setDestination, setDroppable, setExpiration, setGroupID, setGroupSequence, setJMSXGroupFirstForConsumer, setMarshalledProperties, setMemoryUsage, setMessageId, setOriginalDestination, setOriginalTransactionId, setPersistent, setPriority, setProducerId, setProperty, setReadOnlyBody, setReadOnlyProperties, setRecievedByDFBridge, setRedelivered, setRedeliveryCounter, setRegionDestination, setReplyTo, setTargetConsumerId, setTimestamp, setTransactionId, setType, setUserID, toString
copy, getCommandId, getFrom, getTo, isBrokerInfo, isConnectionControl, isConsumerControl, isMessageAck, isMessageDispatch, isMessageDispatchNotification, isResponse, isResponseRequired, isShutdownInfo, isWireFormatInfo, setCommandId, setFrom, setResponseRequired, setTo
clone, finalize, getClass, notify, notifyAll, 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, setShortProperty, setStringProperty
public static final byte DATA_STRUCTURE_TYPE
protected transient DataOutputStream dataOut
protected transient ByteArrayOutputStream bytesOut
protected transient DataInputStream dataIn
protected transient int length
public ActiveMQBytesMessage()
public Message copy()
copy
in class ActiveMQMessage
public void onSend() throws JMSException
ActiveMQMessage
onSend
in class ActiveMQMessage
JMSException
public void storeContent()
storeContent
in class ActiveMQMessage
public byte getDataStructureType()
getDataStructureType
in interface DataStructure
getDataStructureType
in class ActiveMQMessage
public String getJMSXMimeType()
Message
BlobMessage
it allows you to create a selector on the MIME type of the BLOB bodygetJMSXMimeType
in class ActiveMQMessage
public void clearBody() throws JMSException
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
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 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 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.
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(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(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.NullPointerException
- if the parameter
value
is null.public void reset() throws JMSException
reset
in interface BytesMessage
JMSException
- if an internal error occursprotected void checkWriteOnlyBody() throws MessageNotReadableException
MessageNotReadableException
protected byte[] decompress(ByteSequence dataSequence) throws IOException
IOException
public void setObjectProperty(String name, Object value) throws JMSException
setObjectProperty
in interface Message
setObjectProperty
in class ActiveMQMessage
JMSException
protected void doCompress() throws IOException
doCompress
in class Message
IOException
Copyright © 2005–2016 FuseSource, Corp.. All rights reserved.