org.apache.axiom.soap.impl.dom
Class SOAPEnvelopeImpl
java.lang.Object
org.apache.axiom.om.impl.dom.NodeImpl
org.apache.axiom.om.impl.dom.ChildNode
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:
- java.lang.Cloneable, org.apache.axiom.om.impl.OMContainerEx, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMConstants, org.apache.axiom.om.OMContainer, org.apache.axiom.om.OMElement, org.apache.axiom.om.OMNode, org.apache.axiom.soap.SOAPEnvelope, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList
public class SOAPEnvelopeImpl
- extends SOAPElement
- implements org.apache.axiom.soap.SOAPEnvelope, org.apache.axiom.om.OMConstants
Field Summary |
private static javax.xml.namespace.QName |
HEADER_QNAME
|
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, 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 |
Constructor Summary |
SOAPEnvelopeImpl(DocumentImpl doc,
org.apache.axiom.om.OMXMLParserWrapper builder,
org.apache.axiom.soap.SOAPFactory factory)
|
SOAPEnvelopeImpl(org.apache.axiom.om.OMNamespace ns,
org.apache.axiom.soap.SOAPFactory factory)
|
SOAPEnvelopeImpl(org.apache.axiom.om.OMXMLParserWrapper builder,
org.apache.axiom.soap.SOAPFactory factory)
|
Method Summary |
void |
addChild(org.apache.axiom.om.OMNode child)
|
protected void |
checkParent(org.apache.axiom.om.OMElement parent)
This has to be implemented by all the derived classes to check for the correct parent. |
org.apache.axiom.om.OMNode |
detach()
Method detach |
org.apache.axiom.soap.SOAPBody |
getBody()
Returns the SOAPBody object associated with this SOAPEnvelope
object. |
org.apache.axiom.soap.SOAPHeader |
getHeader()
Returns the SOAPHeader object for this SOAPEnvelope object. |
org.apache.axiom.om.OMNode |
getNextOMSibling()
Default behavior returns null, overriden in ChildNode. |
private javax.xml.namespace.QName |
getPayloadQName_Optimized()
Use a parser property to fetch the first element in the body. |
java.lang.String |
getSOAPBodyFirstElementLocalName()
|
org.apache.axiom.om.OMNamespace |
getSOAPBodyFirstElementNS()
|
org.apache.axiom.soap.SOAPVersion |
getVersion()
|
boolean |
hasFault()
|
protected void |
internalSerialize(javax.xml.stream.XMLStreamWriter writer2,
boolean cache)
|
private void |
serializeInternally(NodeImpl child,
org.apache.axiom.om.impl.MTOMXMLStreamWriter writer)
|
Methods inherited from class org.apache.axiom.om.impl.dom.ElementImpl |
addAttribute, addAttribute, buildWithAttachments, cloneNode, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getElementsByTagName, getElementsByTagNameNS, getFirstElement, getLineNumber, getLocalName, getNamespace, getNamespaceURI, getNamespaceURI, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getTagName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasAttribute, hasAttributeNS, hasAttributes, internalSerialize, internalSerializeAndConsume, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeNamespace, resolveQName, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setOwnerDocument, setText, setText, setType, toString, toStringWithConsume |
Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode |
buildNext, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, hasChildNodes, importNode, insertBefore, removeChild, replaceChild, setFirstChild, setLastChild |
Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl |
appendChild, build, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOMFactory, getOwnerDocument, getTextContent, getUserData, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNodeValue, setPrefix, setTextContent, 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, 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, buildWithAttachments, close, discard, 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, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete |
Methods inherited from interface org.w3c.dom.Node |
appendChild, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData |
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx |
setComplete |
HEADER_QNAME
private static final javax.xml.namespace.QName HEADER_QNAME
SOAPEnvelopeImpl
public SOAPEnvelopeImpl(org.apache.axiom.om.OMXMLParserWrapper builder,
org.apache.axiom.soap.SOAPFactory factory)
- Parameters:
builder
-
SOAPEnvelopeImpl
public SOAPEnvelopeImpl(DocumentImpl doc,
org.apache.axiom.om.OMXMLParserWrapper builder,
org.apache.axiom.soap.SOAPFactory factory)
SOAPEnvelopeImpl
public SOAPEnvelopeImpl(org.apache.axiom.om.OMNamespace ns,
org.apache.axiom.soap.SOAPFactory factory)
- Parameters:
ns
-
getVersion
public org.apache.axiom.soap.SOAPVersion getVersion()
- Specified by:
getVersion
in interface org.apache.axiom.soap.SOAPEnvelope
getHeader
public org.apache.axiom.soap.SOAPHeader getHeader()
throws org.apache.axiom.om.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 org.apache.axiom.soap.SOAPEnvelope
- Returns:
- the
SOAPHeader
object or null
if there is none
- Throws:
org.apache.axiom.om.OMException
- if there is a problem obtaining the SOAPHeader
object
org.apache.axiom.om.OMException
addChild
public void addChild(org.apache.axiom.om.OMNode child)
- Specified by:
addChild
in interface org.apache.axiom.om.OMContainer
- Overrides:
addChild
in class ParentNode
getBody
public org.apache.axiom.soap.SOAPBody getBody()
throws org.apache.axiom.om.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 org.apache.axiom.soap.SOAPEnvelope
- Returns:
- the
SOAPBody
object for this SOAPEnvelope
object or
null
if there is none
- Throws:
org.apache.axiom.om.OMException
- if there is a problem obtaining the SOAPBody
object
org.apache.axiom.om.OMException
detach
public org.apache.axiom.om.OMNode detach()
throws org.apache.axiom.om.OMException
- Method detach
- Specified by:
detach
in interface org.apache.axiom.om.OMNode
- Overrides:
detach
in class ChildNode
- Throws:
org.apache.axiom.om.OMException
checkParent
protected void checkParent(org.apache.axiom.om.OMElement parent)
throws org.apache.axiom.soap.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:
org.apache.axiom.soap.SOAPProcessingException
internalSerialize
protected void internalSerialize(javax.xml.stream.XMLStreamWriter writer2,
boolean cache)
throws javax.xml.stream.XMLStreamException
- Overrides:
internalSerialize
in class ElementImpl
- Throws:
javax.xml.stream.XMLStreamException
serializeInternally
private void serializeInternally(NodeImpl child,
org.apache.axiom.om.impl.MTOMXMLStreamWriter writer)
throws javax.xml.stream.XMLStreamException
- Throws:
javax.xml.stream.XMLStreamException
getNextOMSibling
public org.apache.axiom.om.OMNode getNextOMSibling()
throws org.apache.axiom.om.OMException
- Description copied from class:
NodeImpl
- Default behavior returns null, overriden in ChildNode.
- Specified by:
getNextOMSibling
in interface org.apache.axiom.om.OMNode
- Overrides:
getNextOMSibling
in class ElementImpl
- Throws:
org.apache.axiom.om.OMException
hasFault
public boolean hasFault()
- Specified by:
hasFault
in interface org.apache.axiom.soap.SOAPEnvelope
getSOAPBodyFirstElementLocalName
public java.lang.String getSOAPBodyFirstElementLocalName()
- Specified by:
getSOAPBodyFirstElementLocalName
in interface org.apache.axiom.soap.SOAPEnvelope
getSOAPBodyFirstElementNS
public org.apache.axiom.om.OMNamespace getSOAPBodyFirstElementNS()
- Specified by:
getSOAPBodyFirstElementNS
in interface org.apache.axiom.soap.SOAPEnvelope
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