| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>SOAPBinding</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="SOAPBinding"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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="../../../../javax/xml/ws/soap/MTOMFeature.html" title="class in javax.xml.ws.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/ws/soap/SOAPFaultException.html" title="class in javax.xml.ws.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/ws/soap/SOAPBinding.html" target="_top">Frames</a></li> |
| <li><a href="SOAPBinding.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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.ws.soap</div> |
| <h2 title="Interface SOAPBinding" class="title">Interface SOAPBinding</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../javax/xml/ws/Binding.html" title="interface in javax.xml.ws">Binding</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">SOAPBinding</span> |
| extends <a href="../../../../javax/xml/ws/Binding.html" title="interface in javax.xml.ws">Binding</a></pre> |
| <div class="block">The <code>SOAPBinding</code> interface is an abstraction for |
| the SOAP binding.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.0</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"> </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="../../../../javax/xml/ws/soap/SOAPBinding.html#SOAP11HTTP_BINDING">SOAP11HTTP_BINDING</a></span></code> |
| <div class="block">A constant representing the identity of the SOAP 1.1 over HTTP binding.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#SOAP11HTTP_MTOM_BINDING">SOAP11HTTP_MTOM_BINDING</a></span></code> |
| <div class="block">A constant representing the identity of the SOAP 1.1 over HTTP binding |
| with MTOM enabled by default.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#SOAP12HTTP_BINDING">SOAP12HTTP_BINDING</a></span></code> |
| <div class="block">A constant representing the identity of the SOAP 1.2 over HTTP binding.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#SOAP12HTTP_MTOM_BINDING">SOAP12HTTP_MTOM_BINDING</a></span></code> |
| <div class="block">A constant representing the identity of the SOAP 1.2 over HTTP binding |
| with MTOM enabled by default.</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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </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><a href="../../../../javax/xml/soap/MessageFactory.html" title="class in javax.xml.soap">MessageFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#getMessageFactory--">getMessageFactory</a></span>()</code> |
| <div class="block">Gets the SAAJ <code>MessageFactory</code> instance used by this SOAP binding.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.util.Set<java.lang.String></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#getRoles--">getRoles</a></span>()</code> |
| <div class="block">Gets the roles played by the SOAP binding instance.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../javax/xml/soap/SOAPFactory.html" title="class in javax.xml.soap">SOAPFactory</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#getSOAPFactory--">getSOAPFactory</a></span>()</code> |
| <div class="block">Gets the SAAJ <code>SOAPFactory</code> instance used by this SOAP binding.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#isMTOMEnabled--">isMTOMEnabled</a></span>()</code> |
| <div class="block">Returns <code>true</code> if the use of MTOM is enabled.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#setMTOMEnabled-boolean-">setMTOMEnabled</a></span>(boolean flag)</code> |
| <div class="block">Enables or disables use of MTOM.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/xml/ws/soap/SOAPBinding.html#setRoles-java.util.Set-">setRoles</a></span>(java.util.Set<java.lang.String> roles)</code> |
| <div class="block">Sets the roles played by the SOAP binding instance.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.xml.ws.Binding"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface javax.xml.ws.<a href="../../../../javax/xml/ws/Binding.html" title="interface in javax.xml.ws">Binding</a></h3> |
| <code><a href="../../../../javax/xml/ws/Binding.html#getBindingID--">getBindingID</a>, <a href="../../../../javax/xml/ws/Binding.html#getHandlerChain--">getHandlerChain</a>, <a href="../../../../javax/xml/ws/Binding.html#setHandlerChain-java.util.List-">setHandlerChain</a></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="SOAP11HTTP_BINDING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SOAP11HTTP_BINDING</h4> |
| <pre>static final java.lang.String SOAP11HTTP_BINDING</pre> |
| <div class="block">A constant representing the identity of the SOAP 1.1 over HTTP binding.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#javax.xml.ws.soap.SOAPBinding.SOAP11HTTP_BINDING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SOAP12HTTP_BINDING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SOAP12HTTP_BINDING</h4> |
| <pre>static final java.lang.String SOAP12HTTP_BINDING</pre> |
| <div class="block">A constant representing the identity of the SOAP 1.2 over HTTP binding.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#javax.xml.ws.soap.SOAPBinding.SOAP12HTTP_BINDING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SOAP11HTTP_MTOM_BINDING"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SOAP11HTTP_MTOM_BINDING</h4> |
| <pre>static final java.lang.String SOAP11HTTP_MTOM_BINDING</pre> |
| <div class="block">A constant representing the identity of the SOAP 1.1 over HTTP binding |
| with MTOM enabled by default.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#javax.xml.ws.soap.SOAPBinding.SOAP11HTTP_MTOM_BINDING">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="SOAP12HTTP_MTOM_BINDING"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SOAP12HTTP_MTOM_BINDING</h4> |
| <pre>static final java.lang.String SOAP12HTTP_MTOM_BINDING</pre> |
| <div class="block">A constant representing the identity of the SOAP 1.2 over HTTP binding |
| with MTOM enabled by default.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#javax.xml.ws.soap.SOAPBinding.SOAP12HTTP_MTOM_BINDING">Constant Field Values</a></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="getRoles--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRoles</h4> |
| <pre>java.util.Set<java.lang.String> getRoles()</pre> |
| <div class="block">Gets the roles played by the SOAP binding instance.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>Set<String></code> The set of roles played by the binding instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRoles-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRoles</h4> |
| <pre>void setRoles(java.util.Set<java.lang.String> roles)</pre> |
| <div class="block">Sets the roles played by the SOAP binding instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>roles</code> - The set of roles played by the binding instance.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - On an error in the configuration of |
| the list of roles.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMTOMEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMTOMEnabled</h4> |
| <pre>boolean isMTOMEnabled()</pre> |
| <div class="block">Returns <code>true</code> if the use of MTOM is enabled.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if and only if the use of MTOM is enabled.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMTOMEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMTOMEnabled</h4> |
| <pre>void setMTOMEnabled(boolean flag)</pre> |
| <div class="block">Enables or disables use of MTOM.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>flag</code> - A <code>boolean</code> specifying whether the use of MTOM should |
| be enabled or disabled.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../javax/xml/ws/WebServiceException.html" title="class in javax.xml.ws">WebServiceException</a></code> - If the specified setting is not supported |
| by this binding instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSOAPFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSOAPFactory</h4> |
| <pre><a href="../../../../javax/xml/soap/SOAPFactory.html" title="class in javax.xml.soap">SOAPFactory</a> getSOAPFactory()</pre> |
| <div class="block">Gets the SAAJ <code>SOAPFactory</code> instance used by this SOAP binding.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>SOAPFactory instance used by this SOAP binding.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMessageFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getMessageFactory</h4> |
| <pre><a href="../../../../javax/xml/soap/MessageFactory.html" title="class in javax.xml.soap">MessageFactory</a> getMessageFactory()</pre> |
| <div class="block">Gets the SAAJ <code>MessageFactory</code> instance used by this SOAP binding.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>MessageFactory instance used by this SOAP binding.</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="../../../../javax/xml/ws/soap/MTOMFeature.html" title="class in javax.xml.ws.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../javax/xml/ws/soap/SOAPFaultException.html" title="class in javax.xml.ws.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/xml/ws/soap/SOAPBinding.html" target="_top">Frames</a></li> |
| <li><a href="SOAPBinding.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
