org.jboss.ws.core.soap

Class SOAPHeaderImpl

java.lang.Object

org.jboss.ws.core.soap.NodeImpl

org.jboss.ws.core.soap.SOAPElementImpl

org.jboss.ws.core.soap.SOAPHeaderImpl

All Implemented Interfaces:

SOAPElement, SOAPHeader, Element, Node

public class SOAPHeaderImpl
extends SOAPElementImpl
implements SOAPHeader

A representation of the SOAP header element. A SOAP header element consists of XML data that affects the way the application-specific content is processed by the message provider. For example, transaction semantics, authentication information, and so on, can be specified as the content of a SOAPHeader object.

Author:

Thomas.Diesler@jboss.org

Field Summary

Fields inherited from class org.jboss.ws.core.soap.NodeImpl

domNode, soapParent

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

Constructors

Constructor and Description
SOAPHeaderImpl(String prefix, String namespace)

Method Summary

Methods

Modifier and Type	Method and Description
SOAPElement	addChildElement(SOAPElement child) Add a SOAPHeaderElement as a child of this SOAPHeader instance.
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)
SOAPElement	addTextNode(String value) Attaching a Text node is not legal.
SOAPHeaderElement	addUpgradeHeaderElement(Iterator supportedSoapUris)
SOAPHeaderElement	addUpgradeHeaderElement(String supportedSoapUri)
SOAPHeaderElement	addUpgradeHeaderElement(String[] supportedSoapUris)
Node	appendChild(Node newChild)
Iterator	examineAllHeaderElements() Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.
Iterator	examineHeaderElements(String actor) Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have 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()
Iterator	extractHeaderElements(String actor)
Node	insertBefore(Node newChild, Node refChild)
Node	replaceChild(Node newChild, Node oldChild)

Methods inherited from class org.jboss.ws.core.soap.SOAPElementImpl

addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, createQName, getAllAttributes, getAllAttributesAsQNames, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChildElementByLocalName, getNamespacePrefixes, getNamespaceURI, getSchemaTypeInfo, getSOAPEnvelope, getTagName, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setElementQName, setElementQNameInternal, setEncodingStyle, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setPrefix, writeElement, writeElementContent

Methods inherited from class org.jboss.ws.core.soap.NodeImpl

cloneNode, compareDocumentPosition, detachNode, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, getValue, hasAttributes, hasChildNodes, hashCode, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeChild, setNodeValue, setParentElement, setTextContent, setUserData, setValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.SOAPElement

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

Methods inherited from interface javax.xml.soap.Node

detachNode, 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

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

Constructor Detail

SOAPHeaderImpl

public SOAPHeaderImpl(String prefix,
              String namespace)

Method Detail

addChildElement

public SOAPElement addChildElement(SOAPElement child)
                            throws SOAPException

Add a SOAPHeaderElement as a child of this SOAPHeader instance.

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Parameters:

child - the SOAPElement to be added as a new child

Returns:

an instance representing the new SOAP element that was actually added to the tree.

Throws:

SOAPException - if there was an error in adding this element as a child

addTextNode

public SOAPElement addTextNode(String value)
                        throws SOAPException

Attaching a Text node is not legal.

Specified by:

addTextNode in interface SOAPElement

Overrides:

addTextNode in class SOAPElementImpl

Parameters:

value - 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 or if it is not legal to attach it as a child to this SOAPElement

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

Throws:

SOAPException

addHeaderElement

public SOAPHeaderElement addHeaderElement(QName qname)
                                   throws SOAPException

Specified by:

addHeaderElement in interface SOAPHeader

Throws:

SOAPException

examineAllHeaderElements

public Iterator examineAllHeaderElements()

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

Specified by:

examineAllHeaderElements in interface SOAPHeader

examineHeaderElements

public Iterator examineHeaderElements(String actor)

Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor.

Specified by:

examineHeaderElements in interface SOAPHeader

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

extractAllHeaderElements

public Iterator extractAllHeaderElements()

Specified by:

extractAllHeaderElements in interface SOAPHeader

extractHeaderElements

public Iterator extractHeaderElements(String actor)

Specified by:

extractHeaderElements in interface SOAPHeader

appendChild

public Node appendChild(Node newChild)
                 throws DOMException

Specified by:

appendChild in interface Node

Overrides:

appendChild in class NodeImpl

Throws:

DOMException

insertBefore

public Node insertBefore(Node newChild,
                Node refChild)
                  throws DOMException

Specified by:

insertBefore in interface Node

Overrides:

insertBefore in class NodeImpl

Throws:

DOMException

replaceChild

public Node replaceChild(Node newChild,
                Node oldChild)
                  throws DOMException

Specified by:

replaceChild in interface Node

Overrides:

replaceChild in class NodeImpl

Throws:

DOMException

addNotUnderstoodHeaderElement

public SOAPHeaderElement addNotUnderstoodHeaderElement(QName qname)
                                                throws SOAPException

Specified by:

addNotUnderstoodHeaderElement in interface SOAPHeader

Throws:

SOAPException

addUpgradeHeaderElement

public SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSoapUris)
                                          throws SOAPException

Specified by:

addUpgradeHeaderElement in interface SOAPHeader

Throws:

SOAPException

addUpgradeHeaderElement

public SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)
                                          throws SOAPException

Specified by:

addUpgradeHeaderElement in interface SOAPHeader

Throws:

SOAPException

addUpgradeHeaderElement

public SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri)
                                          throws SOAPException

Specified by:

addUpgradeHeaderElement in interface SOAPHeader

Throws:

SOAPException