SOAPBodyImpl (Red Hat JBoss Enterprise Application Platform 6.4.19.GA public API)

java.lang.Object
- org.jboss.ws.core.soap.NodeImpl
- - org.jboss.ws.core.soap.SOAPElementImpl
  - - org.jboss.ws.core.soap.SOAPBodyImpl

All Implemented Interfaces:

SOAPBody, SOAPElement, Element, Node
```
public class SOAPBodyImpl
extends SOAPElementImpl
implements SOAPBody
```
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.

Author:

Thomas.Diesler@jboss.org, Jason T. Greene

Field Summary
- Fields inherited from class org.jboss.ws.core.soap.NodeImpl
  domNode, soapParent
- 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

Constructor Summary

Constructors
Constructor and Description

SOAPBodyImpl(String prefix, String namespace)

Constructors
Constructor and Description
`SOAPBodyImpl(String prefix, String namespace)`

Method Summary

Methods
Modifier and Type	Method and Description
`SOAPElement`	`addAttribute(Name name, String value)` Adds an attribute with the specified name and value to this SOAPElement object.
`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.
`SOAPElement`	`addChildElement(SOAPElement child)` Convert the child into a SOAPBodyElement
`SOAPBodyElement`	`addDocument(Document doc)` 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.
`Node`	`appendChild(Node newChild)`
`Document`	`extractContentAsDocument()` Creates a new DOM `Document` and sets the first child of this `SOAPBody` as it's document element.
`SOAPBodyElement`	`getBodyElement()`
`SOAPFault`	`getFault()` Returns the `SOAPFault` object in this `SOAPBody` object.
`boolean`	`hasFault()` Indicates whether a `SOAPFault` object exists in this `SOAPBody` object.
`Node`	`insertBefore(Node newChild, Node refChild)`
`Node`	`replaceChild(Node newChild, Node oldChild)`

Methods inherited from class org.jboss.ws.core.soap.SOAPElementImpl
addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChildElementByLocalName, getNamespacePrefixes, getNamespaceURI, getSchemaTypeInfo, getSOAPEnvelope, getTagName, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setElementQName, setElementQNameInternal, setEncodingStyle, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setPrefix, writeElement, writeElementContent

Methods inherited from class org.jboss.ws.core.soap.NodeImpl
cloneNode, compareDocumentPosition, detachNode, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, getValue, hasAttributes, hasChildNodes, hashCode, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeChild, setNodeValue, setParentElement, setTextContent, setUserData, setValue, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

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
cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, setNodeValue, setPrefix, setTextContent, setUserData

- Constructor Detail
  - SOAPBodyImpl
```
public SOAPBodyImpl(String prefix,
            String namespace)
```
- Method Detail
  - addChildElement
```
public SOAPElement addChildElement(SOAPElement child)
                            throws SOAPException
```
    Convert the child into a SOAPBodyElement
    
    Specified by:
    
    addChildElement in interface SOAPElement
    
    Overrides:
    
    addChildElement in class SOAPElementImpl
    
    Parameters:
    child - the SOAPElement to be added as a new child
    
    Returns:
    an instance representing the new SOAP element that was actually added to the tree.
    
    Throws:
    
    SOAPException - if there was an error in adding this element as a child
  - addBodyElement
```
public SOAPBodyElement addBodyElement(Name name)
                               throws SOAPException
```
    Description copied from interface: SOAPBody
    
    Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.
    
    Specified by:
    
    addBodyElement in interface SOAPBody
    
    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:
    SOAPBody.addBodyElement(javax.xml.namespace.QName)
  - addBodyElement
```
public SOAPBodyElement addBodyElement(QName qname)
                               throws SOAPException
```
    Description copied from interface: SOAPBody
    
    Creates a new SOAPBodyElement object with the specified QName and adds it to this SOAPBody object.
    
    Specified by:
    
    addBodyElement in interface SOAPBody
    
    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
    See Also:
    SOAPBody.addBodyElement(Name)
  - addDocument
```
public SOAPBodyElement addDocument(Document doc)
                            throws SOAPException
```
    Description copied from interface: SOAPBody
    
    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.
    
    Specified by:
    
    addDocument in interface SOAPBody
    
    Parameters:
    doc - 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
  - addFault
```
public SOAPFault addFault()
                   throws SOAPException
```
    Description copied from interface: SOAPBody
    
    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.
    
    Specified by:
    
    addFault in interface SOAPBody
    
    Returns:
    the new SOAPFault object
    
    Throws:
    
    SOAPException - if there is a SOAP error
  - addFault
```
public SOAPFault addFault(Name faultCode,
                 String faultString)
                   throws SOAPException
