blob: 96e888b32ce2ef88a134b65825ef2141ba3e27ad [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>RespectBindingFeature</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<link rel="shortcut icon" href="/img/jakarta-favicon.ico">
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RespectBindingFeature";
}
}
catch(err) {
}
//-->
var methods = {"i0":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ws/RespectBinding.html" title="annotation in jakarta.xml.ws"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/xml/ws/Response.html" title="interface in jakarta.xml.ws"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/xml/ws/RespectBindingFeature.html" target="_top">Frames</a></li>
<li><a href="RespectBindingFeature.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.ws</div>
<h2 title="Class RespectBindingFeature" class="title">Class RespectBindingFeature</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../jakarta/xml/ws/WebServiceFeature.html" title="class in jakarta.xml.ws">jakarta.xml.ws.WebServiceFeature</a></li>
<li>
<ul class="inheritance">
<li>jakarta.xml.ws.RespectBindingFeature</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">RespectBindingFeature</span>
extends <a href="../../../jakarta/xml/ws/WebServiceFeature.html" title="class in jakarta.xml.ws">WebServiceFeature</a></pre>
<div class="block">This feature clarifies the use of the <code>wsdl:binding</code>
in a Jakarta XML Web Services runtime.
This feature can be used during the creation of SEI proxy, and
<a href="../../../jakarta/xml/ws/Dispatch.html" title="interface in jakarta.xml.ws"><code>Dispatch</code></a> instances on the client side and <a href="../../../jakarta/xml/ws/Endpoint.html" title="class in jakarta.xml.ws"><code>Endpoint</code></a>
instances on the server side. This feature cannot be used for <a href="../../../jakarta/xml/ws/Service.html" title="class in jakarta.xml.ws"><code>Service</code></a>
instance creation on the client side.
<p>
This feature is only useful with web services that have an
associated WSDL. Enabling this feature requires that a Jakarta XML Web Services
implementation inspect the <code>wsdl:binding</code> for an
endpoint at runtime to make sure that all <code>wsdl:extensions</code>
that have the <code>required</code> attribute set to <code>true</code>
are understood and are being used.
<p>
The following describes the affects of this feature with respect
to be enabled or disabled:
<ul>
<li> ENABLED: In this Mode, a Jakarta XML Web Services runtime MUST assure that all
required <code>wsdl:binding</code> extensions(including policies) are
either understood and used by the runtime, or explicitly disabled by the
web service application. A web service can disable a particular
extension if there is a corresponding <a href="../../../jakarta/xml/ws/WebServiceFeature.html" title="class in jakarta.xml.ws"><code>WebServiceFeature</code></a> or annotation.
Similarly, a web service client can disable
particular extension using the corresponding <code>WebServiceFeature</code> while
creating a proxy or Dispatch instance.
The runtime MUST also make sure that binding of
SEI parameters/return values respect the <code>wsdl:binding</code>.
With this feature enabled, if a required (<code>wsdl:required="true"</code>)
<code>wsdl:binding</code> extension is in the WSDL and it is not
supported by a Jakarta XML Web Services runtime and it has not
been explicitly turned off by the web service developer, then
that Jakarta XML Web Services runtime MUST behave appropriately based on whether it is
on the client or server:
<UL>
<li>Client: runtime MUST throw a
<a href="../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws"><code>WebServiceException</code></a> no sooner than when one of the methods
above is invoked but no later than the first invocation of an endpoint
operation.
<li>Server: throw a <a href="../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws"><code>WebServiceException</code></a> and the endpoint MUST fail to deploy
</ul>
<li> DISABLED: In this Mode, an implementation may choose whether
to inspect the <code>wsdl:binding</code> or not and to what degree
the <code>wsdl:binding</code> will be inspected. For example,
one implementation may choose to behave as if this feature is enabled,
another implementation may only choose to verify the SEI's
parameter/return type bindings.
</ul></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6, JAX-WS 2.1</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../jakarta/xml/ws/soap/AddressingFeature.html" title="class in jakarta.xml.ws.soap"><code>AddressingFeature</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>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/RespectBindingFeature.html#ID">ID</a></span></code>
<div class="block">Constant value identifying the RespectBindingFeature</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.jakarta.xml.ws.WebServiceFeature">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;jakarta.xml.ws.<a href="../../../jakarta/xml/ws/WebServiceFeature.html" title="class in jakarta.xml.ws">WebServiceFeature</a></h3>
<code><a href="../../../jakarta/xml/ws/WebServiceFeature.html#enabled">enabled</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/RespectBindingFeature.html#RespectBindingFeature--">RespectBindingFeature</a></span>()</code>
<div class="block">Creates an <code>RespectBindingFeature</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../jakarta/xml/ws/RespectBindingFeature.html#RespectBindingFeature-boolean-">RespectBindingFeature</a></span>(boolean&nbsp;enabled)</code>
<div class="block">Creates an RespectBindingFeature</div>
</td>
</tr>
</table>
</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/ws/RespectBindingFeature.html#getID--">getID</a></span>()</code>
<div class="block">Get the unique identifier for this WebServiceFeature.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.jakarta.xml.ws.WebServiceFeature">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;jakarta.xml.ws.<a href="../../../jakarta/xml/ws/WebServiceFeature.html" title="class in jakarta.xml.ws">WebServiceFeature</a></h3>
<code><a href="../../../jakarta/xml/ws/WebServiceFeature.html#isEnabled--">isEnabled</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ID">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ID</h4>
<pre>public static final&nbsp;java.lang.String ID</pre>
<div class="block">Constant value identifying the RespectBindingFeature</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#jakarta.xml.ws.RespectBindingFeature.ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RespectBindingFeature--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RespectBindingFeature</h4>
<pre>public&nbsp;RespectBindingFeature()</pre>
<div class="block">Creates an <code>RespectBindingFeature</code>.
The instance created will be enabled.</div>
</li>
</ul>
<a name="RespectBindingFeature-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RespectBindingFeature</h4>
<pre>public&nbsp;RespectBindingFeature(boolean&nbsp;enabled)</pre>
<div class="block">Creates an RespectBindingFeature</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enabled</code> - specifies whether this feature should
be enabled or not.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getID--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getID</h4>
<pre>public&nbsp;java.lang.String&nbsp;getID()</pre>
<div class="block">Get the unique identifier for this WebServiceFeature.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../jakarta/xml/ws/WebServiceFeature.html#getID--">getID</a></code>&nbsp;in class&nbsp;<code><a href="../../../jakarta/xml/ws/WebServiceFeature.html" title="class in jakarta.xml.ws">WebServiceFeature</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the unique identifier for this feature.</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/ws/RespectBinding.html" title="annotation in jakarta.xml.ws"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../jakarta/xml/ws/Response.html" title="interface in jakarta.xml.ws"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?jakarta/xml/ws/RespectBindingFeature.html" target="_top">Frames</a></li>
<li><a href="RespectBindingFeature.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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>