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

java.lang.Object
  extended byorg.apache.axis2.om.impl.llom.OMNodeImpl
      extended byorg.apache.axis2.om.impl.llom.OMElementImpl
          extended byorg.apache.axis2.soap.impl.llom.SOAPElement
              extended byorg.apache.axis2.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.axis2.om.impl.llom.OMElementImpl
attributes, firstChild, localName, namespaces, noPrefixNamespaceCounter, ns
 
Fields inherited from class org.apache.axis2.om.impl.llom.OMNodeImpl
builder, done, nextSibling, nodeType, parent, previousSibling
 
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
 
Constructor Summary
SOAPEnvelopeImpl(OMNamespace ns, SOAPFactory factory)
           
SOAPEnvelopeImpl(OMXMLParserWrapper builder, SOAPFactory factory)
           
 
Method Summary
 void addChild(OMNode child)
          This will add child to the element.
 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.llom.OMElementImpl
addAttribute, addAttribute, buildNext, declareNamespace, declareNamespace, discard, findNamespace, getAllDeclaredNamespaces, getAttribute, getAttributes, getBuilder, getChildElements, getChildren, getChildrenWithName, getFirstAttribute, getFirstChild, getFirstChildWithName, getFirstElement, getLocalName, getNamespace, getNextSibling, getQName, getText, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, isComplete, removeAttribute, serialize, serializeWithCache, setBuilder, setFirstChild, setLocalName, setNamespace, setText
 
Methods inherited from class org.apache.axis2.om.impl.llom.OMNodeImpl
build, getParent, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, serialize, serializeWithCache, setComplete, setNextSibling, setParent, setPreviousSibling, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.axis2.om.OMElement
addAttribute, addAttribute, declareNamespace, declareNamespace, findNamespace, getAllDeclaredNamespaces, getAttribute, getAttributes, getBuilder, getChildElements, getChildren, getChildrenWithName, getFirstAttribute, getFirstChild, getFirstChildWithName, getFirstElement, getLocalName, getNamespace, getQName, getText, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, setBuilder, setFirstChild, setLocalName, setNamespace, setText
 
Methods inherited from interface org.apache.axis2.om.OMNode
build, discard, getNextSibling, getParent, getPreviousSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serializeWithCache
 
Methods inherited from interface org.apache.axis2.om.OMContainer
buildNext, isComplete
 
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(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: OMElement
This will add 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 OMElement
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

serialize

protected void serialize(OMOutputImpl omOutput,
                         boolean cache)
                  throws XMLStreamException
Overrides:
serialize in class OMElementImpl
Throws:
XMLStreamException