org.apache.axis2.soap
Interface SOAPEnvelope

All Superinterfaces:

OMContainer, OMElement, OMNode

All Known Implementing Classes:

SOAPEnvelopeImpl, SOAPEnvelopeImpl

public interface SOAPEnvelope

extends OMElement

Interface SOAPEnvelope

Field Summary

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

Method Summary

SOAPHeaderBlock	addHeader(java.lang.String namespaceURI, java.lang.String name) Convenience method to add a SOAP header to this envelope
SOAPBody	getBody() Returns the SOAPBody object associated with this SOAPEnvelope object.
SOAPHeader	getHeader() Returns the SOAPHeader object for this SOAPEnvelope object.

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, detach, 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

addChild, buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete

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

Returns:

the SOAPHeader object or null if there is none

Throws:

OMException - if there is a problem obtaining the SOAPHeader object

addHeader

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

Convenience method to add a SOAP header to this envelope

Parameters:

namespaceURI -

name -

Throws:

OMException

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

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