org.fusesource.stompjms.message
Class StompJmsStreamMessage

java.lang.Object
  org.fusesource.stompjms.message.StompJmsMessage
      org.fusesource.stompjms.message.StompJmsStreamMessage

All Implemented Interfaces:

javax.jms.Message, javax.jms.StreamMessage

public class StompJmsStreamMessage
extends StompJmsMessage
implements javax.jms.StreamMessage

A StreamMessage object is used to send a stream of primitive types in the Java programming language. It is filled and read sequentially. It inherits from the Message interface and adds a stream message body. Its methods are based largely on those found in java.io.DataInputStream and java.io.DataOutputStream.

The primitive types can be read or written explicitly using methods for each type. They may also be read or written generically as objects. For instance, a call to StreamMessage.writeInt(6) is equivalent to StreamMessage.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 body 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.

StreamMessage objects support the following conversion table. The marked cases must be supported. The unmarked cases must throw a JMSException. The String-to-primitive conversions may throw a runtime exception if the primitive's valueOf() method does not accept it as a valid String representation of the primitive.

A value written as the row type can be read as the column type.

 | | boolean byte short char int long float double String byte[]
 |----------------------------------------------------------------------
 |boolean | X X |byte | X X X X X |short | X X X X |char | X X |int | X X X
 |long | X X |float | X X X |double | X X |String | X X X X X X X X |byte[] |
 X |----------------------------------------------------------------------
 

 

Attempting to read a null value as a primitive type must be treated as calling the primitive's corresponding valueOf(String) conversion method with a null value. Since char does not support a String conversion, attempting to read a null value as a char must throw a NullPointerException.

See Also:

Session.createStreamMessage(), BytesMessage, MapMessage, Message, ObjectMessage, TextMessage

Nested Class Summary

Nested classes/interfaces inherited from class org.fusesource.stompjms.message.StompJmsMessage

StompJmsMessage.JmsMsgType

Field Summary

protected org.fusesource.hawtbuf.DataByteArrayInputStream	dataIn
protected org.fusesource.hawtbuf.DataByteArrayOutputStream	dataOut
protected int	remainingBytes

Fields inherited from class org.fusesource.stompjms.message.StompJmsMessage

acknowledgeCallback, frame, properties, readOnlyBody, readOnlyProperties, redeliveryCounter, transactionId

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

StompJmsStreamMessage()

Method Summary

protected void	checkWriteOnlyBody()
void	clearBody() Clears out the message body.
StompJmsMessage	copy()
void	copy(StompJmsStreamMessage copy)
StompJmsMessage.JmsMsgType	getMsgType()
void	onSend() Send operation event listener.
boolean	readBoolean() Reads a boolean from the stream message.
byte	readByte() Reads a byte value from the stream message.
int	readBytes(byte[] value) Reads a byte array field from the stream message into the specified byte[] object (the read buffer).
char	readChar() Reads a Unicode character value from the stream message.
double	readDouble() Reads a double from the stream message.
float	readFloat() Reads a float from the stream message.
int	readInt() Reads a 32-bit integer from the stream message.
long	readLong() Reads a 64-bit integer from the stream message.
java.lang.Object	readObject() Reads an object from the stream message.
short	readShort() Reads a 16-bit integer from the stream message.
java.lang.String	readString() Reads a String from the stream message.
void	reset() Puts the message body in read-only mode and repositions the stream of bytes to the beginning.
void	storeContent() serialize the payload
java.lang.String	toString()
void	writeBoolean(boolean value) Writes a boolean to the stream message.
void	writeByte(byte value) Writes a byte to the stream message.
void	writeBytes(byte[] value) Writes a byte array field to the stream message.
void	writeBytes(byte[] value, int offset, int length) Writes a portion of a byte array as a byte array field to the stream message.
void	writeChar(char value) Writes a char to the stream message.
void	writeDouble(double value) Writes a double to the stream message.
void	writeFloat(float value) Writes a float to the stream message.
void	writeInt(int value) Writes an int to the stream message.
void	writeLong(long value) Writes a long to the stream message.
void	writeObject(java.lang.Object value) Writes an object to the stream message.
void	writeShort(short value) Writes a short to the stream message.
void	writeString(java.lang.String value) Writes a String to the stream message.

Methods inherited from class org.fusesource.stompjms.message.StompJmsMessage

