Google Git
Sign in
apache / tomee-site-pub / 43cf80e624a0cecf0f38bef5ef2614bfb2410f57 / . / jakartaee-9.0 / javadoc / jakarta / xml / soap / SOAPHeaderElement.html
blob: 13bbb77c1fc1f42aa0ad7dfb3217ac86840d55b4 [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>
<title>SOAPHeaderElement</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SOAPHeaderElement";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="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="../../../jakarta/xml/soap/SOAPHeader.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/xml/soap/SOAPHeaderElement.html" target="_top">Frames</a></li>
<li><a href="SOAPHeaderElement.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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">jakarta.xml.soap</div>
<h2 title="Interface SOAPHeaderElement" class="title">Interface SOAPHeaderElement</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.w3c.dom.Element, org.w3c.dom.Node, <a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">SOAPHeaderElement</span>
extends <a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></pre>
<div class="block">An object representing the contents in the SOAP header part of the
SOAP envelope.
The immediate children of a <code>SOAPHeader</code> object can
be represented only as <code>SOAPHeaderElement</code> objects.
<P>
A <code>SOAPHeaderElement</code> object can have other
<code>SOAPElement</code> objects as its children.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</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.Node</h3>
<code>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</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getActor--">getActor</a></span>()</code>
<div class="block">Returns the uri of the <i>actor</i> attribute of this
<code>SOAPHeaderElement</code>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getMustUnderstand--">getMustUnderstand</a></span>()</code>
<div class="block">Returns the boolean value of the mustUnderstand attribute for this
<code>SOAPHeaderElement</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getRelay--">getRelay</a></span>()</code>
<div class="block">Returns the boolean value of the <i>relay</i> attribute for this
<code>SOAPHeaderElement</code></div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getRole--">getRole</a></span>()</code>
<div class="block">Returns the value of the <i>Role</i> attribute of this
<code>SOAPHeaderElement</code>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setActor-java.lang.String-">setActor</a></span>(java.lang.String&nbsp;actorURI)</code>
<div class="block">Sets the actor associated with this <code>SOAPHeaderElement</code>
object to the specified actor.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setMustUnderstand-boolean-">setMustUnderstand</a></span>(boolean&nbsp;mustUnderstand)</code>
<div class="block">Sets the mustUnderstand attribute for this <code>SOAPHeaderElement</code>
object to be either true or false.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setRelay-boolean-">setRelay</a></span>(boolean&nbsp;relay)</code>
<div class="block">Sets the <i>relay</i> attribute for this <code>SOAPHeaderElement</code> to be
either true or false.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setRole-java.lang.String-">setRole</a></span>(java.lang.String&nbsp;uri)</code>
<div class="block">Sets the <code>Role</code> associated with this <code>SOAPHeaderElement</code>
object to the specified <code>Role</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.xml.soap.SOAPElement">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.xml.soap.<a href="../../../jakarta/xml/soap/SOAPElement.html" title="interface in jakarta.xml.soap">SOAPElement</a></h3>
<code><a href="../../../jakarta/xml/soap/SOAPElement.html#addAttribute-jakarta.xml.soap.Name-java.lang.String-">addAttribute</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addAttribute-javax.xml.namespace.QName-java.lang.String-">addAttribute</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-jakarta.xml.soap.Name-">addChildElement</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-javax.xml.namespace.QName-">addChildElement</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-jakarta.xml.soap.SOAPElement-">addChildElement</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-java.lang.String-">addChildElement</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-java.lang.String-java.lang.String-">addChildElement</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addChildElement-java.lang.String-java.lang.String-java.lang.String-">addChildElement</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addNamespaceDeclaration-java.lang.String-java.lang.String-">addNamespaceDeclaration</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#addTextNode-java.lang.String-">addTextNode</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#createQName-java.lang.String-java.lang.String-">createQName</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getAllAttributes--">getAllAttributes</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getAllAttributesAsQNames--">getAllAttributesAsQNames</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getAttributeValue-jakarta.xml.soap.Name-">getAttributeValue</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getAttributeValue-javax.xml.namespace.QName-">getAttributeValue</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements--">getChildElements</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements-jakarta.xml.soap.Name-">getChildElements</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getChildElements-javax.xml.namespace.QName-">getChildElements</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getElementName--">getElementName</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getElementQName--">getElementQName</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getEncodingStyle--">getEncodingStyle</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getNamespacePrefixes--">getNamespacePrefixes</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getNamespaceURI-java.lang.String-">getNamespaceURI</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#getVisibleNamespacePrefixes--">getVisibleNamespacePrefixes</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#removeAttribute-jakarta.xml.soap.Name-">removeAttribute</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#removeAttribute-javax.xml.namespace.QName-">removeAttribute</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#removeContents--">removeContents</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#removeNamespaceDeclaration-java.lang.String-">removeNamespaceDeclaration</a>, <a href="../../../jakarta/xml/soap/SOAPElement.html#setElementQName-javax.xml.namespace.QName-">setElementQName</a>, <a href="../../../jakarta/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.jakarta.xml.soap.Node">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;jakarta.xml.soap.<a href="../../../jakarta/xml/soap/Node.html" title="interface in jakarta.xml.soap">Node</a></h3>
<code><a href="../../../jakarta/xml/soap/Node.html#detachNode--">detachNode</a>, <a href="../../../jakarta/xml/soap/Node.html#getParentElement--">getParentElement</a>, <a href="../../../jakarta/xml/soap/Node.html#getValue--">getValue</a>, <a href="../../../jakarta/xml/soap/Node.html#recycleNode--">recycleNode</a>, <a href="../../../jakarta/xml/soap/Node.html#setParentElement-jakarta.xml.soap.SOAPElement-">setParentElement</a>, <a href="../../../jakarta/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.Element</h3>
<code>getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS</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.Node</h3>
<code>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</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="setActor-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setActor</h4>
<pre>void&nbsp;setActor(java.lang.String&nbsp;actorURI)</pre>
<div class="block">Sets the actor associated with this <code>SOAPHeaderElement</code>
object to the specified actor. The default value of an actor is:
<code>SOAPConstants.URI_SOAP_ACTOR_NEXT</code>
<P>
If this <code>SOAPHeaderElement</code> supports SOAP 1.2 then this call is
equivalent to <a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setRole-java.lang.String-"><code>setRole(String)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>actorURI</code> - a <code>String</code> giving the URI of the actor
to set</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if there is a problem in
setting the actor.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getActor--"><code>getActor()</code></a></dd>
</dl>
</li>
</ul>
<a name="setRole-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRole</h4>
<pre>void&nbsp;setRole(java.lang.String&nbsp;uri)
throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre>
<div class="block">Sets the <code>Role</code> associated with this <code>SOAPHeaderElement</code>
object to the specified <code>Role</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - the URI of the <code>Role</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is an error in setting the role</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if this message does not
support the SOAP 1.2 concept of Fault Role.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, SAAJ 1.3</dd>
</dl>
</li>
</ul>
<a name="getActor--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActor</h4>
<pre>java.lang.String&nbsp;getActor()</pre>
<div class="block">Returns the uri of the <i>actor</i> attribute of this
<code>SOAPHeaderElement</code>.
<P>
If this <code>SOAPHeaderElement</code> supports SOAP 1.2 then this call is
equivalent to <a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getRole--"><code>getRole()</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>String</code> giving the URI of the actor</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setActor-java.lang.String-"><code>setActor(java.lang.String)</code></a></dd>
</dl>
</li>
</ul>
<a name="getRole--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRole</h4>
<pre>java.lang.String&nbsp;getRole()</pre>
<div class="block">Returns the value of the <i>Role</i> attribute of this
<code>SOAPHeaderElement</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <code>String</code> giving the URI of the <code>Role</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if this message does not
support the SOAP 1.2 concept of Fault Role.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, SAAJ 1.3</dd>
</dl>
</li>
</ul>
<a name="setMustUnderstand-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMustUnderstand</h4>
<pre>void&nbsp;setMustUnderstand(boolean&nbsp;mustUnderstand)</pre>
<div class="block">Sets the mustUnderstand attribute for this <code>SOAPHeaderElement</code>
object to be either true or false.
<P>
If the mustUnderstand attribute is on, the actor who receives the
<code>SOAPHeaderElement</code> must process it correctly. This
ensures, for example, that if the <code>SOAPHeaderElement</code>
object modifies the message, that the message is being modified correctly.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mustUnderstand</code> - <code>true</code> to set the mustUnderstand
attribute to true; <code>false</code> to set it to false</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if there is a problem in
setting the mustUnderstand attribute</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getMustUnderstand--"><code>getMustUnderstand()</code></a>,
<a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setRelay-boolean-"><code>setRelay(boolean)</code></a></dd>
</dl>
</li>
</ul>
<a name="getMustUnderstand--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMustUnderstand</h4>
<pre>boolean&nbsp;getMustUnderstand()</pre>
<div class="block">Returns the boolean value of the mustUnderstand attribute for this
<code>SOAPHeaderElement</code>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the mustUnderstand attribute of this
<code>SOAPHeaderElement</code> object is turned on; <code>false</code>
otherwise</dd>
</dl>
</li>
</ul>
<a name="setRelay-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRelay</h4>
<pre>void&nbsp;setRelay(boolean&nbsp;relay)
throws <a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></pre>
<div class="block">Sets the <i>relay</i> attribute for this <code>SOAPHeaderElement</code> to be
either true or false.
<P>
The SOAP relay attribute is set to true to indicate that the SOAP header
block must be relayed by any node that is targeted by the header block
but not actually process it. This attribute is ignored on header blocks
whose mustUnderstand attribute is set to true or that are targeted at
the ultimate reciever (which is the default). The default value of this
attribute is <code>false</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>relay</code> - the new value of the <i>relay</i> attribute</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../jakarta/xml/soap/SOAPException.html" title="class in jakarta.xml.soap">SOAPException</a></code> - if there is a problem in setting the
relay attribute.</dd>
<dd><code>java.lang.UnsupportedOperationException</code> - if this message does not
support the SOAP 1.2 concept of Relay attribute.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, SAAJ 1.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setMustUnderstand-boolean-"><code>setMustUnderstand(boolean)</code></a>,
<a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getRelay--"><code>getRelay()</code></a></dd>
</dl>
</li>
</ul>
<a name="getRelay--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRelay</h4>
<pre>boolean&nbsp;getRelay()</pre>
<div class="block">Returns the boolean value of the <i>relay</i> attribute for this
<code>SOAPHeaderElement</code></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the relay attribute is turned on;
<code>false</code> otherwise</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if this message does not
support the SOAP 1.2 concept of Relay attribute.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, SAAJ 1.3</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#getMustUnderstand--"><code>getMustUnderstand()</code></a>,
<a href="../../../jakarta/xml/soap/SOAPHeaderElement.html#setRelay-boolean-"><code>setRelay(boolean)</code></a></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="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="../../../jakarta/xml/soap/SOAPHeader.html" title="interface in jakarta.xml.soap"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/xml/soap/SOAPMessage.html" title="class in jakarta.xml.soap"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/xml/soap/SOAPHeaderElement.html" target="_top">Frames</a></li>
<li><a href="SOAPHeaderElement.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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 ======= -->
</body>
</html>