org.jboss.ws.core.soap

Class SOAPBodyImpl

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)

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)
SOAPBodyElement	addBodyElement(QName qname)
SOAPElement	addChildElement(SOAPElement child) Convert the child into a SOAPBodyElement
SOAPBodyElement	addDocument(Document doc)
SOAPFault	addFault()
SOAPFault	addFault(Name faultCode, String faultString)
SOAPFault	addFault(Name faultCode, String faultString, Locale locale)
SOAPFault	addFault(QName faultCode, String faultString)
SOAPFault	addFault(QName faultCode, String faultString, Locale locale)
Node	appendChild(Node newChild)
Document	extractContentAsDocument()
SOAPBodyElement	getBodyElement()
SOAPFault	getFault()
boolean	hasFault()
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.SOAPElement

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle

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

Specified by:

addBodyElement in interface SOAPBody

Throws:

SOAPException

addBodyElement

public SOAPBodyElement addBodyElement(QName qname)
                               throws SOAPException

Specified by:

addBodyElement in interface SOAPBody

Throws:

SOAPException

addDocument

public SOAPBodyElement addDocument(Document doc)
                            throws SOAPException

Specified by:

addDocument in interface SOAPBody

Throws:

SOAPException

addFault

public SOAPFault addFault()
                   throws SOAPException

Specified by:

addFault in interface SOAPBody

Throws:

SOAPException

addFault

public SOAPFault addFault(Name faultCode,
                 String faultString)
                   throws SOAPException

Specified by:

addFault in interface SOAPBody

Throws:

SOAPException

addFault

public SOAPFault addFault(QName faultCode,
                 String faultString)
                   throws SOAPException

Specified by:

addFault in interface SOAPBody

Throws:

SOAPException

addFault

public SOAPFault addFault(Name faultCode,
                 String faultString,
                 Locale locale)
                   throws SOAPException

Specified by:

addFault in interface SOAPBody

Throws:

SOAPException

addFault

public SOAPFault addFault(QName faultCode,
                 String faultString,
                 Locale locale)
                   throws SOAPException

Specified by:

addFault in interface SOAPBody

Throws:

SOAPException

getFault

public SOAPFault getFault()

Specified by:

getFault in interface SOAPBody

hasFault

public boolean hasFault()

Specified by:

hasFault in interface SOAPBody

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

extractContentAsDocument

public Document extractContentAsDocument()
                                  throws SOAPException

Specified by:

extractContentAsDocument in interface SOAPBody

Throws:

SOAPException