acknowledge, checkReadOnlyBody, checkValidObject, clearProperties, copy, decodeString, encodeString, equals, getAcknowledgeCallback, getAllPropertyNames, getBooleanProperty, getByteProperty, getConsumerId, getContent, getDoubleProperty, getFloatProperty, getFrame, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getMessageID, getObjectProperty, getProperties, getPropertyNames, getRedeliveryCounter, getShortProperty, getStompJmsDestination, getStompJmsReplyTo, getStringProperty, getTransactionId, hashCode, incrementRedeliveryCounter, isPersistent, isRedelivered, lazyCreateProperties, propertyExists, removeProperty, setAcknowledgeCallback, setBooleanProperty, setBooleanProperty, setByteProperty, setContent, setDoubleProperty, setFloatProperty, setFrame, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setMessageID, setObjectProperty, setObjectProperty, setPersistent, setProperties, setProperty, setReadOnlyBody, setReadOnlyProperties, setRedelivered, setRedeliveryCounter, setShortProperty, setStringProperty, setTransactionId

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

Field Detail

dataOut

protected transient org.fusesource.hawtbuf.DataByteArrayOutputStream dataOut

dataIn

protected transient org.fusesource.hawtbuf.DataByteArrayInputStream dataIn

remainingBytes

protected transient int remainingBytes

Constructor Detail

StompJmsStreamMessage

public StompJmsStreamMessage()

Method Detail

getMsgType

public StompJmsMessage.JmsMsgType getMsgType()

Overrides:

getMsgType in class StompJmsMessage

copy

public StompJmsMessage copy()
                     throws javax.jms.JMSException

Overrides:

copy in class StompJmsMessage

Throws:

javax.jms.JMSException

copy

public void copy(StompJmsStreamMessage copy)
          throws javax.jms.JMSException

Throws:

javax.jms.JMSException

onSend

public void onSend()
            throws javax.jms.JMSException

Description copied from class: StompJmsMessage

Send operation event listener. Used to get the message ready to be sent.

Overrides:

onSend in class StompJmsMessage

Throws:

javax.jms.JMSException

storeContent

public void storeContent()
                  throws javax.jms.JMSException

Description copied from class: StompJmsMessage

serialize the payload

Overrides:

storeContent in class StompJmsMessage

Throws:

javax.jms.JMSException

clearBody

public void clearBody()
               throws javax.jms.JMSException

Clears out the message body. Clearing a message's body does not clear its header values or property entries.

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.

Specified by:

clearBody in interface javax.jms.Message

Overrides:

clearBody in class StompJmsMessage

Throws:

javax.jms.JMSException - if the JMS provider fails to clear the message body due to some internal error.

readBoolean

public boolean readBoolean()
                    throws javax.jms.JMSException

Reads a boolean from the stream message.

Specified by:

readBoolean in interface javax.jms.StreamMessage

Returns:

the boolean value read

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readByte

public byte readByte()
              throws javax.jms.JMSException

Reads a byte value from the stream message.

Specified by:

readByte in interface javax.jms.StreamMessage

Returns:

the next byte from the stream message as a 8-bit byte

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readShort

public short readShort()
                throws javax.jms.JMSException

Reads a 16-bit integer from the stream message.

Specified by:

readShort in interface javax.jms.StreamMessage

Returns:

a 16-bit integer from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readChar

public char readChar()
              throws javax.jms.JMSException

Reads a Unicode character value from the stream message.

Specified by:

readChar in interface javax.jms.StreamMessage

Returns:

a Unicode character from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readInt

public int readInt()
            throws javax.jms.JMSException

Reads a 32-bit integer from the stream message.

Specified by:

readInt in interface javax.jms.StreamMessage

Returns:

a 32-bit integer value from the stream message, interpreted as an int

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readLong

public long readLong()
              throws javax.jms.JMSException

Reads a 64-bit integer from the stream message.

Specified by:

readLong in interface javax.jms.StreamMessage

Returns:

a 64-bit integer value from the stream message, interpreted as a long

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readFloat

public float readFloat()
                throws javax.jms.JMSException

Reads a float from the stream message.

Specified by:

readFloat in interface javax.jms.StreamMessage

Returns:

a float value from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readDouble

public double readDouble()
                  throws javax.jms.JMSException

Reads a double from the stream message.

Specified by:

readDouble in interface javax.jms.StreamMessage

Returns:

a double value from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readString

public java.lang.String readString()
                            throws javax.jms.JMSException

Reads a String from the stream message.

Specified by:

readString in interface javax.jms.StreamMessage

Returns:

a Unicode string from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

readBytes

public int readBytes(byte[] value)
              throws javax.jms.JMSException

Reads a byte array field from the stream message into the specified byte[] object (the read buffer).

To read the field value, readBytes should be successively called until it returns a value less than the length of the read buffer. The value of the bytes in the buffer following the last byte read is undefined.

If readBytes returns a value equal to the length of the buffer, a subsequent readBytes call must be made. If there are no more bytes to be read, this call returns -1.

If the byte array field value is null, readBytes returns -1.

If the byte array field value is empty, readBytes returns 0.

Once the first readBytes call on a byte[] field value has been made, the full value of the field must be read before it is valid to read the next field. An attempt to read the next field before that has been done will throw a MessageFormatException.

