org.apache.axis2.saaj
Class SOAPHeaderImpl

java.lang.Object
  org.apache.axiom.om.impl.dom.NodeImpl
      org.apache.axis2.saaj.NodeImplEx
          org.apache.axis2.saaj.SOAPElementImpl
              org.apache.axis2.saaj.SOAPHeaderImpl

All Implemented Interfaces:

Cloneable, SOAPElement, SOAPHeader, Element, Node, NodeList

public class SOAPHeaderImpl
extends SOAPElementImpl
implements SOAPHeader

Field Summary

Fields inherited from class org.apache.axis2.saaj.SOAPElementImpl

element

Fields inherited from class org.apache.axis2.saaj.NodeImplEx

parentElement

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

builder, done, factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED

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

SOAPHeaderImpl(org.apache.axiom.soap.SOAPHeader header)
Constructor

Method Summary

SOAPElement	addChildElement(Name name)
SOAPElement	addChildElement(SOAPElement soapElement)
SOAPElement	addChildElement(String localName)
SOAPElement	addChildElement(String localName, String prefix)
SOAPElement	addChildElement(String localName, String prefix, String uri)
SOAPHeaderElement	addHeaderElement(Name name) Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
SOAPHeaderElement	addHeaderElement(QName qname)
SOAPHeaderElement	addNotUnderstoodHeaderElement(QName qname) Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
SOAPElement	addTextNode(String text) Creates a new Text object initialized with the given String and adds it to this SOAPElement object.
SOAPHeaderElement	addUpgradeHeaderElement(Iterator iterator) Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object.
SOAPHeaderElement	addUpgradeHeaderElement(String s)
SOAPHeaderElement	addUpgradeHeaderElement(String[] as)
protected Element	appendElement(org.apache.axiom.om.impl.dom.ElementImpl child)
org.apache.axiom.om.OMNode	detach()
void	detachNode() Removes this Node object from the tree.
Iterator	examineAllHeaderElements() Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.
Iterator	examineHeaderElements(String actor) Returns a list of all the SOAPHeaderElement objects in this SOAPHeader object that have the the specified actor.
Iterator	examineMustUnderstandHeaderElements(String actor) Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent to true.
Iterator	extractAllHeaderElements() Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object.
Iterator	extractHeaderElements(String actor) Returns a list of all the SOAPHeaderElement objects in this SOAPHeader object that have the the specified actor and detaches them from this SOAPHeader object.
Iterator	getChildElements() Returns an iterator over all the immediate content of this element.
Iterator	getChildElements(Name name)

Methods inherited from class org.apache.axis2.saaj.SOAPElementImpl

addAttribute, addAttribute, addChildElement, addNamespaceDeclaration, appendChild, appendText, clone, copyContents, createQName, discard, getAllAttributes, getAllAttributesAsQNames, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getAttributeValue, getChildElements, getChildNodes, getElement, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getLastChild, getLocalName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTagName, getTextContent, getValue, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasChildNodes, internalSerialize, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setElementQName, setEncodingStyle, setParent, setParentElement, setValue, toString

Methods inherited from class org.apache.axis2.saaj.NodeImplEx

getParent, getSchemaTypeInfo, getType, recycleNode, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setType

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

cloneNode, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOMFactory, getUserData, hasAttributes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addAttribute, addChildElement, addNamespaceDeclaration, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle

Methods inherited from interface javax.xml.soap.Node

getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Constructor Detail

SOAPHeaderImpl

public SOAPHeaderImpl(org.apache.axiom.soap.SOAPHeader header)

Constructor

Parameters:

header -

Method Detail

addChildElement

public SOAPElement addChildElement(String localName)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(String localName,
                                   String prefix)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(String localName,
                                   String prefix,
                                   String uri)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(Name name)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(SOAPElement soapElement)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Throws:

SOAPException

appendElement

protected Element appendElement(org.apache.axiom.om.impl.dom.ElementImpl child)
                         throws SOAPException

Overrides:

appendElement in class SOAPElementImpl

Throws:

SOAPException

addHeaderElement

public SOAPHeaderElement addHeaderElement(Name name)
                                   throws SOAPException

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

Specified by:

addHeaderElement in interface SOAPHeader

