public interface SOAPHeader extends SOAPElement
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.
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();
A 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. |
Iterator |
examineAllHeaderElements()
Returns an
Iterator over all the
SOAPHeaderElement objects in this SOAPHeader
object. |
Iterator |
examineHeaderElements(String actor)
Returns a list of all the
SOAPHeaderElement
objects in this SOAPHeader object that have the
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()
Returns an
Iterator over all the
SOAPHeaderElement objects in this SOAPHeader
object and detaches them from this SOAPHeader object. |
Iterator |
extractHeaderElements(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. |
addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, 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 occursIterator examineHeaderElements(String actor)
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.actor - a String giving the
URI of the actor for which to searchIterator object over all the
SOAPHeaderElement objects that contain the
specified actorextractHeaderElements(java.lang.String)Iterator extractHeaderElements(String actor)
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.
actor - a String giving the
URI of the actor for which to searchIterator object over all the
SOAPHeaderElement objects that contain the
specified actorexamineHeaderElements(java.lang.String)Iterator examineMustUnderstandHeaderElements(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.actor - a String giving the URI of the actor for which
to searchIterator object over all the
SOAPHeaderElement objects that contain the
specified actor and are marked as MustUnderstandIterator examineAllHeaderElements()
Iterator over all the
SOAPHeaderElement objects in this SOAPHeader
object.Iterator object over all the
SOAPHeaderElement objects contained by this
SOAPHeaderIterator 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
SOAPHeaderCopyright © The Apache Software Foundation. All Rights Reserved.