To read the byte field value into a new byte[] object, use the readObject method.

Specified by:

readBytes in interface javax.jms.StreamMessage

Parameters:

value - the buffer into which the data is read

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the byte field has been reached

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

readObject()

readObject

public java.lang.Object readObject()
                            throws javax.jms.JMSException

Reads an object from the stream message.

This method can be used to return, in objectified format, an object in the Java programming language ("Java object") that has been written to the stream with the equivalent writeObject method call, or its equivalent primitive writetype method.

Note that byte values are returned as byte[], not Byte[].

An attempt to call readObject to read a byte field value into a new byte[] object before the full value of the byte field has been read will throw a MessageFormatException.

Specified by:

readObject in interface javax.jms.StreamMessage

Returns:

a Java object from the stream message, in objectified format (for example, if the object was written as an int, an Integer is returned)

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

readBytes(byte[] value)

writeBoolean

public void writeBoolean(boolean value)
                  throws javax.jms.JMSException

Writes a boolean to the stream message. The value true is written as the value (byte)1; the value false is written as the value (byte)0.

Specified by:

writeBoolean in interface javax.jms.StreamMessage

Parameters:

value - the boolean value to be written

Throws:

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.

writeByte

public void writeByte(byte value)
               throws javax.jms.JMSException

Writes a byte to the stream message.

Specified by:

writeByte in interface javax.jms.StreamMessage

Parameters:

value - the byte value to be written

Throws:

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.

writeShort

public void writeShort(short value)
                throws javax.jms.JMSException

Writes a short to the stream message.

Specified by:

writeShort in interface javax.jms.StreamMessage

Parameters:

value - the short value to be written

Throws:

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.

writeChar

public void writeChar(char value)
               throws javax.jms.JMSException

Writes a char to the stream message.

Specified by:

writeChar in interface javax.jms.StreamMessage

Parameters:

value - the char value to be written

Throws:

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.

writeInt

public void writeInt(int value)
              throws javax.jms.JMSException

Writes an int to the stream message.

Specified by:

writeInt in interface javax.jms.StreamMessage

Parameters:

value - the int value to be written

Throws:

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.

writeLong

public void writeLong(long value)
               throws javax.jms.JMSException

Writes a long to the stream message.

Specified by:

writeLong in interface javax.jms.StreamMessage

Parameters:

value - the long value to be written

Throws:

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.

writeFloat

public void writeFloat(float value)
                throws javax.jms.JMSException

Writes a float to the stream message.

Specified by:

writeFloat in interface javax.jms.StreamMessage

Parameters:

value - the float value to be written

Throws:

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.

writeDouble

public void writeDouble(double value)
                 throws javax.jms.JMSException

Writes a double to the stream message.

Specified by:

writeDouble in interface javax.jms.StreamMessage

Parameters:

value - the double value to be written

Throws:

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.

writeString

public void writeString(java.lang.String value)
                 throws javax.jms.JMSException

Writes a String to the stream message.

Specified by:

writeString in interface javax.jms.StreamMessage

Parameters:

value - the String value to be written

Throws:

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.

writeBytes

public void writeBytes(byte[] value)
                throws javax.jms.JMSException

Writes a byte array field to the stream message.

The byte array value is written to the message as a byte array field. Consecutively written byte array fields are treated as two distinct fields when the fields are read.

Specified by:

writeBytes in interface javax.jms.StreamMessage

Parameters:

value - the byte array value to be written

Throws:

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.

writeBytes

public void writeBytes(byte[] value,
                       int offset,
                       int length)
                throws javax.jms.JMSException

Writes a portion of a byte array as a byte array field to the stream message.

The a portion of the byte array value is written to the message as a byte array field. Consecutively written byte array fields are treated as two distinct fields when the fields are read.

Specified by:

writeBytes in interface javax.jms.StreamMessage

Parameters:

value - the byte array value to be written

offset - the initial offset within the byte array

length - the number of bytes to use

Throws:

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.

writeObject

public void writeObject(java.lang.Object value)
                 throws javax.jms.JMSException

Writes an object to the stream message.

This method works only for the objectified primitive object types ( Integer, Double, Long ...), String objects, and byte arrays.

Specified by:

writeObject in interface javax.jms.StreamMessage

Parameters:

value - the Java object to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageFormatException - if the object is invalid.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

reset

public void reset()
           throws javax.jms.JMSException

Puts the message body in read-only mode and repositions the stream of bytes to the beginning.

Specified by:

reset in interface javax.jms.StreamMessage

Throws:

javax.jms.JMSException - if an internal error occurs

checkWriteOnlyBody

protected void checkWriteOnlyBody()
                           throws javax.jms.MessageNotReadableException

Throws:

javax.jms.MessageNotReadableException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object