public interface SOAPHeader extends 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);
SOAPHeaderElementATTRIBUTE_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| Modifier and Type | Method and Description |
|---|---|
SOAPHeaderElement |
addHeaderElement(Name name)
Creates a new
SOAPHeaderElement object initialized with the
specified name and adds it to this SOAPHeader object. |
SOAPHeaderElement |
addHeaderElement(javax.xml.namespace.QName qname)
Creates a new
SOAPHeaderElement object initialized with the
specified qname and adds it to this SOAPHeader object. |
SOAPHeaderElement |
addNotUnderstoodHeaderElement(javax.xml.namespace.QName name)
Creates a new NotUnderstood
SOAPHeaderElement object initialized
with the specified name and adds it to this SOAPHeader object. |
SOAPHeaderElement |
addUpgradeHeaderElement(java.util.Iterator<java.lang.String> supportedSOAPURIs)
Creates a new Upgrade
SOAPHeaderElement object initialized
with the specified List of supported SOAP URIs and adds it to this
SOAPHeader object. |
SOAPHeaderElement |
addUpgradeHeaderElement(java.lang.String supportedSoapUri)
Creates a new Upgrade
SOAPHeaderElement object initialized
with the specified supported SOAP URI and adds it to this
SOAPHeader object. |
SOAPHeaderElement |
addUpgradeHeaderElement(java.lang.String[] supportedSoapUris)
Creates a new Upgrade
SOAPHeaderElement object initialized
with the specified array of supported SOAP URIs and adds it to this
SOAPHeader object. |
java.util.Iterator<SOAPHeaderElement> |
examineAllHeaderElements()
Returns an
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object. |
java.util.Iterator<SOAPHeaderElement> |
examineHeaderElements(java.lang.String actor)
Returns an
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object
that have the specified actor. |
java.util.Iterator<SOAPHeaderElement> |
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<SOAPHeaderElement> |
extractAllHeaderElements()
Returns an
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object and detaches them
from this SOAPHeader object. |
java.util.Iterator<SOAPHeaderElement> |
extractHeaderElements(java.lang.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. |
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, setEncodingStyledetachNode, getParentElement, getValue, recycleNode, setParentElement, setValuegetAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNSappendChild, 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, setUserDataSOAPHeaderElement addHeaderElement(Name name) throws SOAPException
SOAPHeaderElement object initialized with the
specified name and adds it to this SOAPHeader object.name - a Name object with the name of the new
SOAPHeaderElement objectSOAPHeaderElement object that was
inserted into this SOAPHeader objectSOAPException - if a SOAP error occursaddHeaderElement(javax.xml.namespace.QName)SOAPHeaderElement addHeaderElement(javax.xml.namespace.QName qname) throws SOAPException
SOAPHeaderElement object initialized with the
specified qname and adds it to this SOAPHeader object.qname - a QName object with the qname of the new
SOAPHeaderElement objectSOAPHeaderElement object that was
inserted into this SOAPHeader objectSOAPException - if a SOAP error occursaddHeaderElement(Name)java.util.Iterator<SOAPHeaderElement> examineMustUnderstandHeaderElements(java.lang.String actor)
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.
actor - a String giving the URI of the actor / role
for which to searchIterator object over all the
SOAPHeaderElement objects that contain the specified
actor / role and are marked as MustUnderstandexamineHeaderElements(java.lang.String),
extractHeaderElements(java.lang.String),
SOAPConstants.URI_SOAP_ACTOR_NEXTjava.util.Iterator<SOAPHeaderElement> examineHeaderElements(java.lang.String actor)
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.
actor - a String giving the URI of the actor / role
for which to searchIterator object over all the
SOAPHeaderElement objects that contain the specified
actor / roleextractHeaderElements(java.lang.String),
SOAPConstants.URI_SOAP_ACTOR_NEXTjava.util.Iterator<SOAPHeaderElement> extractHeaderElements(java.lang.String actor)
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.
actor - a String giving the URI of the actor / role
for which to searchIterator object over all the
SOAPHeaderElement objects that contain the specified
actor / roleexamineHeaderElements(java.lang.String),
SOAPConstants.URI_SOAP_ACTOR_NEXTSOAPHeaderElement addNotUnderstoodHeaderElement(javax.xml.namespace.QName name) throws SOAPException
SOAPHeaderElement object initialized
with the specified name and adds it to this SOAPHeader object.
This operation is supported only by SOAP 1.2.name - a QName object with the name of the
SOAPHeaderElement object that was not understood.SOAPHeaderElement object that was
inserted into this SOAPHeader objectSOAPException - if a SOAP error occurs.java.lang.UnsupportedOperationException - if this is a SOAP 1.1 Header.SOAPHeaderElement addUpgradeHeaderElement(java.util.Iterator<java.lang.String> supportedSOAPURIs) throws SOAPException
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.supportedSOAPURIs - an Iterator object with the URIs of SOAP
versions supported.SOAPHeaderElement object that was
inserted into this SOAPHeader objectSOAPException - if a SOAP error occurs.SOAPHeaderElement addUpgradeHeaderElement(java.lang.String[] supportedSoapUris) throws SOAPException
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.supportedSoapUris - an array of the URIs of SOAP versions supported.SOAPHeaderElement object that was
inserted into this SOAPHeader objectSOAPException - if a SOAP error occurs.SOAPHeaderElement addUpgradeHeaderElement(java.lang.String supportedSoapUri) throws SOAPException
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.supportedSoapUri - the URI of SOAP the version that is supported.SOAPHeaderElement object that was
inserted into this SOAPHeader objectSOAPException - if a SOAP error occurs.java.util.Iterator<SOAPHeaderElement> examineAllHeaderElements()
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object.Iterator object over all the
SOAPHeaderElement objects contained by this
SOAPHeaderextractAllHeaderElements()java.util.Iterator<SOAPHeaderElement> extractAllHeaderElements()
Iterator over all the SOAPHeaderElement objects
in this SOAPHeader object and detaches them
from this SOAPHeader object.Iterator object over all the
SOAPHeaderElement objects contained by this
SOAPHeaderexamineAllHeaderElements()