Module com.sun.xml.messaging.saaj

Package com.sun.xml.messaging.saaj.soap.impl

Class HeaderImpl

java.lang.Object

com.sun.xml.messaging.saaj.soap.impl.ElementImpl

com.sun.xml.messaging.saaj.soap.impl.HeaderImpl

All Implemented Interfaces:

Node, SOAPBodyElement, SOAPElement, SOAPHeader, Element, Node

Direct Known Subclasses:

Header1_1Impl, Header1_2Impl

public abstract class HeaderImpl
extends ElementImpl
implements SOAPHeader

Field Summary

Fields

Modifier and Type	Field	Description
protected static final boolean	MUST_UNDERSTAND_ONLY

Fields inherited from class com.sun.xml.messaging.saaj.soap.impl.ElementImpl

DSIG_NS, elementQName, WSU_NS, XENC_NS

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

Modifier	Constructor	Description
protected	HeaderImpl(SOAPDocumentImpl ownerDoc, NameImpl name)
protected	HeaderImpl(SOAPDocumentImpl ownerDoc, Element domElement)

Method Summary

Modifier and Type	Method	Description
SOAPElement	addChildElement(String localName)	Creates a new SOAPElement object initialized with the specified local name and adds the new element to this SOAPElement object.
protected SOAPElement	addElement(Name name)
protected SOAPElement	addElement(QName name)
SOAPHeaderElement	addHeaderElement(Name name)	Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
SOAPHeaderElement	addHeaderElement(QName name)	Creates a new SOAPHeaderElement object initialized with the specified qname and adds it to this SOAPHeader object.
SOAPHeaderElement	addUpgradeHeaderElement(String supportedSoapUri)	Creates a new Upgrade SOAPHeaderElement object initialized with the specified supported SOAP URI and adds it to this SOAPHeader object.
SOAPHeaderElement	addUpgradeHeaderElement(String[] supportedSoapUris)	Creates a new Upgrade SOAPHeaderElement object initialized with the specified array of supported SOAP URIs and adds it to this SOAPHeader object.
SOAPHeaderElement	addUpgradeHeaderElement(Iterator<String> supportedSoapUris)	Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object.
protected SOAPElement	convertToSoapElement(Element element)
protected abstract SOAPHeaderElement	createHeaderElement(Name name)
protected abstract SOAPHeaderElement	createHeaderElement(QName name)
Iterator<SOAPHeaderElement>	examineAllHeaderElements()	Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.
Iterator<SOAPHeaderElement>	examineHeaderElements(String actor)	Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor.
Iterator<SOAPHeaderElement>	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<SOAPHeaderElement>	extractAllHeaderElements()	Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object.
Iterator<SOAPHeaderElement>	extractHeaderElements(String actor)	Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and detaches them from this SOAPHeader object.
protected Iterator<SOAPHeaderElement>	getHeaderElements(String actor, boolean detach, boolean mustUnderstand)
protected Iterator<SOAPHeaderElement>	getHeaderElementsForActor(String actor, boolean detach, boolean mustUnderstand)
protected abstract NameImpl	getNotUnderstoodName()
protected abstract NameImpl	getSupportedEnvelopeName()
protected abstract NameImpl	getUpgradeName()
SOAPElement	setElementQName(QName newName)	Changes the name of this Element to newName if possible.
void	setParentElement(SOAPElement element)	Sets the parent of this Node object to the given SOAPElement object.

Methods inherited from class com.sun.xml.messaging.saaj.soap.impl.ElementImpl

