| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>MTOMFeature</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="MTOMFeature"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":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/soap/MTOM.html" title="annotation in jakarta.xml.ws.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/xml/ws/soap/SOAPBinding.html" title="interface in jakarta.xml.ws.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/xml/ws/soap/MTOMFeature.html" target="_top">Frames</a></li> |
| <li><a href="MTOMFeature.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </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.soap</div> |
| <h2 title="Class MTOMFeature" class="title">Class MTOMFeature</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.soap.MTOMFeature</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">MTOMFeature</span> |
| extends <a href="../../../../jakarta/xml/ws/WebServiceFeature.html" title="class in jakarta.xml.ws">WebServiceFeature</a></pre> |
| <div class="block">This feature represents the use of MTOM with a |
| web service. |
| |
| 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> |
| The following describes the affects of this feature with respect |
| to being enabled or disabled: |
| <ul> |
| <li> ENABLED: In this Mode, MTOM will be enabled. A receiver MUST accept |
| both a non-optimized and an optimized message, and a sender MAY send an |
| optimized message, or a non-optimized message. The heuristics used by a |
| sender to determine whether to use optimization or not are |
| implementation-specific. |
| <li> DISABLED: In this Mode, MTOM will be disabled |
| </ul> |
| <p> |
| The <a href="../../../../jakarta/xml/ws/soap/MTOMFeature.html#threshold"><code>threshold</code></a> property can be used to set the threshold |
| value used to determine when binary data should be XOP encoded.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.6, JAX-WS 2.1</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="../../../../jakarta/xml/ws/soap/MTOMFeature.html#ID">ID</a></span></code> |
| <div class="block">Constant value identifying the MTOMFeature</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/soap/MTOMFeature.html#threshold">threshold</a></span></code> |
| <div class="block">Property for MTOM threshold value.</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 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"> </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/soap/MTOMFeature.html#MTOMFeature--">MTOMFeature</a></span>()</code> |
| <div class="block">Create an <code>MTOMFeature</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/soap/MTOMFeature.html#MTOMFeature-boolean-">MTOMFeature</a></span>(boolean enabled)</code> |
| <div class="block">Creates a <code>MTOMFeature</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/soap/MTOMFeature.html#MTOMFeature-boolean-int-">MTOMFeature</a></span>(boolean enabled, |
| int threshold)</code> |
| <div class="block">Creates a <code>MTOMFeature</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/soap/MTOMFeature.html#MTOMFeature-int-">MTOMFeature</a></span>(int threshold)</code> |
| <div class="block">Creates a <code>MTOMFeature</code>.</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/soap/MTOMFeature.html#getID--">getID</a></span>()</code> |
| <div class="block">Get the unique identifier for this WebServiceFeature.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/xml/ws/soap/MTOMFeature.html#getThreshold--">getThreshold</a></span>()</code> |
| <div class="block">Gets the threshold value used to determine when binary data |
| should be sent as an attachment.</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 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 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="blockList"> |
| <li class="blockList"> |
| <h4>ID</h4> |
| <pre>public static final java.lang.String ID</pre> |
| <div class="block">Constant value identifying the MTOMFeature</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#jakarta.xml.ws.soap.MTOMFeature.ID">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="threshold"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>threshold</h4> |
| <pre>protected int threshold</pre> |
| <div class="block">Property for MTOM threshold value. This property serves as a hint when |
| MTOM is enabled, binary data above this size in bytes SHOULD be sent |
| as attachment. |
| The value of this property MUST always be >= 0. Default value is 0.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MTOMFeature--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MTOMFeature</h4> |
| <pre>public MTOMFeature()</pre> |
| <div class="block">Create an <code>MTOMFeature</code>. |
| The instance created will be enabled.</div> |
| </li> |
| </ul> |
| <a name="MTOMFeature-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MTOMFeature</h4> |
| <pre>public MTOMFeature(boolean enabled)</pre> |
| <div class="block">Creates a <code>MTOMFeature</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enabled</code> - specifies if this feature should be enabled or not</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MTOMFeature-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MTOMFeature</h4> |
| <pre>public MTOMFeature(int threshold)</pre> |
| <div class="block">Creates a <code>MTOMFeature</code>. |
| The instance created will be enabled.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>threshold</code> - the size in bytes that binary data SHOULD be before |
| being sent as an attachment.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws">WebServiceException</a></code> - if threshold is < 0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="MTOMFeature-boolean-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MTOMFeature</h4> |
| <pre>public MTOMFeature(boolean enabled, |
| int threshold)</pre> |
| <div class="block">Creates a <code>MTOMFeature</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>enabled</code> - specifies if this feature should be enabled or not</dd> |
| <dd><code>threshold</code> - the size in bytes that binary data SHOULD be before |
| being sent as an attachment.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../jakarta/xml/ws/WebServiceException.html" title="class in jakarta.xml.ws">WebServiceException</a></code> - if threshold is < 0</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="blockList"> |
| <li class="blockList"> |
| <h4>getID</h4> |
| <pre>public java.lang.String 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> in class <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> |
| <a name="getThreshold--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getThreshold</h4> |
| <pre>public int getThreshold()</pre> |
| <div class="block">Gets the threshold value used to determine when binary data |
| should be sent as an attachment.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the current threshold size in bytes</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/soap/MTOM.html" title="annotation in jakarta.xml.ws.soap"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/xml/ws/soap/SOAPBinding.html" title="interface in jakarta.xml.ws.soap"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/xml/ws/soap/MTOMFeature.html" target="_top">Frames</a></li> |
| <li><a href="MTOMFeature.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
