|
| MapMessage (Session session) |
| Construct an empty map message for a session. More...
|
|
override Object | Clone () |
| Implements the clone method from ICloneable interfacae More...
|
|
bool | GetBoolean (string name) |
| Returns the boolean value with the specified name. More...
|
|
byte | GetByte (string name) |
| Returns the byte value with the specified name. More...
|
|
short | GetShort (string name) |
| Returns the short value with the specified name. More...
|
|
char | GetChar (string name) |
| Returns the char value with the specified name. More...
|
|
int | GetInt (string name) |
| Returns the int value with the specified name. More...
|
|
long | GetLong (string name) |
| Returns the long value with the specified name. More...
|
|
float | GetFloat (string name) |
| Returns the float value with the specified name. More...
|
|
double | GetDouble (string name) |
| Returns the double value with the specified name. More...
|
|
string | GetString (string name) |
| Returns the string value with the specified name. More...
|
|
byte[] | GetBytes (string name) |
| Returns the byte array value with the specified name. More...
|
|
Object | GetObject (string name) |
| Returns the object value with the specified name. More...
|
|
ICollection | GetMapNames () |
| Returns a collection of all the names in the MapMessage object. More...
|
|
void | SetBoolean (string name, bool value) |
| Sets a boolean value with the specified name into the Map. More...
|
|
void | SetByte (string name, byte value) |
| Sets a byte value with the specified name into the Map. More...
|
|
void | SetShort (string name, short value) |
| Sets a short value with the specified name into the Map. More...
|
|
void | SetChar (string name, char value) |
| Sets a char value with the specified name into the Map. More...
|
|
void | SetInt (string name, int value) |
| Sets an int value with the specified name into the Map. More...
|
|
void | SetLong (string name, long value) |
| Sets a long value with the specified name into the Map. More...
|
|
void | SetFloat (string name, float value) |
| Sets a float value with the specified name into the Map. More...
|
|
void | SetDouble (string name, double value) |
| Sets a double value with the specified name into the Map. More...
|
|
void | SetString (string name, String value) |
| Sets a string value with the specified name into the Map. More...
|
|
void | SetBytes (string name, byte[] value) |
| Sets a byte array value with the specified name into the Map. More...
|
|
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. More...
|
|
void | SetObject (string name, Object value) |
| Sets an object value with the specified name into the Map. More...
|
|
bool | ItemExists (string name) |
| Indicates whether an item exists in this MapMessage object. More...
|
|
override void | ClearBody () |
| Clears out the message body. Clearing a message's body does not clear its header values or property entries. More...
|
|
override string | ToString () |
| returns a string representation of the message More...
|
|
virtual void | ClearProperties () |
| Clears a message's properties. More...
|
|
virtual bool | PropertyExists (string name) |
| Test whether a named property has been set on a message. More...
|
|
bool | GetBooleanProperty (string name) |
| Returns the value of the boolean property with the specified name. More...
|
|
byte | GetByteProperty (string name) |
| Returns the value of the byte property with the specified name. More...
|
|
short | GetShortProperty (string name) |
| Returns the value of the short property with the specified name. More...
|
|
int | GetIntProperty (string name) |
| Returns the value of the int property with the specified name. More...
|
|
long | GetLongProperty (string name) |
| Returns the value of the long property with the specified name. More...
|
|
float | GetFloatProperty (string name) |
| Returns the value of the float property with the specified name. More...
|
|
double | GetDoubleProperty (string name) |
| Returns the value of the double property with the specified name. More...
|
|
string | GetStringProperty (string name) |
| Returns the value of the string property with the specified name. More...
|
|
Object | GetObjectProperty (string name) |
| Returns the value of the object property with the specified name. More...
|
|
virtual object | GetProperty (string name, Type type) |
| THIS IS FOR INTERNAL USE ONLY More...
|
|
void | SetBooleanProperty (string name, bool val) |
| Sets a boolean property value with the specified name into the message More...
|
|
void | SetByteProperty (string name, byte val) |
| Sets a byte property value with the specified name into the message More...
|
|
void | SetShortProperty (string name, short val) |
| Sets a short property value with the specified name into the message More...
|
|
void | SetIntProperty (string name, int val) |
| Sets a int property value with the specified name into the message More...
|
|
void | SetLongProperty (string name, long val) |
| Sets a long property value with the specified name into the message More...
|
|
void | SetFloatProperty (string name, float val) |
| Sets a float property value with the specified name into the message More...
|
|
void | SetDoubleProperty (string name, double val) |
| Sets a double property value with the specified name into the message More...
|
|
void | SetStringProperty (string name, string val) |
| Sets a string property value with the specified name into the message More...
|
|
void | SetObjectProperty (string name, Object val) |
| Sets an object property value with the specified name into the message More...
|
|
void | SetBytesProperty (string name, byte[] val) |
| FOR INTERNAL USE ONLY More...
|
|
virtual void | Acknowledge () |
| Acknowledges all consumed messages of the session of this consumed message. More...
|
|
override string | ToString () |
| returns a string representation of the message More...
|
|
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 .NET 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.
Extentions
TIBCO Enterprise Message Service extends the Jakarta Messaging MapMessage and StreamMessage body types in two ways. These extensions allow TIBCO Enterprise Message Service to exchange messages with TIBCO Rendezvous programs, which have certain features not available within the Jakarta Messaging specification.
-
You can insert another MapMessage or StreamMessage instance as a submessage into a MapMessage or StreamMessage, generating a series of nested messages, instead of a flat message.
-
You can use arrays as well as primitive types for the values.
These extensions add considerable flexibility to the two body types. However, they are extensions and therefore not compliant with Jakarta Messaging specifications. Extended messages are tagged as extensions with the vendor property tag JMS_TIBCO_MSG_EXT.