SOAPEnvelopeImpl (DOOM API)

java.lang.Object
- org.apache.axiom.om.impl.dom.NodeImpl
- - org.apache.axiom.om.impl.dom.ParentNode
  - - org.apache.axiom.om.impl.dom.ElementImpl
    - - org.apache.axiom.om.impl.dom.NSAwareElement
      - org.apache.axiom.soap.impl.dom.SOAPElement
        
        org.apache.axiom.soap.impl.dom.SOAPEnvelopeImpl

All Implemented Interfaces:

org.apache.axiom.core.CoreCharacterDataSinkNode, org.apache.axiom.core.CoreChildNode, org.apache.axiom.core.CoreElement, org.apache.axiom.core.CoreMixedContentContainer, org.apache.axiom.core.CoreNamedNode, org.apache.axiom.core.CoreNode, org.apache.axiom.core.CoreNSAwareElement, org.apache.axiom.core.CoreNSAwareNamedNode, org.apache.axiom.core.CoreParentNode, org.apache.axiom.core.DeferringParentNode, org.apache.axiom.dom.DOMChildNode, org.apache.axiom.dom.DOMElement, org.apache.axiom.dom.DOMNamedNode, org.apache.axiom.dom.DOMNode, org.apache.axiom.dom.DOMNSAwareElement, org.apache.axiom.dom.DOMNSAwareNamedNode, org.apache.axiom.dom.DOMParentNode, org.apache.axiom.om.impl.intf.AxiomChildNode, org.apache.axiom.om.impl.intf.AxiomContainer, org.apache.axiom.om.impl.intf.AxiomCoreParentNode, org.apache.axiom.om.impl.intf.AxiomElement, org.apache.axiom.om.impl.intf.AxiomInformationItem, org.apache.axiom.om.impl.intf.AxiomNamedInformationItem, org.apache.axiom.om.impl.intf.AxiomSerializable, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMElementEx, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMConstants, org.apache.axiom.om.OMContainer, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMInformationItem, org.apache.axiom.om.OMNamedInformationItem, org.apache.axiom.om.OMNode, org.apache.axiom.om.OMSerializable, org.apache.axiom.shared.INSAwareNamedNode, org.apache.axiom.soap.impl.intf.AxiomSOAPElement, org.apache.axiom.soap.impl.intf.AxiomSOAPEnvelope, org.apache.axiom.soap.SOAPEnvelope, Element, Node, NodeList

Direct Known Subclasses:

SOAP11EnvelopeImpl, SOAP12EnvelopeImpl
```
public abstract class SOAPEnvelopeImpl
extends SOAPElement
implements org.apache.axiom.soap.impl.intf.AxiomSOAPEnvelope, org.apache.axiom.om.OMConstants
```

Field Summary
- 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.core.CoreParentNode
  COMPACT, COMPLETE, DISCARDED, INCOMPLETE
- 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

Constructor Summary

Constructors
Constructor and Description

SOAPEnvelopeImpl()

Constructors
Constructor and Description
`SOAPEnvelopeImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(org.apache.axiom.om.OMNode child, boolean fromBuilder)`
`void`	`checkParent(org.apache.axiom.om.OMElement parent)`
`org.apache.axiom.soap.SOAPBody`	`getBody()` Returns the `SOAPBody` object associated with this `SOAPEnvelope` object.
`org.apache.axiom.soap.SOAPHeader`	`getHeader()`
`org.apache.axiom.soap.SOAPHeader`	`getOrCreateHeader()`
`String`	`getSOAPBodyFirstElementLocalName()`
`org.apache.axiom.om.OMNamespace`	`getSOAPBodyFirstElementNS()`
`org.apache.axiom.soap.SOAPVersion`	`getVersion()`
`boolean`	`hasFault()`
`Node`	`insertBefore(Node newChild, Node refChild)` Inserts newChild before the refChild.
`void`	`internalSerialize(org.apache.axiom.om.impl.common.serializer.push.Serializer serializer, org.apache.axiom.om.OMOutputFormat format, boolean cache)`

Methods inherited from class org.apache.axiom.om.impl.dom.NSAwareElement
getNamespaceURI, normalize

Methods inherited from class org.apache.axiom.om.impl.dom.ElementImpl
setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode
appendChild, replaceChild

Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl
compareDocumentPosition, coreGetNodeFactory, getBaseURI, getBuilder, getFeature, getMetaFactory, getUserData, isEqualNode, isSameNode, normalize, setUserData

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

Methods inherited from interface org.apache.axiom.soap.impl.intf.AxiomSOAPEnvelope
internalCheckChild

Methods inherited from interface org.apache.axiom.soap.impl.intf.AxiomSOAPElement
getOMFactory, getSOAPHelper

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomElement
_setAttributeValue, addAttribute, addAttribute, addNamespaceDeclaration, addNamespaceDeclaration, buildWithAttachments, checkChild, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, defaultInternalSerialize, detachAndDiscardParent, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, getType, handleNamespace, initName, insertChild, internalAppendAttribute, removeAttribute, resolveQName, setComplete, setLineNumber, setNamespace, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

