org.apache.axiom.soap.impl.dom
Class SOAPHeaderImpl

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.SOAPHeaderImpl

All Implemented Interfaces:

java.lang.Cloneable, OMContainerEx, OMElementEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMInformationItem, OMNamedInformationItem, OMNode, OMSerializable, SOAPHeader, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

Direct Known Subclasses:

SOAP11HeaderImpl, SOAP12HeaderImpl

public abstract class SOAPHeaderImpl
extends SOAPElement
implements SOAPHeader

Field Summary

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

localName, namespace

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

firstChild, lastChild

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

nextSibling, previousSibling

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

builder, done, 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.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.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

Constructor Summary

SOAPHeaderImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder, SOAPFactory factory)
Constructor SOAPHeaderImpl

SOAPHeaderImpl(SOAPEnvelope envelope, SOAPFactory factory)

Method Summary

SOAPHeaderBlock	addHeaderBlock(java.lang.String localName, OMNamespace ns)
protected void	checkParent(OMElement parent) This has to be implemented by all the derived classes to check for the correct parent.
protected abstract SOAPHeaderBlock	createHeaderBlock(java.lang.String localname, OMNamespace ns)
java.util.Iterator	examineAllHeaderBlocks()
java.util.Iterator	examineHeaderBlocks(java.lang.String role)
java.util.Iterator	examineMustUnderstandHeaderBlocks(java.lang.String actor)
java.util.Iterator	extractAllHeaderBlocks()
abstract java.util.Iterator	extractHeaderBlocks(java.lang.String role)
java.util.ArrayList	getHeaderBlocksWithNSURI(java.lang.String nsURI)
java.util.Iterator	getHeadersToProcess(RolePlayer rolePlayer)
java.util.Iterator	getHeadersToProcess(RolePlayer rolePlayer, java.lang.String namespace)

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

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

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

addChild, buildNext, getBuilder, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChild, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getLastChild, getSAXSource, getTextContent, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasChildNodes, importNode, insertBefore, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent

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

build, close, detach, getNextOMSiblingIfAvailable, getNextSibling, getOwnerDocument, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isComplete, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling

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

appendChild, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOMFactory, getUserData, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, setNodeValue, 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.OMSerializable

build, close, isComplete, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem

getOMFactory

Methods inherited from interface org.apache.axiom.om.OMContainer

addChild, buildNext, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching

Methods inherited from interface org.apache.axiom.om.OMSerializable

build, close, isComplete, serialize, serialize, serializeAndConsume

Methods inherited from interface org.apache.axiom.om.OMInformationItem

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, 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, setTextContent, setUserData

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

getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setComplete, setNextOMSibling, setParent, setPreviousOMSibling

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

getFirstOMChildIfAvailable, setComplete, setFirstChild, setLastChild

Constructor Detail

SOAPHeaderImpl

public SOAPHeaderImpl(SOAPEnvelope envelope,
                      SOAPFactory factory)
               throws SOAPProcessingException

Parameters:

envelope -

Throws:

SOAPProcessingException

SOAPHeaderImpl

public SOAPHeaderImpl(SOAPEnvelope envelope,
                      OMXMLParserWrapper builder,
                      SOAPFactory factory)

Constructor SOAPHeaderImpl

Parameters:

envelope -

builder -

Method Detail

addHeaderBlock

public SOAPHeaderBlock addHeaderBlock(java.lang.String localName,
                                      OMNamespace ns)
                               throws OMException

Specified by:

addHeaderBlock in interface SOAPHeader

Throws:

OMException

createHeaderBlock

protected abstract SOAPHeaderBlock createHeaderBlock(java.lang.String localname,
                                                     OMNamespace ns)

getHeadersToProcess

public java.util.Iterator getHeadersToProcess(RolePlayer rolePlayer)

Specified by:

getHeadersToProcess in interface SOAPHeader

getHeadersToProcess

public java.util.Iterator getHeadersToProcess(RolePlayer rolePlayer,
                                              java.lang.String namespace)

Specified by:

getHeadersToProcess in interface SOAPHeader

examineHeaderBlocks

public java.util.Iterator examineHeaderBlocks(java.lang.String role)

Specified by:

examineHeaderBlocks in interface SOAPHeader

extractHeaderBlocks

public abstract java.util.Iterator extractHeaderBlocks(java.lang.String role)

Specified by:

extractHeaderBlocks in interface SOAPHeader

examineMustUnderstandHeaderBlocks

public java.util.Iterator examineMustUnderstandHeaderBlocks(java.lang.String actor)

Specified by:

examineMustUnderstandHeaderBlocks in interface SOAPHeader

examineAllHeaderBlocks

public java.util.Iterator examineAllHeaderBlocks()

Specified by:

examineAllHeaderBlocks in interface SOAPHeader

extractAllHeaderBlocks

public java.util.Iterator extractAllHeaderBlocks()

Specified by:

extractAllHeaderBlocks in interface SOAPHeader

getHeaderBlocksWithNSURI

public java.util.ArrayList getHeaderBlocksWithNSURI(java.lang.String nsURI)

Specified by:

getHeaderBlocksWithNSURI in interface SOAPHeader

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