blob: d5ed45082a832d6a19e7fa8dfe81968866e9fb5a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SOAPHeader (Apache Axis)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SOAPHeader (Apache Axis)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SOAPHeader.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../javax/xml/soap/SOAPFaultElement.html" title="interface in javax.xml.soap"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/soap/SOAPHeader.html" target="_top">Frames</a></li>
<li><a href="SOAPHeader.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">javax.xml.soap</div>
<h2 title="Interface SOAPHeader" class="title">Interface SOAPHeader</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom">Element</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</a>, <a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/apache/axis/message/SOAPHeader.html" title="class in org.apache.axis.message">SOAPHeader</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">SOAPHeader</span>
extends <a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a></pre>
<div class="block"><P>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
<CODE>SOAPHeader</CODE> object.</P>
<P>A <CODE>SOAPEnvelope</CODE> object contains an empty <CODE>
SOAPHeader</CODE> object by default. If the <CODE>
SOAPHeader</CODE> object, which is optional, is not needed, it
can be retrieved and deleted with the following line of code.
The variable <I>se</I> is a <CODE>SOAPEnvelope</CODE>
object.</P>
<PRE>
se.getHeader().detachNode();
</PRE>
A <CODE>SOAPHeader</CODE> object is created with the <CODE>
SOAPEnvelope</CODE> method <CODE>addHeader</CODE>. This method,
which creates a new header and adds it to the envelope, may be
called only after the existing header has been removed.
<PRE>
se.getHeader().detachNode();
SOAPHeader sh = se.addHeader();
</PRE>
<P>A <CODE>SOAPHeader</CODE> object can have only <CODE>
SOAPHeaderElement</CODE> objects as its immediate children. The
method <CODE>addHeaderElement</CODE> creates a new <CODE>
HeaderElement</CODE> object and adds it to the <CODE>
SOAPHeader</CODE> object. In the following line of code, the
argument to the method <CODE>addHeaderElement</CODE> is a
<CODE>Name</CODE> object that is the name for the new <CODE>
HeaderElement</CODE> object.</P>
<PRE>
SOAPHeaderElement shElement = sh.addHeaderElement(name);
</PRE></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap"><code>SOAPHeaderElement</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.w3c.dom.Node">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.w3c.dom.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</a></h3>
<code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#ATTRIBUTE_NODE" title="class or interface in org.w3c.dom">ATTRIBUTE_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#CDATA_SECTION_NODE" title="class or interface in org.w3c.dom">CDATA_SECTION_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#COMMENT_NODE" title="class or interface in org.w3c.dom">COMMENT_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_FRAGMENT_NODE" title="class or interface in org.w3c.dom">DOCUMENT_FRAGMENT_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_NODE" title="class or interface in org.w3c.dom">DOCUMENT_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_POSITION_CONTAINED_BY" title="class or interface in org.w3c.dom">DOCUMENT_POSITION_CONTAINED_BY</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_POSITION_CONTAINS" title="class or interface in org.w3c.dom">DOCUMENT_POSITION_CONTAINS</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_POSITION_DISCONNECTED" title="class or interface in org.w3c.dom">DOCUMENT_POSITION_DISCONNECTED</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_POSITION_FOLLOWING" title="class or interface in org.w3c.dom">DOCUMENT_POSITION_FOLLOWING</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC" title="class or interface in org.w3c.dom">DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_POSITION_PRECEDING" title="class or interface in org.w3c.dom">DOCUMENT_POSITION_PRECEDING</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#DOCUMENT_TYPE_NODE" title="class or interface in org.w3c.dom">DOCUMENT_TYPE_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#ELEMENT_NODE" title="class or interface in org.w3c.dom">ELEMENT_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#ENTITY_NODE" title="class or interface in org.w3c.dom">ENTITY_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#ENTITY_REFERENCE_NODE" title="class or interface in org.w3c.dom">ENTITY_REFERENCE_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#NOTATION_NODE" title="class or interface in org.w3c.dom">NOTATION_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#PROCESSING_INSTRUCTION_NODE" title="class or interface in org.w3c.dom">PROCESSING_INSTRUCTION_NODE</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#TEXT_NODE" title="class or interface in org.w3c.dom">TEXT_NODE</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap">SOAPHeaderElement</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPHeader.html#addHeaderElement(javax.xml.soap.Name)">addHeaderElement</a></strong>(<a href="../../../javax/xml/soap/Name.html" title="interface in javax.xml.soap">Name</a>&nbsp;name)</code>
<div class="block">Creates a new <CODE>SOAPHeaderElement</CODE> object
initialized with the specified name and adds it to this
<CODE>SOAPHeader</CODE> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPHeader.html#examineAllHeaderElements()">examineAllHeaderElements</a></strong>()</code>
<div class="block">Returns an <code>Iterator</code> over all the
<code>SOAPHeaderElement</code> objects in this <code>SOAPHeader</code>
object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPHeader.html#examineHeaderElements(java.lang.String)">examineHeaderElements</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;actor)</code>
<div class="block">Returns a list of all the <CODE>SOAPHeaderElement</CODE>
objects in this <CODE>SOAPHeader</CODE> object that have the
the specified actor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPHeader.html#examineMustUnderstandHeaderElements(java.lang.String)">examineMustUnderstandHeaderElements</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;actor)</code>
<div class="block">Returns an <code>Iterator</code> over all the
<code>SOAPHeaderElement</code> objects in this <code>SOAPHeader</code>
object that have the specified actor and that have a MustUnderstand
attribute whose value is equivalent to <code>true</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPHeader.html#extractAllHeaderElements()">extractAllHeaderElements</a></strong>()</code>
<div class="block">Returns an <code>Iterator</code> over all the
<code>SOAPHeaderElement</code> objects in this <code>SOAPHeader </code>
object and detaches them from this <code>SOAPHeader</code> object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a></code></td>
<td class="colLast"><code><strong><a href="../../../javax/xml/soap/SOAPHeader.html#extractHeaderElements(java.lang.String)">extractHeaderElements</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;actor)</code>
<div class="block">Returns a list of all the <CODE>SOAPHeaderElement</CODE>
objects in this <CODE>SOAPHeader</CODE> object that have
the the specified actor and detaches them from this <CODE>
SOAPHeader</CODE> object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_javax.xml.soap.SOAPElement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.xml.soap.<a href="../../../javax/xml/soap/SOAPElement.html" title="interface in javax.xml.soap">SOAPElement</a></h3>
<code><a href="../../../javax/xml/soap/SOAPElement.html#addAttribute(javax.xml.soap.Name,%20java.lang.String)">addAttribute</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement(javax.xml.soap.Name)">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement(javax.xml.soap.SOAPElement)">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement(java.lang.String)">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement(java.lang.String,%20java.lang.String)">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addChildElement(java.lang.String,%20java.lang.String,%20java.lang.String)">addChildElement</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addNamespaceDeclaration(java.lang.String,%20java.lang.String)">addNamespaceDeclaration</a>, <a href="../../../javax/xml/soap/SOAPElement.html#addTextNode(java.lang.String)">addTextNode</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getAllAttributes()">getAllAttributes</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getAttributeValue(javax.xml.soap.Name)">getAttributeValue</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getChildElements()">getChildElements</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getChildElements(javax.xml.soap.Name)">getChildElements</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getElementName()">getElementName</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getEncodingStyle()">getEncodingStyle</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getNamespacePrefixes()">getNamespacePrefixes</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getNamespaceURI(java.lang.String)">getNamespaceURI</a>, <a href="../../../javax/xml/soap/SOAPElement.html#getVisibleNamespacePrefixes()">getVisibleNamespacePrefixes</a>, <a href="../../../javax/xml/soap/SOAPElement.html#removeAttribute(javax.xml.soap.Name)">removeAttribute</a>, <a href="../../../javax/xml/soap/SOAPElement.html#removeContents()">removeContents</a>, <a href="../../../javax/xml/soap/SOAPElement.html#removeNamespaceDeclaration(java.lang.String)">removeNamespaceDeclaration</a>, <a href="../../../javax/xml/soap/SOAPElement.html#setEncodingStyle(java.lang.String)">setEncodingStyle</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_javax.xml.soap.Node">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;javax.xml.soap.<a href="../../../javax/xml/soap/Node.html" title="interface in javax.xml.soap">Node</a></h3>
<code><a href="../../../javax/xml/soap/Node.html#detachNode()">detachNode</a>, <a href="../../../javax/xml/soap/Node.html#getParentElement()">getParentElement</a>, <a href="../../../javax/xml/soap/Node.html#getValue()">getValue</a>, <a href="../../../javax/xml/soap/Node.html#recycleNode()">recycleNode</a>, <a href="../../../javax/xml/soap/Node.html#setParentElement(javax.xml.soap.SOAPElement)">setParentElement</a>, <a href="../../../javax/xml/soap/Node.html#setValue(java.lang.String)">setValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.w3c.dom.Element">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.w3c.dom.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom">Element</a></h3>
<code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#getAttribute(java.lang.String)" title="class or interface in org.w3c.dom">getAttribute</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#getAttributeNode(java.lang.String)" title="class or interface in org.w3c.dom">getAttributeNode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#getAttributeNodeNS(java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">getAttributeNodeNS</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#getAttributeNS(java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">getAttributeNS</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#getElementsByTagName(java.lang.String)" title="class or interface in org.w3c.dom">getElementsByTagName</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#getElementsByTagNameNS(java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">getElementsByTagNameNS</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#getSchemaTypeInfo()" title="class or interface in org.w3c.dom">getSchemaTypeInfo</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#getTagName()" title="class or interface in org.w3c.dom">getTagName</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#hasAttribute(java.lang.String)" title="class or interface in org.w3c.dom">hasAttribute</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#hasAttributeNS(java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">hasAttributeNS</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#removeAttribute(java.lang.String)" title="class or interface in org.w3c.dom">removeAttribute</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#removeAttributeNode(org.w3c.dom.Attr)" title="class or interface in org.w3c.dom">removeAttributeNode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#removeAttributeNS(java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">removeAttributeNS</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#setAttribute(java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">setAttribute</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#setAttributeNode(org.w3c.dom.Attr)" title="class or interface in org.w3c.dom">setAttributeNode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#setAttributeNodeNS(org.w3c.dom.Attr)" title="class or interface in org.w3c.dom">setAttributeNodeNS</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#setAttributeNS(java.lang.String,%20java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">setAttributeNS</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#setIdAttribute(java.lang.String,%20boolean)" title="class or interface in org.w3c.dom">setIdAttribute</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#setIdAttributeNode(org.w3c.dom.Attr,%20boolean)" title="class or interface in org.w3c.dom">setIdAttributeNode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Element.html?is-external=true#setIdAttributeNS(java.lang.String,%20java.lang.String,%20boolean)" title="class or interface in org.w3c.dom">setIdAttributeNS</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.w3c.dom.Node">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.w3c.dom.<a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom">Node</a></h3>
<code><a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#appendChild(org.w3c.dom.Node)" title="class or interface in org.w3c.dom">appendChild</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#cloneNode(boolean)" title="class or interface in org.w3c.dom">cloneNode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#compareDocumentPosition(org.w3c.dom.Node)" title="class or interface in org.w3c.dom">compareDocumentPosition</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getAttributes()" title="class or interface in org.w3c.dom">getAttributes</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getBaseURI()" title="class or interface in org.w3c.dom">getBaseURI</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getChildNodes()" title="class or interface in org.w3c.dom">getChildNodes</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getFeature(java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">getFeature</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getFirstChild()" title="class or interface in org.w3c.dom">getFirstChild</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getLastChild()" title="class or interface in org.w3c.dom">getLastChild</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getLocalName()" title="class or interface in org.w3c.dom">getLocalName</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getNamespaceURI()" title="class or interface in org.w3c.dom">getNamespaceURI</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getNextSibling()" title="class or interface in org.w3c.dom">getNextSibling</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getNodeName()" title="class or interface in org.w3c.dom">getNodeName</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getNodeType()" title="class or interface in org.w3c.dom">getNodeType</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getNodeValue()" title="class or interface in org.w3c.dom">getNodeValue</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getOwnerDocument()" title="class or interface in org.w3c.dom">getOwnerDocument</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getParentNode()" title="class or interface in org.w3c.dom">getParentNode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getPrefix()" title="class or interface in org.w3c.dom">getPrefix</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getPreviousSibling()" title="class or interface in org.w3c.dom">getPreviousSibling</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getTextContent()" title="class or interface in org.w3c.dom">getTextContent</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#getUserData(java.lang.String)" title="class or interface in org.w3c.dom">getUserData</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#hasAttributes()" title="class or interface in org.w3c.dom">hasAttributes</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#hasChildNodes()" title="class or interface in org.w3c.dom">hasChildNodes</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#insertBefore(org.w3c.dom.Node,%20org.w3c.dom.Node)" title="class or interface in org.w3c.dom">insertBefore</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#isDefaultNamespace(java.lang.String)" title="class or interface in org.w3c.dom">isDefaultNamespace</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#isEqualNode(org.w3c.dom.Node)" title="class or interface in org.w3c.dom">isEqualNode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#isSameNode(org.w3c.dom.Node)" title="class or interface in org.w3c.dom">isSameNode</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#isSupported(java.lang.String,%20java.lang.String)" title="class or interface in org.w3c.dom">isSupported</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#lookupNamespaceURI(java.lang.String)" title="class or interface in org.w3c.dom">lookupNamespaceURI</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#lookupPrefix(java.lang.String)" title="class or interface in org.w3c.dom">lookupPrefix</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#normalize()" title="class or interface in org.w3c.dom">normalize</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#removeChild(org.w3c.dom.Node)" title="class or interface in org.w3c.dom">removeChild</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#replaceChild(org.w3c.dom.Node,%20org.w3c.dom.Node)" title="class or interface in org.w3c.dom">replaceChild</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#setNodeValue(java.lang.String)" title="class or interface in org.w3c.dom">setNodeValue</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#setPrefix(java.lang.String)" title="class or interface in org.w3c.dom">setPrefix</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#setTextContent(java.lang.String)" title="class or interface in org.w3c.dom">setTextContent</a>, <a href="http://docs.oracle.com/javase/1.4.2/docs/api/org/w3c/dom/Node.html?is-external=true#setUserData(java.lang.String,%20java.lang.Object,%20org.w3c.dom.UserDataHandler)" title="class or interface in org.w3c.dom">setUserData</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addHeaderElement(javax.xml.soap.Name)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addHeaderElement</h4>
<pre><a href="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap">SOAPHeaderElement</a>&nbsp;addHeaderElement(<a href="../../../javax/xml/soap/Name.html" title="interface in javax.xml.soap">Name</a>&nbsp;name)
throws <a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></pre>
<div class="block">Creates a new <CODE>SOAPHeaderElement</CODE> object
initialized with the specified name and adds it to this
<CODE>SOAPHeader</CODE> object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - a <CODE>Name</CODE> object with
the name of the new <CODE>SOAPHeaderElement</CODE>
object</dd>
<dt><span class="strong">Returns:</span></dt><dd>the new <CODE>SOAPHeaderElement</CODE> object that
was inserted into this <CODE>SOAPHeader</CODE>
object</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../javax/xml/soap/SOAPException.html" title="class in javax.xml.soap">SOAPException</a></code> - if a SOAP error occurs</dd></dl>
</li>
</ul>
<a name="examineHeaderElements(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>examineHeaderElements</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&nbsp;examineHeaderElements(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;actor)</pre>
<div class="block">Returns a list of all the <CODE>SOAPHeaderElement</CODE>
objects in this <CODE>SOAPHeader</CODE> 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 <CODE>SOAPHeader</CODE> object, the message is
sent to its ultimate destination.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>actor</code> - a <CODE>String</CODE> giving the
URI of the actor for which to search</dd>
<dt><span class="strong">Returns:</span></dt><dd>an <CODE>Iterator</CODE> object over all the <CODE>
SOAPHeaderElement</CODE> objects that contain the
specified actor</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/xml/soap/SOAPHeader.html#extractHeaderElements(java.lang.String)"><code>extractHeaderElements(java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="extractHeaderElements(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractHeaderElements</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&nbsp;extractHeaderElements(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;actor)</pre>
<div class="block">Returns a list of all the <CODE>SOAPHeaderElement</CODE>
objects in this <CODE>SOAPHeader</CODE> object that have
the the specified actor and detaches them from this <CODE>
SOAPHeader</CODE> object.
<P>This method allows an actor to process only the parts of
the <CODE>SOAPHeader</CODE> object that apply to it and to
remove them before passing the message on to the next
actor.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>actor</code> - a <CODE>String</CODE> giving the
URI of the actor for which to search</dd>
<dt><span class="strong">Returns:</span></dt><dd>an <CODE>Iterator</CODE> object over all the <CODE>
SOAPHeaderElement</CODE> objects that contain the
specified actor</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../javax/xml/soap/SOAPHeader.html#examineHeaderElements(java.lang.String)"><code>examineHeaderElements(java.lang.String)</code></a></dd></dl>
</li>
</ul>
<a name="examineMustUnderstandHeaderElements(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>examineMustUnderstandHeaderElements</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&nbsp;examineMustUnderstandHeaderElements(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;actor)</pre>
<div class="block">Returns an <code>Iterator</code> over all the
<code>SOAPHeaderElement</code> objects in this <code>SOAPHeader</code>
object that have the specified actor and that have a MustUnderstand
attribute whose value is equivalent to <code>true</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>actor</code> - a <code>String</code> giving the URI of the actor for which
to search</dd>
<dt><span class="strong">Returns:</span></dt><dd>an <code>Iterator</code> object over all the
<code>SOAPHeaderElement</code> objects that contain the
specified actor and are marked as MustUnderstand</dd></dl>
</li>
</ul>
<a name="examineAllHeaderElements()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>examineAllHeaderElements</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&nbsp;examineAllHeaderElements()</pre>
<div class="block">Returns an <code>Iterator</code> over all the
<code>SOAPHeaderElement</code> objects in this <code>SOAPHeader</code>
object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Iterator</code> object over all the
<code>SOAPHeaderElement</code> objects contained by this
<code>SOAPHeader</code></dd></dl>
</li>
</ul>
<a name="extractAllHeaderElements()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>extractAllHeaderElements</h4>
<pre><a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a>&nbsp;extractAllHeaderElements()</pre>
<div class="block">Returns an <code>Iterator</code> over all the
<code>SOAPHeaderElement</code> objects in this <code>SOAPHeader </code>
object and detaches them from this <code>SOAPHeader</code> object.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Iterator</code> object over all the
<code>SOAPHeaderElement</code> objects contained by this
<code>SOAPHeader</code></dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/SOAPHeader.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../javax/xml/soap/SOAPFaultElement.html" title="interface in javax.xml.soap"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../javax/xml/soap/SOAPHeaderElement.html" title="interface in javax.xml.soap"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?javax/xml/soap/SOAPHeader.html" target="_top">Frames</a></li>
<li><a href="SOAPHeader.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>