addAttribute, addAttribute, addCDATA, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addNode, addText, addTextNode, appendChild, cloneNode, compareDocumentPosition, convertToSoapText, createElement, createElement, createQName, detachNode, doGetNamespacePrefixes, ensureNamespaceIsDeclared, findAndConvertChildElement, findChild, findEncodingStyleAttributeName, getAllAttributes, getAllAttributesAsQNames, getAllAttributesFrom, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getAttributeValue, getAttributeValueFrom, getBaseURI, getChildElementNodes, getChildElements, getChildElements, getChildElements, getChildElementsFrom, getChildNodes, getDomElement, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFeature, getFirstChild, getLastChild, getLocalName, getLocalPart, getNamespaceAttr, getNamespaceAttrFrom, getNamespaceContextNodes, getNamespaceContextNodes, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPrefix, getPreviousSibling, getQualifiedName, getSchemaTypeInfo, getSoapDocument, getSOAPNamespace, getTagName, getTextContent, getUserData, getValue, getValueNode, getValueNodeStrict, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, importElement, insertBefore, isDefaultNamespace, isEqualNode, isNamespaceQualified, isNamespaceQualified, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, replaceChild, replaceElementWithSOAPElement, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setEncodingStyle, setEncodingStyleNamespace, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setPrefix, setTextContent, setUserData, setValue, tryToFindEncodingStyleAttributeName

Methods inherited from class java.lang.Object

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

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 jakarta.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, 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 jakarta.xml.soap.SOAPElement

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

Methods inherited from interface jakarta.xml.soap.SOAPHeader

addNotUnderstoodHeaderElement

Field Details

MUST_UNDERSTAND_ONLY

protected static final boolean MUST_UNDERSTAND_ONLY

See Also:

• Constant Field Values

Constructor Details

HeaderImpl

protected HeaderImpl(SOAPDocumentImpl ownerDoc,
 NameImpl name)

HeaderImpl

protected HeaderImpl(SOAPDocumentImpl ownerDoc,
 Element domElement)

Method Details

createHeaderElement

protected abstract SOAPHeaderElement createHeaderElement(Name name)
                                                  throws SOAPException

Throws:

SOAPException

createHeaderElement

protected abstract SOAPHeaderElement createHeaderElement(QName name)
                                                  throws SOAPException

Throws:

SOAPException

getNotUnderstoodName

protected abstract NameImpl getNotUnderstoodName()

getUpgradeName

protected abstract NameImpl getUpgradeName()

getSupportedEnvelopeName

protected abstract NameImpl getSupportedEnvelopeName()

addHeaderElement

public SOAPHeaderElement addHeaderElement(Name name)
                                   throws SOAPException

Description copied from interface: SOAPHeader

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

See Also:

• SOAPHeader.addHeaderElement(javax.xml.namespace.QName)

addHeaderElement

public SOAPHeaderElement addHeaderElement(QName name)
                                   throws SOAPException

Description copied from interface: SOAPHeader

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

Specified by:

addHeaderElement in interface SOAPHeader

Parameters:

name - a QName object with the qname of the new SOAPHeaderElement object

Returns:

the new SOAPHeaderElement object that was inserted into this SOAPHeader object

Throws:

SOAPException - if a SOAP error occurs

See Also:

• SOAPHeader.addHeaderElement(Name)

addElement

protected SOAPElement addElement(Name name)
                          throws SOAPException

Overrides:

addElement in class ElementImpl

Throws:

SOAPException

addElement

protected SOAPElement addElement(QName name)
                          throws SOAPException

Overrides:

addElement in class ElementImpl

Throws:

SOAPException

examineHeaderElements

public Iterator<SOAPHeaderElement> examineHeaderElements(String actor)

Description copied from interface: SOAPHeader

Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor. An actor is a global attribute that indicates the intermediate parties that should process a message before it reaches its ultimate receiver. An actor receives the message and processes it before sending it on 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, it is sent to the ultimate receiver along with the message body.

In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.

Specified by:

examineHeaderElements in interface SOAPHeader

Parameters:

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

Returns:

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

See Also:

• SOAPHeader.extractHeaderElements(java.lang.String)
• SOAPConstants.URI_SOAP_ACTOR_NEXT

extractHeaderElements

public Iterator<SOAPHeaderElement> extractHeaderElements(String actor)