```
    Description copied from interface: SOAPBody
    
    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.
    
    Specified by:
    
    addFault in interface SOAPBody
    
    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
    See Also:
    SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)
  - addFault
```
public SOAPFault addFault(QName faultCode,
                 String faultString)
                   throws SOAPException
```
    Description copied from interface: SOAPBody
    
    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
    
    Specified by:
    
    addFault in interface SOAPBody
    
    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
    See Also:
    SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String), SOAPBody.addFault(Name faultCode, String faultString)
  - addFault
```
public SOAPFault addFault(Name faultCode,
                 String faultString,
                 Locale locale)
                   throws SOAPException
```
    Description copied from interface: SOAPBody
    
    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.
    
    Specified by:
    
    addFault in interface SOAPBody
    
    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
    See Also:
    SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)
  - addFault
```
public SOAPFault addFault(QName faultCode,
                 String faultString,
                 Locale locale)
                   throws SOAPException
```
    Description copied from interface: SOAPBody
    
    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.
    
    Specified by:
    
    addFault in interface SOAPBody
    
    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
    See Also:
    SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String), SOAPBody.addFault(Name faultCode, String faultString, Locale locale)
  - getFault
```
public SOAPFault getFault()
```
    Description copied from interface: SOAPBody
    
    Returns the SOAPFault object in this SOAPBody object.
    
    Specified by:
    
    getFault in interface SOAPBody
    
    Returns:
    the SOAPFault object in this SOAPBody object if present, null otherwise.
  - hasFault
```
public boolean hasFault()
```
    Description copied from interface: SOAPBody
    
    Indicates whether a SOAPFault object exists in this SOAPBody object.
    
    Specified by:
    
    hasFault in interface SOAPBody
    
    Returns:
    true if a SOAPFault object exists in this SOAPBody object; false otherwise
  - getBodyElement
```
public SOAPBodyElement getBodyElement()
```
  - appendChild
```
public Node appendChild(Node newChild)
                 throws DOMException
```
    Specified by:
    
    appendChild in interface Node
    
    Overrides:
    
    appendChild in class NodeImpl
    
    Throws:
    
    DOMException
  - insertBefore
```
public Node insertBefore(Node newChild,
                Node refChild)
                  throws DOMException
```
    Specified by:
    
    insertBefore in interface Node
    
    Overrides:
    
    insertBefore in class NodeImpl
    
    Throws:
    
    DOMException
  - replaceChild
```
public Node replaceChild(Node newChild,
                Node oldChild)
                  throws DOMException
```
    Specified by:
    
    replaceChild in interface Node
    
    Overrides:
    
    replaceChild in class NodeImpl
    
    Throws:
    
    DOMException
  - addAttribute
```
public SOAPElement addAttribute(Name name,
                       String value)
                         throws SOAPException
```
    Description copied from class: SOAPElementImpl
    
    Adds an attribute with the specified name and value to this SOAPElement object.
    
    Specified by:
    
    addAttribute in interface SOAPElement
    
    Overrides:
    
    addAttribute in class SOAPElementImpl
    
    Parameters:
    name - a Name object with the name of the attribute
    value - a String giving the value of the attribute
    
    Returns:
    the SOAPElement object into which the attribute was inserted
    
    Throws:
    
    SOAPException - if there is an error in creating the Attribute, or it is invalid to set an attribute with Name name on this SOAPElement.
    See Also:
    SOAPElement.addAttribute(javax.xml.namespace.QName, String)
  - extractContentAsDocument
```
public Document extractContentAsDocument()
                                  throws SOAPException
```
    Description copied from interface: SOAPBody
    
    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.
    
    Specified by:
    
    extractContentAsDocument in interface SOAPBody
    
    Returns:
    the Document representation of the SOAPBody content.
    
    Throws:
    
    SOAPException - if there is not exactly one child SOAPElement of the SOAPBody.

Class SOAPBodyImpl

Field Summary

Fields inherited from class org.jboss.ws.core.soap.NodeImpl

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.jboss.ws.core.soap.SOAPElementImpl

Methods inherited from class org.jboss.ws.core.soap.NodeImpl

Methods inherited from class java.lang.Object

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

Constructor Detail

SOAPBodyImpl

Method Detail

addChildElement

addBodyElement

addBodyElement

addDocument

addFault

addFault

addFault

addFault

addFault

getFault

hasFault

getBodyElement

appendChild

insertBefore

replaceChild

addAttribute

extractContentAsDocument