org.apache.axis2.saaj
Class SOAPHeaderImpl

java.lang.Object
  extended by org.apache.axiom.om.impl.dom.NodeImpl
      extended by org.apache.axis2.saaj.NodeImplEx
          extended by org.apache.axis2.saaj.SOAPElementImpl
              extended by org.apache.axis2.saaj.SOAPHeaderImpl
All Implemented Interfaces:
java.lang.Cloneable, javax.xml.soap.SOAPElement, javax.xml.soap.SOAPHeader, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMNode, org.apache.axiom.om.OMSerializable, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList

public class SOAPHeaderImpl
extends SOAPElementImpl
implements javax.xml.soap.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, NORMALIZED, OWNED, ownerNode, READONLY, 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
 
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.OMNode
DTD_NODE, PI_NODE, SPACE_NODE
 
Constructor Summary
SOAPHeaderImpl(org.apache.axiom.soap.SOAPHeader header)
          Constructor
 
Method Summary
 javax.xml.soap.SOAPElement addChildElement(javax.xml.soap.Name name)
           
 javax.xml.soap.SOAPElement addChildElement(javax.xml.soap.SOAPElement soapElement)
           
 javax.xml.soap.SOAPElement addChildElement(java.lang.String localName)
           
 javax.xml.soap.SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix)
           
 javax.xml.soap.SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
           
 javax.xml.soap.SOAPHeaderElement addHeaderElement(javax.xml.soap.Name name)
          Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
 javax.xml.soap.SOAPHeaderElement addHeaderElement(javax.xml.namespace.QName qname)
           
 javax.xml.soap.SOAPHeaderElement addNotUnderstoodHeaderElement(javax.xml.namespace.QName qname)
          Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
 javax.xml.soap.SOAPElement addTextNode(java.lang.String text)
          Creates a new Text object initialized with the given String and adds it to this SOAPElement object.
 javax.xml.soap.SOAPHeaderElement addUpgradeHeaderElement(java.util.Iterator iterator)
          Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object.
 javax.xml.soap.SOAPHeaderElement addUpgradeHeaderElement(java.lang.String s)
           
 javax.xml.soap.SOAPHeaderElement addUpgradeHeaderElement(java.lang.String[] as)
           
