All Superinterfaces:

Element, Node, SOAPElement
```
public interface SOAPBody
extends 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.

See Also:
SOAPFault

Field Summary
- Fields inherited from interface org.w3c.dom.Node
  ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

Methods
Modifier and Type	Method and Description
`SOAPBodyElement`	`addBodyElement(Name name)` Creates a new `SOAPBodyElement` object with the specified name and adds it to this `SOAPBody` object.
`SOAPBodyElement`	`addBodyElement(QName qname)` Creates a new `SOAPBodyElement` object with the specified QName and adds it to this `SOAPBody` object.
`SOAPBodyElement`	`addDocument(Document document)` Adds the root node of the DOM `Document` to this `SOAPBody` object.
`SOAPFault`	`addFault()` Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
`SOAPFault`	`addFault(Name faultCode, String faultString)` Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
`SOAPFault`	`addFault(Name faultCode, String faultString, Locale locale)` Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
`SOAPFault`	`addFault(QName faultCode, String faultString)` Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
`SOAPFault`	`addFault(QName faultCode, String faultString, Locale locale)` Creates a new `SOAPFault` object and adds it to this `SOAPBody` object.
`Document`	`extractContentAsDocument()` Creates a new DOM `Document` and sets the first child of this `SOAPBody` as it's document element.
`SOAPFault`	`getFault()` Returns the `SOAPFault` object in this `SOAPBody` object.
`boolean`	`hasFault()` Indicates whether a `SOAPFault` object exists in this `SOAPBody` object.

SOAPBody (Java Platform SE 7 ) Home of API Java Contents Haut

Methods inherited from interface javax.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

- Method Detail
  - addFault
```
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.
    
    Returns:
    the new SOAPFault object
    
    Throws:
    
    SOAPException - if there is a SOAP error
  - addFault
```
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.
    
    Parameters:
    faultCode - a Name object giving the fault code to be set; must be one of the fault codes defined in the Version of SOAP specification in use
    faultString - a String giving an explanation of the fault
    locale - a Locale object indicating the native language of the faultString
    
    Returns:
    the new SOAPFault object
    
    Throws:
    
    SOAPException - if there is a SOAP error
    Since:
    
    SAAJ 1.2
    
    See Also:
    SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)
  - addFault
```
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.
    
    Parameters:
    faultCode - a QName object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use.
    faultString - a String giving an explanation of the fault
    locale - a Locale object indicating the native language of the faultString
    
    Returns:
    the new SOAPFault object
    
    Throws:
    
    SOAPException - if there is a SOAP error
    Since:
    
    SAAJ 1.3
    
    See Also:
    SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String), addFault(Name faultCode, String faultString, Locale locale)
  - addFault
```
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.
    
    Parameters:
    faultCode - a Name object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use
    faultString - a String giving an explanation of the fault
    
    Returns:
    the new SOAPFault object
    
    Throws:
    
    SOAPException - if there is a SOAP error
    Since:
    
    SAAJ 1.2
    
    See Also:
    SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)
  - addFault
```
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
    
    Parameters:
    faultCode - a QName object giving the fault code to be set; must be one of the fault codes defined in the version of SOAP specification in use
    faultString - a String giving an explanation of the fault
    
    Returns:
    the new SOAPFault object
    
    Throws:
    
    SOAPException - if there is a SOAP error
    Since:
    
    SAAJ 1.3
    
    See Also:
    SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String), addFault(Name faultCode, String faultString)
  - hasFault
```
boolean hasFault()
```
    Indicates whether a SOAPFault object exists in this SOAPBody object.
    
    Returns:
    true if a SOAPFault object exists in this SOAPBody object; false otherwise
  - getFault
```
SOAPFault getFault()
```
    Returns the SOAPFault object in this SOAPBody object.
    
    Returns:
    the SOAPFault object in this SOAPBody object if present, null otherwise.
  - addBodyElement
```
SOAPBodyElement addBodyElement(Name name)
                               throws SOAPException
```
    Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.
    
    Parameters:
    name - a Name object with the name for the new SOAPBodyElement object
    
    Returns:
    the new SOAPBodyElement object
    
    Throws:
    
    SOAPException - if a SOAP error occurs
    See Also:
    addBodyElement(javax.xml.namespace.QName)
  - addBodyElement
```
SOAPBodyElement addBodyElement(QName qname)
                               throws SOAPException
```
    Creates a new SOAPBodyElement object with the specified QName and adds it to this SOAPBody object.
    
    Parameters:
    qname - a QName object with the qname for the new SOAPBodyElement object
    
    Returns:
    the new SOAPBodyElement object
    
    Throws:
    
    SOAPException - if a SOAP error occurs
    Since:
    
    SAAJ 1.3
    
    See Also:
    addBodyElement(Name)
  - addDocument
```
SOAPBodyElement addDocument(Document document)
                            throws SOAPException
```
    Adds the root node of the 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.
    
    Parameters:
    document - the Document object whose root node will be added to this SOAPBody.
    
    Returns:
    the SOAPBodyElement that represents the root node that was added.
    
    Throws:
    
    SOAPException - if the Document cannot be added
    Since:
    
    SAAJ 1.2
  - extractContentAsDocument
```
Document extractContentAsDocument()
                                  throws SOAPException
```
    Creates a new 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.
    
    Returns:
    the Document representation of the SOAPBody content.
    
    Throws:
    
    SOAPException - if there is not exactly one child SOAPElement of the SOAPBody.
    Since:
    SAAJ 1.3

Site language settings

If you prefer to continue on the site in English, click on "Cancel". If you cancel, this message will no longer appear during the session.

U bevindt zich op de Engels versie van de site, maar uw systeem geeft aan dat u liever de Nederlandse taal gebruikt.
De hele site is nog niet vertaald, maar de menu's en knoppen op de interface zijn grotendeels vertaald.

Wilt u de pagina in het Nederlands bereiken?
Klik hier om door te gaan in het Nederlands:  Raadpleeg de Nederlandse versie van deze pagina

Sie befinden sich in der Englisch Version der Website, Ihr System gibt jedoch an, dass Sie die deutsche Sprache bevorzugen.
 Die gesamte Site ist noch nicht übersetzt, aber die Menüs und Schaltflächen auf der Benutzeroberfläche sind weitgehend übersetzt.

Möchten Sie die Seite auf Deutsch erreichen?
Klicken Sie hier, um fortzufahren:  Konsultieren Sie die deutsche Version dieser Seite

Vous vous trouvez sur la version anglaise du site, mais votre système indique que vous préférez utiliser la langue française.

Souhaitez-vous atteindre la page en français?
Cliquez ici pour continuer en français:  Consulter la page en français

Document created the 11/06/2005, last modified the 04/03/2020 Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/soap/soapbody.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

`References`

Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page. The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut

Interface SOAPBody

Field Summary

Fields inherited from interface org.w3c.dom.Node

Method Summary

Methods inherited from interface javax.xml.soap.SOAPElement

Methods inherited from interface javax.xml.soap.Node

Methods inherited from interface org.w3c.dom.Element

Methods inherited from interface org.w3c.dom.Node

Method Detail

addFault

addFault

addFault

addFault

addFault

hasFault

getFault

addBodyElement

addBodyElement

addDocument

extractContentAsDocument

`References`