org.apache.axis2.soap.impl.dom
Class SOAPEnvelopeImpl

java.lang.Object
  org.apache.axis2.om.impl.dom.NodeImpl
      org.apache.axis2.om.impl.dom.ChildNode
          org.apache.axis2.om.impl.dom.ParentNode
              org.apache.axis2.om.impl.dom.ElementImpl
                  org.apache.axis2.soap.impl.dom.SOAPElement
                      org.apache.axis2.soap.impl.dom.SOAPEnvelopeImpl

All Implemented Interfaces:

org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList, OMConstants, OMContainer, OMContainerEx, OMElement, OMNode, OMNodeEx, SOAPEnvelope

public class SOAPEnvelopeImpl

extends SOAPElement

implements SOAPEnvelope, OMConstants

Field Summary

Fields inherited from class org.apache.axis2.om.impl.dom.ElementImpl

localName, namespace

Fields inherited from class org.apache.axis2.om.impl.dom.ParentNode

firstChild, lastChild

Fields inherited from class org.apache.axis2.om.impl.dom.ChildNode

nextSibling, parentNode, previousSubling

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

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

Fields inherited from interface org.apache.axis2.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.axis2.om.OMConstants

ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DEFAULT_CHAR_SET_ENCODING, DEFAULT_XML_VERSION, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, 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_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

SOAPEnvelopeImpl(DocumentImpl doc, OMXMLParserWrapper builder, SOAPFactory factory)

SOAPEnvelopeImpl(OMNamespace ns, SOAPFactory factory)

SOAPEnvelopeImpl(OMXMLParserWrapper builder, SOAPFactory factory)

Method Summary

void	addChild(OMNode child) This will add the given node as the last child.
SOAPHeaderBlock	addHeader(java.lang.String namespaceURI, java.lang.String name) Convenience method to add a SOAP header to this envelope
protected void	checkParent(OMElement parent) This has to be implemented by all the derived classes to check for the correct parent.
OMNode	detach() Method detach
SOAPBody	getBody() Returns the SOAPBody object associated with this SOAPEnvelope object.
SOAPHeader	getHeader() Returns the SOAPHeader object for this SOAPEnvelope object.
protected void	serialize(OMOutputImpl omOutput, boolean cache)

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

addAttribute, addAttribute, cloneOMElement, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getElementsByTagName, getElementsByTagNameNS, getFirstAttribute, getFirstElement, getLocalName, getNamespace, getNamespaceURI, getNamespaceURI, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getTagName, getText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasAttribute, hasAttributeNS, hasAttributes, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeNamespace, resolveQName, serialize, serializeAndConsume, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLocalName, setNamespace, setOwnerDocument, setText, setType, toString, toStringWithConsume

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

buildNext, getChildNodes, getChildren, getChildrenWithName, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, hasChildNodes, insertBefore, removeChild, replaceChild, setFirstChild

Methods inherited from class org.apache.axis2.om.impl.dom.ChildNode

discard, getNextOMSibling, getNextSibling, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, setNextOMSibling, setParent, setPreviousOMSibling

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

appendChild, build, cloneNode, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOwnerDocument, getTextContent, getUserData, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeWithCache, setComplete, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from class java.lang.Object

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

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

addAttribute, addAttribute, cloneOMElement, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getFirstAttribute, getFirstElement, getLocalName, getNamespace, getQName, getText, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLocalName, setNamespace, setText, toString, toStringWithConsume

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

build, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

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

buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Methods inherited from interface org.apache.axis2.om.impl.OMContainerEx

setComplete

Constructor Detail

SOAPEnvelopeImpl

public SOAPEnvelopeImpl(OMXMLParserWrapper builder,
                        SOAPFactory factory)

Parameters:

builder -

SOAPEnvelopeImpl

public SOAPEnvelopeImpl(DocumentImpl doc,
                        OMXMLParserWrapper builder,
                        SOAPFactory factory)

SOAPEnvelopeImpl

public SOAPEnvelopeImpl(OMNamespace ns,
                        SOAPFactory factory)

Parameters:

ns -

Method Detail

getHeader

public SOAPHeader getHeader()
                     throws OMException

Returns the SOAPHeader object for this SOAPEnvelope object.

This SOAPHeader will just be a container for all the headers in the OMMessage

Specified by:

getHeader in interface SOAPEnvelope

Returns:

the SOAPHeader object or null if there is none

Throws:

OMException - if there is a problem obtaining the SOAPHeader object

OMException

addHeader

public SOAPHeaderBlock addHeader(java.lang.String namespaceURI,
                                 java.lang.String name)
                          throws OMException

Convenience method to add a SOAP header to this envelope

Specified by:

addHeader in interface SOAPEnvelope

Parameters:

namespaceURI -

name -

Throws:

OMException

addChild

public void addChild(OMNode child)

Description copied from interface: OMContainer

This will add the given node as the last child. child to the element. One must preserve the order of children, in this operation Tip : appending the new child is prefered

Specified by:

addChild in interface OMContainer

Overrides:

addChild in class ParentNode

getBody

public SOAPBody getBody()
                 throws 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 SOAPEnvelope

Returns:

the SOAPBody object for this SOAPEnvelope object or null if there is none

Throws:

OMException - if there is a problem obtaining the SOAPBody object

OMException

detach

public OMNode detach()
              throws OMException

Method detach

Specified by:

detach in interface OMNode

Overrides:

detach in class ChildNode

Throws:

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

serialize

protected void serialize(OMOutputImpl omOutput,
                         boolean cache)
                  throws javax.xml.stream.XMLStreamException

Overrides:

serialize in class ElementImpl

Throws:

javax.xml.stream.XMLStreamException