org.apache.axis2.saaj
Class SOAPBodyImpl

java.lang.Object
  extended by org.apache.axiom.om.impl.dom.NodeImpl
      extended by org.apache.axis2.saaj.NodeImplEx
          extended by org.apache.axis2.saaj.SOAPElementImpl
              extended by org.apache.axis2.saaj.SOAPBodyImpl
All Implemented Interfaces:
java.lang.Cloneable, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMNode, org.w3c.dom.Node, org.w3c.dom.NodeList

public class SOAPBodyImpl
extends SOAPElementImpl


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.apache.axiom.om.OMNode
DTD_NODE, PI_NODE, SPACE_NODE
 
Constructor Summary
SOAPBodyImpl(org.apache.axiom.soap.SOAPBody omSOAPBody)
           
 
Method Summary
 SOAPElement addAttribute(javax.xml.namespace.QName qname, java.lang.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.
 SOAPElement addChildElement(javax.xml.namespace.QName qname)
           
 SOAPElement addChildElement(java.lang.String localName)
           
 SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix)
           
 SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
           
 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.
 SOAPElement addTextNode(java.lang.String text)
          Creates a new Text object initialized with the given String and adds it to this SOAPElement object.
protected  org.w3c.dom.Element appendElement(org.apache.axiom.om.impl.dom.ElementImpl child)
           
 javax.xml.namespace.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(javax.xml.namespace.QName qname)
           
 java.util.Iterator getChildElements()
          Returns an iterator over all the immediate content of this element.
 java.util.Iterator getChildElements(Name name)
           
 javax.xml.namespace.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(javax.xml.namespace.QName qname)
           
 SOAPElement setElementQName(javax.xml.namespace.QName qname)
           
 
Methods inherited from class org.apache.axis2.saaj.SOAPElementImpl
addNamespaceDeclaration, appendChild, appendText, copyContents, discard, getAllAttributes, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, 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, removeAttributeNode, removeAttributeNS, removeChild, 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
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, 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
 

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
Overrides:
addChildElement in class SOAPElementImpl
Throws:
SOAPException

addChildElement

public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix)
                            throws SOAPException
Overrides:
addChildElement in class SOAPElementImpl
Throws:
SOAPException

appendElement

protected org.w3c.dom.Element appendElement(org.apache.axiom.om.impl.dom.ElementImpl child)
                                     throws SOAPException
Overrides:
appendElement in class SOAPElementImpl
Throws:
SOAPException

addChildElement

public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix,
                                   java.lang.String uri)
                            throws SOAPException
Overrides:
addChildElement in class SOAPElementImpl
Throws:
SOAPException

addFault

public SOAPFault addFault()
                   throws SOAPException
Creates a new SOAPFault object and adds it to this SOAPBody object.

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.

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.

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.

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.

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.

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.

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

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.

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)
Overrides:
getChildElements in class SOAPElementImpl

addAttribute

public SOAPElement addAttribute(javax.xml.namespace.QName qname,
                                java.lang.String value)
                         throws SOAPException
Description copied from class: SOAPElementImpl
Adds an attribute with the specified name and value to this SOAPElement object.

Overrides:
addAttribute in class SOAPElementImpl
Parameters:
qname - 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

addChildElement

public SOAPElement addChildElement(javax.xml.namespace.QName qname)
                            throws SOAPException
Overrides:
addChildElement in class SOAPElementImpl
Throws:
SOAPException

createQName

public javax.xml.namespace.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.

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()
Overrides:
getAllAttributesAsQNames in class SOAPElementImpl

getAttributeValue

public java.lang.String getAttributeValue(javax.xml.namespace.QName qname)
Overrides:
getAttributeValue in class SOAPElementImpl

getElementQName

public javax.xml.namespace.QName getElementQName()
Overrides:
getElementQName in class SOAPElementImpl

removeAttribute

public boolean removeAttribute(javax.xml.namespace.QName qname)
Overrides:
removeAttribute in class SOAPElementImpl

setElementQName

public SOAPElement setElementQName(javax.xml.namespace.QName qname)
                            throws SOAPException
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.

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.

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


Copyright © 2007 Apache Web Services Project. All Rights Reserved.