Parameters:

name - a Name object with the name of the new SOAPHeaderElement object

Returns:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

Throws:

SOAPException - if a SOAP error occurs

examineHeaderElements

public Iterator examineHeaderElements(String actor)

Returns a list of all the SOAPHeaderElement 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:

examineHeaderElements in interface SOAPHeader

Parameters:

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

Returns:

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

See Also:

extractHeaderElements(java.lang.String)

extractHeaderElements

public Iterator extractHeaderElements(String actor)

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

This method allows an actor 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 actor.

Specified by:

extractHeaderElements in interface SOAPHeader

Parameters:

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

Returns:

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

See Also:

examineHeaderElements(java.lang.String)

examineMustUnderstandHeaderElements

public Iterator examineMustUnderstandHeaderElements(String actor)

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

Specified by:

examineMustUnderstandHeaderElements in interface SOAPHeader

Parameters:

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

Returns:

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

examineAllHeaderElements

public Iterator examineAllHeaderElements()

Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.

Specified by:

examineAllHeaderElements in interface SOAPHeader

Returns:

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

extractAllHeaderElements

public Iterator extractAllHeaderElements()

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

Specified by:

extractAllHeaderElements in interface SOAPHeader

Returns:

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

addHeaderElement

public SOAPHeaderElement addHeaderElement(QName qname)
                                   throws SOAPException

Specified by:

addHeaderElement in interface SOAPHeader

Throws:

SOAPException

addNotUnderstoodHeaderElement

public SOAPHeaderElement addNotUnderstoodHeaderElement(QName qname)
                                                throws SOAPException

Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object. This operation is supported only by SOAP 1.2

Specified by:

addNotUnderstoodHeaderElement in interface SOAPHeader

Parameters:

name - - a QName object with the name of the SOAPHeaderElement object that was not understood.

Returns:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

Throws:

SOAPException- - if a SOAP error occurs. java.lang.UnsupportedOperationException - if this is a SOAP 1.1 Header.

SOAPException

addUpgradeHeaderElement

public SOAPHeaderElement addUpgradeHeaderElement(Iterator iterator)
                                          throws SOAPException

Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.

Specified by:

addUpgradeHeaderElement in interface SOAPHeader

Parameters:

supportedSOAPURIs - - an Iterator object with the URIs of SOAP versions supported.

Returns:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

Throws:

SOAPException - - if a SOAP error occurs.

addUpgradeHeaderElement

public SOAPHeaderElement addUpgradeHeaderElement(String[] as)
                                          throws SOAPException

Specified by:

addUpgradeHeaderElement in interface SOAPHeader

Throws:

SOAPException

addUpgradeHeaderElement

public SOAPHeaderElement addUpgradeHeaderElement(String s)
                                          throws SOAPException

Specified by:

addUpgradeHeaderElement in interface SOAPHeader

Throws:

SOAPException

addTextNode

public SOAPElement addTextNode(String text)
                        throws SOAPException

Description copied from class: SOAPElementImpl

Creates a new Text object initialized with the given String and adds it to this SOAPElement object.

Specified by:

addTextNode in interface SOAPElement

Overrides:

addTextNode in class SOAPElementImpl

Parameters:

text - a String object with the textual content to be added

Returns:

the SOAPElement object into which the new Text object was inserted

Throws:

SOAPException - if there is an error in creating the new Text object

getChildElements

public Iterator getChildElements(Name name)

Specified by:

getChildElements in interface SOAPElement

Overrides:

getChildElements in class SOAPElementImpl

getChildElements

public Iterator getChildElements()

Description copied from class: SOAPElementImpl

Returns an iterator over all the immediate content of this element. This includes Text objects as well as SOAPElement objects.

Specified by:

getChildElements in interface SOAPElement

Overrides:

getChildElements in class SOAPElementImpl

Returns:

an iterator over Text and SOAPElement contained within this SOAPElement object

detachNode

public void detachNode()

Description copied from class: NodeImplEx

Removes this Node object from the tree. Once removed, this node can be garbage collected if there are no application references to it.

Overrides:

detachNode in class SOAPElementImpl

detach

public org.apache.axiom.om.OMNode detach()

Overrides:

detach in class SOAPElementImpl