IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.webservices.soap
Class IBMSOAPMessage

java.lang.Object
  extended by javax.xml.soap.SOAPMessage
      extended by com.ibm.websphere.webservices.soap.IBMSOAPMessage

public abstract class IBMSOAPMessage
extends javax.xml.soap.SOAPMessage

This is a marker interface. IBM value-add methods may be added to this class in the future.

See Also:
SOAPMessage

Field Summary
static java.lang.String ENABLE_LEGACY_GETSOAP_BEHAVIOR
          Determines the behavior of the getSOAPHeader() and getSOAPBody() methods if there is no Header or Body respectively.
 
Fields inherited from class javax.xml.soap.SOAPMessage
CHARACTER_SET_ENCODING, WRITE_XML_DECLARATION
 
Constructor Summary
IBMSOAPMessage()
           
 
Method Summary
 javax.xml.soap.SOAPBody getSOAPBody()
          Gets the SOAP Body contained in this SOAPMessage object.
 javax.xml.soap.SOAPHeader getSOAPHeader()
          Gets the SOAP Header contained in this SOAPMessage object.
 
Methods inherited from class javax.xml.soap.SOAPMessage
addAttachmentPart, countAttachments, createAttachmentPart, createAttachmentPart, createAttachmentPart, getAttachment, getAttachments, getAttachments, getContentDescription, getMimeHeaders, getProperty, getSOAPPart, removeAllAttachments, removeAttachments, saveChanges, saveRequired, setContentDescription, setProperty, writeTo
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ENABLE_LEGACY_GETSOAP_BEHAVIOR

public static final java.lang.String ENABLE_LEGACY_GETSOAP_BEHAVIOR
Determines the behavior of the getSOAPHeader() and getSOAPBody() methods if there is no Header or Body respectively. PROPERTY TYPE: String PROPERTY VALUE: "true" or "false" DEFAULT VALUE: "false" If this SystemProperty is set to true, then the pre-v8 behavior of returning null is enabled. If this SystemProperty is not set or is set to false, then the v8 behavior of throwing an exception is enabled.

See Also:
Constant Field Values
Constructor Detail

IBMSOAPMessage

public IBMSOAPMessage()
Method Detail

getSOAPHeader

public javax.xml.soap.SOAPHeader getSOAPHeader()
                                        throws javax.xml.soap.SOAPException
Gets the SOAP Header contained in this SOAPMessage object.

Overrides:
getSOAPHeader in class javax.xml.soap.SOAPMessage
Returns:
the SOAPHeader object contained by this IBMSOAPMessage object
Throws:
SOAPException - - if the SOAP Header does not exist or cannot be retrieved
javax.xml.soap.SOAPException
Since:
SAAJ 1.2

getSOAPBody

public javax.xml.soap.SOAPBody getSOAPBody()
                                    throws javax.xml.soap.SOAPException
Gets the SOAP Body contained in this SOAPMessage object.

Overrides:
getSOAPBody in class javax.xml.soap.SOAPMessage
Returns:
the SOAPBody object contained by this SOAPMessage object
Throws:
SOAPException - - if the SOAP Body does not exist or cannot be retrieved
javax.xml.soap.SOAPException
Since:
SAAJ 1.2

IBM WebSphere Application ServerTM
Release 8