Home » xml-commons-external-1.4.01-src » javax » xml » soap » [javadoc | source]
javax.xml.soap
public interface: SOAPBody [javadoc | source]

All Implemented Interfaces:
    SOAPElement

An object that represents the contents of the SOAP body element in a SOAP message. A SOAP body element consists of XML data that affects the way the application-specific content is processed.

A SOAPBody object contains SOAPBodyElement objects, which have the content for the SOAP body. A SOAPFault object, which carries status and/or error information, is an example of a SOAPBodyElement object.

Method from javax.xml.soap.SOAPBody Summary:
addBodyElement,   addBodyElement,   addDocument,   addFault,   addFault,   addFault,   addFault,   addFault,   extractContentAsDocument,   getFault,   hasFault
Method from javax.xml.soap.SOAPBody Detail:
 public SOAPBodyElement addBodyElement(Name name) throws SOAPException
    Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.
 public SOAPBodyElement addBodyElement(QName qname) throws SOAPException
    Creates a new SOAPBodyElement object with the specified QName and adds it to this SOAPBody object.
 public SOAPBodyElement addDocument(Document document) throws SOAPException
    Adds the root node of the DOM org.w3c.dom.Document to this SOAPBody object.

    Calling this method invalidates the document parameter. The client application should discard all references to this Document and its contents upon calling addDocument. The behavior of an application that continues to use such references is undefined.

 public SOAPFault addFault() throws SOAPException
    Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have default values set for the mandatory child elements. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.

    A SOAPBody may contain at most one SOAPFault child element.

 public SOAPFault addFault(Name faultCode,
    String faultString) throws SOAPException
    Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.

    For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element.

    In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang attribute on the Fault/Reason/Text element will be set to java.util.Locale.getDefault()

    A SOAPBody may contain at most one SOAPFault child element.

 public SOAPFault addFault(QName faultCode,
    String faultString) throws SOAPException
    Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.

    For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element.

    In case of a SOAP 1.2 fault, the default value for the mandatory xml:lang attribute on the Fault/Reason/Text element will be set to java.util.Locale.getDefault()

    A SOAPBody may contain at most one SOAPFault child element

 public SOAPFault addFault(Name faultCode,
    String faultString,
    Locale locale) throws SOAPException
    Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.

    For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element.

    A SOAPBody may contain at most one SOAPFault child element.

 public SOAPFault addFault(QName faultCode,
    String faultString,
    Locale locale) throws SOAPException
    Creates a new SOAPFault object and adds it to this SOAPBody object. The type of the SOAPFault will be a SOAP 1.1 or a SOAP 1.2 SOAPFault depending on the protocol specified while creating the MessageFactory instance.

    For SOAP 1.2 the faultCode parameter is the value of the Fault/Code/Value element and the faultString parameter is the value of the Fault/Reason/Text element. For SOAP 1.1 the faultCode parameter is the value of the faultcode element and the faultString parameter is the value of the faultstring element.

    A SOAPBody may contain at most one SOAPFault child element.

 public Document extractContentAsDocument() throws SOAPException
    Creates a new DOM org.w3c.dom.Document and sets the first child of this SOAPBody as it's document element. The child SOAPElement is removed as part of the process.
 public SOAPFault getFault()
    Returns the SOAPFault object in this SOAPBody object.
 public boolean hasFault()
    Indicates whether a SOAPFault object exists in this SOAPBody object.