SOAPEnvelopeImpl (Axiom Impl API)

java.lang.Object
- org.apache.axiom.om.impl.common.InformationItem
- - org.apache.axiom.om.impl.llom.OMInformationItemImpl
  - - org.apache.axiom.om.impl.llom.OMSerializableImpl
    - - org.apache.axiom.om.impl.llom.OMNodeImpl
      - org.apache.axiom.om.impl.llom.OMElementImpl
        
        org.apache.axiom.soap.impl.llom.SOAPElement
        
        org.apache.axiom.soap.impl.llom.SOAPEnvelopeImpl

All Implemented Interfaces:

org.apache.axiom.core.CoreChildNode, org.apache.axiom.core.CoreElement, org.apache.axiom.core.CoreNode, org.apache.axiom.core.CoreParentNode, org.apache.axiom.core.DeferringParentNode, org.apache.axiom.om.impl.common.AxiomChildNode, org.apache.axiom.om.impl.common.AxiomContainer, org.apache.axiom.om.impl.common.AxiomElement, org.apache.axiom.om.impl.common.AxiomInformationItem, org.apache.axiom.om.impl.common.AxiomNamedInformationItem, org.apache.axiom.om.impl.common.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.soap.SOAPEnvelope
```
public class SOAPEnvelopeImpl
extends SOAPElement
implements org.apache.axiom.soap.SOAPEnvelope, org.apache.axiom.om.OMConstants
```
Class SOAPEnvelopeImpl

Field Summary
- Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
  attributes, namespaces
- 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.apache.axiom.core.CoreParentNode
  COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

Constructors
Constructor and Description
`SOAPEnvelopeImpl(org.apache.axiom.om.OMNamespace ns, org.apache.axiom.soap.SOAPFactory factory)` Constructor
`SOAPEnvelopeImpl(org.apache.axiom.soap.SOAPMessage message, org.apache.axiom.om.OMXMLParserWrapper builder, org.apache.axiom.soap.SOAPFactory factory)` Constructor

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(org.apache.axiom.om.OMNode child, boolean fromBuilder)` Add a SOAPHeader or SOAPBody object
`protected void`	`checkParent(org.apache.axiom.om.OMElement parent)` This has to be implemented by all the derived classes to check for the correct parent.
`protected org.apache.axiom.om.OMElement`	`createClone(org.apache.axiom.om.OMCloneOptions options, org.apache.axiom.om.OMContainer targetParent)`
`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()`
`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.soap.impl.llom.SOAPElement
internalSetParent

Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
addAttribute, addAttribute, addNamespaceDeclaration, addNamespaceDeclaration, build, buildWithAttachments, checkChild, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getDefaultNamespace, getLineNumber, getNamespaceURI, removeAttribute, setComplete, setLineNumber, setNamespace, toString, toStringWithConsume, undeclarePrefix

Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
clone, coreSetParent

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl
getOMFactory

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, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setLineNumber, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

Methods inherited from interface org.apache.axiom.om.OMNode
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore

Methods inherited from interface org.apache.axiom.om.OMContainer
addChild, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeChildren

Methods inherited from interface org.apache.axiom.om.OMSerializable
build, close, isComplete, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem
clone, getOMFactory

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

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomElement
detachAndDiscardParent, discard, getChildElements, getFirstElement, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, getType, handleNamespace, insertChild, resolveQName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, writeTextTo

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomContainer
addChild, defaultBuild, discarded, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, isComplete, prepareNewChild, removeChildren, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

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

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

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomInformationItem
coreGetNodeFactory

Methods inherited from interface org.apache.axiom.om.impl.common.AxiomNamedInformationItem
getLocalName, getNamespace, getPrefix, getQName, handleNamespace, hasName, internalGetLocalName, internalSetLocalName, internalSetNamespace, setLocalName

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

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

Methods inherited from interface org.apache.axiom.core.CoreParentNode
buildNext, coreAppendChild, coreAppendChildren, coreGetFirstChild, coreGetFirstChildIfAvailable, coreGetLastChild, coreGetLastKnownChild, coreRemoveChildren

- Constructor Detail
  - SOAPEnvelopeImpl
```
public SOAPEnvelopeImpl(org.apache.axiom.soap.SOAPMessage message,
                org.apache.axiom.om.OMXMLParserWrapper builder,
                org.apache.axiom.soap.SOAPFactory factory)
```
    Constructor
    
    Parameters:
    message -
    builder - the OMXMLParserWrapper building this envelope
    factory - the SOAPFactory building this envelope
  - SOAPEnvelopeImpl
```
public SOAPEnvelopeImpl(org.apache.axiom.om.OMNamespace ns,
                org.apache.axiom.soap.SOAPFactory factory)
```
    Constructor
    
    Parameters:
    ns - OMNamespace for this envelope
    factory - SOAPFactory associated with this envelope
- 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)
```
    Add a SOAPHeader or SOAPBody object
    
    Specified by:
    
    addChild in interface org.apache.axiom.om.impl.common.AxiomContainer
    
    Specified by:
    
    addChild in interface org.apache.axiom.om.impl.OMContainerEx
    
    Parameters:
    child - an OMNode to add - must be either a SOAPHeader or a SOAPBody
  - 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
  - checkParent
```
protected void checkParent(org.apache.axiom.om.OMElement parent)
                    throws org.apache.axiom.soap.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:
    
    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.common.AxiomSerializable
    
    Overrides:
    
    internalSerialize in class OMElementImpl
    
    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
  - createClone
```
protected org.apache.axiom.om.OMElement createClone(org.apache.axiom.om.OMCloneOptions options,
                                        org.apache.axiom.om.OMContainer targetParent)
```
    Overrides:
    
    createClone in class OMElementImpl

Class SOAPEnvelopeImpl

Field Summary

Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl

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

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

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

Constructor Summary

Method Summary

Methods inherited from class org.apache.axiom.soap.impl.llom.SOAPElement

Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl

Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl

Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Constructor Detail

SOAPEnvelopeImpl

SOAPEnvelopeImpl

Method Detail

getVersion

getHeader

getOrCreateHeader

addChild

getBody

checkParent

internalSerialize

hasFault

getSOAPBodyFirstElementLocalName

getSOAPBodyFirstElementNS

createClone