org.apache.axis2.saaj
Class SOAPBodyImpl

java.lang.Object
  org.apache.axiom.om.impl.dom.NodeImpl
      org.apache.axis2.saaj.NodeImplEx
          org.apache.axis2.saaj.SOAPElementImpl
              org.apache.axis2.saaj.SOAPBodyImpl

All Implemented Interfaces:

java.lang.Cloneable, SOAPBody, SOAPElement, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMNode, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

public class SOAPBodyImpl
extends SOAPElementImpl
implements SOAPBody

Field Summary

Fields inherited from class org.apache.axis2.saaj.SOAPElementImpl

element

Fields inherited from class org.apache.axis2.saaj.NodeImplEx

parentElement

Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl

builder, done, factory, FIRSTCHILD, flags, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED

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

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

Fields inherited from interface org.apache.axiom.om.OMNode

DTD_NODE, PI_NODE, SPACE_NODE

Constructor Summary

SOAPBodyImpl(org.apache.axiom.soap.SOAPBody omSOAPBody)

Method Summary

SOAPElement	addAttribute(QName qname, java.lang.String value)
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 name and adds it to this SOAPBody object.
SOAPElement	addChildElement(QName qname)
SOAPElement	addChildElement(SOAPElement soapElement) Add a SOAPElement as a child of this SOAPElement instance.
SOAPElement	addChildElement(java.lang.String localName) Creates a new SOAPElement object initialized with the given String object and adds the new element to this SOAPElement object.
SOAPElement	addChildElement(java.lang.String localName, java.lang.String prefix) Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object.
SOAPElement	addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri) Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object.
SOAPBodyElement	addDocument(org.w3c.dom.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, java.lang.String faultString) Creates a new SOAPFault object and adds it to this SOAPBody object.
SOAPFault	addFault(Name faultCode, java.lang.String faultString, java.util.Locale locale) Creates a new SOAPFault object and adds it to this SOAPBody object.
SOAPFault	addFault(QName faultcode, java.lang.String faultString)
SOAPFault	addFault(QName faultCode, java.lang.String faultString, java.util.Locale locale) Creates a new SOAPFault object and adds it to this SOAPBody object.
SOAPElement	addTextNode(java.lang.String text) Creates a new Text object initialized with the given String and adds it to this SOAPElement object.
QName	createQName(java.lang.String localName, java.lang.String prefix) Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement.
org.apache.axiom.om.OMNode	detach()
void	detachNode() Removes this Node object from the tree.
org.w3c.dom.Document	extractContentAsDocument() Creates a new DOM org.w3c.dom.Document and sets the first child of this SOAPBody as its document element.
java.util.Iterator	getAllAttributesAsQNames()
java.lang.String	getAttributeValue(QName qname)
java.util.Iterator	getChildElements() Returns an iterator over all the immediate content of this element.
java.util.Iterator	getChildElements(Name name) Returns an iterator over all the child elements with the specified name.
java.util.Iterator	getChildElements(QName qname)
QName	getElementQName()
SOAPFault	getFault() Returns the SOAPFault object in this SOAPBody object.
boolean	hasFault() Indicates whether a SOAPFault object exists in this SOAPBody object.
boolean	removeAttribute(QName qname)
SOAPElement	setElementQName(QName qname)

Methods inherited from class org.apache.axis2.saaj.SOAPElementImpl

addAttribute, addChildElement, addNamespaceDeclaration, discard, getAllAttributes, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getChildNodes, getElement, getElementName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getLastChild, getLocalName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTagName, getValue, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasChildNodes, internalSerialize, internalSerializeAndConsume, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setEncodingStyle, setParent, setParentElement, setValue, toString

Methods inherited from class org.apache.axis2.saaj.NodeImplEx

getParent, getSchemaTypeInfo, getType, recycleNode, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setType

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl

appendChild, build, buildWithAttachments, cloneNode, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNextOMSibling, getNodeValue, getOMFactory, getPreviousOMSibling, getTextContent, getUserData, hasAttributes, insertBefore, insertSiblingAfter, insertSiblingBefore, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, setPrefix, setPreviousOMSibling, setTextContent, setUserData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addChildElement, addNamespaceDeclaration, getAllAttributes, getAttributeValue, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle

Methods inherited from interface javax.xml.soap.Node

getParentElement, getValue, recycleNode, setParentElement, setValue

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

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

