org.fusesource.stomp.jms.message

Class StompJmsMapMessage

java.lang.Object

org.fusesource.stomp.jms.message.StompJmsMessage

org.fusesource.stomp.jms.message.StompJmsMapMessage

All Implemented Interfaces:

javax.jms.MapMessage, javax.jms.Message

public class StompJmsMapMessage
extends StompJmsMessage
implements javax.jms.MapMessage

A MapMessage object is used to send a set of name-value pairs. The names are String objects, and the values are primitive data types in the Java programming language. The names must have a value that is not null, and not an empty string. The entries can be accessed sequentially or randomly by name. The order of the entries is undefined. MapMessage inherits from the Message interface and adds a message body that contains a Map.

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 MapMessage.setInt("foo", 6) is equivalent to MapMessage.setObject("foo", 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 a client receives a MapMessage, it is in read-only mode. If a client attempts to write to the message at this point, a MessageNotWriteableException is thrown. If clearBody is called, the message can now be both read from and written to.

MapMessage 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 |----------------------------------------------------------------------
 <p/>
 

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.createMapMessage(), BytesMessage, Message, ObjectMessage, StreamMessage, TextMessage

Nested Class Summary

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

StompJmsMessage.JmsMsgType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	map

Fields inherited from class org.fusesource.stomp.jms.message.StompJmsMessage

acknowledgeCallback, connection, frame, properties, readOnlyBody, readOnlyProperties, REVERSED_HEADER_NAMES, transactionId

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor and Description
StompJmsMapMessage()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBody() Clears out the message body.
StompJmsMessage	copy()
void	copy(StompJmsMapMessage other)
boolean	getBoolean(java.lang.String name) Returns the boolean value with the specified name.
byte	getByte(java.lang.String name) Returns the byte value with the specified name.
byte[]	getBytes(java.lang.String name) Returns the byte array value with the specified name.
char	getChar(java.lang.String name) Returns the Unicode character value with the specified name.
java.util.Map<java.lang.String,java.lang.Object>	getContentMap()
double	getDouble(java.lang.String name) Returns the double value with the specified name.
float	getFloat(java.lang.String name) Returns the float value with the specified name.
int	getInt(java.lang.String name) Returns the int value with the specified name.
long	getLong(java.lang.String name) Returns the long value with the specified name.
java.util.Enumeration<java.lang.String>	getMapNames() Returns an Enumeration of all the names in the MapMessage object.
StompJmsMessage.JmsMsgType	getMsgType()
java.lang.Object	getObject(java.lang.String name) Returns the value of the object with the specified name.
short	getShort(java.lang.String name) Returns the short value with the specified name.
java.lang.String	getString(java.lang.String name) Returns the String value with the specified name.
boolean	itemExists(java.lang.String name) Indicates whether an item exists in this MapMessage object.
protected void	put(java.lang.String name, java.lang.Object value)
void	setBoolean(java.lang.String name, boolean value) Sets a boolean value with the specified name into the Map.
void	setByte(java.lang.String name, byte value) Sets a byte value with the specified name into the Map.
void	setBytes(java.lang.String name, byte[] value) Sets a byte array value with the specified name into the Map.
void	setBytes(java.lang.String name, byte[] value, int offset, int length) Sets a portion of the byte array value with the specified name into the Map.
void	setChar(java.lang.String name, char value) Sets a Unicode character value with the specified name into the Map.
void	setDouble(java.lang.String name, double value) Sets a double value with the specified name into the Map.
void	setFloat(java.lang.String name, float value) Sets a float value with the specified name into the Map.
void	setInt(java.lang.String name, int value) Sets an int value with the specified name into the Map.
void	setLong(java.lang.String name, long value) Sets a long value with the specified name into the Map.
void	setObject(java.lang.String name, java.lang.Object value) Sets an object value with the specified name into the Map.
void	setShort(java.lang.String name, short value) Sets a short value with the specified name into the Map.
void	setString(java.lang.String name, java.lang.String value) Sets a String value with the specified name into the Map.
void	storeContent() serialize the payload
java.lang.String	toString()

Methods inherited from class org.fusesource.stomp.jms.message.StompJmsMessage

acknowledge, checkReadOnlyBody, checkValidObject, clearProperties, copy, decodeString, encodeString, equals, getAcknowledgeCallback, getAllPropertyNames, getBooleanProperty, getByteProperty, getConnection, getConsumerId, getContent, getDoubleProperty, getFloatProperty, getFrame, getHeaderMap, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getMessageID, getObjectProperty, getProperties, getPropertyNames, getRedeliveryCounter, getShortProperty, getStompJmsDestination, getStompJmsReplyTo, getStringProperty, getTransactionId, hashCode, isPersistent, isRedelivered, lazyCreateProperties, onSend, propertyExists, removeProperty, setAcknowledgeCallback, setBooleanProperty, setBooleanProperty, setByteProperty, setConnection, 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

map

protected transient java.util.Map<java.lang.String,java.lang.Object> map

Constructor Detail

StompJmsMapMessage

public StompJmsMapMessage()

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(StompJmsMapMessage other)
          throws javax.jms.JMSException

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

getBoolean

public boolean getBoolean(java.lang.String name)
                   throws javax.jms.JMSException

Returns the boolean value with the specified name.

Specified by:

getBoolean in interface javax.jms.MapMessage

Parameters:

name - the name of the boolean

Returns:

the boolean value with the specified name

Throws:

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

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

getByte

public byte getByte(java.lang.String name)
             throws javax.jms.JMSException

Returns the byte value with the specified name.

Specified by:

getByte in interface javax.jms.MapMessage

Parameters:

name - the name of the byte

Returns:

the byte value with the specified name

Throws:

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

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

getShort

public short getShort(java.lang.String name)
               throws javax.jms.JMSException

Returns the short value with the specified name.

Specified by:

getShort in interface javax.jms.MapMessage

Parameters:

name - the name of the short

Returns:

the short value with the specified name

Throws:

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

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

getChar

public char getChar(java.lang.String name)
             throws javax.jms.JMSException

Returns the Unicode character value with the specified name.

Specified by:

getChar in interface javax.jms.MapMessage

Parameters:

name - the name of the Unicode character

Returns:

the Unicode character value with the specified name

Throws:

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

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

getInt

public int getInt(java.lang.String name)
           throws javax.jms.JMSException

Returns the int value with the specified name.

Specified by:

getInt in interface javax.jms.MapMessage

Parameters:

name - the name of the int

Returns:

the int value with the specified name

Throws:

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

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

getLong

public long getLong(java.lang.String name)
             throws javax.jms.JMSException

Returns the long value with the specified name.

Specified by:

getLong in interface javax.jms.MapMessage

Parameters:

name - the name of the long

Returns:

the long value with the specified name

Throws:

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

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

getFloat

public float getFloat(java.lang.String name)
               throws javax.jms.JMSException

Returns the float value with the specified name.

Specified by:

getFloat in interface javax.jms.MapMessage

Parameters:

name - the name of the float

Returns:

the float value with the specified name

Throws:

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

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

getDouble

public double getDouble(java.lang.String name)
                 throws javax.jms.JMSException

Returns the double value with the specified name.

Specified by:

getDouble in interface javax.jms.MapMessage

Parameters:

name - the name of the double

Returns:

the double value with the specified name

Throws:

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

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

getString

public java.lang.String getString(java.lang.String name)
                           throws javax.jms.JMSException

Returns the String value with the specified name.

Specified by:

getString in interface javax.jms.MapMessage

Parameters:

name - the name of the String

Returns:

the String value with the specified name; if there is no item by this name, a null value is returned

Throws:

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

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

getBytes

public byte[] getBytes(java.lang.String name)
                throws javax.jms.JMSException

Returns the byte array value with the specified name.

Specified by:

getBytes in interface javax.jms.MapMessage

Parameters:

name - the name of the byte array

Returns:

a copy of the byte array value with the specified name; if there is no item by this name, a null value is returned.

Throws:

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

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

getObject

public java.lang.Object getObject(java.lang.String name)
                           throws javax.jms.JMSException

Returns the value of the object with the specified name.

This method can be used to return, in objectified format, an object in the Java programming language ("Java object") that had been stored in the Map with the equivalent setObject method call, or its equivalent primitive set type method.

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

Specified by:

getObject in interface javax.jms.MapMessage

Parameters:

name - the name of the Java object

Returns:

a copy of the Java object value with the specified name, in objectified format (for example, if the object was set as an int, an Integer is returned); if there is no item by this name, a null value is returned

Throws:

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

getMapNames

public java.util.Enumeration<java.lang.String> getMapNames()
                                                    throws javax.jms.JMSException

Returns an Enumeration of all the names in the MapMessage object.

Specified by:

getMapNames in interface javax.jms.MapMessage

Returns:

an enumeration of all the names in this MapMessage

Throws:

javax.jms.JMSException

put

protected void put(java.lang.String name,
       java.lang.Object value)
            throws javax.jms.JMSException

Throws:

javax.jms.JMSException

setBoolean

public void setBoolean(java.lang.String name,
              boolean value)
                throws javax.jms.JMSException

Sets a boolean value with the specified name into the Map.

Specified by:

setBoolean in interface javax.jms.MapMessage

Parameters:

name - the name of the boolean

value - the boolean value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setByte

public void setByte(java.lang.String name,
           byte value)
             throws javax.jms.JMSException

Sets a byte value with the specified name into the Map.

Specified by:

setByte in interface javax.jms.MapMessage

Parameters:

name - the name of the byte

value - the byte value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setShort

public void setShort(java.lang.String name,
            short value)
              throws javax.jms.JMSException

Sets a short value with the specified name into the Map.

Specified by:

setShort in interface javax.jms.MapMessage

Parameters:

name - the name of the short

value - the short value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setChar

public void setChar(java.lang.String name,
           char value)
             throws javax.jms.JMSException

Sets a Unicode character value with the specified name into the Map.

Specified by:

setChar in interface javax.jms.MapMessage

Parameters:

name - the name of the Unicode character

value - the Unicode character value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setInt

public void setInt(java.lang.String name,
          int value)
            throws javax.jms.JMSException

Sets an int value with the specified name into the Map.

Specified by:

setInt in interface javax.jms.MapMessage

Parameters:

name - the name of the int

value - the int value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setLong

public void setLong(java.lang.String name,
           long value)
             throws javax.jms.JMSException

Sets a long value with the specified name into the Map.

Specified by:

setLong in interface javax.jms.MapMessage

Parameters:

name - the name of the long

value - the long value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setFloat

public void setFloat(java.lang.String name,
            float value)
              throws javax.jms.JMSException

Sets a float value with the specified name into the Map.

Specified by:

setFloat in interface javax.jms.MapMessage

Parameters:

name - the name of the float

value - the float value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setDouble

public void setDouble(java.lang.String name,
             double value)
               throws javax.jms.JMSException

Sets a double value with the specified name into the Map.

Specified by:

setDouble in interface javax.jms.MapMessage

Parameters:

name - the name of the double

value - the double value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setString

public void setString(java.lang.String name,
             java.lang.String value)
               throws javax.jms.JMSException

Sets a String value with the specified name into the Map.

Specified by:

setString in interface javax.jms.MapMessage

Parameters:

name - the name of the String

value - the String value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setBytes

public void setBytes(java.lang.String name,
            byte[] value)
              throws javax.jms.JMSException

Sets a byte array value with the specified name into the Map.

Specified by:

setBytes in interface javax.jms.MapMessage

Parameters:

name - the name of the byte array

value - the byte array value to set in the Map; the array is copied so that the value for name will not be altered by future modifications

Throws:

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

java.lang.NullPointerException - if the name is null, or if the name is an empty string.

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

setBytes

public void setBytes(java.lang.String name,
            byte[] value,
            int offset,
            int length)
              throws javax.jms.JMSException

Sets a portion of the byte array value with the specified name into the Map.

Specified by:

setBytes in interface javax.jms.MapMessage

Parameters:

name - the name of the byte array

value - the byte array value to set in the Map

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.

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

setObject

public void setObject(java.lang.String name,
             java.lang.Object value)
               throws javax.jms.JMSException

Sets an object value with the specified name into the Map.

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

Specified by:

setObject in interface javax.jms.MapMessage

Parameters:

name - the name of the Java object

value - the Java object value to set in the Map

Throws:

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

java.lang.IllegalArgumentException - if the name is null or if the name is an empty string.

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

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

itemExists

public boolean itemExists(java.lang.String name)
                   throws javax.jms.JMSException

Indicates whether an item exists in this MapMessage object.

Specified by:

itemExists in interface javax.jms.MapMessage

Parameters:

name - the name of the item to test

Returns:

true if the item exists

Throws:

javax.jms.JMSException - if the JMS provider fails to determine if the item exists due to some internal error.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getContentMap

public java.util.Map<java.lang.String,java.lang.Object> getContentMap()
                                                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException