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

java.lang.Object
  org.apache.axis2.om.impl.dom.NodeImpl
      org.apache.axis2.om.impl.dom.ChildNode
          org.apache.axis2.om.impl.dom.ParentNode
              org.apache.axis2.om.impl.dom.ElementImpl
                  org.apache.axis2.soap.impl.dom.SOAPElement
                      org.apache.axis2.soap.impl.dom.SOAPHeaderImpl

All Implemented Interfaces:

Cloneable, Element, Node, NodeList, OMConstants, OMContainer, OMContainerEx, OMElement, OMNode, OMNodeEx, SOAPHeader

Direct Known Subclasses:

SOAP11HeaderImpl, SOAP12HeaderImpl

public abstract class SOAPHeaderImpl

extends SOAPElement

implements SOAPHeader

Field Summary

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

localName, namespace

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

firstChild, lastChild

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

nextSibling, parentNode, previousSibling

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

builder, done, FIRSTCHILD, flags, nodeType, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED

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

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.apache.axis2.om.OMConstants

ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DEFAULT_CHAR_SET_ENCODING, DEFAULT_XML_VERSION, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI

Constructor Summary

SOAPHeaderImpl(SOAPEnvelope envelope)

SOAPHeaderImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder)
Constructor SOAPHeaderImpl

Method Summary

abstract SOAPHeaderBlock	addHeaderBlock(String localName, OMNamespace ns) Creates a new SOAPHeaderBlock object initialized with the specified name and adds it to this SOAPHeader object.
protected void	checkParent(OMElement parent) This has to be implemented by all the derived classes to check for the correct parent.
Iterator	examineAllHeaderBlocks() Returns an Iterator over all the SOAPHeaderBlock objects in this SOAPHeader object.
Iterator	examineHeaderBlocks(String paramRole) Returns a list of all the SOAPHeaderBlock objects in this SOAPHeader object that have the the specified actor.
Iterator	examineMustUnderstandHeaderBlocks(String actor) Returns an Iterator over all the SOAPHeaderBlock objects in this SOAPHeader object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent to true.
Iterator	extractAllHeaderBlocks() Returns an Iterator over all the SOAPHeaderBlock objects in this SOAPHeader object and detaches them from this SOAPHeader object.
abstract Iterator	extractHeaderBlocks(String role) Returns a list of all the SOAPHeaderBlock objects in this SOAPHeader object that have the the specified role and detaches them from this SOAPHeader object.
ArrayList	getHeaderBlocksWithNSURI(String nsURI) Return all the Headers that has the Namespace URI to given NS URI.

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

addAttribute, addAttribute, cloneNode, cloneOMElement, declareNamespace, declareNamespace, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getElementsByTagName, getElementsByTagNameNS, getFirstElement, getLocalName, getNamespace, getNamespaceURI, getNamespaceURI, getNextOMSibling, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getTagName, getText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasAttribute, hasAttributeNS, hasAttributes, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeNamespace, resolveQName, serialize, serialize, serializeAndConsume, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLocalName, setNamespace, setOwnerDocument, setText, setType, toString, toStringWithConsume

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

addChild, buildNext, getChildNodes, getChildren, getChildrenWithName, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, hasChildNodes, insertBefore, removeChild, replaceChild, setFirstChild

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

detach, getNextSibling, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, setNextOMSibling, setParent, setPreviousOMSibling

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

appendChild, build, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOwnerDocument, getTextContent, getUserData, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeWithCache, 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.axis2.om.OMElement

addAttribute, addAttribute, cloneOMElement, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, 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

Methods inherited from interface org.w3c.dom.Node

appendChild, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

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

setComplete

Constructor Detail

SOAPHeaderImpl

public SOAPHeaderImpl(SOAPEnvelope envelope)
               throws SOAPProcessingException

Parameters:

envelope -

SOAPHeaderImpl

public SOAPHeaderImpl(SOAPEnvelope envelope,
                      OMXMLParserWrapper builder)

Constructor SOAPHeaderImpl

Parameters:

envelope -

builder -

Method Detail

addHeaderBlock

public abstract SOAPHeaderBlock addHeaderBlock(String localName,
                                               OMNamespace ns)
                                        throws OMException

Creates a new SOAPHeaderBlock object initialized with the specified name and adds it to this SOAPHeader object.

Specified by:

addHeaderBlock in interface SOAPHeader

Parameters:

localName -

ns -

Returns:

the new SOAPHeaderBlock object that was inserted into this SOAPHeader object

Throws:

OMException - if a SOAP error occurs

OMException

examineHeaderBlocks

public Iterator examineHeaderBlocks(String paramRole)

Returns a list of all the SOAPHeaderBlock objects in this SOAPHeader object that have the the specified actor. An actor is a global attribute that indicates the intermediate parties to whom the message should be sent. An actor receives the message and then sends it to the next actor. The default actor is the ultimate intended recipient for the message, so if no actor attribute is included in a SOAPHeader object, the message is sent to its ultimate destination.

Specified by:

examineHeaderBlocks in interface SOAPHeader

Parameters:

paramRole - a String giving the URI of the actor for which to search

Returns:

an Iterator object over all the SOAPHeaderBlock objects that contain the specified actor

See Also:

extractHeaderBlocks(java.lang.String)

extractHeaderBlocks

public abstract Iterator extractHeaderBlocks(String role)

Returns a list of all the SOAPHeaderBlock objects in this SOAPHeader object that have the the specified role and detaches them from this SOAPHeader object.

This method allows an role to process only the parts of the SOAPHeader object that apply to it and to remove them before passing the message on to the next role.

Specified by:

extractHeaderBlocks in interface SOAPHeader

Parameters:

role - a String giving the URI of the role for which to search

Returns:

an Iterator object over all the SOAPHeaderBlock objects that contain the specified role

See Also:

examineHeaderBlocks(java.lang.String)

examineMustUnderstandHeaderBlocks

public Iterator examineMustUnderstandHeaderBlocks(String actor)

Returns an Iterator over all the SOAPHeaderBlock objects in this SOAPHeader object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent to true.

Specified by:

examineMustUnderstandHeaderBlocks in interface SOAPHeader

Parameters:

actor - a String giving the URI of the actor for which to search

Returns:

an Iterator object over all the SOAPHeaderBlock objects that contain the specified actor and are marked as MustUnderstand

examineAllHeaderBlocks

public Iterator examineAllHeaderBlocks()

Returns an Iterator over all the SOAPHeaderBlock objects in this SOAPHeader object. Not that this will return elements containing the QName (http://schemas.xmlsoap.org/soap/envelope/, Header)

Specified by:

examineAllHeaderBlocks in interface SOAPHeader

Returns:

an Iterator object over all the SOAPHeaderBlock objects contained by this SOAPHeader

extractAllHeaderBlocks

public Iterator extractAllHeaderBlocks()

Returns an Iterator over all the SOAPHeaderBlock objects in this SOAPHeader object and detaches them from this SOAPHeader object.

Specified by:

extractAllHeaderBlocks in interface SOAPHeader

Returns:

an Iterator object over all the SOAPHeaderBlock objects contained by this SOAPHeader

getHeaderBlocksWithNSURI

public ArrayList getHeaderBlocksWithNSURI(String nsURI)

Description copied from interface: SOAPHeader

Return all the Headers that has the Namespace URI to given NS URI.

Specified by:

getHeaderBlocksWithNSURI in interface SOAPHeader

Parameters:

nsURI -

Returns:

Returns ArrayList.

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