Constructor Detail

SOAPBodyImpl

public SOAPBodyImpl(org.apache.axiom.soap.SOAPBody omSOAPBody)

Parameters:

omSOAPBody -

Method Detail

addChildElement

public SOAPElement addChildElement(java.lang.String localName)
                            throws SOAPException

Description copied from interface: SOAPElement

Creates a new SOAPElement object initialized with the given String object and adds the new element to this SOAPElement object.

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Parameters:

localName - a String giving the local name for the element

Returns:

the new SOAPElement object that was created

Throws:

SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix)
                            throws SOAPException

Description copied from interface: SOAPElement

Creates a new SOAPElement object initialized with the specified local name and prefix and adds the new element to this SOAPElement object.

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Parameters:

localName - a String giving the local name for the new element

prefix - a String giving the namespace prefix for the new element

Returns:

the new SOAPElement object that was created

Throws:

SOAPException - if there is an error in creating the SOAPElement object

addChildElement

public SOAPElement addChildElement(SOAPElement soapElement)
                            throws SOAPException

Description copied from interface: SOAPElement

Add a SOAPElement as a child of this SOAPElement instance. The SOAPElement is expected to be created by a SOAPElementFactory. Callers should not rely on the element instance being added as is into the XML tree. Implementations could end up copying the content of the SOAPElement passed into an instance of a different SOAPElement implementation. For instance if addChildElement() is called on a SOAPHeader, element will be copied into an instance of a SOAPHeaderElement.

The fragment rooted in element is either added as a whole or not at all, if there was an error.

The fragment rooted in element cannot contain elements named "Envelope", "Header" or "Body" and in the SOAP namespace. Any namespace prefixes present in the fragment should be fully resolved using appropriate namespace declarations within the fragment itself.

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Parameters:

soapElement - 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

addChildElement

public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix,
                                   java.lang.String uri)
                            throws SOAPException

Description copied from interface: SOAPElement

Creates a new SOAPElement object initialized with the specified local name, prefix, and URI and adds the new element to this SOAPElement object.

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Parameters:

localName - a String giving the local name for the new element

prefix - a String giving the namespace prefix for the new element

uri - a String giving the URI of the namespace to which the new element belongs

Returns:

the new SOAPElement object that was created

Throws:

SOAPException - if there is an error in creating the SOAPElement object

addFault

public SOAPFault addFault()
                   throws SOAPException

Creates a new SOAPFault object and adds it to this SOAPBody object.

Specified by:

addFault in interface SOAPBody

Returns:

the new SOAPFault object

Throws:

SOAPException - if there is a SOAP error

hasFault

public boolean hasFault()

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

getFault

public SOAPFault getFault()

Returns the SOAPFault object in this SOAPBody object.

Specified by:

getFault in interface SOAPBody

Returns:

the SOAPFault object in this SOAPBody object

addBodyElement

public SOAPBodyElement addBodyElement(Name name)
                               throws SOAPException

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

addFault

public SOAPFault addFault(Name faultCode,
                          java.lang.String faultString,
                          java.util.Locale locale)
                   throws SOAPException

Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring and localized to locale.

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 SOAP 1.1 specification and of type QName

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

addFault

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

Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring.

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 SOAP 1.1 specification and of type QName

faultString - a String giving an explanation of the fault

Returns:

the new SOAPFault object

Throws:

SOAPException - if there is a SOAP error

addDocument

