org.apache.axiom.soap.impl.dom

Class SOAPEnvelopeImpl

java.lang.Object

org.apache.axiom.om.impl.dom.NodeImpl

org.apache.axiom.om.impl.dom.ParentNode

org.apache.axiom.om.impl.dom.ElementImpl

org.apache.axiom.soap.impl.dom.SOAPElement

org.apache.axiom.soap.impl.dom.SOAPEnvelopeImpl

All Implemented Interfaces:

IChildNode, IContainer, IElement, IParentNode, NamedNode, OMContainerEx, OMElementEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMInformationItem, OMNamedInformationItem, OMNode, OMSerializable, SOAPEnvelope, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

public class SOAPEnvelopeImpl
extends SOAPElement
implements SOAPEnvelope, OMConstants

Field Summary

Fields

Modifier and Type	Field and Description
private static javax.xml.namespace.QName	HEADER_QNAME

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

builder, localName, namespace, state

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

firstChild, lastChild

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

factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

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.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.apache.axiom.om.impl.common.IParentNode

COMPLETE, DISCARDED, INCOMPLETE

Constructor Summary

Constructors

Constructor and Description
SOAPEnvelopeImpl(ParentNode parentNode, OMNamespace ns, OMXMLParserWrapper builder, OMFactory factory, boolean generateNSDecl)

Method Summary

Modifier and Type	Method and Description
void	addChild(OMNode child, boolean fromBuilder)
private void	checkChild(OMNode child) Check that a node is allowed as a child of a SOAP envelope.
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, ParentNode targetParent, boolean generateNSDecl)
SOAPBody	getBody() Returns the SOAPBody object associated with this SOAPEnvelope object.
SOAPHeader	getHeader() Returns the SOAPHeader object for this SOAPEnvelope object.
private javax.xml.namespace.QName	getPayloadQName_Optimized() Use a parser property to fetch the first element in the body.
java.lang.String	getSOAPBodyFirstElementLocalName() Retrieves the local name of the first element in the body.
OMNamespace	getSOAPBodyFirstElementNS() Retrieves the OMNamespace of the first element in the body.
SOAPVersion	getVersion()
boolean	hasFault() Returns true if there is a SOAPFault in the body.
org.w3c.dom.Node	insertBefore(org.w3c.dom.Node newChild, org.w3c.dom.Node refChild) Inserts newChild before the refChild.
void	internalSerialize(javax.xml.stream.XMLStreamWriter writer2, boolean cache) Serializes the node.
private void	serializeInternally(NodeImpl child, MTOMXMLStreamWriter writer)

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

setParent

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

addAttribute, addAttribute, addNamespaceDeclaration, build, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, discard, discarded, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getElementsByTagName, getElementsByTagNameNS, getFirstElement, getIParentNode, getLineNumber, getLocalName, getNamespace, getNamespaceContext, getNamespacesInScope, getNamespaceURI, getNamespaceURI, getNextOMSibling, getNextSibling, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getState, getTagName, getText, getTextAsQName, getTextAsStream, getType, hasAttribute, hasAttributeNS, hasAttributes, internalSetNamespace, isComplete, lookupNamespaceURI, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChildren, resolveQName, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setComplete, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setPrefix, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo

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

addChild, appendChild, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChild, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getLastChild, getLastKnownOMChild, getLength, getSAXSource, getTextContent, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasChildNodes, item, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent

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

clone, cloneNode, close, compareDocumentPosition, detach, getBaseURI, getFeature, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getOwnerDocument, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, getUserData, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setNextOMSibling, setNodeValue, setParent, setPreviousOMSibling, setUserData

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.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setTextContent, setUserData

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

getLastKnownOMChild, setFirstChild, setLastChild

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

getFirstOMChildIfAvailable

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

getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling

Field Detail

HEADER_QNAME

private static final javax.xml.namespace.QName HEADER_QNAME

Constructor Detail

SOAPEnvelopeImpl

public SOAPEnvelopeImpl(ParentNode parentNode,
                        OMNamespace ns,
                        OMXMLParserWrapper builder,
                        OMFactory factory,
                        boolean generateNSDecl)

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

OMException

checkChild

private void checkChild(OMNode child)

Check that a node is allowed as a child of a SOAP envelope.

Parameters:

child -

addChild

public void addChild(OMNode child,
                     boolean fromBuilder)

Specified by:

addChild in interface OMContainerEx

Overrides:

addChild in class ParentNode

insertBefore

public org.w3c.dom.Node insertBefore(org.w3c.dom.Node newChild,
                                     org.w3c.dom.Node refChild)
                              throws org.w3c.dom.DOMException

Description copied from class: ParentNode

Inserts newChild before the refChild. If the refChild is null then the newChild is made the last child.

Specified by:

insertBefore in interface org.w3c.dom.Node

Overrides:

insertBefore in class ParentNode

Throws:

org.w3c.dom.DOMException

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

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 interface: OMNodeEx

Serializes the node. Note that this is an internal method that MUST NOT be used outside of Axiom. Please use OMSerializable.serialize(XMLStreamWriter, boolean) instead.

Specified by:

internalSerialize in interface OMNodeEx

Overrides:

internalSerialize in class ElementImpl

cache - indicates if caching should be enabled

Throws:

javax.xml.stream.XMLStreamException

serializeInternally

private void serializeInternally(NodeImpl child,
                                 MTOMXMLStreamWriter writer)
                          throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

hasFault

public boolean hasFault()

Description copied from interface: SOAPEnvelope

Returns true if there is a SOAPFault in the body. The implementation may choose to get this information by building the OM tree or use parser provided information.

Specified by:

hasFault in interface SOAPEnvelope

Returns:

true if SOAPFault in the body

getSOAPBodyFirstElementLocalName

public java.lang.String getSOAPBodyFirstElementLocalName()

Description copied from interface: SOAPEnvelope

Retrieves the local name of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the name, but don't necessarily need the OMElement.

Specified by:

getSOAPBodyFirstElementLocalName in interface SOAPEnvelope

Returns:

local name of first element in the body or null

getSOAPBodyFirstElementNS

public OMNamespace getSOAPBodyFirstElementNS()

Description copied from interface: SOAPEnvelope

Retrieves the OMNamespace of the first element in the body. The implementation might build the OMElement or it may obtain this information from the builder/parser without building the OMElement. Use this method in the situations where you need to know the OMNamespace, but don't necessarily need the OMElement.

Specified by:

getSOAPBodyFirstElementNS in interface SOAPEnvelope

Returns:

the namespace of first element in the body, or null if the element has no namespace or the body is empty

getPayloadQName_Optimized

private javax.xml.namespace.QName getPayloadQName_Optimized()

Use a parser property to fetch the first element in the body. Returns null if this optimized property is not set or not available.

Returns:

The qname of the first element in the body or null

createClone

protected OMElement createClone(OMCloneOptions options,
                                ParentNode targetParent,
                                boolean generateNSDecl)

Overrides:

createClone in class ElementImpl