Methods inherited from interface org.apache.axiom.om.OMElement
serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMNamedInformationItem
getLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, hasName, setLocalName

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomContainer
addChild, build, defaultGetXMLStreamReader, discarded, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, notifyChildComplete, prepareNewChild, removeChildren, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMContainer
getBuilder

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomCoreParentNode
isComplete

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomSerializable
close, getBuilder, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomInformationItem
clone, getMetaFactory

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomChildNode
detach, getNextOMSibling, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomNamedInformationItem
coreGetLocalName, coreGetNamespaceURI, coreGetPrefix, coreSetName, coreSetPrefix, defaultGetNamespace, defaultGetQName, getNamespace, getQName, hasName, initName, internalGetLocalName, internalSetLocalName, internalSetNamespace, setLocalName, updateLocalName

Methods inherited from interface org.apache.axiom.shared.INSAwareNamedNode
getLocalName, getNamespaceURI, getPrefix

Methods inherited from interface org.apache.axiom.core.CoreNSAwareElement
coreGetNodeType, getImplicitNamespaceURI, getImplicitPrefix

Methods inherited from interface org.apache.axiom.core.CoreElement
coreAppendAttribute, coreGetAttribute, coreGetAttributesByType, coreGetFirstAttribute, coreGetLastAttribute, coreLookupNamespaceURI, coreLookupPrefix, coreRemoveAttribute, coreSetAttribute, coreSetAttribute, init, initSource

Methods inherited from interface org.apache.axiom.core.CoreChildNode
coreClone, coreDetach, coreGetNextSibling, coreGetNextSibling, coreGetNextSiblingIfAvailable, coreGetParent, coreGetParentElement, coreGetPreviousSibling, coreGetPreviousSibling, coreHasParent, coreInsertSiblingAfter, coreInsertSiblingBefore, coreInsertSiblingsBefore, coreReplaceWith, coreSetNextSibling, coreSetOwnerDocument, coreSetPreviousSibling, getRootOrOwnerDocument, internalSetParent, internalUnsetParent

Methods inherited from interface org.apache.axiom.core.CoreMixedContentContainer
coreGetCharacterData

Methods inherited from interface org.apache.axiom.core.CoreCharacterDataSinkNode
coreSetCharacterData

Methods inherited from interface org.apache.axiom.core.DeferringParentNode
coreSetBuilder, getBuilder

Methods inherited from interface org.apache.axiom.core.CoreParentNode
buildNext, cloneChildrenIfNecessary, coreAppendChild, coreAppendChildren, coreGetElements, coreGetFirstChild, coreGetFirstChild, coreGetFirstChildIfAvailable, coreGetLastChild, coreGetLastChild, coreGetLastKnownChild, coreGetNodes, coreRemoveChildren, coreSetCharacterData, coreSetState, forceExpand, getState, isExpanded

Methods inherited from interface org.apache.axiom.dom.DOMElement
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getElementsByTagName, getElementsByTagNameNS, getNamespaceContext, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getSchemaTypeInfo, getTagName, getTextContent, hasAttribute, hasAttributeNS, hasAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setNodeValue, setTextContent

Methods inherited from interface org.apache.axiom.dom.DOMChildNode
getNextSibling, getParentNode, getPreviousSibling

Methods inherited from interface org.apache.axiom.dom.DOMParentNode
getChildNodes, getFirstChild, getLastChild, getLength, hasChildNodes, item, removeChild

Methods inherited from interface org.w3c.dom.Element
setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.apache.axiom.dom.DOMNSAwareNamedNode
internalGetName, setPrefix

Methods inherited from interface org.apache.axiom.dom.DOMNode
cloneNode, isDefaultNamespace, isSupported, lookupNamespaceURI, lookupPrefix

- Constructor Detail
  - SOAPEnvelopeImpl
```
public SOAPEnvelopeImpl()
```
- Method Detail
  - getVersion
```
public org.apache.axiom.soap.SOAPVersion getVersion()
```
    Specified by:
    
    getVersion in interface org.apache.axiom.soap.SOAPEnvelope
  - getHeader
```
public org.apache.axiom.soap.SOAPHeader getHeader()
```
    Specified by:
    
    getHeader in interface org.apache.axiom.soap.SOAPEnvelope
  - getOrCreateHeader
```
public org.apache.axiom.soap.SOAPHeader getOrCreateHeader()
```
    Specified by:
    
    getOrCreateHeader in interface org.apache.axiom.soap.SOAPEnvelope
  - addChild
