WebLogic Messaging API Class Library

IMessage�Methods

The methods of the IMessage interface are listed below. For a complete list of IMessage interface members, see the IMessage Members topic.

Public Instance Methods

AcknowledgeAcknowledges all consumed messages of the session of this consumed message. All consumed JMS messages support the Acknowledge method for use when a client has specified that its JMS session's consumed messages are to be explicitly acknowledged. By invoking Acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to. Calls to Acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes. A client may individually Acknowledge each message as it is consumed, or it may choose to Acknowledge messages as an application-defined group (which is done by calling Acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.) WebLogic provides an optional extension that is configurable on the connection factory which controls acknowledge behavior: the acknowledge policy can be set to "acknowledge all", or "acknowledge previous", where "acknowledge previous" is an extension that causes calls acknowledges to only acknowledge messages up to and including the current message instead of all of a session's unacknowledged messages. A client may individually Acknowledge each message as it is consumed, or it may choose to Acknowledge messages as an application-defined group (which is done by calling Acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.) Messages that have been received but not acknowledged may be redelivered.
ClearBodyClears 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.
ClearPropertiesClears a message's properties. The message's header fields and body are not cleared.
GetBooleanPropertyReturns the value of the boolean property with the specified name.
GetBytePropertyReturns the value of the sbyte property with the specified name.
GetDoublePropertyReturns the value of the double property with the specified name.
GetFloatPropertyReturns the value of the float property with the specified name.
GetIntPropertyReturns the value of the int property with the specified name.
GetLongPropertyReturns the value of the long property with the specified name.
GetObjectPropertyReturns the value of the primitive object property with the specified name. This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent SetObjectProperty method call, or its equivalent primitive settypeProperty method.
GetPropertyNamesReturns an Enumeration of all the property names. Note that JMS standard header fields are not considered properties and are not returned in this enumeration.
GetShortPropertyReturns the value of the short property with the specified name.
GetStringPropertyReturns the value of the String property with the specified name.
PropertyExistsIndicates whether a property value exists.
SetBooleanPropertySets a boolean property value with the specified name into the message.
SetBytePropertySets a sbyte property value with the specified name into the message.
SetDoublePropertySets a double property value with the specified name into the message.
SetFloatPropertySets a float property value with the specified name into the message.
SetIntPropertySets an int property value with the specified name into the message.
SetLongPropertySets a long property value with the specified name into the message.
SetObjectPropertySets a primitive object property value with the specified name into the message. Note that this method works only for the objectified primitive object types (int, double, long ...) and String objects.
SetShortPropertySets a short property value with the specified name into the message.
SetStringPropertySets a String property value with the specified name into the message.

See Also

IMessage Interface | WebLogic.Messaging Namespace | Receive() | Receive(long) | ReceiveNoWait() | MessageEventHandler | IBytesMessage | IMapMessage | IObjectMessage | IStreamMessage | ITextMessage