org.apache.axiom.soap.impl.dom
Class SOAPBodyImpl

java.lang.Object
  extended by org.apache.axiom.om.impl.dom.NodeImpl
      extended by org.apache.axiom.om.impl.dom.ChildNode
          extended by org.apache.axiom.om.impl.dom.ParentNode
              extended by org.apache.axiom.om.impl.dom.ElementImpl
                  extended by org.apache.axiom.soap.impl.dom.SOAPElement
                      extended by org.apache.axiom.soap.impl.dom.SOAPBodyImpl
All Implemented Interfaces:
java.lang.Cloneable, OMContainerEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMNode, SOAPBody, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList
Direct Known Subclasses:
SOAP11BodyImpl, SOAP12BodyImpl

public abstract class SOAPBodyImpl
extends SOAPElement
implements SOAPBody, OMConstants


Field Summary
protected  boolean hasSOAPFault
          Field hasSOAPFault
 
Fields inherited from class org.apache.axiom.om.impl.dom.ElementImpl
localName, namespace
 
Fields inherited from class org.apache.axiom.om.impl.dom.ParentNode
firstChild, lastChild
 
Fields inherited from class org.apache.axiom.om.impl.dom.ChildNode
nextSibling, parentNode, previousSibling
 
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.apache.axiom.om.OMNode
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
 
Fields inherited from interface org.apache.axiom.om.OMConstants
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
 
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
SOAPBodyImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder, SOAPFactory factory)
          Constructor SOAPBodyImpl
SOAPBodyImpl(SOAPEnvelope envelope, SOAPFactory factory)
           
 
Method Summary
abstract  SOAPFault addFault(java.lang.Exception e)
          Creates a new SOAPFault object and adds it to this SOAPBody object.
 void addFault(SOAPFault soapFault)
           
protected  void checkParent(OMElement parent)
          This has to be implemented by all the derived classes to check for the correct parent.
 SOAPFault getFault()
          Returns the SOAPFault object in this SOAPBody object.
 java.lang.String getFirstElementLocalName()
          Retrieves the local name of the first element in the body.
 OMNamespace getFirstElementNS()
          Retrieves the OMNamespace of the first element in the body.
 boolean hasFault()
          Indicates whether a SOAPFault object exists in this SOAPBody object.
 
Methods inherited from class org.apache.axiom.om.impl.dom.ElementImpl
addAttribute, addAttribute, buildWithAttachments, cloneNode, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getElementsByTagName, getElementsByTagNameNS, getFirstElement, getLineNumber, getLocalName, getNamespace, getNamespaceURI, getNamespaceURI, getNextOMSibling, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getTagName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasAttribute, hasAttributeNS, hasAttributes, internalSerialize, internalSerialize, internalSerializeAndConsume, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeNamespace, resolveQName, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setOwnerDocument, setText, setText, setType, toString, toStringWithConsume
 
Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode
addChild, buildNext, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, getTextContent, hasChildNodes, importNode, insertBefore, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent
 
Methods inherited from class org.apache.axiom.om.impl.dom.ChildNode
detach, getNextSibling, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, setNextOMSibling, setParent, setPreviousOMSibling
 
Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl
appendChild, build, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOMFactory, getOwnerDocument, getUserData, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNodeValue, setPrefix, setUserData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.axiom.om.OMElement
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getText, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume
 
Methods inherited from interface org.apache.axiom.om.OMNode
build, buildWithAttachments, close, detach, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume
 
Methods inherited from interface org.apache.axiom.om.OMContainer
addChild, buildNext, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete
 
Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
 
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx
setComplete
 

Field Detail

hasSOAPFault

protected boolean hasSOAPFault
Field hasSOAPFault

Constructor Detail

SOAPBodyImpl

public SOAPBodyImpl(SOAPEnvelope envelope,
                    SOAPFactory factory)
             throws SOAPProcessingException
Parameters:
envelope -
Throws:
SOAPProcessingException

SOAPBodyImpl

public SOAPBodyImpl(SOAPEnvelope envelope,
                    OMXMLParserWrapper builder,
                    SOAPFactory factory)
Constructor SOAPBodyImpl

Parameters:
envelope -
builder -
Method Detail

addFault

public abstract SOAPFault addFault(java.lang.Exception e)
                            throws OMException
Creates a new SOAPFault object and adds it to this SOAPBody object.

Specified by:
addFault in interface SOAPBody
Parameters:
e -
Returns:
the new SOAPFault object
Throws:
OMException - if there is a SOAP error
OMException

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

addFault

public void addFault(SOAPFault soapFault)
              throws OMException
Specified by:
addFault in interface SOAPBody
Parameters:
soapFault -
Throws:
OMException
OMException

checkParent

protected void checkParent(OMElement parent)
                    throws SOAPProcessingException
Description copied from class: SOAPElement
This has to be implemented by all the derived classes to check for the correct parent.

Specified by:
checkParent in class SOAPElement
Throws:
SOAPProcessingException

getFirstElementNS

public OMNamespace getFirstElementNS()
Description copied from interface: SOAPBody
Retrieves the OMNamespace of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the OMNamespace, but don't necessarily need the OMElement.

Specified by:
getFirstElementNS in interface SOAPBody
Returns:
OMNamespace of first element in the body or null

getFirstElementLocalName

public java.lang.String getFirstElementLocalName()
Description copied from interface: SOAPBody
Retrieves the local name of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the name, but don't necessarily need the OMElement.

Specified by:
getFirstElementLocalName in interface SOAPBody
Returns:
local name of first element in the body or null


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.