public final class ActiveMQMapMessage extends ActiveMQMessage implements MapMessage
Modifier and Type | Field and Description |
---|---|
static byte |
TYPE |
message, propertiesReadOnly, readOnly
DEFAULT_DELIVERY_DELAY, DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
Modifier | Constructor and Description |
---|---|
|
ActiveMQMapMessage() |
protected |
ActiveMQMapMessage(ClientMessage message,
ClientSession session) |
protected |
ActiveMQMapMessage(ClientSession session) |
|
ActiveMQMapMessage(MapMessage foreign,
ClientSession session)
Constructor for a foreign MapMessage
|
Modifier and Type | Method and Description |
---|---|
void |
clearBody()
Clears out the message body.
|
void |
doBeforeReceive() |
void |
doBeforeSend() |
protected <T> T |
getBodyInternal(Class<T> c) |
boolean |
getBoolean(String name)
Returns the
boolean value with the specified name. |
byte |
getByte(String name)
Returns the
byte value with the specified name. |
byte[] |
getBytes(String name)
Returns the byte array value with the specified name.
|
char |
getChar(String name)
Returns the Unicode character value with the specified name.
|
double |
getDouble(String name)
Returns the
double value with the specified name. |
float |
getFloat(String name)
Returns the
float value with the specified name. |
int |
getInt(String name)
Returns the
int value with the specified name. |
long |
getLong(String name)
Returns the
long value with the specified name. |
Enumeration |
getMapNames()
Returns an
Enumeration of all the names in the
MapMessage object. |
Object |
getObject(String name)
Returns the value of the object with the specified name.
|
short |
getShort(String name)
Returns the
short value with the specified name. |
String |
getString(String name)
Returns the
String value with the specified name. |
byte |
getType() |
protected boolean |
hasNoBody()
Helper method for
ActiveMQMessage.isBodyAssignableTo(Class) . |
boolean |
isBodyAssignableTo(Class c)
Returns whether the message body is capable of being assigned to the
specified type.
|
boolean |
itemExists(String name)
Indicates whether an item exists in this
MapMessage object. |
void |
setBoolean(String name,
boolean value)
Sets a
boolean value with the specified name into the Map. |
void |
setByte(String name,
byte value)
Sets a
byte value with the specified name into the Map. |
void |
setBytes(String name,
byte[] value)
Sets a byte array value with the specified name into the Map.
|
void |
setBytes(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(String name,
char value)
Sets a Unicode character value with the specified name into the Map.
|
void |
setDouble(String name,
double value)
Sets a
double value with the specified name into the Map. |
void |
setFloat(String name,
float value)
Sets a
float value with the specified name into the Map. |
void |
setInt(String name,
int value)
Sets an
int value with the specified name into the Map. |
void |
setLong(String name,
long value)
Sets a
long value with the specified name into the Map. |
void |
setObject(String name,
Object value)
Sets an object value with the specified name into the Map.
|
void |
setShort(String name,
short value)
Sets a
short value with the specified name into the Map. |
void |
setString(String name,
String value)
Sets a
String value with the specified name into the Map. |
acknowledge, checkBuffer, checkRead, checkWrite, clearProperties, coreCompositeTypeToJMSCompositeType, coreMaptoJMSMap, createMessage, createMessage, getBody, getBooleanProperty, getByteProperty, getCoreMessage, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, resetMessageID, saveToOutputStream, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIndividualAcknowledge, setInputStream, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setOutputStream, setShortProperty, setStringProperty, toString, waitCompletionOnStream
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
acknowledge, clearProperties, getBody, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDeliveryTime, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDeliveryTime, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty
public static final byte TYPE
protected ActiveMQMapMessage(ClientSession session)
protected ActiveMQMapMessage(ClientMessage message, ClientSession session)
public ActiveMQMapMessage()
public ActiveMQMapMessage(MapMessage foreign, ClientSession session) throws JMSException
foreign
- JMSException
public byte getType()
getType
in class ActiveMQMessage
public void setBoolean(String name, boolean value) throws JMSException
MapMessage
boolean
value with the specified name into the Map.setBoolean
in interface MapMessage
name
- the name of the boolean
value
- the boolean
value to set in the MapJMSException
- 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 setByte(String name, byte value) throws JMSException
MapMessage
byte
value with the specified name into the Map.setByte
in interface MapMessage
name
- the name of the byte
value
- the byte
value to set in the MapJMSException
- 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 setShort(String name, short value) throws JMSException
MapMessage
short
value with the specified name into the Map.setShort
in interface MapMessage
name
- the name of the short
value
- the short
value to set in the MapJMSException
- 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 setChar(String name, char value) throws JMSException
MapMessage
setChar
in interface MapMessage
name
- the name of the Unicode charactervalue
- the Unicode character value to set in the MapJMSException
- 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 setInt(String name, int value) throws JMSException
MapMessage
int
value with the specified name into the Map.setInt
in interface MapMessage
name
- the name of the int
value
- the int
value to set in the MapJMSException
- 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 setLong(String name, long value) throws JMSException
MapMessage
long
value with the specified name into the Map.setLong
in interface MapMessage
name
- the name of the long
value
- the long
value to set in the MapJMSException
- 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 setFloat(String name, float value) throws JMSException
MapMessage
float
value with the specified name into the Map.setFloat
in interface MapMessage
name
- the name of the float
value
- the float
value to set in the MapJMSException
- 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 setDouble(String name, double value) throws JMSException
MapMessage
double
value with the specified name into the Map.setDouble
in interface MapMessage
name
- the name of the double
value
- the double
value to set in the MapJMSException
- 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 setString(String name, String value) throws JMSException
MapMessage
String
value with the specified name into the Map.setString
in interface MapMessage
name
- the name of the String
value
- the String
value to set in the MapJMSException
- 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 setBytes(String name, byte[] value) throws JMSException
MapMessage
setBytes
in interface MapMessage
name
- the name of the byte arrayvalue
- 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 modificationsJMSException
- 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 setBytes(String name, byte[] value, int offset, int length) throws JMSException
MapMessage
setBytes
in interface MapMessage
name
- the name of the byte arrayvalue
- the byte array value to set in the Mapoffset
- 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 setObject(String name, Object value) throws JMSException
MapMessage
This method works only for the objectified primitive
object types (Integer
, Double
,
Long
...), String
objects, and byte
arrays.
setObject
in interface MapMessage
name
- the name of the Java objectvalue
- the Java object value to set in the MapJMSException
- if the JMS provider fails to write the message
due to some internal error.MessageFormatException
- if the object is invalid.MessageNotWriteableException
- if the message is in read-only
mode.public boolean getBoolean(String name) throws JMSException
MapMessage
boolean
value with the specified name.getBoolean
in interface MapMessage
name
- the name of the boolean
boolean
value with the specified nameJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public byte getByte(String name) throws JMSException
MapMessage
byte
value with the specified name.getByte
in interface MapMessage
name
- the name of the byte
byte
value with the specified nameJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public short getShort(String name) throws JMSException
MapMessage
short
value with the specified name.getShort
in interface MapMessage
name
- the name of the short
short
value with the specified nameJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public char getChar(String name) throws JMSException
MapMessage
getChar
in interface MapMessage
name
- the name of the Unicode characterJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public int getInt(String name) throws JMSException
MapMessage
int
value with the specified name.getInt
in interface MapMessage
name
- the name of the int
int
value with the specified nameJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public long getLong(String name) throws JMSException
MapMessage
long
value with the specified name.getLong
in interface MapMessage
name
- the name of the long
long
value with the specified nameJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public float getFloat(String name) throws JMSException
MapMessage
float
value with the specified name.getFloat
in interface MapMessage
name
- the name of the float
float
value with the specified nameJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public double getDouble(String name) throws JMSException
MapMessage
double
value with the specified name.getDouble
in interface MapMessage
name
- the name of the double
double
value with the specified nameJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public String getString(String name) throws JMSException
MapMessage
String
value with the specified name.getString
in interface MapMessage
name
- the name of the String
String
value with the specified name; if there
is no item by this name, a null value is returnedJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public byte[] getBytes(String name) throws JMSException
MapMessage
getBytes
in interface MapMessage
name
- the name of the byte arrayJMSException
- if the JMS provider fails to read the message
due to some internal error.MessageFormatException
- if this type conversion is invalid.public Object getObject(String name) throws JMSException
MapMessage
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<I>type</I>
method.
Note that byte values are returned as byte[]
, not
Byte[]
.
getObject
in interface MapMessage
name
- the name of the Java objectint
, an Integer
is returned); if there is no
item by this name, a null value is returnedJMSException
- if the JMS provider fails to read the message
due to some internal error.public Enumeration getMapNames() throws JMSException
MapMessage
Enumeration
of all the names in the
MapMessage
object.getMapNames
in interface MapMessage
MapMessage
JMSException
- if the JMS provider fails to read the message
due to some internal error.public boolean itemExists(String name) throws JMSException
MapMessage
MapMessage
object.itemExists
in interface MapMessage
name
- the name of the item to testJMSException
- if the JMS provider fails to determine if the
item exists due to some internal error.public void clearBody() throws JMSException
Message
If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.
clearBody
in interface Message
clearBody
in class ActiveMQMessage
JMSException
- if the JMS provider fails to clear the message
body due to some internal error.public void doBeforeSend() throws Exception
doBeforeSend
in class ActiveMQMessage
Exception
public void doBeforeReceive() throws ActiveMQException
doBeforeReceive
in class ActiveMQMessage
ActiveMQException
protected boolean hasNoBody()
ActiveMQMessage
ActiveMQMessage.isBodyAssignableTo(Class)
.hasNoBody
in class ActiveMQMessage
public boolean isBodyAssignableTo(Class c)
Message
getBody
on the same message with the same type argument would not throw a
MessageFormatException.
If the message is a StreamMessage
then false is always returned.
If the message is a ObjectMessage
and object deserialization
fails then false is returned. If the message has no body then any type may be specified and true is
returned.
isBodyAssignableTo
in interface Message
isBodyAssignableTo
in class ActiveMQMessage
c
- The specified type TextMessage
then this method will
only return true if this parameter is set to
String.class
or another type to which a String
is assignable. ObjectMessage
then this
method will only return true if this parameter is set to
java.io.Serializable.class
or another class to
which the body is assignable. MapMessage
then this method
will only return true if this parameter is set to
java.util.Map.class
(or java.lang.Object.class
). BytesMessage
then this this
method will only return true if this parameter is set to
byte[].class
(or java.lang.Object.class
). TextMessage
, ObjectMessage
, MapMessage
or BytesMessage
and the message has no body,
then the above does not apply and this method will return true
irrespective of the value of this parameter.Message
(but not one of its subtypes)
then this method will return true
irrespective of the value of this parameter.protected <T> T getBodyInternal(Class<T> c)
getBodyInternal
in class ActiveMQMessage
Copyright © 2017 JBoss by Red Hat. All rights reserved.