protected  org.w3c.dom.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.
 java.util.Iterator examineAllHeaderElements()
          Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.
 java.util.Iterator examineHeaderElements(java.lang.String actor)
          Returns a list of all the SOAPHeaderElement objects in this SOAPHeader object that have the the specified actor.
 java.util.Iterator examineMustUnderstandHeaderElements(java.lang.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.
 java.util.Iterator extractAllHeaderElements()
          Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object.
 java.util.Iterator extractHeaderElements(java.lang.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.
 java.util.Iterator getChildElements()
          Returns an iterator over all the immediate content of this element.
 java.util.Iterator getChildElements(javax.xml.soap.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
build, buildWithAttachments, cloneNode, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNextOMSibling, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getPreviousOMSibling, getUserData, hasAttributes, insertBefore, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, replaceChild, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, setPrefix, setPreviousOMSibling, 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.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
 
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 javax.xml.soap.SOAPElement addChildElement(java.lang.String localName)
                                           throws javax.xml.soap.SOAPException
Specified by:
addChildElement in interface javax.xml.soap.SOAPElement
Overrides:
addChildElement in class SOAPElementImpl
Throws:
javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(java.lang.String localName,
                                                  java.lang.String prefix)
                                           throws javax.xml.soap.SOAPException
Specified by:
addChildElement in interface javax.xml.soap.SOAPElement
Overrides:
addChildElement in class SOAPElementImpl
Throws:
javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(java.lang.String localName,
                                                  java.lang.String prefix,
                                                  java.lang.String uri)
                                           throws javax.xml.soap.SOAPException
Specified by:
addChildElement in interface javax.xml.soap.SOAPElement
Overrides:
addChildElement in class SOAPElementImpl
Throws:
javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(javax.xml.soap.Name name)
                                           throws javax.xml.soap.SOAPException
Specified by:
addChildElement in interface javax.xml.soap.SOAPElement
Overrides:
addChildElement in class SOAPElementImpl
Throws:
javax.xml.soap.SOAPException

addChildElement

public javax.xml.soap.SOAPElement addChildElement(javax.xml.soap.SOAPElement soapElement)
                                           throws javax.xml.soap.SOAPException
Specified by:
addChildElement in interface javax.xml.soap.SOAPElement
Overrides:
addChildElement in class SOAPElementImpl
Throws:
javax.xml.soap.SOAPException

appendElement

protected org.w3c.dom.Element appendElement(org.apache.axiom.om.impl.dom.ElementImpl child)
                                     throws javax.xml.soap.SOAPException
Overrides:
appendElement in class SOAPElementImpl
Throws:
javax.xml.soap.SOAPException

addHeaderElement

public javax.xml.soap.SOAPHeaderElement addHeaderElement(javax.xml.soap.Name name)
                                                  throws javax.xml.soap.SOAPException
Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.

Specified by:
addHeaderElement in interface javax.xml.soap.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:
javax.xml.soap.SOAPException - if a SOAP error occurs

examineHeaderElements

public java.util.Iterator examineHeaderElements(java.lang.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 javax.xml.soap.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 java.util.Iterator extractHeaderElements(java.lang.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 javax.xml.soap.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 java.util.Iterator examineMustUnderstandHeaderElements(java.lang.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 javax.xml.soap.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 java.util.Iterator examineAllHeaderElements()
Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.

Specified by:
examineAllHeaderElements in interface javax.xml.soap.SOAPHeader
Returns:
an Iterator object over all the SOAPHeaderElement objects contained by this SOAPHeader

extractAllHeaderElements

public java.util.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 javax.xml.soap.SOAPHeader
Returns:
an Iterator object over all the SOAPHeaderElement objects contained by this SOAPHeader

addHeaderElement

public javax.xml.soap.SOAPHeaderElement addHeaderElement(javax.xml.namespace.QName qname)
                                                  throws javax.xml.soap.SOAPException
Specified by:
addHeaderElement in interface javax.xml.soap.SOAPHeader
Throws:
javax.xml.soap.SOAPException

addNotUnderstoodHeaderElement

public javax.xml.soap.SOAPHeaderElement addNotUnderstoodHeaderElement(javax.xml.namespace.QName qname)
                                                               throws javax.xml.soap.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 javax.xml.soap.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.
javax.xml.soap.SOAPException

addUpgradeHeaderElement

public javax.xml.soap.SOAPHeaderElement addUpgradeHeaderElement(java.util.Iterator iterator)
                                                         throws javax.xml.soap.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 javax.xml.soap.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:
javax.xml.soap.SOAPException - - if a SOAP error occurs.

addUpgradeHeaderElement

public javax.xml.soap.SOAPHeaderElement addUpgradeHeaderElement(java.lang.String[] as)
                                                         throws javax.xml.soap.SOAPException
Specified by:
addUpgradeHeaderElement in interface javax.xml.soap.SOAPHeader
Throws:
javax.xml.soap.SOAPException

addUpgradeHeaderElement

public javax.xml.soap.SOAPHeaderElement addUpgradeHeaderElement(java.lang.String s)
                                                         throws javax.xml.soap.SOAPException
Specified by:
addUpgradeHeaderElement in interface javax.xml.soap.SOAPHeader
Throws:
javax.xml.soap.SOAPException

addTextNode

public javax.xml.soap.SOAPElement addTextNode(java.lang.String text)
                                       throws javax.xml.soap.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 javax.xml.soap.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:
javax.xml.soap.SOAPException - if there is an error in creating the new Text object

getChildElements

public java.util.Iterator getChildElements(javax.xml.soap.Name name)
Specified by:
getChildElements in interface javax.xml.soap.SOAPElement
Overrides:
getChildElements in class SOAPElementImpl

getChildElements

public java.util.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 javax.xml.soap.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()
Specified by:
detach in interface org.apache.axiom.om.OMNode
Overrides:
detach in class SOAPElementImpl


Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.