public SOAPBodyElement addDocument(org.w3c.dom.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.

Specified by:

addDocument in interface SOAPBody

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

addBodyElement

public SOAPBodyElement addBodyElement(QName qname)
                               throws SOAPException

Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.

Specified by:

addBodyElement in interface SOAPBody

Parameters:

qname - a QName object with the name for the new SOAPBodyElement object

Returns:

the new SOAPBodyElement object

Throws:

SOAPException - if a SOAP error occurs

addFault

public SOAPFault addFault(QName faultcode,
                          java.lang.String faultString)
                   throws SOAPException

Specified by:

addFault in interface SOAPBody

Throws:

SOAPException

addFault

public SOAPFault addFault(QName faultCode,
                          java.lang.String faultString,
                          java.util.Locale locale)
                   throws SOAPException

Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring and localized to locale.

Specified by:

addFault in interface SOAPBody

Parameters:

faultCode - a QName object giving the fault code to be

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

extractContentAsDocument

public org.w3c.dom.Document extractContentAsDocument()
                                              throws SOAPException

Creates a new DOM org.w3c.dom.Document and sets the first child of this SOAPBody as its document element. The child SOAPElement is removed as part of the process.

Specified by:

extractContentAsDocument in interface SOAPBody

Returns:

The org.w3c.dom.Document representation of the SOAPBody content.

Throws:

SOAPException - - if there is not exactly one child SOAPElement of the SOAPBody.

detachNode

public void detachNode()

Description copied from class: NodeImplEx

Removes this Node object from the tree. Once removed, this node can be garbage collected if there are no application references to it.

Overrides:

detachNode in class SOAPElementImpl

detach

public org.apache.axiom.om.OMNode detach()

Specified by:

detach in interface org.apache.axiom.om.OMNode

Overrides:

detach in class SOAPElementImpl

getChildElements

public java.util.Iterator getChildElements(Name name)

Description copied from interface: SOAPElement

Returns an iterator over all the child elements with the specified name.

Specified by:

getChildElements in interface SOAPElement

Overrides:

getChildElements in class SOAPElementImpl

Parameters:

name - a Name object with the name of the child elements to be returned

Returns:

an Iterator object over all the elements in this SOAPElement object with the specified name

addAttribute

public SOAPElement addAttribute(QName qname,
                                java.lang.String value)
                         throws SOAPException

Specified by:

addAttribute in interface SOAPElement

Overrides:

addAttribute in class SOAPElementImpl

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(QName qname)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Throws:

SOAPException

createQName

public QName createQName(java.lang.String localName,
                         java.lang.String prefix)
                  throws SOAPException

Description copied from class: SOAPElementImpl

Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement. The remaining elements of the new QName are taken directly from the parameters, localName and prefix.

Specified by:

createQName in interface SOAPElement

Overrides:

createQName in class SOAPElementImpl

Parameters:

localName - - a String containing the local part of the name. prefix - a String containing the prefix for the name.

Returns:

a QName with the specified localName and prefix, and with a namespace that is associated with the prefix in the context of this SOAPElement. This namespace will be the same as the one that would be returned by getNamespaceURI(String) if it were given prefix as its parameter.

Throws:

SOAPException - - if the QName cannot be created.

getAllAttributesAsQNames

public java.util.Iterator getAllAttributesAsQNames()

Specified by:

getAllAttributesAsQNames in interface SOAPElement

Overrides:

getAllAttributesAsQNames in class SOAPElementImpl

getAttributeValue

public java.lang.String getAttributeValue(QName qname)

Specified by:

getAttributeValue in interface SOAPElement

Overrides:

getAttributeValue in class SOAPElementImpl

getChildElements

public java.util.Iterator getChildElements(QName qname)

Specified by:

getChildElements in interface SOAPElement

Overrides:

getChildElements in class SOAPElementImpl

getElementQName

public QName getElementQName()

Specified by:

getElementQName in interface SOAPElement

Overrides:

getElementQName in class SOAPElementImpl

removeAttribute

public boolean removeAttribute(QName qname)

Specified by:

removeAttribute in interface SOAPElement

Overrides:

removeAttribute in class SOAPElementImpl

setElementQName

public SOAPElement setElementQName(QName qname)
                            throws SOAPException

Specified by:

setElementQName in interface SOAPElement

Overrides:

setElementQName in class SOAPElementImpl

Throws:

SOAPException

getChildElements

public java.util.Iterator getChildElements()

Description copied from class: SOAPElementImpl

Returns an iterator over all the immediate content of this element. This includes Text objects as well as SOAPElement objects.

Specified by:

getChildElements in interface SOAPElement

Overrides:

getChildElements in class SOAPElementImpl

Returns:

an iterator over Text and SOAPElement contained within this SOAPElement object

addTextNode

public SOAPElement addTextNode(java.lang.String text)
                        throws SOAPException

Description copied from class: SOAPElementImpl

Creates a new Text object initialized with the given String and adds it to this SOAPElement object.

Specified by:

addTextNode in interface SOAPElement

Overrides:

addTextNode in class SOAPElementImpl

Parameters:

text - a String object with the textual content to be added

Returns:

the SOAPElement object into which the new Text object was inserted

Throws:

SOAPException - if there is an error in creating the new Text object