| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Invocation</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="Invocation"; |
| } |
| } |
| 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/ws/rs/client/Entity.html" title="class in jakarta.ws.rs.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html" title="interface in jakarta.ws.rs.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/client/Invocation.html" target="_top">Frames</a></li> |
| <li><a href="Invocation.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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">jakarta.ws.rs.client</div> |
| <h2 title="Interface Invocation" class="title">Interface Invocation</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Invocation</span></pre> |
| <div class="block">A client request invocation. |
| |
| An invocation is a request that has been prepared and is ready for execution. Invocations provide a generic (command) |
| interface that enables a separation of concerns between the creator and the submitter. In particular, the submitter |
| does not need to know how the invocation was prepared, but only how it should be executed (synchronously or |
| asynchronously) and when.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html" title="interface in jakarta.ws.rs.client"><code>Invocation.Builder</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html" title="interface in jakarta.ws.rs.client">Invocation.Builder</a></span></code> |
| <div class="block">A client request invocation builder.</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="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core">Response</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.html#invoke--">invoke</a></span>()</code> |
| <div class="block">Synchronously invoke the request and receive a response back.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.html#invoke-java.lang.Class-">invoke</a></span>(java.lang.Class<T> responseType)</code> |
| <div class="block">Synchronously invoke the request and receive a response of the specified type back.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><T> T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.html#invoke-jakarta.ws.rs.core.GenericType-">invoke</a></span>(<a href="../../../../jakarta/ws/rs/core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a><T> responseType)</code> |
| <div class="block">Synchronously invoke the request and receive a response of the specified generic type back.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/ws/rs/client/Invocation.html" title="interface in jakarta.ws.rs.client">Invocation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.html#property-java.lang.String-java.lang.Object-">property</a></span>(java.lang.String name, |
| java.lang.Object value)</code> |
| <div class="block">Set a new property in the context of a request represented by this invocation.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.util.concurrent.Future<<a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core">Response</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.html#submit--">submit</a></span>()</code> |
| <div class="block">Submit the request for an asynchronous invocation and receive a future response back.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><T> java.util.concurrent.Future<T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.html#submit-java.lang.Class-">submit</a></span>(java.lang.Class<T> responseType)</code> |
| <div class="block">Submit the request for an asynchronous invocation and receive a future response of the specified type back.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><T> java.util.concurrent.Future<T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.html#submit-jakarta.ws.rs.core.GenericType-">submit</a></span>(<a href="../../../../jakarta/ws/rs/core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a><T> responseType)</code> |
| <div class="block">Submit the request for an asynchronous invocation and receive a future response of the specified generic type back.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><T> java.util.concurrent.Future<T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/ws/rs/client/Invocation.html#submit-jakarta.ws.rs.client.InvocationCallback-">submit</a></span>(<a href="../../../../jakarta/ws/rs/client/InvocationCallback.html" title="interface in jakarta.ws.rs.client">InvocationCallback</a><T> callback)</code> |
| <div class="block">Submit the request for an asynchronous invocation and register an <a href="../../../../jakarta/ws/rs/client/InvocationCallback.html" title="interface in jakarta.ws.rs.client"><code>InvocationCallback</code></a> to process the future |
| result of the invocation.</div> |
| </td> |
| </tr> |
| </table> |
| </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="property-java.lang.String-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>property</h4> |
| <pre><a href="../../../../jakarta/ws/rs/client/Invocation.html" title="interface in jakarta.ws.rs.client">Invocation</a> property(java.lang.String name, |
| java.lang.Object value)</pre> |
| <div class="block">Set a new property in the context of a request represented by this invocation. |
| <p> |
| The property is available for a later retrieval via <a href="../../../../jakarta/ws/rs/client/ClientRequestContext.html#getProperty-java.lang.String-"><code>ClientRequestContext.getProperty(String)</code></a> or |
| <a href="../../../../jakarta/ws/rs/ext/InterceptorContext.html#getProperty-java.lang.String-"><code>InterceptorContext.getProperty(String)</code></a>. If a property with a given name is already set in the |
| request context, the existing value of the property will be updated. Setting a <code>null</code> value into a property |
| effectively removes the property from the request property bag. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - property name.</dd> |
| <dd><code>value</code> - (new) property value. <code>null</code> value removes the property with the given name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the updated invocation.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html#property-java.lang.String-java.lang.Object-"><code>Invocation.Builder.property(String, Object)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invoke--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invoke</h4> |
| <pre><a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core">Response</a> invoke()</pre> |
| <div class="block">Synchronously invoke the request and receive a response back.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>response</code></a> object as a result of the request invocation.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../jakarta/ws/rs/client/ResponseProcessingException.html" title="class in jakarta.ws.rs.client">ResponseProcessingException</a></code> - in case processing of a received HTTP response fails (e.g. in a filter or during |
| conversion of the response entity data to an instance of a particular Java type).</dd> |
| <dd><code><a href="../../../../jakarta/ws/rs/ProcessingException.html" title="class in jakarta.ws.rs">ProcessingException</a></code> - in case the request processing or subsequent I/O operation fails.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invoke-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invoke</h4> |
| <pre><T> T invoke(java.lang.Class<T> responseType)</pre> |
| <div class="block">Synchronously invoke the request and receive a response of the specified type back.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - response type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>responseType</code> - Java type the response should be converted into.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response object of the specified type as a result of the request invocation.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../jakarta/ws/rs/client/ResponseProcessingException.html" title="class in jakarta.ws.rs.client">ResponseProcessingException</a></code> - in case processing of a received HTTP response fails (e.g. in a filter or during |
| conversion of the response entity data to an instance of a particular Java type).</dd> |
| <dd><code><a href="../../../../jakarta/ws/rs/ProcessingException.html" title="class in jakarta.ws.rs">ProcessingException</a></code> - in case the request processing or subsequent I/O operation fails.</dd> |
| <dd><code><a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></code> - in case the response status code of the response returned by the server is not |
| <a href="../../../../jakarta/ws/rs/core/Response.Status.Family.html#SUCCESSFUL"><code>successful</code></a> and the specified response type is not |
| <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="invoke-jakarta.ws.rs.core.GenericType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>invoke</h4> |
| <pre><T> T invoke(<a href="../../../../jakarta/ws/rs/core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a><T> responseType)</pre> |
| <div class="block">Synchronously invoke the request and receive a response of the specified generic type back.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - generic response type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>responseType</code> - type literal representing a generic Java type the response should be converted into.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>response object of the specified generic type as a result of the request invocation.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../jakarta/ws/rs/client/ResponseProcessingException.html" title="class in jakarta.ws.rs.client">ResponseProcessingException</a></code> - in case processing of a received HTTP response fails (e.g. in a filter or during |
| conversion of the response entity data to an instance of a particular Java type).</dd> |
| <dd><code><a href="../../../../jakarta/ws/rs/ProcessingException.html" title="class in jakarta.ws.rs">ProcessingException</a></code> - in case the request processing or subsequent I/O operation fails.</dd> |
| <dd><code><a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs">WebApplicationException</a></code> - in case the response status code of the response returned by the server is not |
| <a href="../../../../jakarta/ws/rs/core/Response.Status.Family.html#SUCCESSFUL"><code>successful</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="submit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>submit</h4> |
| <pre>java.util.concurrent.Future<<a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core">Response</a>> submit()</pre> |
| <div class="block">Submit the request for an asynchronous invocation and receive a future response back. |
| <p> |
| Note that calling the <code>Future.get()</code> method on the returned <code>Future</code> instance may |
| throw an <code>ExecutionException</code> that wraps a <a href="../../../../jakarta/ws/rs/ProcessingException.html" title="class in jakarta.ws.rs"><code>ProcessingException</code></a> thrown in case of |
| an invocation processing failure. In case a processing of a properly received response fails, the wrapped processing |
| exception will be of <a href="../../../../jakarta/ws/rs/client/ResponseProcessingException.html" title="class in jakarta.ws.rs.client"><code>ResponseProcessingException</code></a> type and will contain the <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a> instance whose |
| processing has failed. |
| </p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>future <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>response</code></a> object as a result of the request invocation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="submit-java.lang.Class-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>submit</h4> |
| <pre><T> java.util.concurrent.Future<T> submit(java.lang.Class<T> responseType)</pre> |
| <div class="block">Submit the request for an asynchronous invocation and receive a future response of the specified type back. |
| <p> |
| Note that calling the <code>Future.get()</code> method on the returned <code>Future</code> instance may |
| throw an <code>ExecutionException</code> that wraps either a <a href="../../../../jakarta/ws/rs/ProcessingException.html" title="class in jakarta.ws.rs"><code>ProcessingException</code></a> thrown in |
| case of an invocation processing failure or a <a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs"><code>WebApplicationException</code></a> or one of its subclasses thrown in case |
| the received response status code is not <a href="../../../../jakarta/ws/rs/core/Response.Status.Family.html#SUCCESSFUL"><code>successful</code></a> and |
| the specified response type is not <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a>. In case a processing of a properly received |
| response fails, the wrapped processing exception will be of <a href="../../../../jakarta/ws/rs/client/ResponseProcessingException.html" title="class in jakarta.ws.rs.client"><code>ResponseProcessingException</code></a> type and will contain |
| the <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a> instance whose processing has failed. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - response type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>responseType</code> - Java type the response should be converted into.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>future response object of the specified type as a result of the request invocation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="submit-jakarta.ws.rs.core.GenericType-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>submit</h4> |
| <pre><T> java.util.concurrent.Future<T> submit(<a href="../../../../jakarta/ws/rs/core/GenericType.html" title="class in jakarta.ws.rs.core">GenericType</a><T> responseType)</pre> |
| <div class="block">Submit the request for an asynchronous invocation and receive a future response of the specified generic type back. |
| <p> |
| Note that calling the <code>Future.get()</code> method on the returned <code>Future</code> instance may |
| throw an <code>ExecutionException</code> that wraps either a <a href="../../../../jakarta/ws/rs/ProcessingException.html" title="class in jakarta.ws.rs"><code>ProcessingException</code></a> thrown in |
| case of an invocation processing failure or a <a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs"><code>WebApplicationException</code></a> or one of its subclasses thrown in case |
| the received response status code is not <a href="../../../../jakarta/ws/rs/core/Response.Status.Family.html#SUCCESSFUL"><code>successful</code></a> and |
| the specified response type is not <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a>. In case a processing of a properly received |
| response fails, the wrapped processing exception will be of <a href="../../../../jakarta/ws/rs/client/ResponseProcessingException.html" title="class in jakarta.ws.rs.client"><code>ResponseProcessingException</code></a> type and will contain |
| the <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a> instance whose processing has failed. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - generic response type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>responseType</code> - type literal representing a generic Java type the response should be converted into.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>future response object of the specified generic type as a result of the request invocation.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="submit-jakarta.ws.rs.client.InvocationCallback-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>submit</h4> |
| <pre><T> java.util.concurrent.Future<T> submit(<a href="../../../../jakarta/ws/rs/client/InvocationCallback.html" title="interface in jakarta.ws.rs.client">InvocationCallback</a><T> callback)</pre> |
| <div class="block">Submit the request for an asynchronous invocation and register an <a href="../../../../jakarta/ws/rs/client/InvocationCallback.html" title="interface in jakarta.ws.rs.client"><code>InvocationCallback</code></a> to process the future |
| result of the invocation. |
| <p> |
| Note that calling the <code>Future.get()</code> method on the returned <code>Future</code> instance may |
| throw an <code>ExecutionException</code> that wraps either a <a href="../../../../jakarta/ws/rs/ProcessingException.html" title="class in jakarta.ws.rs"><code>ProcessingException</code></a> thrown in |
| case of an invocation processing failure or a <a href="../../../../jakarta/ws/rs/WebApplicationException.html" title="class in jakarta.ws.rs"><code>WebApplicationException</code></a> or one of its subclasses thrown in case |
| the received response status code is not <a href="../../../../jakarta/ws/rs/core/Response.Status.Family.html#SUCCESSFUL"><code>successful</code></a> and |
| the generic type of the supplied response callback is not <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a>. In case a processing of |
| a properly received response fails, the wrapped processing exception will be of <a href="../../../../jakarta/ws/rs/client/ResponseProcessingException.html" title="class in jakarta.ws.rs.client"><code>ResponseProcessingException</code></a> |
| type and will contain the <a href="../../../../jakarta/ws/rs/core/Response.html" title="class in jakarta.ws.rs.core"><code>Response</code></a> instance whose processing has failed. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - response type</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>callback</code> - invocation callback for asynchronous processing of the request invocation result.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>future response object of the specified type as a result of the request invocation.</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/ws/rs/client/Entity.html" title="class in jakarta.ws.rs.client"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/ws/rs/client/Invocation.Builder.html" title="interface in jakarta.ws.rs.client"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/ws/rs/client/Invocation.html" target="_top">Frames</a></li> |
| <li><a href="Invocation.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><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </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> |
