- All Superinterfaces:
Element
,Node
,Node
,SOAPElement
SOAPHeader
object.
A SOAPEnvelope
object contains an empty
SOAPHeader
object by default. If the SOAPHeader
object, which is optional, is not needed, it can be retrieved and deleted
with the following line of code. The variable se is a
SOAPEnvelope
object.
se.getHeader().detachNode();
SOAPHeader
object is created with the SOAPEnvelope
method addHeader
. This method, which creates a new header and adds it
to the envelope, may be called only after the existing header has been removed.
se.getHeader().detachNode();
SOAPHeader sh = se.addHeader();
A SOAPHeader
object can have only SOAPHeaderElement
objects as its immediate children. The method addHeaderElement
creates a new HeaderElement
object and adds it to the
SOAPHeader
object. In the following line of code, the
argument to the method addHeaderElement
is a Name
object that is the name for the new HeaderElement
object.
SOAPHeaderElement shElement = sh.addHeaderElement(name);
- Since:
- 1.6
- See Also:
-
Field Summary
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
-
Method Summary
Modifier and TypeMethodDescriptionaddHeaderElement
(Name name) Creates a newSOAPHeaderElement
object initialized with the specified name and adds it to thisSOAPHeader
object.addHeaderElement
(QName qname) Creates a newSOAPHeaderElement
object initialized with the specified qname and adds it to thisSOAPHeader
object.Creates a new NotUnderstoodSOAPHeaderElement
object initialized with the specified name and adds it to thisSOAPHeader
object.addUpgradeHeaderElement
(String supportedSoapUri) Creates a new UpgradeSOAPHeaderElement
object initialized with the specified supported SOAP URI and adds it to thisSOAPHeader
object.addUpgradeHeaderElement
(String[] supportedSoapUris) Creates a new UpgradeSOAPHeaderElement
object initialized with the specified array of supported SOAP URIs and adds it to thisSOAPHeader
object.addUpgradeHeaderElement
(Iterator<String> supportedSOAPURIs) Creates a new UpgradeSOAPHeaderElement
object initialized with the specified List of supported SOAP URIs and adds it to thisSOAPHeader
object.Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object.examineHeaderElements
(String actor) Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the specified actor.Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent totrue
.Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object and detaches them from thisSOAPHeader
object.extractHeaderElements
(String actor) Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the specified actor and detaches them from thisSOAPHeader
object.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, 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 jakarta.xml.soap.SOAPElement
addAttribute, addAttribute, addChildElement, 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, setElementQName, setEncodingStyle
-
Method Details
-
addHeaderElement
Creates a newSOAPHeaderElement
object initialized with the specified name and adds it to thisSOAPHeader
object.- Parameters:
name
- aName
object with the name of the newSOAPHeaderElement
object- Returns:
- the new
SOAPHeaderElement
object that was inserted into thisSOAPHeader
object - Throws:
SOAPException
- if a SOAP error occurs- See Also:
-
addHeaderElement
Creates a newSOAPHeaderElement
object initialized with the specified qname and adds it to thisSOAPHeader
object.- Parameters:
qname
- aQName
object with the qname of the newSOAPHeaderElement
object- Returns:
- the new
SOAPHeaderElement
object that was inserted into thisSOAPHeader
object - Throws:
SOAPException
- if a SOAP error occurs- Since:
- 1.6, SAAJ 1.3
- See Also:
-
examineMustUnderstandHeaderElements
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent totrue
.In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.
- Parameters:
actor
- aString
giving the URI of theactor
/role
for which to search- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specifiedactor
/role
and are marked as MustUnderstand - Since:
- 1.6, SAAJ 1.2
- See Also:
-
examineHeaderElements
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
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.
- Parameters:
actor
- aString
giving the URI of theactor
/role
for which to search- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specifiedactor
/role
- See Also:
-
extractHeaderElements
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the specified actor and detaches them from thisSOAPHeader
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.
- Parameters:
actor
- aString
giving the URI of theactor
/role
for which to search- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specifiedactor
/role
- See Also:
-
addNotUnderstoodHeaderElement
Creates a new NotUnderstoodSOAPHeaderElement
object initialized with the specified name and adds it to thisSOAPHeader
object. This operation is supported only by SOAP 1.2.- Parameters:
name
- aQName
object with the name of theSOAPHeaderElement
object that was not understood.- Returns:
- the new
SOAPHeaderElement
object that was inserted into thisSOAPHeader
object - Throws:
SOAPException
- if a SOAP error occurs.UnsupportedOperationException
- if this is a SOAP 1.1 Header.- Since:
- 1.6, SAAJ 1.3
-
addUpgradeHeaderElement
Creates a new UpgradeSOAPHeaderElement
object initialized with the specified List of supported SOAP URIs and adds it to thisSOAPHeader
object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.- Parameters:
supportedSOAPURIs
- anIterator
object with the URIs of SOAP versions supported.- Returns:
- the new
SOAPHeaderElement
object that was inserted into thisSOAPHeader
object - Throws:
SOAPException
- if a SOAP error occurs.- Since:
- 1.6, SAAJ 1.3
-
addUpgradeHeaderElement
Creates a new UpgradeSOAPHeaderElement
object initialized with the specified array of supported SOAP URIs and adds it to thisSOAPHeader
object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.- Parameters:
supportedSoapUris
- an array of the URIs of SOAP versions supported.- Returns:
- the new
SOAPHeaderElement
object that was inserted into thisSOAPHeader
object - Throws:
SOAPException
- if a SOAP error occurs.- Since:
- 1.6, SAAJ 1.3
-
addUpgradeHeaderElement
Creates a new UpgradeSOAPHeaderElement
object initialized with the specified supported SOAP URI and adds it to thisSOAPHeader
object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.- Parameters:
supportedSoapUri
- the URI of SOAP the version that is supported.- Returns:
- the new
SOAPHeaderElement
object that was inserted into thisSOAPHeader
object - Throws:
SOAPException
- if a SOAP error occurs.- Since:
- 1.6, SAAJ 1.3
-
examineAllHeaderElements
Iterator<SOAPHeaderElement> examineAllHeaderElements()Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object.- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects contained by thisSOAPHeader
- Since:
- 1.6, SAAJ 1.2
- See Also:
-
extractAllHeaderElements
Iterator<SOAPHeaderElement> extractAllHeaderElements()Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object and detaches them from thisSOAPHeader
object.- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects contained by thisSOAPHeader
- Since:
- 1.6, SAAJ 1.2
- See Also:
-