org.apache.axiom.soap.impl.llom
Class SOAPEnvelopeImpl

java.lang.Object
  extended byorg.apache.axiom.om.impl.llom.OMNodeImpl
      extended byorg.apache.axiom.om.impl.llom.OMElementImpl
          extended byorg.apache.axiom.soap.impl.llom.SOAPElement
              extended byorg.apache.axiom.soap.impl.llom.SOAPEnvelopeImpl
All Implemented Interfaces:
OMConstants, OMContainer, OMContainerEx, OMElement, OMNode, OMNodeEx, SOAPEnvelope

public class SOAPEnvelopeImpl
extends SOAPElement
implements SOAPEnvelope, OMConstants

Class SOAPEnvelopeImpl


Field Summary
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
attributes, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
builder, done, factory, nextSibling, nodeType, parent, previousSibling
 
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_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
 
Constructor Summary
SOAPEnvelopeImpl(OMNamespace ns, SOAPFactory factory)
           
SOAPEnvelopeImpl(OMXMLParserWrapper builder, SOAPFactory factory)
           
 
Method Summary
 void addChild(OMNode child)
          Adds the given node as the last child.
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 internalSerialize(javax.xml.stream.XMLStreamWriter writer2, boolean cache)
           
 
Methods inherited from class org.apache.axiom.soap.impl.llom.SOAPElement
setParent
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
addAttribute, addAttribute, buildNext, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithName, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getLineNumber, getLocalName, getNamespace, getNextOMSibling, getQName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, internalSerializeAndConsume, isComplete, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
build, getOMFactory, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setPreviousOMSibling, setType
 
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, 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
buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete
 
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx
setComplete
 

Constructor Detail

SOAPEnvelopeImpl

public SOAPEnvelopeImpl(OMXMLParserWrapper builder,
                        SOAPFactory factory)
Parameters:
builder -

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

addChild

public void addChild(OMNode child)
Description copied from interface: OMContainer
Adds the given node as the last child. One must preserve the order of children, in this operation. Tip : appending the new child is preferred.

Specified by:
addChild in interface OMContainer
Overrides:
addChild in class OMElementImpl

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 OMElementImpl
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

internalSerialize

protected void internalSerialize(javax.xml.stream.XMLStreamWriter writer2,
                                 boolean cache)
                          throws javax.xml.stream.XMLStreamException
Overrides:
internalSerialize in class OMElementImpl
Throws:
javax.xml.stream.XMLStreamException