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

java.lang.Object
  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:

IChildNode, IContainer, IElement, IParentNode, OMContainerEx, OMElementEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMInformationItem, OMNamedInformationItem, OMNode, OMSerializable, 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, builder, firstChild, lastChild, localName, namespaces, ns, qName, state

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

nextSibling, parent, previousSibling

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

factory

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.om.impl.common.IParentNode

COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

SOAPEnvelopeImpl(OMNamespace ns, SOAPFactory factory)
Constructor

SOAPEnvelopeImpl(SOAPMessage message, OMXMLParserWrapper builder, SOAPFactory factory)
Constructor

Method Summary

void	addChild(OMNode child, boolean fromBuilder) Add a SOAPHeader or SOAPBody object
protected void	checkParent(OMElement parent) This has to be implemented by all the derived classes to check for the correct parent.
protected OMElement	createClone(OMCloneOptions options, OMContainer targetParent)
SOAPBody	getBody() Returns the SOAPBody object associated with this SOAPEnvelope object.
SOAPHeader	getHeader() Returns the SOAPHeader object for this SOAPEnvelope object.
java.lang.String	getSOAPBodyFirstElementLocalName()
OMNamespace	getSOAPBodyFirstElementNS()
SOAPVersion	getVersion()
boolean	hasFault()
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer2, boolean cache) Serializes the node.

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

registerContentHandler, setParent

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

addAttribute, addAttribute, addChild, addNamespaceDeclaration, build, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, discarded, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getDescendants, getFirstChildWithName, getFirstElement, getFirstOMChild, getFirstOMChildIfAvailable, getLastKnownOMChild, getLineNumber, getLocalName, getNamespace, getNamespaceContext, getNamespacesInScope, getNamespaceURI, getPrefix, getQName, getSAXSource, getState, getText, getTextAsQName, getTextAsStream, getType, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, isComplete, removeAttribute, removeChildren, resolveQName, setBuilder, setComplete, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

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

clone, getIParentNode, getNextOMSibling, getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setPreviousOMSibling

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

close, getOMFactory, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume

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, setBuilder, 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, 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, setLocalName

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

getIParentNode

Methods inherited from interface org.apache.axiom.om.impl.OMNodeEx

getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setPreviousOMSibling

Constructor Detail

SOAPEnvelopeImpl

public SOAPEnvelopeImpl(SOAPMessage message,
                        OMXMLParserWrapper builder,
                        SOAPFactory factory)

Constructor

Parameters:

message -

builder - the OMXMLParserWrapper building this envelope

factory - the SOAPFactory building this envelope

SOAPEnvelopeImpl

public SOAPEnvelopeImpl(OMNamespace ns,
                        SOAPFactory factory)

Constructor

Parameters:

ns - OMNamespace for this envelope

factory - SOAPFactory associated with this envelope

Method Detail

getVersion

public SOAPVersion getVersion()

Specified by:

getVersion in interface SOAPEnvelope

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

addChild

public void addChild(OMNode child,
                     boolean fromBuilder)

Add a SOAPHeader or SOAPBody object

Specified by:

addChild in interface OMContainerEx

Overrides:

addChild in class OMElementImpl

Parameters:

child - an OMNode to add - must be either a SOAPHeader or a SOAPBody

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

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

public void internalSerialize(javax.xml.stream.XMLStreamWriter writer2,
                              boolean cache)
                       throws javax.xml.stream.XMLStreamException

Description copied from class: OMSerializableImpl

Serializes the node.

Specified by:

internalSerialize in interface OMNodeEx

Overrides:

internalSerialize in class OMElementImpl

Throws:

javax.xml.stream.XMLStreamException

hasFault

public boolean hasFault()

Specified by:

hasFault in interface SOAPEnvelope

getSOAPBodyFirstElementLocalName

public java.lang.String getSOAPBodyFirstElementLocalName()

Specified by:

getSOAPBodyFirstElementLocalName in interface SOAPEnvelope

getSOAPBodyFirstElementNS

public OMNamespace getSOAPBodyFirstElementNS()

Specified by:

getSOAPBodyFirstElementNS in interface SOAPEnvelope

createClone

protected OMElement createClone(OMCloneOptions options,
                                OMContainer targetParent)

Overrides:

createClone in class OMElementImpl