com.sssw.jms.api
Interface JMQSOAPMessage

All Superinterfaces:

Message

public interface JMQSOAPMessage

extends Message

A JMQSOAPMessage object is used to send a message containing a javax.xml.soap.SOAPMessage. This makes it easy to integrate JAXM applications with JMS applications.

When a consumer receives a JMQSOAPMessage, it is in read-only mode. If a consumer 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.

Since:

jBroker MQ 2.0

See Also:

SOAPMessage, Message, JMQSession

Field Summary

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Method Summary

javax.xml.soap.SOAPMessage	getMessage() Gets the SOAP message contained in this message's data.
void	setMessage(javax.xml.soap.SOAPMessage message) Sets message as this message's data.

Methods inherited from interface javax.jms.Message

acknowledge, clearBody, 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

Method Detail

setMessage

public void setMessage(javax.xml.soap.SOAPMessage message)
                throws JMSException

Sets message as this message's data. If a message was previously set as the message's data, it will be replaced by the message.

Parameters:

message - the SOAPMessage containing the message's data

Throws:

JMSException - if the JMS provider fails to set the text due to some internal error.

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

getMessage

public javax.xml.soap.SOAPMessage getMessage()
                                      throws JMSException

Gets the SOAP message contained in this message's data. The default value is null.

Returns:

the SOAPMessage containing the message's data

Throws:

JMSException - if the JMS provider fails to get the text due to some internal error.