```
public void addChild(org.apache.axiom.om.OMNode child,
            boolean fromBuilder)
```
    Specified by:
    
    addChild in interface org.apache.axiom.om.impl.intf.AxiomContainer
    
    Specified by:
    
    addChild in interface org.apache.axiom.om.impl.OMContainerEx
  - insertBefore
```
public Node insertBefore(Node newChild,
                Node refChild)
                  throws DOMException
```
    Description copied from class: ParentNode
    
    Inserts newChild before the refChild. If the refChild is null then the newChild is made the last child.
    
    Specified by:
    
    insertBefore in interface Node
    
    Overrides:
    
    insertBefore in class ParentNode
    
    Throws:
    
    DOMException
  - getBody
```
public org.apache.axiom.soap.SOAPBody getBody()
                                       throws org.apache.axiom.om.OMException
```
    Returns the SOAPBody object associated with this SOAPEnvelope object.
    This SOAPBody will just be a container for all the BodyElements in the OMMessage
    
    Specified by:
    
    getBody in interface org.apache.axiom.soap.SOAPEnvelope
    
    Returns:
    the SOAPBody object for this SOAPEnvelope object or null if there is none
    
    Throws:
    
    org.apache.axiom.om.OMException - if there is a problem obtaining the SOAPBody object
    
    org.apache.axiom.om.OMException
  - checkParent
```
public void checkParent(org.apache.axiom.om.OMElement parent)
                 throws org.apache.axiom.soap.SOAPProcessingException
```
    Specified by:
    
    checkParent in interface org.apache.axiom.soap.impl.intf.AxiomSOAPElement
    
    Throws:
    
    org.apache.axiom.soap.SOAPProcessingException
  - internalSerialize
```
public void internalSerialize(org.apache.axiom.om.impl.common.serializer.push.Serializer serializer,
                     org.apache.axiom.om.OMOutputFormat format,
                     boolean cache)
                       throws org.apache.axiom.om.impl.common.serializer.push.OutputException
```
    Specified by:
    
    internalSerialize in interface org.apache.axiom.om.impl.intf.AxiomElement
    
    Specified by:
    
    internalSerialize in interface org.apache.axiom.om.impl.intf.AxiomSerializable
    
    Throws:
    
    org.apache.axiom.om.impl.common.serializer.push.OutputException
  - hasFault
```
public boolean hasFault()
```
    Specified by:
    
    hasFault in interface org.apache.axiom.soap.SOAPEnvelope
  - getSOAPBodyFirstElementLocalName
```
public String getSOAPBodyFirstElementLocalName()
```
    Specified by:
    
    getSOAPBodyFirstElementLocalName in interface org.apache.axiom.soap.SOAPEnvelope
  - getSOAPBodyFirstElementNS
```
public org.apache.axiom.om.OMNamespace getSOAPBodyFirstElementNS()
```
    Specified by:
    
    getSOAPBodyFirstElementNS in interface org.apache.axiom.soap.SOAPEnvelope

Class SOAPEnvelopeImpl

Field Summary

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

Fields inherited from interface org.apache.axiom.core.CoreParentNode

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.axiom.soap.impl.intf.AxiomSOAPEnvelope

Methods inherited from interface org.apache.axiom.soap.impl.intf.AxiomSOAPElement

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomElement

Methods inherited from interface org.apache.axiom.om.OMElement

Methods inherited from interface org.apache.axiom.om.OMNamedInformationItem

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomContainer

Methods inherited from interface org.apache.axiom.om.OMContainer

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomCoreParentNode

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomSerializable

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomInformationItem

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomChildNode

Methods inherited from interface org.apache.axiom.om.impl.intf.AxiomNamedInformationItem

Methods inherited from interface org.apache.axiom.shared.INSAwareNamedNode

Methods inherited from interface org.apache.axiom.core.CoreNSAwareElement

Methods inherited from interface org.apache.axiom.core.CoreElement

Methods inherited from interface org.apache.axiom.core.CoreChildNode

Methods inherited from interface org.apache.axiom.core.CoreMixedContentContainer

Methods inherited from interface org.apache.axiom.core.CoreCharacterDataSinkNode

Methods inherited from interface org.apache.axiom.core.DeferringParentNode

Methods inherited from interface org.apache.axiom.core.CoreParentNode

Methods inherited from interface org.apache.axiom.dom.DOMElement

Methods inherited from interface org.apache.axiom.dom.DOMChildNode

Methods inherited from interface org.apache.axiom.dom.DOMParentNode

Methods inherited from interface org.w3c.dom.Element

Methods inherited from interface org.apache.axiom.dom.DOMNSAwareNamedNode

Methods inherited from interface org.apache.axiom.dom.DOMNode

Constructor Detail

SOAPEnvelopeImpl

Method Detail

getVersion

getHeader

getOrCreateHeader

addChild

insertBefore

getBody

checkParent

internalSerialize

hasFault

getSOAPBodyFirstElementLocalName

getSOAPBodyFirstElementNS