Description copied from interface: SOAPHeader

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

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

In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.

Specified by:

extractHeaderElements in interface SOAPHeader

Parameters:

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

Returns:

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

See Also:

• SOAPHeader.examineHeaderElements(java.lang.String)
• SOAPConstants.URI_SOAP_ACTOR_NEXT

getHeaderElementsForActor

protected Iterator<SOAPHeaderElement> getHeaderElementsForActor(String actor,
 boolean detach,
 boolean mustUnderstand)

getHeaderElements

protected Iterator<SOAPHeaderElement> getHeaderElements(String actor,
 boolean detach,
 boolean mustUnderstand)

setParentElement

public void setParentElement(SOAPElement element)
                      throws SOAPException

Description copied from interface: Node

Sets the parent of this Node object to the given SOAPElement object.

Specified by:

setParentElement in interface Node

Overrides:

setParentElement in class ElementImpl

Parameters:

element - the SOAPElement object to be set as the parent of this Node object

Throws:

SOAPException - if there is a problem in setting the parent to the given element

See Also:

• Node.getParentElement()

addChildElement

public SOAPElement addChildElement(String localName)
                            throws SOAPException

Description copied from interface: SOAPElement

Creates a new SOAPElement object initialized with the specified local name and adds the new element to this SOAPElement object. The new SOAPElement inherits any in-scope default namespace.

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class ElementImpl

Parameters:

localName - a String giving the local name for the element

Returns:

the new SOAPElement object that was created

Throws:

SOAPException - if there is an error in creating the SOAPElement object

examineAllHeaderElements

public Iterator<SOAPHeaderElement> examineAllHeaderElements()

Description copied from interface: SOAPHeader

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

See Also:

• SOAPHeader.extractAllHeaderElements()

examineMustUnderstandHeaderElements

public Iterator<SOAPHeaderElement> examineMustUnderstandHeaderElements(String actor)

Description copied from interface: SOAPHeader

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.

In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.

Specified by:

examineMustUnderstandHeaderElements in interface SOAPHeader

Parameters:

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

Returns:

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

See Also:

• SOAPHeader.examineHeaderElements(java.lang.String)
• SOAPHeader.extractHeaderElements(java.lang.String)
• SOAPConstants.URI_SOAP_ACTOR_NEXT

extractAllHeaderElements

public Iterator<SOAPHeaderElement> extractAllHeaderElements()

Description copied from interface: SOAPHeader

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

See Also:

• SOAPHeader.examineAllHeaderElements()

addUpgradeHeaderElement

public SOAPHeaderElement addUpgradeHeaderElement(Iterator<String> supportedSoapUris)
                                          throws SOAPException

Description copied from interface: SOAPHeader

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 supportedSoapUri)
                                          throws SOAPException

Description copied from interface: SOAPHeader

Creates a new Upgrade SOAPHeaderElement object initialized with the specified supported SOAP URI 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:

supportedSoapUri - the URI of SOAP the version that is 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[] supportedSoapUris)
                                          throws SOAPException

Description copied from interface: SOAPHeader

Creates a new Upgrade SOAPHeaderElement object initialized with the specified array 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 array of 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.

convertToSoapElement

protected SOAPElement convertToSoapElement(Element element)

Overrides:

convertToSoapElement in class ElementImpl

setElementQName

public SOAPElement setElementQName(QName newName)
                            throws SOAPException

Description copied from interface: SOAPElement

Changes the name of this Element to newName if possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody etc. cannot have their names changed using this method. Any attempt to do so will result in a SOAPException being thrown.

Callers should not rely on the element instance being renamed as is. Implementations could end up copying the content of the SOAPElement to a renamed instance.

Specified by:

setElementQName in interface SOAPElement

Overrides:

setElementQName in class ElementImpl

Parameters:

newName - the new name for the Element.

Returns:

The renamed Node

Throws:

SOAPException - if changing the name of this Element is not allowed.