|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.activemq.message.AbstractPacket
org.activemq.message.ActiveMQMessage
org.activemq.message.ActiveMQBytesMessage
A 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.
Session.createBytesMessage(),
MapMessage,
Message,
ObjectMessage,
StreamMessage,
TextMessage| Field Summary |
| Fields inherited from class org.activemq.message.AbstractPacket |
bitArray, BROKERS_VISITED_INDEX, cachedHashCode, RECEIPT_REQUIRED_INDEX |
| Fields inherited from interface javax.jms.Message |
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE |
| Constructor Summary | |
ActiveMQBytesMessage()
|
|
| Method Summary | |
void |
clearBody()
Clears out the message body. |
ActiveMQMessage |
deepCopy()
|
ByteArray |
getBodyAsBytes()
|
long |
getBodyLength()
Gets the number of bytes of the message body when the message is in read-only mode. |
int |
getPacketType()
Return the type of Packet |
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 |
setBodyAsBytes(byte[] bodyAsBytes,
int offset,
int length)
|
ActiveMQMessage |
shallowCopy()
|
java.lang.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(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. |
| Methods inherited from class org.activemq.message.AbstractPacket |
addBrokerVisited, clearBrokersVisited, decrementMemoryReferenceCount, equals, getBitArray, getBrokersVisited, getBrokersVisitedAsString, getId, getMemoryUsage, getMemoryUsageReferenceCount, getPacketTypeAsString, hasVisited, incrementMemoryReferenceCount, initializeOther, isReceipt, isReceiptRequired, setBitArray, setBrokersVisitedAsString, setId, setMemoryUsage, setReceiptRequired |
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface javax.jms.Message |
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 |
| Methods inherited from interface org.activemq.io.util.MemoryManageable |
decrementMemoryReferenceCount, getMemoryUsage, getMemoryUsageReferenceCount, incrementMemoryReferenceCount |
| Constructor Detail |
public ActiveMQBytesMessage()
| Method Detail |
public int getPacketType()
getPacketType in interface PacketgetPacketType in class ActiveMQMessage
public ActiveMQMessage shallowCopy()
throws javax.jms.JMSException
shallowCopy in class ActiveMQMessagejavax.jms.JMSException
public ActiveMQMessage deepCopy()
throws javax.jms.JMSException
deepCopy in class ActiveMQMessagejavax.jms.JMSException
public void setBodyAsBytes(byte[] bodyAsBytes,
int offset,
int length)
setBodyAsBytes in class ActiveMQMessagebodyAsBytes - The bodyAsBytes to set.offset - length -
public ByteArray getBodyAsBytes()
throws java.io.IOException
getBodyAsBytes in class ActiveMQMessagejava.io.IOException - if an exception occurs retreiving the data
public void clearBody()
throws javax.jms.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 javax.jms.MessageclearBody in class ActiveMQMessagejavax.jms.JMSException - if the JMS provider fails to clear the message body due to some internal error.
public long getBodyLength()
throws javax.jms.JMSException
getBodyLength in interface javax.jms.BytesMessagejavax.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 stream.
readBoolean in interface javax.jms.BytesMessageboolean value read
javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public byte readByte()
throws javax.jms.JMSException
readByte in interface javax.jms.BytesMessagebyte
javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public int readUnsignedByte()
throws javax.jms.JMSException
readUnsignedByte in interface javax.jms.BytesMessagejavax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public short readShort()
throws javax.jms.JMSException
readShort in interface javax.jms.BytesMessagejavax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public int readUnsignedShort()
throws javax.jms.JMSException
readUnsignedShort in interface javax.jms.BytesMessagejavax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public char readChar()
throws javax.jms.JMSException
readChar in interface javax.jms.BytesMessagejavax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public int readInt()
throws javax.jms.JMSException
readInt in interface javax.jms.BytesMessageint
javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public long readLong()
throws javax.jms.JMSException
readLong in interface javax.jms.BytesMessagelong
javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public float readFloat()
throws javax.jms.JMSException
float from the bytes message stream.
readFloat in interface javax.jms.BytesMessagefloat
javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public double readDouble()
throws javax.jms.JMSException
double from the bytes message stream.
readDouble in interface javax.jms.BytesMessagedouble
javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public java.lang.String readUTF()
throws javax.jms.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 javax.jms.BytesMessagejavax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.
javax.jms.MessageEOFException - if unexpected end of bytes stream has been reached.
javax.jms.MessageNotReadableException - if the message is in write-only mode.
public int readBytes(byte[] value)
throws javax.jms.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 javax.jms.BytesMessagevalue - the buffer into which the data is read
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 int readBytes(byte[] value,
int length)
throws javax.jms.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 javax.jms.BytesMessagevalue - the buffer into which the data is readlength - the number of bytes to read; must be less than or equal to value.length
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 void writeBoolean(boolean value)
throws javax.jms.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 javax.jms.BytesMessagevalue - the boolean value to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeByte(byte value)
throws javax.jms.JMSException
byte to the bytes message stream as a 1-byte value.
writeByte in interface javax.jms.BytesMessagevalue - the byte value to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeShort(short value)
throws javax.jms.JMSException
short to the bytes message stream as two bytes, high byte first.
writeShort in interface javax.jms.BytesMessagevalue - the short to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeChar(char value)
throws javax.jms.JMSException
char to the bytes message stream as a 2-byte value, high byte first.
writeChar in interface javax.jms.BytesMessagevalue - the char value to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeInt(int value)
throws javax.jms.JMSException
int to the bytes message stream as four bytes, high byte first.
writeInt in interface javax.jms.BytesMessagevalue - the int to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeLong(long value)
throws javax.jms.JMSException
long to the bytes message stream as eight bytes, high byte first.
writeLong in interface javax.jms.BytesMessagevalue - the long to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeFloat(float value)
throws javax.jms.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 javax.jms.BytesMessagevalue - the float value to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeDouble(double value)
throws javax.jms.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 javax.jms.BytesMessagevalue - the double value to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeUTF(java.lang.String value)
throws javax.jms.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 javax.jms.BytesMessagevalue - the String value to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeBytes(byte[] value)
throws javax.jms.JMSException
writeBytes in interface javax.jms.BytesMessagevalue - the byte array to be written
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeBytes(byte[] value,
int offset,
int length)
throws javax.jms.JMSException
writeBytes in interface javax.jms.BytesMessagevalue - the byte array value to be writtenoffset - the initial offset within the byte arraylength - the number of bytes to use
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
public void writeObject(java.lang.Object value)
throws javax.jms.JMSException
This method works only for the objectified primitive object types (Integer,Double,
Long ...), String objects, and byte arrays.
writeObject in interface javax.jms.BytesMessagevalue - the object in the Java programming language ("Java object") to be written; it must not be null
javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.
javax.jms.MessageFormatException - if the object is of an invalid type.
javax.jms.MessageNotWriteableException - if the message is in read-only mode.
java.lang.NullPointerException - if the parameter value is null.
public void reset()
throws javax.jms.JMSException
reset in interface javax.jms.BytesMessagejavax.jms.JMSException - if an internal error occurspublic java.lang.String toString()
toString in class ActiveMQMessage
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||